A subprojects/varchunk/.build.yml => subprojects/varchunk/.build.yml +17 -0
@@ 0,0 1,17 @@
+# SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+# SPDX-License-Identifier: CC0-1.0
+
+image: alpine/latest
+packages:
+ - reuse
+ - meson
+tasks:
+ - setup: |
+ cd varchunk
+ meson setup build
+ - build: |
+ cd varchunk
+ ninja -C build
+ - test: |
+ cd varchunk
+ ninja -C build test
A subprojects/varchunk/.gitignore => subprojects/varchunk/.gitignore +5 -0
@@ 0,0 1,5 @@
+# SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+# SPDX-License-Identifier: CC0-1.0
+
+tags
+*.taghl
A subprojects/varchunk/LICENSES/Artistic-2.0.txt => subprojects/varchunk/LICENSES/Artistic-2.0.txt +85 -0
@@ 0,0 1,85 @@
+The Artistic License 2.0
+
+Copyright (c) 2000-2006, The Perl Foundation.
+
+Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
+
+Preamble
+
+This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software.
+
+You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement.
+
+Definitions
+
+ "Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package.
+
+ "Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures.
+
+ "You" and "your" means any person who would like to copy, distribute, or modify the Package.
+
+ "Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version.
+
+ "Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization.
+
+ "Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees.
+
+ "Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder.
+
+ "Modified Version" means the Package, if it has been changed, and such changes were not explicitly requested by the Copyright Holder.
+
+ "Original License" means this Artistic License as Distributed with the Standard Version of the Package, in its current version or as it may be modified by The Perl Foundation in the future.
+
+ "Source" form means the source code, documentation source, and configuration files for the Package.
+
+ "Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form.
+
+Permission for Use and Modification Without Distribution
+
+(1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version.
+
+Permissions for Redistribution of the Standard Version
+
+(2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package.
+
+(3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License.
+
+Distribution of Modified Versions of the Package as Source
+
+(4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following:
+
+ (a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version.
+ (b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version.
+ (c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under
+
+ (i) the Original License or
+ (ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed.
+
+Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source
+
+(5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include complete instructions on how to get the Source of the Standard Version. Such instructions must be valid at the time of your distribution. If these instructions, at any time while you are carrying out such distribution, become invalid, you must provide new instructions on demand or cease further distribution. If you provide valid instructions or cease distribution within thirty days after you become aware that the instructions are invalid, then you do not forfeit any of your rights under this license.
+
+(6) You may Distribute a Modified Version in Compiled form without the Source, provided that you comply with Section 4 with respect to the Source of the Modified Version.
+
+Aggregating or Linking the Package
+
+(7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Standard or Modified Versions as included in the aggregation.
+
+(8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package.
+
+Items That are Not Considered Part of a Modified Version
+
+(9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version. In addition, such works are not considered parts of the Package itself, and are not subject to the terms of this license.
+
+General Provisions
+
+(10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
+
+(11) If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
+
+(12) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
+
+(13) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
+
+(14) Disclaimer of Warranty:
+THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
A subprojects/varchunk/LICENSES/CC0-1.0.txt => subprojects/varchunk/LICENSES/CC0-1.0.txt +121 -0
@@ 0,0 1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+ CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+ LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+ ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+ INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+ REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+ PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+ THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+ HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+ i. the right to reproduce, adapt, distribute, perform, display,
+ communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+ likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+ subject to the limitations in paragraph 4(a), below;
+ v. rights protecting the extraction, dissemination, use and reuse of data
+ in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+ European Parliament and of the Council of 11 March 1996 on the legal
+ protection of databases, and under any national implementation
+ thereof, including any amended or successor version of such
+ directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+ world based on applicable law or treaty, and any national
+ implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+ surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+ warranties of any kind concerning the Work, express, implied,
+ statutory or otherwise, including without limitation warranties of
+ title, merchantability, fitness for a particular purpose, non
+ infringement, or the absence of latent or other defects, accuracy, or
+ the present or absence of errors, whether or not discoverable, all to
+ the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+ that may apply to the Work or any use thereof, including without
+ limitation any person's Copyright and Related Rights in the Work.
+ Further, Affirmer disclaims responsibility for obtaining any necessary
+ consents, permissions or other rights required for any use of the
+ Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+ party to this document and has no duty or obligation with respect to
+ this CC0 or use of the Work.
A subprojects/varchunk/README.md => subprojects/varchunk/README.md +104 -0
@@ 0,0 1,104 @@
+<!--
+ -- (SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+ -- (SPDX-License-Identifier: CC0-1.0
+ -->
+# Varchunk
+
+## Ringbuffer optimized for realtime event handling
+
+[](https://builds.open-music-kontrollers.ch/~hp/varchunk/?)
+
+### Properties
+
+* Is realtime-safe
+* Is lock-free
+* Supports variably sized chunks
+* Supports contiguous memory chunks
+* Supports zero copy operation
+* Uses a simplistic API
+
+### Build / test
+
+ git clone https://git.open-music-kontrollers.ch/~hp/varchunk
+ cd varchunk
+ meson build
+ cd build
+ ninja -j4
+ ninja test
+
+### Dependencies
+
+#### Optional
+
+* [REUSE](https://git.fsfe.org/reuse/tool) (tool for compliance with the REUSE recommendations)
+
+### Usage
+
+ #include <pthread.h>
+ #include <varchunk.h>
+
+ static void *
+ producer_main(void *arg)
+ {
+ varchunk_t *varchunk = arg;
+ void *ptr;
+ const size_t towrite = sizeof(uint32_t);
+ uint32_t counter = 0;
+
+ while(counter <= 1000000)
+ {
+ if( (ptr = varchunk_write_request(varchunk, towrite)) )
+ {
+ // write 'towrite' bytes to 'ptr'
+ *(uint32_t *)ptr = counter++;
+ varchunk_write_advance(varchunk, towrite);
+ }
+ }
+
+ return NULL;
+ }
+
+ static void *
+ consumer_main(void *arg)
+ {
+ varchunk_t *varchunk = arg;
+ const void *ptr;
+ size_t toread;
+
+ while(1)
+ {
+ if( (ptr = varchunk_read_request(varchunk, &toread)) )
+ {
+ // read 'toread' bytes from 'ptr'
+ if(*(uint32_t *)ptr >= 1000000)
+ break;
+ varchunk_read_advance(varchunk);
+ }
+ }
+
+ return NULL;
+ }
+
+ int
+ main(int argc, char **argv)
+ {
+ if(!varchunk_is_lock_free())
+ return -1;
+
+ pthread_t producer;
+ pthread_t consumer;
+ varchunk_t *varchunk = varchunk_new(8192, true);
+ if(!varchunk)
+ return -1;
+
+ pthread_create(&consumer, NULL, consumer_main, varchunk);
+ pthread_create(&producer, NULL, producer_main, varchunk);
+
+ pthread_join(producer, NULL);
+ pthread_join(consumer, NULL);
+
+ varchunk_free(varchunk);
+
+ return 0;
+ }
+
A subprojects/varchunk/meson.build => subprojects/varchunk/meson.build +57 -0
@@ 0,0 1,57 @@
+# SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+# SPDX-License-Identifier: CC0-1.0
+
+project('varchunk', 'c', default_options : [
+ 'buildtype=release',
+ 'warning_level=3',
+ 'werror=false',
+ 'b_lto=true',
+ 'c_std=c11'])
+
+reuse = find_program('reuse', required : false)
+
+add_project_arguments('-D_GNU_SOURCE', language : 'c')
+
+cc = meson.get_compiler('c')
+
+thread_dep = dependency('threads')
+
+lib_deps = []
+
+lib_incs = []
+lib_incs += include_directories('')
+
+lib_srcs = []
+lib_srcs += join_paths('src', 'varchunk.c')
+
+if host_machine.system() == 'linux'
+ rt_dep = cc.find_library('rt')
+ lib_deps += rt_dep
+endif
+
+varchunk = declare_dependency(
+ include_directories : lib_incs,
+ dependencies : lib_deps,
+ sources : lib_srcs)
+
+test_deps = []
+test_deps += varchunk
+test_deps += thread_dep
+
+test_srcs = []
+test_srcs += join_paths('test', 'test.c')
+
+test_varchunk = executable('Test', test_srcs,
+ dependencies : test_deps,
+ install : false)
+
+test('Test', test_varchunk,
+ args : ['100000'],
+ timeout : 360) # seconds
+
+if reuse.found()
+ test('REUSE', reuse, args : [
+ '--root', meson.current_source_dir(),
+ 'lint'
+ ])
+endif
A subprojects/varchunk/meson_options.txt => subprojects/varchunk/meson_options.txt +4 -0
@@ 0,0 1,4 @@
+# SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+# SPDX-License-Identifier: CC0-1.0
+
+option('version', type : 'string', value : '0.1.135')
A subprojects/varchunk/src/varchunk.c => subprojects/varchunk/src/varchunk.c +295 -0
@@ 0,0 1,295 @@
+/*
+ * SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+ * SPDX-License-Identifier: Artistic-2.0
+ */
+
+#include <assert.h>
+
+#if !defined(_WIN32)
+# include <sys/mman.h> // mlock
+#endif
+
+#include <varchunk/varchunk.h>
+
+#define VARCHUNK_PAD(SIZE) ( ( (size_t)(SIZE) + 7U ) & ( ~7U ) )
+
+bool
+varchunk_is_lock_free(void)
+{
+ varchunk_t varchunk;
+
+ return atomic_is_lock_free(&varchunk.head)
+ && atomic_is_lock_free(&varchunk.tail);
+}
+
+size_t
+varchunk_body_size(size_t minimum)
+{
+ size_t size = 1;
+ while(size < minimum)
+ size <<= 1; // assure size to be a power of 2
+ return size;
+}
+
+void
+varchunk_init(varchunk_t *varchunk, size_t body_size, bool release_and_acquire)
+{
+ varchunk->acquire = release_and_acquire
+ ? memory_order_acquire
+ : memory_order_relaxed;
+ varchunk->release = release_and_acquire
+ ? memory_order_release
+ : memory_order_relaxed;
+
+ atomic_init(&varchunk->head, 0);
+ atomic_init(&varchunk->tail, 0);
+
+ varchunk->size = body_size;
+ varchunk->mask = varchunk->size - 1;
+}
+
+varchunk_t *
+varchunk_new(size_t minimum, bool release_and_acquire)
+{
+ varchunk_t *varchunk = NULL;
+
+ const size_t body_size = varchunk_body_size(minimum);
+ const size_t total_size = sizeof(varchunk_t) + body_size;
+
+#if defined(_WIN32)
+ varchunk = _aligned_malloc(total_size, sizeof(varchunk_elmnt_t));
+#else
+ posix_memalign((void **)&varchunk, sizeof(varchunk_elmnt_t), total_size);
+ mlock(varchunk, total_size); // prevent memory from being flushed to disk
+#endif
+
+ if(varchunk)
+ varchunk_init(varchunk, body_size, release_and_acquire);
+
+ return varchunk;
+}
+
+void
+varchunk_free(varchunk_t *varchunk)
+{
+ if(varchunk)
+ {
+#if !defined(_WIN32)
+ munlock(varchunk->buf, varchunk->size);
+#endif
+ free(varchunk);
+ }
+}
+
+static inline void
+_varchunk_write_advance_raw(varchunk_t *varchunk, size_t head, size_t written)
+{
+ // only producer is allowed to advance write head
+ const size_t new_head = (head + written) & varchunk->mask;
+ atomic_store_explicit(&varchunk->head, new_head, varchunk->release);
+}
+
+void *
+varchunk_write_request_max(varchunk_t *varchunk, size_t minimum, size_t *maximum)
+{
+ assert(varchunk);
+
+ size_t space; // size of writable buffer
+ size_t end; // virtual end of writable buffer
+ const size_t head = atomic_load_explicit(&varchunk->head, memory_order_relaxed); // read head
+ const size_t tail = atomic_load_explicit(&varchunk->tail, varchunk->acquire); // read tail (consumer modifies it any time)
+ const size_t padded = 2*sizeof(varchunk_elmnt_t) + VARCHUNK_PAD(minimum);
+
+ // calculate writable space
+ if(head > tail)
+ space = ((tail - head + varchunk->size) & varchunk->mask) - 1;
+ else if(head < tail)
+ space = (tail - head) - 1;
+ else // head == tail
+ space = varchunk->size - 1;
+ end = head + space;
+
+ if(end > varchunk->size) // available region wraps over at end of buffer
+ {
+ // get first part of available buffer
+ uint8_t *buf1 = varchunk->buf + head;
+ const size_t len1 = varchunk->size - head;
+
+ if(len1 < padded) // not enough space left on first part of buffer
+ {
+ // get second part of available buffer
+ uint8_t *buf2 = varchunk->buf;
+ const size_t len2 = end & varchunk->mask;
+
+ if(len2 < padded) // not enough space left on second buffer, either
+ {
+ varchunk->rsvd = 0;
+ varchunk->gapd = 0;
+ if(maximum)
+ *maximum = varchunk->rsvd;
+ return NULL;
+ }
+ else // enough space left on second buffer, use it!
+ {
+ varchunk->rsvd = len2;
+ varchunk->gapd = len1;
+ if(maximum)
+ *maximum = varchunk->rsvd;
+ return buf2 + sizeof(varchunk_elmnt_t);
+ }
+ }
+ else // enough space left on first part of buffer, use it!
+ {
+ varchunk->rsvd = len1;
+ varchunk->gapd = 0;
+ if(maximum)
+ *maximum = varchunk->rsvd;
+ return buf1 + sizeof(varchunk_elmnt_t);
+ }
+ }
+ else // available region is contiguous
+ {
+ uint8_t *buf = varchunk->buf + head;
+
+ if(space < padded) // no space left on contiguous buffer
+ {
+ varchunk->rsvd = 0;
+ varchunk->gapd = 0;
+ if(maximum)
+ *maximum = varchunk->rsvd;
+ return NULL;
+ }
+ else // enough space left on contiguous buffer, use it!
+ {
+ varchunk->rsvd = space;
+ varchunk->gapd = 0;
+ if(maximum)
+ *maximum = varchunk->rsvd;
+ return buf + sizeof(varchunk_elmnt_t);
+ }
+ }
+}
+
+void *
+varchunk_write_request(varchunk_t *varchunk, size_t minimum)
+{
+ return varchunk_write_request_max(varchunk, minimum, NULL);
+}
+
+void
+varchunk_write_advance(varchunk_t *varchunk, size_t written)
+{
+ assert(varchunk);
+ // fail miserably if stupid programmer tries to write more than rsvd
+ assert(written <= varchunk->rsvd);
+
+ // write elmnt header at head
+ const size_t head = atomic_load_explicit(&varchunk->head, memory_order_relaxed);
+ if(varchunk->gapd > 0)
+ {
+ // fill end of first buffer with gap
+ varchunk_elmnt_t *elmnt = (varchunk_elmnt_t *)(varchunk->buf + head);
+ elmnt->size = varchunk->gapd - sizeof(varchunk_elmnt_t);
+ elmnt->gap = 1;
+
+ // fill written element header
+ elmnt = (void *)varchunk->buf;
+ elmnt->size = written;
+ elmnt->gap = 0;
+ }
+ else // varchunk->gapd == 0
+ {
+ // fill written element header
+ varchunk_elmnt_t *elmnt = (varchunk_elmnt_t *)(varchunk->buf + head);
+ elmnt->size = written;
+ elmnt->gap = 0;
+ }
+
+ // advance write head
+ _varchunk_write_advance_raw(varchunk, head,
+ varchunk->gapd + sizeof(varchunk_elmnt_t) + VARCHUNK_PAD(written));
+}
+
+static inline void
+_varchunk_read_advance_raw(varchunk_t *varchunk, size_t tail, size_t read)
+{
+ // only consumer is allowed to advance read tail
+ const size_t new_tail = (tail + read) & varchunk->mask;
+ atomic_store_explicit(&varchunk->tail, new_tail, varchunk->release);
+}
+
+const void *
+varchunk_read_request(varchunk_t *varchunk, size_t *toread)
+{
+ assert(varchunk);
+ size_t space; // size of available buffer
+ const size_t tail = atomic_load_explicit(&varchunk->tail, memory_order_relaxed); // read tail
+ const size_t head = atomic_load_explicit(&varchunk->head, varchunk->acquire); // read head (producer modifies it any time)
+
+ // calculate readable space
+ if(head > tail)
+ space = head - tail;
+ else
+ space = (head - tail + varchunk->size) & varchunk->mask;
+
+ if(space > 0) // there may be chunks available for reading
+ {
+ const size_t end = tail + space; // virtual end of available buffer
+
+ if(end > varchunk->size) // available buffer wraps around at end
+ {
+ // first part of available buffer
+ const uint8_t *buf1 = varchunk->buf + tail;
+ const size_t len1 = varchunk->size - tail;
+ const varchunk_elmnt_t *elmnt = (const varchunk_elmnt_t *)buf1;
+
+ if(elmnt->gap) // gap elmnt?
+ {
+ // skip gap
+ _varchunk_read_advance_raw(varchunk, tail, len1);
+
+ // second part of available buffer
+ const uint8_t *buf2 = varchunk->buf;
+ // there will always be at least on element after a gap
+ elmnt = (const varchunk_elmnt_t *)buf2;
+
+ *toread = elmnt->size;
+ return buf2 + sizeof(varchunk_elmnt_t);
+ }
+ else // valid chunk, use it!
+ {
+ *toread = elmnt->size;
+ return buf1 + sizeof(varchunk_elmnt_t);
+ }
+ }
+ else // available buffer is contiguous
+ {
+ // get buffer
+ const uint8_t *buf = varchunk->buf + tail;
+ const varchunk_elmnt_t *elmnt = (const varchunk_elmnt_t *)buf;
+
+ *toread = elmnt->size;
+ return buf + sizeof(varchunk_elmnt_t);
+ }
+ }
+ else // no chunks available aka empty buffer
+ {
+ *toread = 0;
+ return NULL;
+ }
+}
+
+void
+varchunk_read_advance(varchunk_t *varchunk)
+{
+ assert(varchunk);
+ // get elmnt header from tail (for size)
+ const size_t tail = atomic_load_explicit(&varchunk->tail, memory_order_relaxed);
+ const varchunk_elmnt_t *elmnt = (const varchunk_elmnt_t *)(varchunk->buf + tail);
+
+ // advance read tail
+ _varchunk_read_advance_raw(varchunk, tail,
+ sizeof(varchunk_elmnt_t) + VARCHUNK_PAD(elmnt->size));
+}
+
+#undef VARCHUNK_PAD
A subprojects/varchunk/test/test.c => subprojects/varchunk/test/test.c +242 -0
@@ 0,0 1,242 @@
+/*
+ * SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+ * SPDX-License-Identifier: Artistic-2.0
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <inttypes.h>
+#include <pthread.h>
+#include <unistd.h>
+#include <assert.h>
+
+#include <varchunk/varchunk.h>
+
+#if !defined(_WIN32)
+# include <sys/mman.h>
+# include <sys/stat.h>
+# include <fcntl.h>
+# include <string.h>
+# define VARCHUNK_USE_SHARED_MEM
+
+static const struct timespec req = {
+ .tv_sec = 0,
+ .tv_nsec = 1
+};
+#endif
+
+static uint64_t iterations = 10000000;
+#define THRESHOLD (RAND_MAX / 256)
+#define PAD(SIZE) ( ( (size_t)(SIZE) + 7U ) & ( ~7U ) )
+
+static void *
+producer_main(void *arg)
+{
+ varchunk_t *varchunk = arg;
+ uint8_t *ptr;
+ const uint8_t *end;
+ size_t written;
+ uint64_t cnt = 0;
+
+ while(cnt < iterations)
+ {
+#if !defined(_WIN32)
+ if(rand() < THRESHOLD)
+ {
+ nanosleep(&req, NULL);
+ }
+#endif
+
+ written = PAD(rand() * 1024.f / RAND_MAX);
+
+ size_t maximum;
+ if( (ptr = varchunk_write_request_max(varchunk, written, &maximum)) )
+ {
+ assert(maximum >= written);
+ end = ptr + written;
+ for(uint8_t *src=ptr; src<end; src+=sizeof(uint64_t))
+ {
+ *(uint64_t *)src = cnt;
+ assert(*(uint64_t *)src == cnt);
+ }
+ varchunk_write_advance(varchunk, written);
+ cnt++;
+ }
+ else
+ {
+ // buffer full
+ }
+ }
+
+ return NULL;
+}
+
+static void *
+consumer_main(void *arg)
+{
+ varchunk_t *varchunk = arg;
+ const uint8_t *ptr;
+ const uint8_t *end;
+ size_t toread;
+ uint64_t cnt = 0;
+
+ while(cnt < iterations)
+ {
+#if !defined(_WIN32)
+ if(rand() < THRESHOLD)
+ {
+ nanosleep(&req, NULL);
+ }
+#endif
+
+ if( (ptr = varchunk_read_request(varchunk, &toread)) )
+ {
+ end = ptr + toread;
+ for(const uint8_t *src=ptr; src<end; src+=sizeof(uint64_t))
+ {
+ assert(*(const uint64_t *)src == cnt);
+ }
+ varchunk_read_advance(varchunk);
+ cnt++;
+ }
+ else
+ {
+ // buffer empty
+ }
+ }
+
+ return NULL;
+}
+
+static void
+test_threaded()
+{
+ pthread_t producer;
+ pthread_t consumer;
+ varchunk_t *varchunk = varchunk_new(8192, true);
+ assert(varchunk);
+
+ pthread_create(&consumer, NULL, consumer_main, varchunk);
+ pthread_create(&producer, NULL, producer_main, varchunk);
+
+ pthread_join(producer, NULL);
+ pthread_join(consumer, NULL);
+
+ varchunk_free(varchunk);
+}
+
+#if defined(VARCHUNK_USE_SHARED_MEM)
+typedef struct _varchunk_shm_t varchunk_shm_t;
+
+struct _varchunk_shm_t {
+ char *name;
+ int fd;
+ varchunk_t *varchunk;
+};
+
+static int
+varchunk_shm_init(varchunk_shm_t *varchunk_shm, const char *name, size_t minimum, bool release_and_acquire)
+{
+ const size_t body_size = varchunk_body_size(minimum);
+ const size_t total_size = sizeof(varchunk_t) + body_size;
+
+ varchunk_shm->name = strdup(name);
+ if(!varchunk_shm->name)
+ {
+ return -1;
+ }
+
+ bool is_first = true;
+ varchunk_shm->fd = shm_open(varchunk_shm->name, O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR);
+ if(varchunk_shm->fd == -1)
+ {
+ is_first = false;
+ varchunk_shm->fd = shm_open(varchunk_shm->name, O_RDWR , S_IRUSR | S_IWUSR);
+ }
+ if(varchunk_shm->fd == -1)
+ {
+ free(varchunk_shm->name);
+ return -1;
+ }
+
+ if( (ftruncate(varchunk_shm->fd, total_size) == -1)
+ || ((varchunk_shm->varchunk = mmap(NULL, total_size, PROT_READ | PROT_WRITE,
+ MAP_SHARED, varchunk_shm->fd, 0)) == MAP_FAILED) )
+ {
+ shm_unlink(varchunk_shm->name);
+ close(varchunk_shm->fd);
+ free(varchunk_shm->name);
+ return -1;
+ }
+
+ if(is_first)
+ {
+ varchunk_init(varchunk_shm->varchunk, body_size, release_and_acquire);
+ }
+
+ return 0;
+}
+
+static void
+varchunk_shm_deinit(varchunk_shm_t *varchunk_shm)
+{
+ const size_t total_size = sizeof(varchunk_t) + varchunk_shm->varchunk->size;
+
+ munmap(varchunk_shm->varchunk, total_size);
+ shm_unlink(varchunk_shm->name);
+ close(varchunk_shm->fd);
+ free(varchunk_shm->name);
+}
+
+static void
+test_shared()
+{
+ const char *name = "/varchunk_shm_test";
+ pid_t pid = fork();
+
+ assert(pid != -1);
+
+ if(pid == 0) // child
+ {
+ varchunk_shm_t varchunk_shm;
+ assert(varchunk_shm_init(&varchunk_shm, name, 8192, true) == 0);
+
+ consumer_main(varchunk_shm.varchunk);
+
+ varchunk_shm_deinit(&varchunk_shm);
+ }
+ else // parent
+ {
+ varchunk_shm_t varchunk_shm;
+ assert(varchunk_shm_init(&varchunk_shm, name, 8192, true) == 0);
+
+ producer_main(varchunk_shm.varchunk);
+
+ varchunk_shm_deinit(&varchunk_shm);
+ }
+}
+#endif
+
+int
+main(int argc, char **argv)
+{
+#if !defined(_WIN32)
+ const int seed = time(NULL);
+ srand(seed);
+#endif
+
+ if(argc >= 2)
+ {
+ iterations = atoi(argv[1]);
+ }
+
+ assert(varchunk_is_lock_free());
+
+ test_threaded();
+
+#if defined(VARCHUNK_USE_SHARED_MEM)
+ test_shared();
+#endif
+
+ return 0;
+}
A subprojects/varchunk/varchunk/varchunk.h => subprojects/varchunk/varchunk/varchunk.h +79 -0
@@ 0,0 1,79 @@
+/*
+ * SPDX-FileCopyrightText: Hanspeter Portner <dev@open-music-kontrollers.ch>
+ * SPDX-License-Identifier: Artistic-2.0
+ */
+
+#ifndef _VARCHUNK_H
+#define _VARCHUNK_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdlib.h>
+#include <stdint.h>
+#include <stdatomic.h>
+#include <stdbool.h>
+
+/*****************************************************************************
+ * API START
+ *****************************************************************************/
+
+typedef struct _varchunk_elmnt_t varchunk_elmnt_t;
+typedef struct _varchunk_t varchunk_t;
+
+struct _varchunk_elmnt_t {
+ uint32_t size;
+ uint32_t gap;
+};
+
+struct _varchunk_t {
+ size_t size;
+ size_t mask;
+ size_t rsvd;
+ size_t gapd;
+
+ memory_order acquire;
+ memory_order release;
+
+ atomic_size_t head;
+ atomic_size_t tail;
+
+ uint8_t buf [] __attribute__((aligned(sizeof(varchunk_elmnt_t))));
+};
+
+bool
+varchunk_is_lock_free(void);
+
+size_t
+varchunk_body_size(size_t minimum);
+
+varchunk_t *
+varchunk_new(size_t minimum, bool release_and_acquire);
+
+void
+varchunk_free(varchunk_t *varchunk);
+
+void
+varchunk_init(varchunk_t *varchunk, size_t body_size, bool release_and_acquire);
+
+void *
+varchunk_write_request_max(varchunk_t *varchunk, size_t minimum, size_t *maximum);
+
+void *
+varchunk_write_request(varchunk_t *varchunk, size_t minimum);
+
+void
+varchunk_write_advance(varchunk_t *varchunk, size_t written);
+
+const void *
+varchunk_read_request(varchunk_t *varchunk, size_t *toread);
+
+void
+varchunk_read_advance(varchunk_t *varchunk);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif //_VARCHUNK_H