shmc.h

Go to the documentation of this file.

/*
 * (c) 2008-2009 Adam Lackorzynski <adam@os.inf.tu-dresden.de>,
 *               Björn Döbel <doebel@os.inf.tu-dresden.de>
 *     economic rights: Technische Universität Dresden (Germany)
 * This file is part of TUD:OS and distributed under the terms of the
 * GNU Lesser General Public License 2.1.
 * Please see the COPYING-LGPL-2.1 file for details.
 */
#pragma once
 
#include <l4/sys/compiler.h>
#include <l4/sys/linkage.h>
#include <l4/sys/types.h>
#include <l4/sys/err.h>

 
#define __INCLUDED_FROM_L4SHMC_H__
#include <l4/shmc/types.h>
 
L4_BEGIN_DECLS

L4_CV long
l4shmc_create(char const *shmc_name);

L4_CV long
l4shmc_attach(char const *shmc_name, l4shmc_area_t *shmarea);

L4_CV long
l4shmc_get_client_nr(l4shmc_area_t const *shmarea);

L4_CV long
l4shmc_mark_client_initialized(l4shmc_area_t *shmarea);

L4_CV long
l4shmc_get_initialized_clients(l4shmc_area_t *shmarea, l4_umword_t *bitmask);

L4_CV long
l4shmc_add_chunk(l4shmc_area_t *shmarea, char const *chunk_name,
                 l4_umword_t chunk_capacity, l4shmc_chunk_t *chunk);

L4_CV long
l4shmc_add_signal(l4shmc_area_t *shmarea, char const *signal_name,
                  l4shmc_signal_t *signal);

L4_CV L4_INLINE long
l4shmc_trigger(l4shmc_signal_t *signal);

L4_CV L4_INLINE long
l4shmc_chunk_try_to_take(l4shmc_chunk_t *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_try_to_take_for_writing(l4shmc_chunk_t *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_try_to_take_for_overwriting(l4shmc_chunk_t *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_try_to_take_for_reading(l4shmc_chunk_t *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_ready(l4shmc_chunk_t *chunk, l4_umword_t size);

L4_CV L4_INLINE long
l4shmc_chunk_ready_sig(l4shmc_chunk_t *chunk, l4_umword_t size);

L4_CV L4_INLINE long
l4shmc_get_chunk(l4shmc_area_t *shmarea, char const *chunk_name,
                 l4shmc_chunk_t *chunk);

L4_CV long
l4shmc_get_chunk_to(l4shmc_area_t *shmarea, char const *chunk_name,
                    l4_umword_t timeout_ms, l4shmc_chunk_t *chunk);

L4_CV long
l4shmc_iterate_chunk(l4shmc_area_t const *shmarea, char const **chunk_name,
                     long offs);

L4_CV long
l4shmc_attach_signal(l4shmc_area_t *shmarea, char const *signal_name,
                     l4_cap_idx_t thread, l4shmc_signal_t *signal);
 

L4_CV long
l4shmc_get_signal(l4shmc_area_t *shmarea, char const *signal_name,
                  l4shmc_signal_t *signal);

L4_CV long
l4shmc_enable_signal(l4shmc_signal_t *signal);

L4_CV long
l4shmc_enable_chunk(l4shmc_chunk_t *chunk);

L4_CV L4_INLINE long
l4shmc_wait_any(l4shmc_signal_t **retsignal);

L4_CV L4_INLINE long
l4shmc_wait_any_try(l4shmc_signal_t **retsignal);

L4_CV long
l4shmc_wait_any_to(l4_timeout_t timeout, l4shmc_signal_t **retsignal);

L4_CV L4_INLINE long
l4shmc_wait_signal(l4shmc_signal_t *signal);

L4_CV long
l4shmc_wait_signal_to(l4shmc_signal_t *signal, l4_timeout_t timeout);

L4_CV L4_INLINE long
l4shmc_wait_signal_try(l4shmc_signal_t *signal);

L4_CV L4_INLINE long
l4shmc_wait_chunk(l4shmc_chunk_t *chunk);

L4_CV long
l4shmc_wait_chunk_to(l4shmc_chunk_t *chunk, l4_timeout_t timeout);

L4_CV L4_INLINE long
l4shmc_wait_chunk_try(l4shmc_chunk_t *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_consumed(l4shmc_chunk_t *chunk);

L4_CV long
l4shmc_connect_chunk_signal(l4shmc_chunk_t *chunk, l4shmc_signal_t *signal);

L4_CV L4_INLINE long
l4shmc_is_chunk_ready(l4shmc_chunk_t const *chunk);

L4_CV L4_INLINE long
l4shmc_is_chunk_clear(l4shmc_chunk_t const *chunk);

L4_CV L4_INLINE void *
l4shmc_chunk_ptr(l4shmc_chunk_t const *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_size(l4shmc_chunk_t const *chunk);

L4_CV L4_INLINE long
l4shmc_chunk_capacity(l4shmc_chunk_t const *chunk);

L4_CV L4_INLINE l4shmc_signal_t *
l4shmc_chunk_signal(l4shmc_chunk_t const *chunk);

L4_CV L4_INLINE l4_cap_idx_t
l4shmc_signal_cap(l4shmc_signal_t const *signal);

L4_CV L4_INLINE long
l4shmc_check_magic(l4shmc_chunk_t const *chunk);

L4_CV long
l4shmc_area_size(l4shmc_area_t const *shmarea);

L4_CV long
l4shmc_area_size_free(l4shmc_area_t const *shmarea);

L4_CV long
l4shmc_area_overhead(void);

L4_CV long
l4shmc_chunk_overhead(void);
 
#include <l4/shmc/internal.h>
 
L4_END_DECLS