0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-15 06:21:06 +01:00
construct/modules
2020-10-06 16:25:03 -07:00
..
admin modules/admin: Implement (undocumented) users/deactivate. 2020-05-02 23:57:53 -07:00
client Revert "modules/client/sync/rooms/timeline: Fix polylog limited flag condition." 2020-10-06 03:50:02 -07:00
federation modules/federation/version: Reorg into namespace; additional properties. 2020-09-29 00:36:46 -07:00
identity modules: Re-type matrix resource handlers under m::resource. 2019-09-29 14:00:02 -07:00
js ircd::m/modules: Update various client listeners w/ callback. 2018-07-06 18:40:15 -07:00
key modules/key/query: Implement federation 3.3.2.2 POST method. 2020-04-07 11:57:12 -07:00
media ircd::rand: Simplify interface; comments/cleanup. 2020-10-06 16:25:03 -07:00
console.cc modules/console: More useful allocation bytes info in ios cmd. 2020-10-06 00:02:29 -07:00
llvm.cc modules/llvm: Add conditional compilation for libllvm module. 2020-10-01 20:26:16 -07:00
m_breadcrumbs.cc ircd:Ⓜ️ Rename breadcrumb_rooms to breadcrumbs; related. 2020-08-23 02:32:54 -07:00
m_bridge.cc ircd:Ⓜ️:app: Rename everything to bridge:: add basic query; simplify config interface. 2020-04-10 19:29:17 -07:00
m_command.cc ircd: Add missing globular_imatch. 2020-04-26 17:02:21 -07:00
m_control.cc modules/m_control: Don't propagate exception after unloading the module it originated from. 2020-04-21 03:08:54 -07:00
m_device.cc matrix: Add m::homeserver; preliminary virtual origin networks. 2019-10-01 17:56:01 -07:00
m_device_list_update.cc ircd:Ⓜ️:device: Reclassify interface at m::user::devices. 2020-04-01 19:52:31 -07:00
m_direct.cc modules: Fix various hookfn instance constness. 2019-08-09 21:27:41 -07:00
m_direct_to_device.cc modules/m_direct_to_device: Tweak logic for local message handling; handle exception per msg. 2019-02-22 15:40:53 -08:00
m_ignored_user_list.cc modules: Distill all API's from modules up to matrix lib. 2019-09-27 19:35:26 -07:00
m_listen.cc modules/m_listen: Improve infolog msg in runlevel handlers; noexcept on quit handler. 2020-06-12 18:18:57 -07:00
m_noop.cc modules/m_noop: Update header / comment. 2019-01-25 14:53:59 -08:00
m_presence.cc modules/m_presence: Add per-user rate conf item; add branch to synapse spam infra. 2020-09-28 03:48:06 -07:00
m_profile.cc modules: Split user profile related API from hooks; into module. 2019-09-27 19:35:26 -07:00
m_push.cc ircd:Ⓜ️:user::notifications: Add room_id to opts; prefix keying strategy. 2020-03-24 14:56:30 -07:00
m_receipt.cc ircd::db: Use reference to prevent string copy. 2020-07-10 23:58:07 -07:00
m_relation.cc ircd:Ⓜ️ Optimize various callsites for type queries. 2020-05-24 19:08:08 -07:00
m_room_aliases.cc ircd::db: Use reference to prevent string copy. 2020-07-10 23:58:07 -07:00
m_room_canonical_alias.cc modules: Fix various hookfn instance constness. 2019-08-09 21:27:41 -07:00
m_room_create.cc modules/m_room_create: Condition to suppress variable level log msg. 2020-03-16 21:27:11 -07:00
m_room_history_visibility.cc modules: Distill all API's from modules up to matrix lib. 2019-09-27 19:35:26 -07:00
m_room_join_rules.cc modules/m_room_join_rules: Fix room summary trigger. 2019-09-22 21:45:19 -07:00
m_room_member.cc modules/m_room_member: Remove cruft. 2020-04-13 16:59:30 -07:00
m_room_message.cc modules/m_room_message: Split highlight auth hook to module. 2019-09-27 19:35:26 -07:00
m_room_name.cc modules: Start an m.room.name module w/ length check conforms hook. 2019-08-25 14:28:20 -07:00
m_room_power_levels.cc ircd:Ⓜ️ Optimize various callsites for type queries. 2020-05-24 19:08:08 -07:00
m_room_redaction.cc ircd:Ⓜ️ Fix m::index() interface for consistent leading std::nothrow_t. 2020-04-01 16:20:11 -07:00
m_room_server_acl.cc modules: Distill all API's from modules up to matrix lib. 2019-09-27 19:35:26 -07:00
m_room_third_party_invite.cc ircd:Ⓜ️ Move event::auth to room::auth; move to module. 2019-08-18 03:09:34 -07:00
Makefile.am Use foreign automake options to append flags here without warning. 2020-09-18 22:27:23 -07:00
net_dns_cache.cc ircd::db: Use reference to prevent string copy. 2020-07-10 23:58:07 -07:00
README.md modules: Improve README bullets. 2020-01-11 23:31:53 -08:00
stats.cc modules/stats: Iterate items for /stats response. (#31) 2020-06-17 20:52:38 -07:00
web_hook.cc modules/web_hook: Replace and fix multi-line content formattings. 2020-05-11 16:31:48 -07:00
web_root.cc modules/web_root: Return non-throwing 404 here. 2020-10-05 20:15:12 -07:00
well_known.cc matrix: Add m::homeserver; preliminary virtual origin networks. 2019-10-01 17:56:01 -07:00

Module Tree

This directory contains dynamically loadable functionality to libircd.

Approach

Unlike most of the module systems found in traditional C free software projects, our approach is oriented around global symbol availability to the address space rather than explicit imports from self-contained modules. This direction is made viable by C++ and advances in the compiler and linker toolchains. The result is significantly simpler and more convenient for developers to work with.

GLOBAL SYMBOLS

Modules are loaded with RTLD_GLOBAL on both posix and windows platforms. Use of C++ namespaces, visibility attributes, STB_GNU_UNIQUE, etc are adequate to make this modernization.

WEAK UNDEFINED SYMBOLS

All project code is built to silently weaken undefined symbols. This means a complicated interface declared in a header, like a class interface with public and private and static members (typical in C++) can be included by itself into any part of the project without knowing where the definitions of that interface are until they are first used at runtime.

If definitions are not available because they are in an unloaded module: a C++ exception is thrown directly from the callsite. We have built this action is built into the lookup mechanism of the runtime dynamic linker; none of this requires knowledge or effort from developers to use.

Layout

(TODO)

Getting started

The header mods/mapi.h is specific to modules and included for modules in addition to the core ircd.h. Both of these are included automatically via the compiler's command-line and the developer does not have to #include either in the module.

  1. Every loadable module requires a static ircd::mapi::header with the explicit name of IRCD_MODULE. This is an object which will be sought by the module loader in libircd.
// Example of a trivial module

ircd::mapi::header
IRCD_MODULE
{
	"My Module", []
	{
		puts("hi\n");
	}
};

  1. Add an _la_SOURCES entry for your module in the appropriate place in Makefile.am.

  2. Add the module .la name to the appropriate LTLIBRARIES list in Makefile.am.