libevl/eshi
Philippe Gerum 04db253a39 lib/thread: hide low-level details from applications
evl_get_current() contains implementation details which are definitely
not part of the API and the way this works should not be exposed.

Signed-off-by: Philippe Gerum <rpm@xenomai.org>
2020-12-13 12:29:25 +01:00
..
Makefile build: copy tidbits only if install_all is given 2020-05-04 15:42:36 +02:00
README.md lib: introduce the interface to observables 2020-04-30 12:11:14 +02:00
clock.c lib: rename evl_udelay() to evl_usleep() 2020-01-21 14:52:21 +01:00
event.c lib: introduce element visibility attribute 2020-04-18 20:43:02 +02:00
flags.c lib: introduce element visibility attribute 2020-04-18 20:43:02 +02:00
heap.c eshi: EVL shim library 2019-08-09 19:07:39 +02:00
init.c lib, eshi: move version string to evl_version 2019-11-13 10:00:39 +01:00
internal.h lib/thread: hide low-level details from applications 2020-12-13 12:29:25 +01:00
mutex.c lib: introduce element visibility attribute 2020-04-18 20:43:02 +02:00
poll.c lib: introduce the interface to observables 2020-04-30 12:11:14 +02:00
proxy.c lib/thread: hide low-level details from applications 2020-12-13 12:29:25 +01:00
sched.c eshi: EVL shim library 2019-08-09 19:07:39 +02:00
sem.c lib: introduce element visibility attribute 2020-04-18 20:43:02 +02:00
thread.c eshi: fix access race to thread index tree 2020-03-28 16:47:28 +01:00
timer.c eshi: EVL shim library 2019-08-09 19:07:39 +02:00
version.c lib, eshi: move version string to evl_version 2019-11-13 10:00:39 +01:00

README.md

== PURPOSE of libeshi

The EVL shim library mimics the behavior of the original EVL API based on plain POSIX calls from the native *libc, which does not require the EVL core to be enabled in the host kernel. It is useful when the real-time guarantees delivered by the EVL core are not required for quick prototyping or debugging application code.

== USAGE

To build against the EVL shim library, you need to update a couple of settings from the Makefile building your application as follows (*):

CPPFLAGS/CFLAGS:

  • Replace -I$(prefix)/include by -I$(prefix)/include/eshi

LDFLAGS:

  • Replace -levl by -leshi

For instance:

(CC) -o app app.c -I(prefix)/include/eshi -L$(prefix)/lib -leshi -lpthread -lrt

(*) $(prefix) is the installation root of libevl (e.g. /usr/evl).

== LIMITATIONS

This API supports process-local services only. The resources/objects it creates cannot be shared between processes.

The following calls are not supported:

evl_peek_flags evl_peek_sem evl_new_xbuf evl_open_mutex evl_open_event evl_open_flags evl_open_sem The observable API.

== VARIATION(S)

evl_poll: POLLOUT is always set for evl_flags. Unlike with the native libevl API, this condition cannot be monitored for detecting event consumption by the receiver side, i.e. waiting for the value to be cleared upon a successful call to evl_wait*_flags.