SeaStar is an event-driven framework allowing you to write non-blocking, asynchronous code in a relatively straightforward manner (once understood). It is based on futures.
For more details and alternative work-flows, read HACKING.md.
Assuming that you would like to use system packages (RPMs or DEBs) for Seastar's dependencies, first install them:
$ sudo ./install-dependencies.sh
then configure (in "release" mode):
$ ./configure.py --mode=release
then compile:
In case there are compilation issues, especially like g++: internal compiler error: Killed (program cc1plus)
try giving more memory to gcc, either by limiting the amount of threads ( -j1 ) and/or allowing at least 4g ram to your machine.
If you're missing a dependency of Seastar, then it is possible to have the configuration process fetch a version of the dependency locally for development.
For example, to fetch fmt
locally, configure Seastar like this:
$ ./configure.py --mode=dev --cook fmt
--cook
can be repeated many times for selecting multiple dependencies.
The configure.py script is a wrapper around cmake. The --mode argument maps to CMAKE_BUILD_TYPE, and supports the following modes
CMake mode Debug info Optimizations Sanitizers Allocator Checks Use for debugDebug
Yes -O0
ASAN, UBSAN System All gdb release RelWithDebInfo
Yes -O3
None Seastar Asserts production dev Dev
(Custom) No -O1
None Seastar Asserts build and test cycle sanitize Sanitize
(Custom) Yes -Os
ASAN, UBSAN System All second level of tests, track down bugs
Note that seastar is more sensitive to allocators and optimizations than usual. A quick rule of the thumb of the relative performances is that release is 2 times faster than dev, 150 times faster than sanitize and 300 times faster than debug.
Using Seastar from its build directory (without installation)It's possible to consume Seastar directly from its build directory with CMake or pkg-config
.
We'll assume that the Seastar repository is located in a directory at $seastar_dir
.
Via pkg-config
:
$ g++ my_app.cc $(pkg-config --libs --cflags --static $seastar_dir/build/release/seastar.pc) -o my_app
and with CMake using the Seastar
package:
CMakeLists.txt
for my_app
:
set (CMAKE_CXX_STANDARD 23)
find_package (Seastar REQUIRED)
add_executable (my_app
my_app.cc)
target_link_libraries (my_app
Seastar::seastar)
$ mkdir $my_app_dir/build
$ cd $my_app_dir/build
$ cmake -DCMAKE_PREFIX_PATH="$seastar_dir/build/release;$seastar_dir/build/release/_cooking/installed" -DCMAKE_MODULE_PATH=$seastar_dir/cmake $my_app_dir
The CMAKE_PREFIX_PATH
values ensure that CMake can locate Seastar and its compiled submodules. The CMAKE_MODULE_PATH
value ensures that CMake can uses Seastar's CMake scripts for locating its dependencies.
You can also consume Seastar after it has been installed to the file-system.
Important:
$build_dir/_cooking/installed
First, configure the installation path:
$ ./configure.py --mode=release --prefix=/usr/local
then run the install
target:
$ ninja -C build/release install
then consume it from pkg-config
:
$ g++ my_app.cc $(pkg-config --libs --cflags --static seastar) -o my_app
or consume it with the same CMakeLists.txt
as before but with a simpler CMake invocation:
(If Seastar has not been installed to a "standard" location like /usr
or /usr/local
, then you can invoke CMake with -DCMAKE_PREFIX_PATH=$my_install_root
.)
There are also instructions for building on any host that supports Docker.
Seastar's C++ standard: C++20 or C++23Seastar supports both C++20, and C++23. The build defaults to the latest standard supported by your compiler, but can be explicitly selected with the --c++-standard
configure option, e.g., --c++-standard=20
, or if using CMake directly, by setting on the CMAKE_CXX_STANDARD
CMake variable.
See the compatibity statement for more information.
There is a mini tutorial and a more comprehensive one.
The documentation is available on the web.
Learn more about Seastar on the main project website.
Seastar comes with its own userspace TCP/IP stack for better performance.
Recommended hardware configuration for SeaStarRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4