AuroraRuntime/README.md

## PREALPHA
## AuroraRuntime

The Aurora Runtime is a low level platform abstraction layer for modern cross-platform C++
development targeting powerful embedded and PC systems. Simply fetch a binary package for
your toolchain or integrate the self-contained buildscripts into your applications build
pipeline to get started. 

![console](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/raw/branch/master/Media/wxHello.png)
![picture](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/raw/branch/master/Media/Hello%20Aurora.png)
![picture](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/raw/branch/master/Media/Hello%20Linux.png)

## Features

- Reduced C++ standard template library dependence despite requiring a modern-ish driver (^1) (portable when?)
- Logging; UTF-8 logger, common sink backends, formating interface
- Debug and Telementry; asserts, panics, exception logging, demangling of symbols, more
- Crypto ECC/[25519, P-384, P-256], [AES, RSA, X509], CBC[AES, Stinky3DES], HMAC, HashCash, BCrypt, [common digests]
- Basic cmdline parsing from any module
- Exit and fatal save condition callbacks
- Random; secure, user-seeded, and fast
- Hardware Info; memory and cpu info (including cpu feature bits, core topology, e-core awareness, and basic cache size)
- Software stack information for retrieving kernel, version, brand, family, build string, etc
- Compression (deflate, gzip, zstd, LZ4, bzip2, TODO: lzma, brotli)
- Locale and encoding
- High performance threading and synchronization primitives (os userland sched optimized)
- Async subsystem backed by high performance sync primitives (cv loop) and hybrid switching into IO polling (think userland cv-backed promises + waitmultipleobjects)
- IO subsystem for standard cross-platform IO loop queues, IPC (mutex with auto-unlock, semaphores, full-duplex single-connection pipes, and shared memory), file (direct uncached access), and network 
- Abstract kernel IO transactions, IPC objects, timers, semaphores, and others in the form of ILoopSources
- Common IO transaction interface for network, file, and handle async access (with workarounds for platform querks)
- IO processor for common network, pipe processing, and general work on any given thread (think of it as an io context)
- IO pipe processor for the processing of data when invoked by io transactions and other signalable interfaces 
- Protocol stack concept, for implementing low-overhead IO stream processors, where data is streamed through layers of interceptors
- Builtin support for TLS and compression in the form of protocol stack interceptors
- Non-locking file system watchers with IO subsystem interoperability
- Process spawning with stream redirection backed by the IO subsystem
- Process memory management with IPC and file mapping
- FIO settings registry
- C++ utility templates and macros
- Follows all strings are UTF-8 convention

^1 bring your own types [auROXTL](https://git.reece.sx/AuroraSupport/auROXTL)

## Links

API:
* [Runtime](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/src/branch/master/Include/Aurora)
* [auROXTL](https://gitea.reece.sx/AuroraSupport/auROXTL/src/branch/master/Include)

API Docs: \
Tests and Examples: [Hello Aurora](https://gitea.reece.sx/AuroraSupport/HelloAurora) \
Build Pipeline: [Aurora Build](https://git.reece.sx/AuroraPipeline/Build) (Lua/Premake) \
Donate / Other Links: [Reece.SX](https://reece.sx/#contact) \
Discord: [Invite](https://discord.gg/XYjCGWWa4J)

## Support

| Platform    | Support |
| ----------- | ------- |
| NT/XP | ❌ |
| NT/Win7 | ⚠️ |
| NT/Win8.1+ | ⚠️ |
| NT/Win10 RS4+ | ✅ |
| NT/Win11 | ✅ |
| NT/UWP | 🕖 |
| NT/GameOS| ❌ |
| Linux | ✅ |
| FreeBSD 9 | ❌ |
| FreeBSD 11 | ❌ |
| OpenBSD | ❌ |
| XNU/NS-like | ❌ |

Win7/8: memory management (AuProcess) is limited. \
Applications that don't need ::mmap-like functionality **with pre-reserved address allocations** should put your minimum requirements into the Vista era of NTs. \
See: [Windows 7 defects](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/src/branch/master/Media/Windows%207%20Defects.txt)
## Performance

Performance of each system should ideally be that of the best implementation on the platform,
and no worse than the STL. Due to heavyweight requirements and spiral model defined objectives,
a handful of unknown good industry standard libraries have been brought into achieve compression,
crypto, alloc, and formatting objectives. Footprint is expected to be on the heavier side for optimal
performance (incl toll for C++ tradeoffs), usability, and flexibility.



Defer to benchmarks

## Utilities

Aurora Sugar:                          [Main Header](https://git.reece.sx/AuroraSupport/auROXTL/src/branch/master/Include/auROXTLUtils.hpp), [(*.)Utils.hpp](https://gitea.reece.sx/AuroraSupport/auROXTL/src/branch/master/Include/auROXTL)  \
Aurora Macro Sugar:                    [Main Header](https://git.reece.sx/AuroraSupport/auROXTL/src/branch/master/Include/auROXTL/AU_MACROS.hpp) \
Aurora Overloadable Type Declerations: [Main Header](https://gitea.reece.sx/AuroraSupport/auROXTL/src/branch/master/Include/auROXTLTypes.hpp)


## Logging

Logging is implemented through 2 subsystems, console and logging. Console provides IO abstraction
to the logger subsystem sinks. Sinks are user implementable interfaces that can be either synchronous
or asynchronous. Loggers are defined as an internal object the takes logger messages and dumps
them to the relevant subscriber.

Flushing occurs at a fixed rate on a low prio background thread without any configuration requirement.
The resources spent on the background thread is shared with the telemetry and debug subsystems to
reduce the overall thread count of the runtime. Flushes also occur during panic events and other
relevant problematic points. 

Asynchronous logger sinks may double buffer log lines between the asynchronous callback and
OnFlush callback, where the latter call is guaranteed after one or more delegated dispatch. The
Windows Event Log backend takes advantage of this to multi-line group messages by approx time
and log level.

Additionally, in the console subsystem, consoles that provide an input stream can be used in
conjunction with the parse subsystem to provide basic command-based deserialization, tokenization,
and dispatch of UTF-8 translated strings regardless of the system locale. Command processing
comes under the namespace of consoles, not logging.

## Exceptions

![ICanHasStackTraces](https://gitea.reece.sx/AuroraSupport/AuroraRuntime/raw/branch/master/Media/ICanHasStackTraces.png)

Through the use of compiler internal overloads, ELF hooking, and Win32 
`AddVectoredExceptionHandler`, Aurora Runtime hooks exceptions at the time of throw, including 
*some* out of ecosystem exceptions, providing detailed telemetry of the object type, object 
string, and backtrace. In addition, the `AuDebug` namespace provides TLS based last-error and 
last-backtrace methods. <br>

EXCEPTIONS ARE NOT CONTROL FLOW...<br>
- Aurora Runtime WILL attempt to mitigate exceptions in internal logic
- Aurora Runtime WILL NOT abuse exceptions to communicate failure
- Aurora Runtime WILL try to decouple internal exceptions from the API
- Aurora Runtime WILL NOT use anything that automatically crashes on exception catch (no-noexcept)
- Aurora Runtime WILL provide extended exception information to telemetry backends and through 
   the `AuDebug` namespace
- Aurora Runtime WILL NOT make any guarantees of being globally-noexcept; however, it should be a 
   safe assumption in non-critical environments 

`SysPanic` can be used to format a `std::terminate`-like exit condition, complete with telemetry 
data and safe cleanup.

## Thread Primitives

The Aurora Runtime provides platform optimized threading primitives inheriting from a featureful
IWaitable interface. Each method is guaranteed. Each primitive is user-land scheduler optimized.

```
struct IWaitable
{
   virtual bool TryLock()                            = 0;
   virtual void Lock(relativeTimeoutInMilliseconds)  = 0;
   virtual void Lock()                               = 0;
   virtual void Unlock()                             = 0;
}
```

Included high performance primitives
- arbitrary condition variable ^1
- condition mutex 
- condition variable
- critical section ^2
- event
- mutex
- semaphore 
- rwlock ^3
- spinlocks

^1 Accepts __any__ IWaitable as the mutex \
^2 Reentrant Mutex \
^3 Includes extended read to write upgrades and permits write-entrant read-routines to prevent
writer deadlocks.

### Fixing problems in other scheduler apis

Problem one (1): \
    Most STL implementations have generally awful to unnecessarily inefficient abstraction.
    Defer to libc++'s abuse of spin while (cond) yield loops and msvc/stl's painfully slow
    std::mutex and semaphore primitives. 

Problem Two (2): \
    Moving to or from linux, macos, bsd, and win32 under varous kernels, there is no one
    standard (even in posix land) for the key thread primitives. 

Bonus point NT (3): \
    The userland CriticalSection/CV set of APIs suck, lacking timeouts and try lock 

Bonus point UNIX (4): \
    No wait multiple mechanism
    

1, 2, 3: Use the high performance AuThreadPrimitives objects

4: Consider using loop sources, perhaps with the async subsystem, in your async application.
Performance of loop sources will vary wildly between platforms, always being generally worse
than the high performance primitives. They should be used to observe kernel-level signalable
resources.

4 ex: Windows developers could use loop sources as a replacement to WaitMultipleObjects with
  more overhead 

## IO

The Aurora Runtime implements loop, file io, network io, and other sub-subsystems with
various adapters and connectors.

An important note about texting encoding. Stdin, file encoding, text decoders, and other IO
resources work with codepage UTF-8 as the internal encoding scheme. String overloads and
dedicated string APIs in the IO subsystem will always write BOM prefixed UTF-8, and attempt
to read a BOM to translate any other arbitrary user generated text input to UTF-8.

### Loop

The Aurora Runtime implements a kernel-scheduler optimized IO loop subsystem for managing GUIs;
network, file, ipc AIO; and thread synchronization objects for when these waitables converse.

ILoopSource is an interface defined by the loop subsystem for IO objects with a signalable state.
Attached to an ILoopQueue, the ILoopQueue will provide wait-any/wait-all/is-signaled polling with
optional subscription functionality. Furthermore, ILoopQueues are thread-safe allowing for cross-thread
or mid-wait work scheduling (as in, the addition of new subscribers during sleep or callback).

It is possible to run loop queues like a poll object or with an arbitrary amount of optional
subscribers per loop source.

Subscription notifications allow for optimized loop source removal or no-action/non-removal replies
from subscription implementer. If you and all other subscribers want to evict the ILoopSource,
the source will be automatically removed from the ILoopQueue. If just you vote to evict, you will
no longer receive updates for the object, but the ILoopSource and other subscribers will remain.


### IPC

Included in the IPC subsystem are pipes, as used by AuProcesses; events; mutexes; semaphores;
and shared memory views. IPC objects are exported by an internally generated non-standard string
which contains platform specific information to import such object in a compatible application.
Aurora IPC is not bound by processes bound by a common worker, instead, UNIX sockets and procfs
are used to implement IPC within the applications namespace/sandbox.

### FIO

A simple blocking file stream is provided by an open function given an Aurora path string and a
file advisory lock level. This object can be used with AuProcess to map regions of the file into
the address map. However, everything about this object is blocking.

An alternative asynchronous IAsyncFileStream interface is available which supplies IO transaction
objects for scheduling direct disk reads. One should be careful to note each platform has file AIO 
querks. For instance...

- Linux will block on most file systems if metadata has to be poked
- FS support is limited (NT/NTFS > Linux/XFS > NT/xxxx (w/ caching) > Linux/EXT4 > unsupported)
- Read/Writes musts be made with respect to sector alignment
- Removing caching on Linux will mitigate blocking behaviour (~O_DIRECT blocking io_submit)
- ...but caching on Win32 is sometimes desirable
- Linux reads might be limited by max_sectors_kb or max_segments 

For large block reads: \
bDirectIO = true; read directly from fs (recommend) \
offsets -> must align

When data is small enough for file caches to be useful: \
bDirectIO = !AuBuild::kIsNtDerived (recommend) \
offsets -> align for the highest denominator

Additional utility functions exist outside of the two file interfaces for: stat, directory iteration,
UTF-8 string reading and writing, blocking binary read/writes, and more.

### Paths

We assume all paths are messy. Incorrect splitters, double splitters, relative paths, and keywords are resolved internally.
No URL or path builder, data structure to hold a tokenized URI expression, or similar concept exists in the codebase.
All string paths are simply expanded, similar to MSCRT's `fullpath` or UNIX's `realpath`, at time of usage.


| Expression       | Meaning                             |
|------------------|-------------------------------------|
| `Path[0] == '.'` | Current Working Directory           |
| `Path[0] == '^'` | Executable module's Directory       |
| `Path[0] == '~'` | User Profile Storage + SDK brand    |
| `Path[0] == '!'` | All User Shared Storage + SDK brand |
| `..`             | Go up a directory                   |
| `/`              | Agnostic Directory Splitter         |
| `\`              | Agnostic Directory Splitter         |
| `.` [SPLITTER]   | Nothing                             |

### TLS

TLS client and partial server support is provided by protocol stack interceptors meaning that our implementation is no-socket.
It's possible to write into a buffered protocol stack using the provided stream writer, simulating data coming through a socket channel;
and to fetch the response/translated message using an end protocol piece to be supplied with the data, or using the provided stream reader to read the end
to read the end interceptors buffer once the protocol stack has been ticked.

### Resources

The Aurora Runtime provides system, application, and user specific paths under the `Aurora::IO::FS` subsystem.
These include the users home directory, a per vendor sandboxed application user directory, a per vendor sandboxed application
all users directory, the user-installable program directory, the user's real home directory, and other such relevant paths. 

### Networking


### Character IO


## Proccesses

The Aurora Runtime provides child process monitoring, asynchronous child stdin/out/err transactions, child synchronization
(via a primitive threading event and an io event), process spawning, file opening, and url opening functionality. 

## Locale

Encoding and decoding of UTF-8, UTF-16, UTF-32, GBK, GB-2312, and SJIS is supported through OS provided decoders.
System localization information, including system codepage, country, and system language, is provided by the available
envrionment variables, OS specific interfaces, or the overload mechanism.

## Memory

### Allocator 

Objects are allocated across API/module boundaries using an ABI defined by Aurora Runtime.

Such OOP design in contrast to header-everything is contingent on well-defined interface boundaries which make sense from a 
perspective of optimizaton (primarily allocation and indirect branching) and usability.

Allocations are optimized by using a known good third party library, mimalloc. In the future, it should be possible to replace the 
standard allocator; however, for now all allocations are routed through Aurora::Memory which is backed by mi_xxxx calls.
Mimalloc and/or other such slab and zone based allocators can and must be explored as an optimization for C++'s tendency to
arbitrary allocate memory. This should improve the performance of reasonbly written modules with OOP in mind.

Indirect branches are optimized by simply trying to design APIs that arent complete ass for humans and systems to work with.

### Memory Heap

Aurora provides a heap allocator for dividing up a large preallocated region of memory.

Currently, we use a modified version of O(1) heap that provides a constant worst case allocation and deallocation
of any given request. Memory is provided by AuProcess for the requested allocation, but AuMemory might be unfortunately
hit during the initialization of a heap.


### Shared Pointers

Memory objects, including shared pointers, and the object allocation model is defined by AuROXTL. The `AuSPtr` class template
is backed by the standard `std::shared_ptr`, extended by `#include <auROXTL/auMemoryModel.hpp>,` in the default configuration.

The reason we wrap shared pointers is two folds
1) in code that doesn't need to be fast, we can simply hack in is valid checks on assignment or use an interface with panic branches
   to handle null access conditions. 
2) in the future, it may be desirable to use established AuEnableSharedOnThis, AuSharedFromThis, etc idoms to migrate existing code
   to an alternative non-std::shared_ptr backed system.

AuSPtr and friends are reducable and constructible from and from their std::shared_ptr/unique counterparts.

```
Types: 
    AuSPtr<Type_t>
    AuWPtr<Type_t>
    AuUPtr<Type_t, Deleter_t>
	
Functions:
    AuSPtr<T> AuMakeShared<T>(Args&& ...)
    AuSPtr<T> AuUnsafeRaiiToShared<T>(T *)
    AuSPtr<T> AuUnsafeRaiiToShared<T>(AuUPtr<T>) 

Macros:
    _new (pseudo no-throw new operator)
    AuSPtr<This_T> AuSharedFromThis()
    AuWPtr<This_T> AuWeakFromThis()
    AuFunction<...> AuBindThis(This_t *::?, ...)
```

Defer to [auROXTL](https://git.reece.sx/AuroraSupport/auROXTL) for more information


## Debug

### Asserts

[TODO]

#### Example: 
Debug, Release, and Ship (all) assertions:
```cpp
SysAssert(AuFunction{}, "unexpected default function")
```

Debug and Release (debug and optimized ship-with-debug) assertions:
```cpp
SysAssertDbg(AuFunction{}, "unexpected default function")
```

### Error stack

```cpp
TEST(ErrorStack, A)
{
    AuErrorStack errors;
    
    SysPushErrorIO("Something something IO error");
    SysPushErrorIO("Something something IO error 1");
    SysPushErrorIO("Something something IO error 2 {}", "hello worlds");
    
    ASSERT_TRUE(errors.HasCaptured());
    ASSERT_TRUE(errors.HasMultipleOccurred());
    ASSERT_TRUE(errors.FirstMessage()->pNextThreadMesage);
    ASSERT_TRUE(errors.FirstMessage()->pNextThreadMesage->pNextThreadMesage);
    
    AuLogDbg("{}, {}, {}",
             *errors.ToString(),
             errors.FirstMessage()->pNextThreadMesage->ToString(),
             errors.FirstMessage()->pNextThreadMesage->pNextThreadMesage->ToString());
}

TEST(ErrorStack, B)
{
    AuErrorStack errors;
    try
    {
        AU_THROW_FORMATTED("hello people {}", 23423423);
        //throw "hello modern platforms";
    }
    catch (...)
    {
    }
    ASSERT_TRUE(errors.HasCaptured());
    AuLogDbg("{}", *errors.ToString());
}
```
[More](https://gitea.reece.sx/AuroraSupport/HelloAurora/src/branch/master/Tests/Public/19.%20Hello%20Debug/Main.cpp)


## Binding

Aurora Runtime provides C++ APIs; however, it should be noted that two libraries are used to extend interfaces and enums
to help with porting and internal utility access. One, AuroraEnums, wraps basic enumerations and provides value vectors;
value strings; look up; iteration; and more. The other, AuroraInterfaces, provides *TWO* class types for each virtual interface.
Each interface can be backed by a; C++ class method overriding a superclass's `virtual ...(...) = 0;` method, or a `AuFunctional`
-based structure.

It should be noted that most language bindings and generator libraries (^swig, v8pp, nbind, luabind) work with shared pointers.
Other user code may wish to stuff pointers into a machineword-sized space, whether its a C library, a FFI, or a size constraint.
One handle or abstraction layer will be required to integrate the C++ API into the destination platform, and assuming we have a
C++ language frontend parsing our API, we can use `AuSPtr` for all caller-to-method constant reference scanerios.
Furthermore, `AuSPtrs` can be created, without a deletor, using `AuUnsafeRaiiToShared(unique/raw pointer)`. To solve the raw
pointer issue, `AuSPtrs` are created in the public headers with the help of exported/default visibility interface create and
destroy functions. These APIs provide raw pointers to public C++ interfaces, and as such, can be binded using virtually any
shim generator. Method and API mapping will likely involve manual work from the library developer to reimplement AU concepts
under their language runtime instead of using the C++ platform, or at least require manual effort to shim or map each runtime
prototype into something more sane across the language barrier.

Memory is generally viewed through a `std::span` like concept called MemoryViews. `MemoryViewRead` and `MemoryViewWrite`
provide windows into a defined address range. `MemoryViewStreamRead` and `MemoryViewStreamWrite` expand upon this concept by
accepting an additional offset (`AuUInt &: reference`) that is used by internal APIs to indicate how many bytes were written
or read from a given input region. Such requirement came about from so many APIs, networking, compression, encoding, doing the
exact same thing in different not-so-portable ways. Unifying memory access to 4 class types should aid with SWIG prototyping. 

Unrelated note, structure interfacing with questionable C++ ABI reimplementations is somewhat sketchy in FFI projects (^ CppSharp)
can lead to some memory leaks.


## Aurora Async

[TODO]
- Promises 
- Thread Pool
- Optional shutdown on work exhaustion
- Wait for task[s] completion builtin to work objects
- IO subsystem interop

Example:

## Strings

The auROXTL header only library defines an `AuString` type as an `std::string`; however, it should be assumed this type represents
a binary blob of UTF-8. Further locale processing is delegated to `Aurora::Locale[::Encoding]`

## Dependencies

Aurora
- [AuroraPipeline Include](https://git.reece.sx/AuroraPipeline/Include) ^2
- [auROXTL](https://git.reece.sx/AuroraSupport/auROXTL) ^2
- [AuroraEnum](https://git.reece.sx/AuroraSupport/AuroraEnum) ^1
- [AuroraInterfaces](https://git.reece.sx/AuroraSupport/AuroraInterfaces) ^1
- [AuroraForEach](https://git.reece.sx/AuroraSupport/AuroraForEach) ^1

Crypto (third party)
- [LibTomCrypt](https://git.reece.sx/AuroraMiddleware/libtomcrypt) / [LibTomMath](https://git.reece.sx/AuroraMiddleware/libtommath) ^5
- [mbedTLS](https://git.reece.sx/AuroraMiddleware/mbedtls)

Compression (third party)
- [zstd](https://git.reece.sx/AuroraMiddleware/zstd)
- [zlib](https://git.reece.sx/AuroraMiddleware/zlib)
- [bzip2](https://git.reece.sx/AuroraMiddleware/bzip2)

Utility (third party)
- [stduuid](https://git.reece.sx/AuroraMiddleware/stduuid)  ^6
- [fmtlib](https://git.reece.sx/AuroraMiddleware/fmt) ^4 ^6
- [nl. json](https://git.reece.sx/AuroraMiddleware/nlohmannjson) ^6


^1 Include-only macro library \
^2 Provides core utilities and stl decoupling \
^3 Provides platform information, included by default by the Aurora build pipeline \
^4 C++ 20 saw another pathetic adoption attempt of an open source library, this one actually passed, but hardly \
   anyone implements std::format. Not to mention such is only a subset of the original library.  \
^5 Public Domain \
^6 Potentially STL heavy, still potentially portable w/ a modern-ish toolchain


## Philosophies

- Assume C++17 language support in the language driver

- Use AuXXX type bindings for std types, allow customers to overload the std namespace \
   We assume *some* containers and utility APIs exist, but where they come from is up to you

- Keep the code and build chain simple such that any C++ developer could maintain 
  their own software stack built around aurora components.

- Dependencies and concepts should be cross-platform, cross-architecture, cross-ring friendly
  
  It is recommended to fork and replace any legacy OS specific code with equivalent
   AuroraRuntime concepts, introducing a circular dependency with the Aurora Runtime
  
  APIs shouldn't be designed around userland, mobile computing, or desktop computing;
   AuroraRuntime must provide a common backbone for all applications. 
   
  Locale and user-info APIs will be limited due to the assumption userland is not a 
   concept

- Dependencies, excluding core reference algorithms (eg compression), must be rewritten
   and phased out over time.

- Dependencies should not be added if most platforms provide some degree of native support<br>
  Examples:<br>
            -> Don't depend on a pthread shim for windows; implement the best thread <br>
               primitives that lie on the best possible api for them <br>
            -> Don't depend on ICU when POSIX's iconv and Win32's multibyte apis cover<br>
               everything a conservative developer cares about; chinese, utf-16, utf-8,<br>
               utf-32 conversion, on top of all the ancient windows codepages

- Dependencies should only be added conservatively when it saves development time and 
  provides production hardening <br>
  Examples:<br>
            -> Use embedded crypto libraries; libtomcrypt, libtommath<br>
                ->> While there are some bugs in libtomcrypt and others, none appear to <br>
                   cryptographically cripple the library. Could you do better?<br>
            -> Use portable libraries like mbedtls, O(1) heap, mimalloc<br>
                ->> Writing a [D]TLS/allocator stack would take too much time<br>
                ->> Linking against external allocators, small cross-platform utilities, and <br>
                   so on is probably fine <br>
            -> Shim libcurl instead of inventing yet another http stack <br>