Commit b6dc601d authored by Hanspeter Portner's avatar Hanspeter Portner

Merge commit '7a0c5bea' as 'varchunk'

parents 43dfd580 7a0c5bea
stages:
- test
.variables_template: &variables_definition
variables:
BASE_NAME: "varchunk"
PKG_CONFIG_PATH: "/opt/lv2/lib/pkgconfig:/opt/${CI_BUILD_NAME}/lib/pkgconfig:/usr/lib/${CI_BUILD_NAME}/pkgconfig"
.common_template: &common_definition
<<: *variables_definition
stage: test
.build_template: &build_definition
<<: *common_definition
script:
- meson --cross-file "${CI_BUILD_NAME}" build
- ninja -C build
.test_template: &test_definition
<<: *common_definition
script:
- meson --cross-file "${CI_BUILD_NAME}" build
- ninja -C build
- cd build
- meson test --verbose --wrap "${CI_BUILD_NAME}.wrap"
.universal_linux_template: &universal_linux_definition
image: ventosus/universal-linux-gnu
<<: *test_definition
.arm_linux_template: &arm_linux_definition
image: ventosus/arm-linux-gnueabihf
<<: *test_definition
.universal_w64_template: &universal_w64_definition
image: ventosus/universal-w64-mingw32
before_script:
- ln -s /usr/i686-w64-mingw32/lib/libwinpthread-1.dll /opt/i686-w64-mingw32/lib/libwinpthread-1.dll
- ln -s /usr/x86_64-w64-mingw32/lib/libwinpthread-1.dll /opt/x86_64-w64-mingw32/lib/libwinpthread-1.dll
<<: *test_definition
.universal_apple_template: &universal_apple_definition
image: ventosus/universal-apple-darwin
<<: *build_definition
# building in docker
x86_64-linux-gnu:
<<: *universal_linux_definition
i686-linux-gnu:
<<: *universal_linux_definition
arm-linux-gnueabihf:
<<: *arm_linux_definition
x86_64-w64-mingw32:
<<: *universal_w64_definition
i686-w64-mingw32:
<<: *universal_w64_definition
universal-apple-darwin:
<<: *universal_apple_definition
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.
# Varchunk
## Ringbuffer optimized for realtime event handling
### Properties
* Is realtime-safe
* Is lock-free
* Supports variably sized chunks
* Supports contiguous memory chunks
* Supports zero copy operation
* Uses a simplistic API
### Build Status
[![build status](https://gitlab.com/OpenMusicKontrollers/varchunk/badges/master/build.svg)](https://gitlab.com/OpenMusicKontrollers/varchunk/commits/master)
### Build / test
git clone https://git.open-music-kontrollers.ch/lad/varchunk
cd varchunk
meson build
cd build
ninja -j4
ninja test
### 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;
}
### License
Copyright (c) 2015-2017 Hanspeter Portner (dev@open-music-kontrollers.ch)
This is free software: you can redistribute it and/or modify
it under the terms of the Artistic License 2.0 as published by
The Perl Foundation.
This source is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Artistic License 2.0 for more details.
You should have received a copy of the Artistic License 2.0
along the source as a COPYING file. If not, obtain it from
<http://www.perlfoundation.org/artistic_license_2_0>.
project('varchunk', 'c', default_options : [
'buildtype=release',
'warning_level=3',
'werror=true',
'b_lto=false',
'c_std=c11'])
version = run_command('cat', 'VERSION').stdout().strip()
add_project_arguments('-D_GNU_SOURCE', language : 'c')
conf_data = configuration_data()
cc = meson.get_compiler('c')
thread_dep = dependency('threads')
deps = [thread_dep]
if host_machine.system() == 'linux'
rt_dep = cc.find_library('rt')
deps += rt_dep
endif
test_varchunk = executable('test_varchunk',
'test_varchunk.c',
dependencies : deps,
install : false)
test('Test', test_varchunk,
args : ['100000'],
timeout : 360) # seconds
/*
* Copyright (c) 2015-2017 Hanspeter Portner (dev@open-music-kontrollers.ch)
*
* This is free software: you can redistribute it and/or modify
* it under the terms of the Artistic License 2.0 as published by
* The Perl Foundation.
*
* This source is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Artistic License 2.0 for more details.
*
* You should have received a copy of the Artistic License 2.0
* along the source as a COPYING file. If not, obtain it from
* http://www.perlfoundation.org/artistic_license_2_0.
*/
#include <stdio.h>
#include <stdlib.h>
#include <inttypes.h>
#include <pthread.h>
#include <unistd.h>
#include <assert.h>
#include <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;
}
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment