0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-10-31 19:08:59 +01:00
construct/include/ircd
2023-03-26 18:23:30 -07:00
..
allocator ircd::allocator::node: Add scope usage convenience. 2023-02-05 18:45:08 -08:00
buffer ircd::buffer: Suppress errant array/stringop-overflow in debug+assert mode. 2023-01-15 22:32:00 -08:00
cl Fix undef var templates for explicit instantiations across units (-Wundefined-var-template). 2023-02-04 13:20:44 -08:00
ctx ircd::ctx::pool: Add option for dispatch strategy; behavior changed by default. 2023-02-20 20:15:44 -08:00
db ircd: Promote slave-mode to a non-maintenance mode allowing listeners. 2023-03-19 13:21:11 -07:00
fs ircd::fs::dev: Add stats gather struct w/ console cmd. 2023-03-16 12:03:32 -07:00
gpt ircd::gpt: Add micro-benchmark start/stop probes. 2023-02-16 21:13:18 -08:00
http2 ircd::http2: Start an RFC7540 implementation. 2019-06-21 16:54:22 -07:00
ios ircd::ios: ABI simplify; fix double-indirection, AGU load, code size on context switch. 2023-03-20 10:31:09 -07:00
js
json ircd::json::tuple: Modernize constant evaluation selection list constructions. 2023-03-11 13:48:37 -08:00
m ircd:Ⓜ️:vm: Add reverse reflection of phase enum. 2023-03-23 03:29:57 -07:00
math ircd::math: Add difference template convenience. 2023-01-01 21:28:54 +00:00
mods ircd::mapi: Annotate noexcept; non-dynamic alloc; codegen reduction all modules. 2023-03-05 12:05:13 -08:00
net ircd::net: Add close option to skip shutdown syscall prior to close. 2023-03-20 14:01:42 -07:00
prof ircd: Fix -Wdeprecated-copy-with-user-provided-dtor or remove empty dtors. 2023-02-17 16:51:54 -08:00
resource ircd::resource: Optimize response w/ iov for fused head and content. 2023-03-20 20:56:56 -07:00
server ircd::net: Allow designated and implicit constructions for close_opts. 2023-03-20 14:01:42 -07:00
simd ircd::simd: Fix 'return type cannot be vectorized' inhibition (clang). 2023-03-26 16:14:06 -07:00
simt ircd::simt: Add hardware ident access register (AMDDNA) 2023-01-02 20:25:58 +00:00
spirit ircd::spirit: Fix multiple definitions from phoenix::placeholders (GCC). 2023-03-05 16:49:55 -08:00
util ircd::util: Add sign cast convenience suite. 2023-03-25 18:37:56 -07:00
.gitignore Abstract ircd::resource from ircd:Ⓜ️:resource; fix header stack. 2019-09-29 14:00:02 -07:00
asio.h ircd::asio: Fix missing condition for newer boost systems w/o liburing. 2023-03-21 19:27:23 -07:00
assert.h ircd: Attribute nodebug on assert frames, artificial ineffective for clang. 2023-02-09 11:11:01 -08:00
b58.h ircd: Split base64 and base58 into separate namespaces. 2020-08-10 04:56:28 -07:00
b64.h ircd::b64: Optimize outer loop vectorized codegen. (clang/AVX512) 2023-03-26 17:47:24 -07:00
backtrace.h ircd::backtrace: Add array template construction overload. 2020-05-02 23:57:53 -07:00
beep.h ircd::fs: Eliminate user-defined ctors on various opts for designated inits. 2022-06-19 20:27:13 -07:00
byte_view.h ircd: Add template option to skip runtime conditional in byte_view conversion. 2020-09-17 10:49:41 -07:00
cbor.h ircd::cbor: Remove cruft; collapse directory for now. 2020-07-31 21:34:45 -07:00
client.h ircd::net: Allow designated and implicit constructions for close_opts. 2023-03-20 14:01:42 -07:00
cmp.h ircd: Split out overgrown components from stringops.h 2019-07-11 15:51:09 -07:00
color.h
conf.h ircd::conf: Add reference to conf::item in setter callbacks. 2023-02-27 15:29:16 -08:00
crh.h Convert static member constexprs to non-reference type. 2022-06-28 17:42:49 -07:00
demangle.h ircd: Move demangle() out of util. 2019-09-19 16:37:45 -07:00
ed25519.h ircd::ed25519: Add create option to ctor; remove reference to global. 2020-09-15 18:46:28 -07:00
exception.h ircd::exception: Move throwing errno+system_category out-of-line. 2022-07-08 11:39:45 -07:00
exec.h Fix undef var templates for explicit instantiations across units (-Wundefined-var-template). 2023-02-04 13:20:44 -08:00
fmt.h ircd: Various symbol internalizing and PLT reductions. 2022-06-17 21:11:54 -07:00
fpe.h ircd::fpe: Add debug log info; cold sections. 2022-06-17 21:11:53 -07:00
globular.h ircd::util: Generalize util::boolean into returns template. 2023-02-09 19:17:45 -08:00
grammar.h ircd: Forward declare missing karma::rule; ensure visibility of public rules. 2022-06-28 12:37:14 -07:00
http.h ircd::http: Recognize additional proxy related headers for now. #189 2023-02-23 19:03:29 -08:00
icu.h ircd::icu: Add bulk vector utility overloads. 2021-02-25 14:38:52 -08:00
info.h ircd::info: Fix leaf for avx2/avx512f; additional tsc related. 2023-03-26 18:23:30 -07:00
iov.h
ircd.h ircd: Promote slave-mode to a non-maintenance mode allowing listeners. 2023-03-19 13:21:11 -07:00
js.h ircd: Misc fixes for clang. 2019-06-23 16:22:06 -06:00
leb128.h ircd::leb128: Add RB_GENERIC condition on platform intrinsics. 2019-12-21 14:37:41 -08:00
lex_cast.h ircd: Add hours/minutes to lex_cast specialization suite. 2022-06-17 21:11:53 -07:00
logger.h Fix undef var templates for explicit instantiations across units (-Wundefined-var-template). 2023-02-04 13:20:44 -08:00
magic.h ircd: Various symbol surface reductions and sorting. 2022-06-17 21:11:53 -07:00
magick.h ircd: Define all IRCD_USE_ as integers for constexprs. 2022-06-23 09:36:44 -07:00
Makefile.am Ensure EXTRA_*FLAGS is properly appended after other build flags. 2023-01-18 08:11:02 -08:00
matrix.h Abstract ircd::resource from ircd:Ⓜ️:resource; fix header stack. 2019-09-29 14:00:02 -07:00
nacl.h ircd::nacl: Improve sodium initialization; various cleanup. 2019-06-13 13:46:57 -06:00
openssl.h ircd::openssl: Fix argument narrowing from default constants. 2022-06-17 21:11:54 -07:00
panic.h ircd: Various symbol internalizing and PLT reductions. 2022-06-17 21:11:54 -07:00
parse.h
pbc.h ircd: Add PBC stub. 2020-02-11 15:47:18 -08:00
png.h ircd::png: Elaborate callback surface; add logger to prevent libpng writes to stderr. 2021-01-23 10:57:01 -08:00
portable.h configure: Add --enable-clones for dynamic function multi-versioning. 2023-03-05 12:05:13 -08:00
rand.h ircd::rand: Remove inline noexcepts. 2021-02-27 13:01:02 -08:00
README.md
rfc1035.h ircd: Fixes for macro collision (gnu++20). 2022-06-19 20:14:23 -07:00
rfc1459.h
rfc3986.h ircd::rfc3986: Fix grammar throwing out of url::decode_unsafe(). 2022-08-02 13:18:58 -07:00
run.h ircd::util: Fix undefined-var-template linkage related warning. 2022-07-20 12:31:49 -07:00
spirit.h ircd::spirit: Split substring_view into header. 2022-06-17 21:11:54 -07:00
stats.h ircd::stats: Add signed integer, chrono specializations; use panic exception. 2020-12-23 03:56:43 -08:00
stdinc.h ircd: Split stduse.h from stdinc.h. 2022-07-08 10:45:33 -07:00
stduse.h ircd: Split stduse.h from stdinc.h. 2022-07-08 10:45:33 -07:00
string_view.h ircd::string_view: Modernize constant evaluation comparisons. 2023-03-11 13:48:07 -08:00
stringops.h ircd: Fix stringop-overread complaint for memchr on empty str (gcc-12). 2023-01-15 22:32:00 -08:00
strl.h ircd::strl: Simplify strlcat; reuse strlcpy. (related f705df096d). 2022-07-03 15:04:02 -07:00
strn.h ircd: Add strncpy++ tool. 2019-09-18 09:50:14 -07:00
sys.h ircd::exception: Move throwing errno+system_category out-of-line. 2022-07-08 11:39:45 -07:00
terminate.h ircd: Improve terminate interface; simplify impl. 2020-12-13 10:45:34 -08:00
time.h ircd: Fix/improve comments. [ci skip] 2020-12-06 10:36:47 -08:00
tokens.h ircd::tokens: Relax noexcept on token result closures. 2022-10-08 15:37:14 -07:00
utf8.h ircd::utf: Split header; improve decode codegen; inline length. 2021-09-14 23:39:55 -07:00
utf16.h ircd::utf: Split header; improve decode codegen; inline length. 2021-09-14 23:39:55 -07:00
vector_view.h ircd::vector_view: Add constexpr constructions. 2022-07-12 22:36:50 -07:00
versions.h ircd::versions: Declare list specialization; noexcept ctors; minor cleanup. 2022-07-20 18:32:38 -07:00
vg.h ircd::vg: Add template convenience defined(); improve call interface. 2022-06-17 21:11:54 -07:00

IRCd Library API

Project Namespaces

  • IRCD_ Preprocessor #define and macros.
  • RB_ Build system related preprocessor #defines and macros (legacy).
  • ircd_ C namespace and demangled bindings.
  • ircd:: C++ namespace scope.
  • X-IRCd- HTTP header key namespace.
  • ircd. Matrix event type namespace.
  • ircd_ Environmental variables (see: conf.h).

What To Include

libircd headers are organized into several aggregates groups

As a C++ project there are a lot of header files. Header files depend on other header files. We don't expect the developer of a compilation unit to figure out an exact list of header files necessary to include for that unit. Instead we have aggregated groups of header files which are then precompiled. These aggregations are mostly oriented around a specific project dependency.

Note: The term 'stack' may be found in place of the preferred term 'group' in other documentation.

  • Standard Include group <ircd/ircd.h> is the main header group. This group involves the standard library and most of libircd. This is what an embedder will be working with. These headers will expose our own interfaces wrapping 3rd party dependencies which are not included there.

    There are actually two files in play here: <ircd/ircd.h> and <ircd/ircd.pic.h>. The latter is generated dynamically and will not exist until make creates it. We have to offer two different pre-compilations: one with -fPIC and one without.

  • Boost ASIO include group <ircd/asio.h> is a header group exposing the boost::asio library. We only involve this header in compilation units working directly with asio for networking et al. Involving this header file slows down compilation compared with the standard group.

  • Boost Spirit include group <ircd/spirit.h> is a header group exposing the spirit parser framework to compilation units which involve formal grammars. Involving this header is a monumental slowdown when compiling.

  • JavaScript include group <ircd/js/js.h> is a header group exposing symbols from the SpiderMonkey JS engine. Alternatively, <ircd/js.h> is part of the standard include group which includes any wrapping to hide SpiderMonkey.

  • MAPI include group <ircd/mapi.h> is the standard header group for modules. This group is an extension to the standard include group but has specific tools for pluggable modules which are not part of the libircd core.

Invocation

libircd is not thread-safe. It does not protect exposed interfaces with locks. Embedders must access libircd from a single thread.

Initialize the library with a call to ircd::init().