master branch, upcoming release)Version 0.6.0 is a major release, changing much of the extension API (HTTP, pub/sub, CLI) and some of the core API (i.e., moving the evio polling to One-Shot polling).
Coming Soon...
This beta release updates some default values to make them more reasonable for common use cases.
These values, such as the LIB_SOCK_MAX_CAPACITY and the FIO_HASH_INITIAL_CAPACITY can be updated during compile time.
Some of these default values can be bypassed during runtime by using specific function calls (such as fio_hash_new2).
Released fixes for issues related to the TechEmpower Framework Benchmarks 80 core startup.
Fix: fixed error handling during cluster mode startup, making sure facil.io fails to start.
Update: capped maximum core detection value to 120 cores. Any value larger than 120 will raise a warning and the cap (120) will be used.
Released after stress testing and memory leakage testing.
Breaking Change: (websockets) the websocket on_close callback signature had changed to allow it to be called on connection/upgrade failures as well (easier udata cleanup).
Fix (facil): fixes an issue introduced in the beta.2 version, where deferred events that where scheduled before a call to facil_run would only be called for the parent process. Now these events would perform as intended (once in the root process and once in each worker process).
Fix (facil): updates the logical assumption about open connections, to make sure any open connections are closed when re-spawning a child worker. This shift the connection assumption from unsafe (forked connections should be closed by extensions) to safe (reconnection should be handled by extension). This change should effect internal extensions only, since active connections aren't handled by the root process in clustered mode.
Change (websocket): the protocol is now more forgiving in cases where clients don't mask empty messages.
Feature (websockets): A simple and easy Websocket client using websocket_connect as well as support for more complex clients (with authentication logic etc') using a combination of the http_connect and http_upgrade2ws functions.
Minor: some changes to the inner HTTP logic, fixed some error messages, and other minor updates.
Version 0.6.0 is a major release, changing much of the extension API (HTTP, pub/sub, CLI) and some of the core API (i.e., moving the evio polling to One-Shot polling).
In this beta 2 release:
Fix (facil): fixes an issue that could occur when forking a large number of processes, where cluster connection locks would remain locked, causing the cluster connections to spin the CPU and prevent shutdown.
Fix (redis, pubsub, evio): fixes for the internal Redis engine. There was a connection re-establishing error related to updates in the new evio event logic.
Update: (http) Added experimental query parsing helpers that perform nested parameter name resolution (i.e. named_hash[named_array][]=value). Logic might change as performance considerations apply. I'd love to read your feedback on this feature.
Update: (facil) Simplified the child worker sentinel observation logic, to use threads instead of IPC.
Version 0.6.0 is a major release, changing much of the extension API (HTTP, pub/sub, CLI) and some of the core API (i.e., moving the evio polling to One-Shot polling).
In this beta 1 release:
Fix (http): fixed an issue where receiving the same header name more than once would fail to convert the header value into an array of values.
Minor fixes: more error handling, more tests, fixed fiobj_iseq to test hash keys as well as objects. The fio_hashmap.h key caching for removed objects is cleared when hash is empty (i.e, if it‘s empty, it’s really empty).
Performance minor improvements. For example, Header Hash Maps are now cleared and reused by HTTP/1.1 during keep-alive (instead of deallocated and reallocated).
This is a major release, changing much of the extension API (HTTP, pub/sub, CLI) and some of the core API (i.e., moving the evio polling to One-Shot polling).
Migration isn't difficult, but is not transparent either.
Fix (backported): (websocket_parser) The websocket parser had a memory offset and alignment handling issue in it's unmasking (XOR) logic and the new memory alignment protection code. The issue would impact the parser in rare occasions when multiple messages where pipelined in the internal buffer and their length produced an odd alignment (the issue would occur with very fast clients, or a very stressed server).
Note About Fixes:
I simply rewrote much of the code to know if the issues I fixed were present in the 0.5.x version or not.
I believe some things work better. Some of the locking concerns will have less contention and I think I fixed some issues in the fiobj core types as well as the http extension.
However, experience tells me a new major release (0.6.0) is always more fragile than a patch release. I did my best to test the new code, but experience tells me my tests are often as buggy as the code they test.
Anyway, I‘m releasing 0.6.0 knowing it works better than the 0.5.8 version, but also knowing it wasn’t battle tested just yet.
Changes!: (fiobj / facil.io objects):
Major API changes.
The facil.io dynamic type library moved closer to facil.io's core, integrating itself into the HTTP request/response handling, the Pub/Sub engine, the Websocket internal buffer and practically every aspect of the library.
This required some simplification of the fiobj and making sure future changes would require less of a migration process.
The Symbol and Couplet types were removed, along with nesting protection support (which nobody seemed to use anyway).
We're back to static typing with enum, using macros and inline functions for type identification (better performance at the expense of making extendability somewhat harder).
Hashes are now 100% collision resistant and have improved memory locality, at the expense of using more memory and performing calling memcmp (this can be avoided when seeking / removing / deleting items, but not when overwriting items).
Changes!: (http):
The HTTP API and engine was completely re-written (except the HTTP/1.1 parser), both to support future client mode (including chunked encoding for trailing headers) and to make routing and request parsing easier.
The updates to the HTTP API might result in decreased performance during the HTTP request reading due to the need to allocate resources and possibly copy some of the data into dynamic storage... For example, header Hash Tables replaced header Arrays, improving lookup times and increasing creation time.
The HTTP parser now breaks down long URI schemes into a short URI + host header (which might become an array if it's included anyway).
Changes!: (websocket):
The Websocket API includes numerous breaking changes, not least is the pub/sub API rewrite that now leverages FIOBJ Strings / Symbols.
websocket_write_each was deprecated (favoring a pub/sub only design).
Changes!: (pubsub):
The pubsub API was redesigned after re-evaluating the function of a pub/sub engine and in order to take advantage of the FIOBJ type system.
Channel names now use a hash map with collision protection (using memcmp to compare channel names). The means that the 4 but trie is no longer in use and will be deprecated.
Changes!: (redis):
redis_engine was rewritten, along with the RESP parser, to reflect the changes in the new pubsub service and to remove obsolete code.Changes!: (facil):
Slight API changes:
facil_last_tick now returns struct timespec instead of time_t, allowing for more accurate time stamping.
facil_cluster_send and facil_cluster_set_handler were redesigned to reflect the new cluster engine (now using Unix Sockets instead of pipes).
Internal updates to accommodate changes to other libraries.
Cluster mode now behaves as sentinel, re-spawning any crashed worker processes (except in DEBUG mode).
Changes!: (evio):
the evented IO library was redesigned for one-shot notifications, requiring a call to evio_add or evio_set_timer in order to receive future notifications.
This was a significant change in behavior and the changes to the API (causing backwards incompatibility) were intentional.
the code was refactored to separate system specific logic into different files. making it easier to support more systems in the future.
Changes!: (sock):
the socket library now supports automatic Unix detection (set port to NULL and provide a valid Unix socket path in the address field).
the socket library's Read/Write hooks API was revised, separating the function pointers from the user data. At server loads over 25%, this decreases the memory footprint.
the socket library's packet buffer API was deprecated and all sock_write2(...) operations take ownership of the memory/file (enforce move).
The internal engine was updated, removing pre-allocated packet buffers altogether and enabling packet header allocation using malloc, which introduces a significant changes to the internal behavior, possibly effecting embedded systems.
Changes!: (defer):
Removed forking from the defer library, moving the fork logic into the main facil source code.
Defer thread pools and now include two weak functions that allow for customized thread scheduling (wakeup/wait). These are overwritten by facil.io (in facil.c).
By default, defer will use nanosleep.
Refactoring: (fiobj) moved the underlying Dynamic Array and Hash Table logic into single file libraries that support void * pointers, allowing the same logic to be used for any C object collection (as well as the facil.io objects).
Fix (backported from 0.6.0): (websocket_parser) The websocket parser had a memory offset and alignment handling issue in it's unmasking (XOR) logic and the new memory alignment protection code. The issue would impact the parser in rare occasions when multiple messages where pipelined in the internal buffer and their length produced an odd alignment (the issue would occur with very fast clients, or a very stressed server).
Fix: (defer, fiobj) fix Linux compatibility concerns (when using GCC). Credit goes to @kotocom for opening issue #23.
Fix: (defer) fixes the non-debug version of the new (v.0.5.6) defer, which didn't define some debug macros.
Updates: minor updates to the boilerplate documentation and the “new application” creation process.
Fix: Added cmake_minimum_required and related CMake fixes to the CMake file and generator. Credit to David Morán (@david-moran) for PR #22 fixing the CMakelist.txt.
Compatibility: (websocket_parser) removed unaligned memory access from the XOR logic in the parser, making it more compatible with older CPU systems that don't support unaligned memory access or 64 bit word lengths.
Optimization: (defer) rewrote the data structure to use a hybrid cyclic buffer and linked list for the task queue (instead of a simple linked list), optimizing locality and minimizing memory allocations.
Misc: minor updates and tweaks, such as adding the fiobj_ary2prt function for operations such as quick sort, updating some documentation etc'.
Fix: (fiobj) fixed an issue #21, where gcc would complain about overwriting the fio_cstr_s struct due to const members. Credit to @vit1251 for exposing this issue.
Fix: (fiobj) fixed NULL pointer testing for fiobj_free(NULL).
Compatibility: (gcc-6) Fix some compatibility concerns with gcc version 6, as well as some warnings that were exposed when testing with gcc.
Optimization: (fiobj) optimized the JSON parsing memory allocations as well as fixed some of the function declarations to add the const keyword where relevant.
I've been making so many changes, it took me a while.
This version includes all the updates in the unreleased version 0.5.3 as well as some extra work.
The new HTTP/1.1 and Websocket parsers have been debugged and tested in the Iodine Ruby server, the dynamic type system (fiobj_s) will be updated to revision 2 in this release...
Change/Update: (fiobj) The dynamic type library was redesigned to make it extendable. This means that code that used type testing using a switch statement needs to be rewritten.
Fix: (websocket) issues with the new websocket parser were fixed. Credit to Tom Lahti (@uidzip) for exposing the issues.
Change: minor changes to the versioning scheme removed some version MACROS... this isn‘t API related, so I don’t consider it a breaking change, but it might effect code that relied too much on internal workings. The only valid version macros are the FACIL_VERSION_* macros, in the facil.h header.
Change: (http) the HTTP/1.x parser was re-written and replaced. It should perform the same, while being easier to maintain. Also, the new parser could potentially be used to author an HTTP client.
Change: (websocket) the Websocket parser was re-written and replaced, decoupling the parser and message wrapper from the IO layer. Performance might slightly improve, but should mostly remain the same. The new code is easier to maintain and easier to port to other implementations. Also, the new parser supports a client mode (message masking).
Fix: (websocket) fix #16, where a client's first message could have been lost due to long on_open processing times. This was fixed by fragmenting the upgrade event into two events, adding the facil_attach_locked feature and attaching the new protocol before sending the response. Credit to @madsheep and @nilclass for exposing the issue and tracking it down to the on_open callbacks.
Fix: (sock) sockets created using the TCP/IP sock library now use TCP_NODELAY as the new default. This shouldn't be considered a breaking change as much as it should be considered a fix.
Fix: (http1) HTTP/1.x is now more fragmented, avoiding a read loop to allow for mid-stream / mid-processing protocol upgrades. This also fixes #16 at it's root (besides the improved websocket callback handling).
Fix: (http1) HTTP/1.x now correctly initializes the udata pointer to NULL fore each new request.
Fix: (facil) the facil_run_every function now correctly calls the on_finish callback when a timer initialization fails. This fixes a leak that could have occurred due to inconsistent API expectations. Workarounds written due to this issue should be removed.
Fix: (facil) connection timeout is now correctly ignored for timers.
Fix: (defer) a shutdown issue in defer_perform_in_fork was detected by @cdkrot and his fix was implemented.
Fix: (evio) fixed an issue where the evented IO library failed to reset the state indicator after evio_close was called, causing some functions to believe that events are still processed. Now the evio_isactive will correctly indicate that the evented IO is inactive after evio_close was called.
Fix: (evio) fixes an issue where evio_add_timer would fail with EEXIST instead of reporting success (this might be related to timer consolidation concerns in the Linux kernel).
Fix: (evio) better timer fd creation compatibility with different Linux kernels.
Fix: (documentation) credit to @cdkrot for reporting an outdated demo in the README.
Fix: (linking) added the missing -lm linker flag for gcc/Linux (I was using clang, which automatically links to the math library, so I didn't notice this).
Portability: added extern "C" directive for untested C++ support.
Feature: 🎉 added a CLI helper service, allowing easy parsing and publishing of possible command line arguments.
Feature: 🎉🎉 added a dynamic type library to facil.io's core, making some common web related tasks easier to manage.
Feature: 🎉🎉🎉 added native JSON support. JSON strings can be converted to fiobj_s * objects and fiobj_s * objects can be rendered as JSON! I'm hoping to get it benchmarked publicly.
Change: non-breaking changes to the folder structure are also reflected in the updated makefile and .clang_complete.
Fix: (defer) fixed SIGTERM handling (signal was mistakingly filtered away).
Fix: (http_response) fixed http_response_sendfile2 where path concatenation occurred without a folder separator (/) and exclusively safe file paths were being ignored (the function assumed an unsafe path to be used, at least in part).
Fix: minor fixes and documentation.
Fix / Feature: (facil) sibling processes will now detect a sibling's death (caused by a crashed process) and shutdown.
Feature: @benjcal suggested the script used to create new applications. The current version is a stand-in draft used for testing.
Feature: temporary boiler plate code for a simple “hello world” HTTP application using the new application script (see the README). This is a temporary design to allow us to test the script‘s functionality and decide on the final boiler plate’s design.
Fix: (sock) Fixed an issue where sock_flush would always invoke sock_touch, even if no data was actually sent on the wire.
Fix: (sock) fixed a possible issue with sock_flush_strong which might have caused the facil.io to hang.
Fix: (Websocket) fixed an issue with fragmented pipelined Websocket messages.
Feature: (facil) easily force an IO event, even if it did not occur, using facil_force_event.
Braking changes: (pubsub) The API was changed / updated, making pubsub_engine_s objects easier to author and allowing allocations to be avoided by utilizing two void * udata fields... Since this is a breaking change, and following semantic versioning, the minor version is updated. I do wish I could have delayed the version bump, as the roadmap ahead is long, but it is what it is.
Braking changes: (facil) Since the API is already changing a bit, I thought I'd clean it up a bit and have all the on_X flow events (on_close, on_fail, on_start...) share the same function signature where possible.
Changes: (facil) Minor changes to the fio_cluster_* API now use signed message types. All negative msg_type values are reserved for internal use.
Fix: plugging memory leaks while testing the system under very high stress.
Fix: (pubsub, fio_dict) Fixed glob pattern matching... I hope. It seems to work fine, but I'm not sure it the algorithm matches the Redis implementation which is the de-facto standard for channel pattern matching.
Security: (http) the HTTP parser now breaks pipelined HTTP requests into fragmented events, preventing an attacker from monopolizing requests through endless pipelining of requests that have a long processing time.
Fix: (http) http_listen will now always copy the string for the public_folder, allowing dynamic strings to be safely used.
Fix: (http) default error files weren't located due to missing / in name. Fixed by adjusting the requirement for the / to be more adaptive.
Fix: (http) dates were off by 1 day. Now fixed.
Fix: (http1) a minor issue in the on_data callback could have caused the parser to crash in rare cases of fragmented pipelined requests on slower connections. This is now fixed.
Fix?: (http) When decoding the path or a request, the + sign is now left unencoded (correct behavior), trusting in better clients in this great jungle.
Fix: (facil) facil_defer would leak memory if a connection was disconnected while a task was scheduled.
Fix: (facil) facil_connect now correctly calls the on_fail callback even on immediate failures (i.e. when the function call was missing a target address and port).
Fix: (facil) facil_connect can now be called before other socket events (protected form library initialization conflicts).
Fix: (facil) facil_listen will now always copy the string for the port, allowing dynamic strings to be safely used when FACIL_PRINT_STATE is set.
Fix: (facil) facil_last_tick would crash if called before the library was initialized during socket operations (facil_listen, facil_attach, etc')... now facil_last_tick falls back to time() if nothing happened yet.
Fix: (facil) .on_idle now correctly checks for non networks events as well before the callback is called.
Fix: (defer) A large enough (or fast enough) thread pool in a forked process would complete the existing tasks before the active flag was set, causing the facil.io reactor to be stranded in an unscheduled mode, as if expecting to exit. This is now fixed by setting a temporary flag pointer for the forked children, preventing a premature task cleanup.
Changes: Major folder structure updates make development and support for CMake submodules easier. These changes should also make it easier to push PRs for by offering the dev folder for any localized testing prior to submitting the PR.
Feature: (websockets) The websocket pub/sub support is here - supporting protocol tasks as well as direct client publishsing (and autu text/binary detection)! There are limits and high memory costs related to channel names, since pubsub uses a trie for absolute channel matching (i.e. channel name length should be short, definitely less than 1024Bytes).
Feature: (redis) The websocket pub/sub support features a shiny new Redis engine to synchronize pub/sub across machines! ... I tested it as much as I could, but I know my tests are as buggy as my code, so please test before using.
Feature: (facil_listen, http_listen) supports an optional on_finish_rw callback to clean-up the rw_udata object.
Feature: (pubsub) channels now use the available fio_dict_s (trie) data store. The potential price of the larger data-structure is elevated by it's absolute protection against hash collisions. Also, I hope that since channels are more often searched than created, this should improve performance when searching for channels by both pattern and perfect match. I hope this combination of hash tables (for client lookup) and tries (for channel traversal) will provide the best balance between string matching, pattern matching, iterations and subscription management.
Feature: (http) http_listen now supports an on_finish callback.
Feature: (http1) HTTP/1.1 will, in some cases, search for available error files (i.e. “400.html”) in the public_folder root, allowing for custom error messages.
Feature: CMake inclusion. Credit to @OwenDelahoy (PR#8).
To use facil.io in a CMake build you may add it as a submodule to the project's repository.
git submodule add https://github.com/boazsegev/facil.io.git
Then add the following line the project's
CMakeLists.txtadd_subdirectory(facil.io)
Optimize: (fio_hash_table) optimize fio_ht_s bin memory allocations.
Fix: (pubsub) Fixed collisions between equal channel names on different engines, so that channels are only considered equal if they share the same name as well as the same engine (rather than only the same name)... actually, if they share the same channel name SipHash value XOR‘d with the engine’s memory location.
Fix: (facil) Fixed compiling error on older gcc v.4.8.4, discovered on Ubuntu trusty/64.
Fix: Fix enhanced CPU cycles introduced in the v.0.4.3 update. Now CPU cycles are lower and thread throttling handles empty queues more effectively.
Performance: (pubsub) now uses a hash-table storage for the channels, clients and patterns, making the duplicate review in pubsub_subscribe much faster, as well as improving large channel collection performance (nothing I can do about pattern pub/sub, though, as they still need to be matched using iterations, channel by channel and for every channel match).
Feature: (http) The http_response_sendfile2 function will now test for a gzip encoded alternative when the client indicated support for the encoding. To provide a gzip alternative file, simply gzip the original file and place the .gz file in the original file's location.
Folder Structure: Updated the folder structure to reflect source code relation to the library. core being required files, http relating to http etc'.
Fix: Some killer error handling should now signal all the process group to exit.
Fix: (sock, websocket) sock_buffer_send wouldn't automatically schedule a socket buffer flush. This caused some websocket messages to stay in the unsent buffer until a new event would push them along. Now flushing is scheduled and messages are send immediately, regardless of size.
Fix: (facil) facil_attach now correctly calls the on_close callback in case of error.
Fix: (facil) facil_protocol_try_lock would return false errors, preventing external access to the internal protocol data... this is now fixed.
Feature: (facil) Experimental cluster mode messaging, allowing messages to be sent to all the cluster workers. A classic use-case would be a localized pub/sub websocket service that doesn‘t require a backend database for syncing a single machine... Oh wait, we’ve added that one too...
Feature: (facil) Experimental cluster wide pub/sub API with expendable engine support (i.e., I plan to add Redis as a possible engine for websocket pub/sub).
Update: (http) Updated the http_listen to accept the new sock_rw_hook_set and rw_udata options.
Update: (sock) Rewrote some of the error handling code. Will it change anything? only if there were issues I didn't know about. It mostly effects errno value availability, I think.
Fix: (sock) Fixed an issue with the sendfile implementation on macOS and BSD, where medium to large files wouldn't be sent correctly.
Fix: (sock) Fixed the sock_rw_hook_set implementation (would lock the wrong fd).
Design: (facil) Separated the Read/Write hooks from the protocol's on_open callback by adding a set_rw_hook callback, allowing the same protocol to be used either with or without Read/Write hooks (i.e., both HTTP and HTTPS can share the same on_open function).
Fix: (evio, facil) Closes the evio once facil.io finished running, presumably allowing facil.io to be reinitialized and run again.
Fix: (defer) return an error if defer_perform_in_fork is called from within a running defer-forked process.
Fix: (sock, facil, bscrypt) Add missing static keywords.
Compatibility: (bscrypt) Add an alternative HAS_UNIX_FEATURES test that fits older *nix compilers.
Fix: (HTTP/1.1) fixed the default response date (should have been “now”, but was initialized to 0 instead).
Fix: fixed thread throttling for better energy conservation.
Fix: fixed stream response logging.
Compatibility: (HTTP/1.1) Automatic should_close now checks for HTTP/1.0 clients to determine connection persistence.
Compatibility: (HTTP/1.1) Added spaces after header names, since some parsers don't seem to read the RFC.
Fix/Compatibility: compiling under Linux had been improved.
Updated core and design. New API. Minor possible fixes for HTTP pipelining and parsing.
The following is a historic change log, from before the facil_ API.
Note: This change log is incomplete. I started it quite late, as interest in the libraries started to warrant better documentation of any changes made.
Although the libraries in this repo are designed to work together, they are also designed to work separately. Hence, the change logs for each library are managed separately. Here are the different libraries and changes:
Lib-React (libreact) - The Reactor library.
Lib-Sock (libsock) - The socket helper library (development incomplete).
Lib-Async (libasync) - The thread pool and tasking library.
Lib-Server (libserver) - The server writing library.
MiniCrypt (minicrypt) - Common simple crypto library (development incomplete).
HTTP Protocol (http) - including request and response helpers, etc'.
Websocket extension (websockets) - Websocket Protocol for the basic HTTP implementation provided.
Changes I plan to make in future versions:
Implement a Server.connect for client connections and a Websocket client implementation.
Implement Websocket writing using libsock packets instead of malloc.
Remove / fix server task container pooling (FDTask and GroupTask pools).
I attempt to follow semantic versioning, except that the libraries are still under pre-release development, so version numbers get updated only when a significant change occurs or API breaks.
Libraries with versions less then 0.1.0 have missing features (i.e. mini-crypt is missing almost everything except what little published functions it offers).
Minor bug fixes, implementation optimizations etc' might not prompt a change in version numbers (not even the really minor ones).
API breaking changes always cause version bumps (could be a tiny version bump for tiny API changes).
Git commits aren't automatically tested yet and they might introduce new issues or break existing code (I use Git also for backup purposes)...
... In other words, since these libraries are still in early development, test before adopting any updates.
Rewrite from core. The code is (I think) better organized.
Different API.
The reactor is now stateless instead of an object. All state data (except the reactor‘s ID, which remains static throughout during it’s existence), is managed by the OS implementation (kqueue/epoll).
Callbacks are statically linked instead of dynamically assigned.
Better integration with libsock.
(optional) Handles libsock's UUID instead of direct file descriptors, preventing file descriptor collisions.
libsock, where the sock_flush wasn't automatically called due to inline function optimizations used by the compiler (and my errant code).Baseline (changes not logged before this point in time).
getrlimit is broken, causing server capacity limits to be less than they could / should be.libsock 0.2.1, where sock_close wouldn't close the socket even when all the data was sent.Larger user level buffer - increased from ~4Mb to ~16Mb.
The system call to write will be deferred (asynchronous) when using libasync. This can be changed by updating the SOCK_DELAY_WRITE value in the libsock.c file.
This will not prevent sock_write from emulating a blocking state while the user level buffer is full.
Almost the same API. Notice the following: no initialization required; rw_hooks callbacks aren't protected by a lock (use your own thread protection code).
There was an unknown issue with version 0.1.0 that caused large data sending to hang... tracking it proved harder then re-writing the whole logic, which was both easier and allowed for simplifying some of the code for better maintenance.
sock_checkout_packet will now hang until a packet becomes available. Don‘t check out more then a single packet at a time and don’t hold on to checked out packets, or you might find your threads waiting.
Huge rewrite. Different API.
Uses connection UUIDs instead of direct file descriptors, preventing file descriptor collisions. Note that the UUIDs aren't random and cannot be used to identify the connections across machines or processes.
No global lock, spin-lock oriented design.
Better (optional) integration with libreact.
libsock experienced minor API changes, specifically to the init_socklib function (which now accepts 0 arguments).
The rw_hooks now support a flush callback for hooks that keep an internal buffer. Implementing the flush callback will allow these callbacks to prevent a pre-mature closure of the socket stream and ensure that all the data will be sent.
Added the client implementation (sock_connect).
Rewrote the whole library to allow for a fixed user-land buffer limit. This means that instead of having buffer packets automatically allocated when more memory is required, the sock_write(2) function will hang and flush any pending socket buffers until packets become available.
File sending is now offset based, so fseek data is ignored. This means that it would be possible to cache open fd files and send the same file descriptor to multiple clients.
Fixed issues with non-system sendfile and with underused packet pool memory.
Added the .metadata.keep_open flag, to allow file caching... however, keep in mind that the file offset for read/write is the file's lseek position and sending the same file to different sockets will create race conditions related to the file lseek position.
Fix for epoll's on_ready not being sent (sock flush must raise the EAGAIN error, or the on_ready event will not get called). Kqueue is better since the on_ready refers to the buffer being clear instead of available (less events to copy the same amount of data, as each data write is optimal when enough data is available to be written).
optional implementation of sendfile for Apple, BSD and Linux (BSD not tested).
Misc. optimizations. i.e. Buffer packet size now increased to 64Kb, to fit Linux buffer allocation.
File sending now supports file descriptors.
TLC support replaced with a simplified read/write hook.
Changed struct SockWriteOpt to a typedef sock_write_info_s.
Changed struct Packet to a typedef sock_packet_s.
fixed and issue where using sock_write(2) for big data chunks would cause errors when copying the data to the user buffer.
it should be noted, for performance reasons, that it is better to send big data using external pointers (especially if the data is cashed) using the sock_send_packet function - for cached data, do not set the packet->external flag, so the data isn't freed after it was sent.
fixed situations in which the send_packet might not close a file (if the packet buffer references a FILE) before returning an error.
The use of sock_free_packet is now required for any unused Packet object pointers checked out using sock_checkout_packet.
This requirement allows the pool management to minimize memory fragmentation for long running processes.
libsock memory requirements are now higher, as the user land buffer's Packet memory pool is pre-allocated to minimize memory fragmentation.
Corrected documentation mistakes, such as the one stating that the sock_send_packet function will not handle the Packet object's memory on error (it does handle the memory, always).
Baseline (changes not logged before this point in time).
I rewrote (almost) everything.
libasync now behaves as a global state machine. No more async_p objects.
Uses (by default) nanosleep instead of pipes (you can revert back to pipes by setting a simple flag). This, so far, seems to provide better performance (at the expense of a slightly increased CPU load).
Fixed task pool initialization to zero-out data that might cause segmentation faults.
libasync's task pool optimizations and limits were added to minimize memory fragmentation issues for long running processes.
Baseline (changes not logged before this point in time).
Limited the number of threads (1023) and processes (127) that can be invoked without changing the library's code.
Minor performance oriented changes.
Fixed an issue where Websocket upgrade would allow code execution in parallel with on_open (protocol locking was fixed while switching the protocol).
Added server_each_unsafe to iterate over all client connections to perform a task. The unsafe part in the name is very important - for example, memory could be deallocated during execution.
Minor performance oriented changes.
Shutdown process should now allow single threaded asynchronous (evented) task scheduling.
Updating a socket's timeout settings automatically “touches” the socket (resets the timeout count).
Rewrite from core. The code is more concise with less duplications.
Different API.
The server is now a global state machine instead of an object.
Better integration with libsock.
Handles libsock's UUID instead of direct file descriptors, preventing file descriptor collisions and preventing long running tasks from writing to the wrong client (i.e., if file descriptor 6 got disconnected and someone else connected and receive file descriptor 6 to identify the socket).
Better concurrency protection and protocol cleanup on_close. Now, deferred tasks (server_task / server_each), the on_data callback and even the on_close callback all run within a connection‘s “lock” (busy flag), limiting concurrency for a single connection to the on_ready and ping callbacks. No it is safe to free the protocol’s memory during an on_close callback, as it is (almost) guarantied that no running tasks are using that memory (this assumes that ping and on_ready don‘t use any data placed protocol’s memory).
Moved the global server lock (the one protecting global server data integrity) from a mutex to a spin-lock. Considering API design changes that might allow avoiding a lock.
File sending is now offset based, so lseek data is ignored. This means that it should be possible to cache open fd files and send the same file descriptor to multiple clients.
sendfile to only accept file descriptors (not FILE *). This is an optimization requirement.fixed situations in which the sendfile might not close the file before returning an error.
There was a chance that the on_data callback might return after the connection was disconnected and a new connection was established for the same fd. This could have caused the busy flag to be cleared even if the new connection was actually busy. This potential issue had been fixed by checking the connection against the UUID counter before clearing the busy flag.
reminder: The Server.rw_hooks feature is deprecated. Use libsock's TLC (Transport Layer Callbacks) features instead.
Baseline (changes not logged before this point in time).
gmtime implementation that ignores localization.Baseline (changes not logged before this point in time).
Sep. 13, 2016: ETag support for the static file server, responding with 304 on valid If-None-Match.
Sep. 13, 2016: Updated HEAD request handling for static files.
Fixed pipelining... I think.
Jun 26, 2016: Fixed logging for static file range requests.
Jun 26, 2016: Moved URL decoding logic to the HttpRequest object.
Jun 20, 2016: Added basic logging support.
Jun 20, 2016: Added automatic Content-Length header constraints when setting status code to 1xx, 204 or 304.
Jun 20, 2016: Nicer messages on startup.
Jun 20, 2016: Updated for new lib-server and libsock.
Jun 16, 2016: HttpResponse date handling now utilizes a faster (and dirtier) solution then the standard libc gmtime_r and strftime solutions.
Jun 12, 2016: HTTP protocol and HttpResponse sendfile and HttpResponse.sendfile fixes and optimizations. Now file sending uses file descriptors instead of FILE *, avoiding the memory allocations related to FILE * data.
Jun 12, 2016: HttpResponse copy optimizes the first header buffer packet to copy as much of the body as possible into the buffer packet, right after the headers.
Jun 12, 2016: Optimized mime type search for static file service.
Jun 9, 2016: Rewrote the HttpResponse implementation to leverage libsock's direct user-land buffer packet injection, minimizing user land data-copying.
Jun 9, 2016: rewrote the HTTP sendfile handling for public folder settings.
Jun 9, 2016: Fixed an issue related to the new pooling scheme, where old data would persist in some pooled request objects.
Jun 8, 2016: The HttpRequest object is now being pooled within the request library (not the HTTP protocol implementation) using Atomics (less mutex locking) and minimizing memory fragmentation by pre-initializing the buffer on first request (preventing memory allocated after the first request from getting “stuck behind” any of the pool members).
Jun 7, 2016: Baseline (changes not logged before this point in time).
Resolved issue #6, Credit to @Filly for exposing the issue.
Memory pool removed. Might be reinstated after patching it up, but when more tests were added, the memory pool failed them.
Jan 12, 2017: Memory Performance.
The Websocket connection Protocol now utilizes both a C level memory pool and a local thread storage for temporary data. This helps mitigate possible memory fragmentation issues related to long running processes and long-lived objects.
In addition, the socket read buffer was moved from the protocol object to a local thread storage (assumes pthreads and not green threads). This minimizes the memory footprint for each connection (at the expense of memory locality) and should allow Iodine to support more concurrent connections using less system resources.
Last, but not least, the default message buffer per connection starts at 4Kb instead of 16Kb (grows as needed, up to Iodine::Rack.max_msg_size), assuming smaller messages are the norm.
Baseline (changes not logged before this point in time).