mirror of
https://github.com/shadowsocks/shadowsocks-libev.git
synced 2026-10-28 19:53:46 +00:00
add licenses for libipset and libcork
This commit is contained in:
Max Lv
@@ -0,0 +1,30 @@
|
||||
Copyright © 2011-2012, RedJack, LLC.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
• Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
• Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
• Neither the name of RedJack Software, LLC nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
@@ -0,0 +1,65 @@
|
||||
# libcork
|
||||
|
||||
So what is libcork, exactly? It's a “simple, easily embeddable,
|
||||
cross-platform C library”. It falls roughly into the same category as
|
||||
[glib](http://library.gnome.org/devel/glib/) or
|
||||
[APR](http://apr.apache.org/) in the C world; the STL,
|
||||
[POCO](http://pocoproject.org/), or [QtCore](http://qt.nokia.com/)
|
||||
in the C++ world; or the standard libraries of any decent dynamic
|
||||
language.
|
||||
|
||||
So if libcork has all of these comparables, why a new library? Well,
|
||||
none of the C++ options are really applicable here. And none of the C
|
||||
options work, because one of the main goals is to have the library be
|
||||
highly modular, and useful in resource-constrained systems. Once we
|
||||
describe some of the design decisions that we've made in libcork, you'll
|
||||
hopefully see how this fits into an interesting niche of its own.
|
||||
|
||||
## Using libcork
|
||||
|
||||
There are two primary ways to use libcork in your own software project:
|
||||
as a _shared library_, or _embedded_.
|
||||
|
||||
When you use libcork as a shared library, you install it just like you
|
||||
would any other C library. We happen to use CMake as our build system,
|
||||
so you follow the usual CMake recipe to install the library. (See the
|
||||
[INSTALL](INSTALL) file for details.) All of the libcork code is
|
||||
contained within a single shared library (called libcork.so,
|
||||
libcork.dylib, or cork.dll, depending on the system). We also install a
|
||||
pkg-config file that makes it easy to add the appropriate compiler flags
|
||||
in your own build scripts. So, you use pkg-config to find libcork's
|
||||
include and library files, link with libcork, and you're good to go.
|
||||
|
||||
The alternative is to embed libcork into your own software project's
|
||||
directory structure. In this case, your build scripts compile the
|
||||
libcork source along with the rest of your code. This has some
|
||||
advantages for resource-constrained systems, since (assuming your
|
||||
compiler and linker are any good), you only include the libcork routines
|
||||
that you actually use. And if your toolchain supports link-time
|
||||
optimization, the libcork routines can be optimized into the rest of
|
||||
your code.
|
||||
|
||||
Which should you use? That's really up to you. Linking against the
|
||||
shared library adds a runtime dependency, but gives you the usual
|
||||
benefits of shared libraries: the library in memory is shared across
|
||||
each program that uses it; you can install a single bug-fix update and
|
||||
all libcork programs automatically take advantage of the new release;
|
||||
etc. The embedding option is great if you really need to make your
|
||||
library as small as possible, or if you don't want to add that runtime
|
||||
dependency.
|
||||
|
||||
## Design decisions
|
||||
|
||||
Note that having libcork be **easily** embeddable has some ramifications
|
||||
on the library's design. In particular, we don't want to make any
|
||||
assumptions about which build system you're embedding libcork into. We
|
||||
happen to use CMake, but you might be using autotools, waf, scons, or
|
||||
any number of others. Most cross-platform libraries follow the
|
||||
autotools model of performing some checks at compile time (maybe during
|
||||
a separate “configure” phase, maybe not) to choose the right API
|
||||
implementation for the current platform. Since we can't assume a build
|
||||
system, we have to take a different approach, and do as many checks as
|
||||
we can using the C preprocessor. Any check that we can't make in the
|
||||
preprocessor has to be driven by a C preprocessor macro definition,
|
||||
which you (the libcork user) are responsible for checking for and
|
||||
defining. So we need to have as few of those as possible.
|
||||
@@ -0,0 +1,30 @@
|
||||
Copyright © 2009-2013, RedJack, LLC.
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions are
|
||||
met:
|
||||
|
||||
• Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
• Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
• Neither the name of RedJack Software, LLC nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
@@ -0,0 +1,10 @@
|
||||
# ipset
|
||||
|
||||
The ipset library provides C data types for storing sets of IP
|
||||
addresses, and maps of IP addresses to integers. It supports both
|
||||
IPv4 and IPv6 addresses. It's implemented using [Binary Decision
|
||||
Diagrams](http://en.wikipedia.org/wiki/Binary_decision_diagram)
|
||||
(BDDs), which (we hypothesize) makes it space efficient for large
|
||||
sets.
|
||||
|
||||
Please see the INSTALL file for installation instructions.
|
||||
Reference in New Issue
Block a user