1.1 --- a/docs/wiki/Libraries Sat Oct 29 01:19:48 2022 +0200
1.2 +++ b/docs/wiki/Libraries Mon Nov 21 01:19:48 2022 +0100
1.3 @@ -10,16 +10,38 @@
1.4
1.5 Convenience functions for `libext2fs` operations.
1.6
1.7 +|| '''Header File''' || '''Contents''' ||
1.8 +|| `e2access/access.h` || Access control functions ||
1.9 +|| `e2access/format.h` || File metadata formatting ||
1.10 +|| `e2access/image.h` || Filesystem image access functions ||
1.11 +|| `e2access/path.h` || Path functions ||
1.12 +|| `e2access/utils.h` || Common utilities for filesystem users ||
1.13 +
1.14 == libe2access_blockserver ==
1.15
1.16 A convenience wrapper around `libext2fs`, providing initialisation functions
1.17 for the opening of filesystems and for indicating the capability through which
1.18 a block server, this providing a filesystem, may be accessed.
1.19
1.20 +|| '''Header File''' || '''Contents''' ||
1.21 +|| `e2access/fs.h` || Filesystem opening functions ||
1.22 +
1.23 == libexec ==
1.24
1.25 Support for initialising and executing programs in new tasks.
1.26
1.27 +|| '''Header File''' || '''Contents''' ||
1.28 +|| `exec/common.h` || Common structures and functions ||
1.29 +|| `exec/elf.h` || ELF payload decoding support ||
1.30 +|| `exec/external_pager.h` || A system pager implementation residing in a separate task ||
1.31 +|| `exec/internal_pager.h` || A system pager implementation residing in the same task as a program ||
1.32 +|| `exec/mapped_region.h` || Mapped memory region support ||
1.33 +|| `exec/memory.h` || Program memory initialisation support ||
1.34 +|| `exec/pager.h` || Common system pager functionality ||
1.35 +|| `exec/process.h` || Support for initialising programs in new tasks and threads ||
1.36 +|| `exec/segment.h` || Program memory segment support ||
1.37 +|| `exec/stack.h` || Stack support for new tasks and threads ||
1.38 +
1.39 == libext2fs ==
1.40
1.41 The ext2 filesystem library provided by the
1.42 @@ -35,20 +57,106 @@
1.43
1.44 The [[Client Library|client library]] for accessing filesystem servers.
1.45
1.46 +|| '''Header File''' || '''Contents''' ||
1.47 +|| `fsclient/client.h` || Filesystem client functions ||
1.48 +|| `fsclient/file.h` || File access convenience functions and types ||
1.49 +|| `fsclient/notifier.h` || File event notification support ||
1.50 +
1.51 == libfsserver ==
1.52
1.53 The [[Server Library|server library]] providing supporting abstractions and
1.54 functionality for filesystem-related [[Components|components]].
1.55
1.56 +|| '''Header File''' || '''Contents''' ||
1.57 +|| `fsserver/access_map.h` || An access map providing memory corresponding to file regions. ||
1.58 +|| `fsserver/accessor.h` || Generic accessor functionality. ||
1.59 +|| `fsserver/accountable.h` || Accountable object support. ||
1.60 +|| `fsserver/block_file_accessor.h` || A file accessor employing a rewritable memory area. ||
1.61 +|| `fsserver/block_file_opener.h` || An opener for a file employing a rewritable memory area. ||
1.62 +|| `fsserver/copied_page_mapper.h` || A page mapper providing copied memory pages or deferring to another page mapper to satisfy file accesses. ||
1.63 +|| `fsserver/directory_accessor.h` || An object providing access to a filesystem directory. ||
1.64 +|| `fsserver/directory_provider.h` || An object providing a directory abstraction with notification facilities. ||
1.65 +|| `fsserver/directory_resource.h` || A resource offering support for directory operations. ||
1.66 +|| `fsserver/ext2_directory_accessor.h` || An object for a directory provided by an Ext2-compatible filesystem. ||
1.67 +|| `fsserver/ext2_file_accessor.h` || A file accessor employing a file provided by an Ext2-compatible filesystem. ||
1.68 +|| `fsserver/ext2_file_opener.h` || An opener for a file provided by an Ext2-compatible filesystem. ||
1.69 +|| `fsserver/ext2_file_operations.h` || File operations supporting an Ext2-compatible filesystem. ||
1.70 +|| `fsserver/ext2_filesystem.h` || A resource supporting the creation of user-specific ext2 filesystem opener resources. ||
1.71 +|| `fsserver/file_opening.h` || Generic support for opening files. ||
1.72 +|| `fsserver/file_pager.h` || File-specific pager functionality. ||
1.73 +|| `fsserver/file_provider.h` || An object encapsulating file resources. ||
1.74 +|| `fsserver/filesystem_resource.h` || A resource supporting the creation of user-specific opener resources. ||
1.75 +|| `fsserver/generic_page_mapper.h` || A generic page mapper providing memory pages to satisfy file accesses. ||
1.76 +|| `fsserver/host_directory_accessor.h` || An object for a "host" directory provided via the C library. ||
1.77 +|| `fsserver/host_file_accessor.h` || A file accessor employing a "host" file provided via the C library. ||
1.78 +|| `fsserver/host_file_opener.h` || An opener for a "host" file provided via the C library. ||
1.79 +|| `fsserver/ipc.h` || Interprocess communication utilities. ||
1.80 +|| `fsserver/masked_page_mapper.h` || A page mapper providing memory pages to satisfy file accesses, masking the limits of a visible region of the file's contents. ||
1.81 +|| `fsserver/notification.h` || Notification support. ||
1.82 +|| `fsserver/opener_context_resource.h` || A context resource offering support for opening files. ||
1.83 +|| `fsserver/opener_resource.h` || A resource offering support for creating contexts and opening files. ||
1.84 +|| `fsserver/page_mapper.h` || A page mapper providing memory pages to satisfy file accesses. ||
1.85 +|| `fsserver/page_owner.h` || A page owner abstraction, indicating the current user of a memory region. ||
1.86 +|| `fsserver/page_queue.h` || A page queue abstraction. ||
1.87 +|| `fsserver/page_queue_partitioned.h` || A page queue retaining two internal collections of memory pages. ||
1.88 +|| `fsserver/page_queue_shared.h` || A page queue whose users take turns to access pages. ||
1.89 +|| `fsserver/pager.h` || Generic pager functionality. ||
1.90 +|| `fsserver/pages.h` || A page collection abstraction providing pages from a queue to users. ||
1.91 +|| `fsserver/pipe_accessor.h` || A pipe accessor merely resetting allocated memory for use. ||
1.92 +|| `fsserver/pipe_opener_resource.h` || A pipe opener resource. ||
1.93 +|| `fsserver/pipe_pager.h` || A pipe pager providing access to pipe content and navigation support. ||
1.94 +|| `fsserver/pipe_paging.h` || A pipe paging coordinator, permitting memory sharing pipe endpoints. ||
1.95 +|| `fsserver/provider.h` || Filesystem object provider support. ||
1.96 +|| `fsserver/provider_registry.h` || A registry of filesystem object providers. ||
1.97 +|| `fsserver/resource.h` || Common resource classes and functions. ||
1.98 +|| `fsserver/resource_registry.h` || A registry of filesystem object resources. ||
1.99 +|| `fsserver/resource_server.h` || Common resource server functions. ||
1.100 +|| `fsserver/simple_pager.h` || A simple pager exposing a single memory region. ||
1.101 +|| `fsserver/test_file_accessor.h` || A test accessor producing generated content. ||
1.102 +|| `fsserver/test_file_opener.h` || An opener for a test file containing generated content. ||
1.103 +
1.104 == libipc ==
1.105
1.106 A library providing IPC (interprocess communication) mechanisms to support
1.107 communication and interactions between components.
1.108
1.109 +|| '''Header File''' || '''Contents''' ||
1.110 +|| `ipc/cap_alloc.h` || Capability allocation and management ||
1.111 +|| `ipc/direct.h` || Interprocess communication operations ||
1.112 +|| `ipc/factory.h` || Factory-related data types ||
1.113 +|| `ipc/irq.h` || Interrupt request handling ||
1.114 +|| `ipc/macros_ipc.h` || Interprocess communication macros ||
1.115 +|| `ipc/map.h` || Capability mapping between tasks ||
1.116 +|| `ipc/mem_ipc.h` || Memory sharing abstractions ||
1.117 +|| `ipc/message.h` || Interprocess communication message abstraction ||
1.118 +|| `ipc/semaphore.h` || Semaphore utilities ||
1.119 +|| `ipc/server.h` || Server binding/registration ||
1.120 +|| `ipc/thread.h` || Thread-related initialisation ||
1.121 +|| `ipc/util_ipc.h` || Interprocess communication abstractions ||
1.122 +
1.123 == libmem ==
1.124
1.125 A library providing memory-related abstractions and utilities.
1.126
1.127 +|| '''Header File''' || '''Contents''' ||
1.128 +|| `mem/flexpage.h` || A flexpage abstraction ||
1.129 +|| `mem/memory.h` || A generic memory pool abstraction ||
1.130 +|| `mem/memory_incremental.h` || A memory pool allocating a region at a time from the system ||
1.131 +|| `mem/memory_preallocated.h` || A memory pool providing regions from a preallocated amount of memory ||
1.132 +|| `mem/memory_utils.h` || Memory quantity calculation utilities ||
1.133 +|| `mem/region.h` || Memory region abstractions ||
1.134 +|| `mem/send_flexpage.h` || A "send" flexpage abstraction for communicating memory mappings ||
1.135 +|| `mem/types.h` || Miscellaneous types ||
1.136 +
1.137 == libsystypes ==
1.138
1.139 A repository of fundamental types used by the other libraries.
1.140 +
1.141 +|| '''Header File''' || '''Contents''' ||
1.142 +|| `systypes/base.h` || Base types used by various other types ||
1.143 +|| `systypes/factory.h` || Factory-related data type macros ||
1.144 +|| `systypes/fcntl.h` || File control definitions ||
1.145 +|| `systypes/format.h` || Format specifiers for output ||
1.146 +|| `systypes/stat.h` || File metadata abstractions ||
1.147 +|| `systypes/timespec.h` || Time-related types ||
1.148 +|| `systypes/user.h` || User abstractions ||