b4440094b0
- util::Mutex is now a std::shared_timed_mutex, which is capable of
exclusive and shared locks.
- util::Lock is still present as a std::lock_guard<util::Mutex>.
- the locking annotations are preserved, but updated to the latest
supported by clang rather than using abseil's older/deprecated ones.
- ACQUIRE_LOCK macro is gone since we don't pass mutexes by pointer into
locks anymore (WTF abseil).
- ReleasableLock is gone. Instead there are now some llarp::util helper
methods to obtain unique and/or shared locks:
- `auto lock = util::unique_lock(mutex);` gets an RAII-but-also
unlockable object (std::unique_lock<T>, with T inferred from
`mutex`).
- `auto lock = util::shared_lock(mutex);` gets an RAII shared (i.e.
"reader") lock of the mutex.
- `auto lock = util::unique_locks(mutex1, mutex2, mutex3);` can be
used to atomically lock multiple mutexes at once (returning a
tuple of the locks).
This are templated on the mutex which makes them a bit more flexible
than using a concrete type: they can be used for any type of lockable
mutex, not only util::Mutex. (Some of the code here uses them for
getting locks around a std::mutex). Until C++17, using the RAII types
is painfully verbose:
```C++
// pre-C++17 - needing to figure out the mutex type here is annoying:
std::unique_lock<util::Mutex> lock(mutex);
// pre-C++17 and even more verbose (but at least the type isn't needed):
std::unique_lock<decltype(mutex)> lock(mutex);
// our compromise:
auto lock = util::unique_lock(mutex);
// C++17:
std::unique_lock lock(mutex);
```
All of these functions will also warn (under gcc or clang) if you
discard the return value. You can also do fancy things like
`auto l = util::unique_lock(mutex, std::adopt_lock)` (which lets a
lock take over an already-locked mutex).
- metrics code is gone, which also removes a big pile of code that was
only used by metrics:
- llarp::util::Scheduler
- llarp:🧵:TimerQueue
- llarp::util::Stopwatch
|
5 years ago | |
|---|---|---|
| .github | 6 years ago | |
| android | 5 years ago | |
| client | ||
| cmake | 5 years ago | |
| contrib | 5 years ago | |
| crypto | 5 years ago | |
| daemon | 5 years ago | |
| debian | 5 years ago | |
| docker | 5 years ago | |
| docs | 5 years ago | |
| external | 5 years ago | |
| include | 5 years ago | |
| jni | 5 years ago | |
| libabyss | 5 years ago | |
| llarp | 5 years ago | |
| osx-setup | 5 years ago | |
| test | 5 years ago | |
| ui-ios | 5 years ago | |
| ui-macos | 5 years ago | |
| ui-win32 | 5 years ago | |
| vendor | 5 years ago | |
| win32-setup | 5 years ago | |
| .clang-format | ||
| .clang-tidy | 5 years ago | |
| .dir-locals.el | ||
| .dockerignore | 5 years ago | |
| .gitignore | 5 years ago | |
| .gitlab-ci.yml | 5 years ago | |
| .gitmodules | 5 years ago | |
| .travis.yml | 5 years ago | |
| CMakeLists.txt | 5 years ago | |
| CMakeSettings.json | 5 years ago | |
| CONTRIBUTING.md | 5 years ago | |
| CONTRIBUTING_es.md | 5 years ago | |
| CROSSCOMPILE.md | 5 years ago | |
| Doxyfile | ||
| LICENSE | 5 years ago | |
| Makefile | 5 years ago | |
| doc | ||
| lokinet-bootstrap | 5 years ago | |
| lokinet-docker.ini | 6 years ago | |
| module.modulemap | ||
| motto.txt | 5 years ago | |
| readme.md | 5 years ago | |
| readme_es.md | 5 years ago | |
| release.md | 5 years ago | |
| release_es.md | 5 years ago | |
| run-lokinet.bat | 6 years ago | |
| testnet_readme.md | 6 years ago | |
readme.md
Lokinet
Lokinet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
You can learn more about the high level design of LLARP here
And you can read the LLARP protocol specification here
You can view documentation on how to get started here .
Usage
See the documentation on how to get started.
Also read the Public Testing Guide for installation and other helpful information.
Running on Linux
DO NOT RUN AS ROOT, run as normal user. This requires the binary to have the proper setcaps set by make install on the binary.
to run as client:
$ lokinet -g
$ lokinet-bootstrap
$ lokinet
to run as relay:
$ lokinet -r -g
$ lokinet-bootstrap
$ lokinet
Running on MacOS/UNIX/BSD
YOU HAVE TO RUN AS ROOT, run using sudo. Elevated privileges are needed to create the virtual tunnel interface.
The MacOS installer places the normal binaries (lokinet and lokinet-bootstrap) in /usr/local/bin which should be in your path, so you can easily use the binaries from your terminal. The installer also nukes your previous config and keys and sets up a fresh config and downloads the latest bootstrap seed.
to run as client:
$ lokinet -g
$ lokinet-bootstrap
$ sudo lokinet
to run as relay:
$ lokinet -r -g
$ lokinet-bootstrap
$ sudo lokinet
Running on Windows
DO NOT RUN AS ELEVATED USER, run as normal user.
to run as client, run the run-lokinet.bat batch file as your normal user.
Building
Build requirements:
- GNU Make
- CMake
- C++ 14 capable C++ compiler
- gcovr (if generating test coverage with gcc)
- libuv >= 1.27.0
- libsodium >= 1.0.18
- libcurl
Linux
build:
$ sudo apt install build-essential cmake git libcap-dev curl libuv1-dev libsodium-dev libcurl4-openssl-dev pkg-config
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make
install:
$ sudo make install
alternatively make a debian package with:
$ debuild -uc -us -b
this puts the built packages in ../
Static Linux
static native optimized:
$ make static STATIC_LINK=ON
cross compile fully static armhf (rpi 2 and up)
$ make static STATIC_LINK=ON DOWNLOAD_SODIUM=ON TOOLCHAIN=contrib/cross/armhf.toolchain.cmake
MacOS
build: make sure you have cmake, libuv and xcode command line tools installed
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8
install:
$ sudo make install
Windows
build (where $ARCH is your platform - i686 or x86_64):
$ pacman -Sy base-devel mingw-w64-$ARCH-toolchain git libtool autoconf mingw-w64-$ARCH-cmake
$ git clone https://github.com/loki-project/loki-network.git
$ cd loki-network
$ mkdir -p build; cd build
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK_RUNTIME=ON -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -G 'Unix Makefiles'
install (elevated) to $PROGRAMFILES/lokinet or $ProgramFiles(x86)/lokinet:
$ make install
if cross-compiling, install mingw-w64 from your distro's package manager, or build from source, then:
$ mkdir -p build; cd build
$ export COMPILER=clang # if using clang for windows
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK_RUNTIME=ON -DCMAKE_CROSSCOMPILING=ON -DCMAKE_TOOLCHAIN_FILE=../contrib/cross/mingw[32].cmake
this will create a static binary that can be installed anywhere, with no other dependency other than libc (minimum v6.1)
Solaris 2.10+
NOTE: Oracle Solaris users need to download/compile the TAP driver from http://www.whiteboard.ne.jp/~admin2/tuntap/
The generated binaries may work on Solaris 2.10 or earlier, you're on your own. (Recommended: -static-libstdc++ -static-libgcc, and the TAP driver if not already installed on the target system.)
Building on a v2.10 or earlier system is unsupported, and may not even work; recent GCC releases have progressively dropped support for older system releases.
build:
$ sudo pkg install build-essential gcc8 wget tuntap cmake (optional: ninja ccache - from omnios extra) (OmniOS CE)
$ sudo pkg install base-developer-utilities developer-gnu developer-studio-utilities gcc-7 wget cmake (Oracle Solaris, see note)
$ sudo pkg install build-essential wget gcc-8 documentation/tuntap header-tun tun (optional: ninja ccache) (all other SunOS)
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8
install:
$ sudo make install
NetBSD (and other platforms where pkgsrc is the native package mgr)
TODO: add pkgsrc instructions
OpenBSD (uses legacy netbsd pkg manager)
build:
# pkg_add curl cmake git (optional: ninja ccache)
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8
install (root):
# gmake install
FreeBSD
build:
$ pkg install cmake git curl libuv libsodium pkgconf
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ mkdir build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make
install (root):
# make install