p99_futex.h

Go to the documentation of this file.

/* This may look like nonsense, but it really is -*- mode: C; coding: utf-8 -*- */
/*                                                                              */
/* Except for parts copied from previous work and as explicitly stated below,   */
/* the author and copyright holder for this work is                             */
/* (C) copyright  2012 Jens Gustedt, INRIA, France                              */
/*                                                                              */
/* This file is free software; it is part of the P99 project.                   */
/*                                                                              */
/* Licensed under the Apache License, Version 2.0 (the "License");              */
/* you may not use this file except in compliance with the License.             */
/* You may obtain a copy of the License at                                      */
/*                                                                              */
/*     http://www.apache.org/licenses/LICENSE-2.0                               */
/*                                                                              */
/* Unless required by applicable law or agreed to in writing, software          */
/* distributed under the License is distributed on an "AS IS" BASIS,            */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.     */
/* See the License for the specific language governing permissions and          */
/* limitations under the License.                                               */
/*                                                                              */
#ifndef P99_FUTEX_H
#define P99_FUTEX_H
 
#include "p99_type.h"
#include "p99_threads.h"
#include "p99_posix_default.h"
 
P99_DECLARE_STRUCT(p99_futex_c11);
 
#if defined(DOXYGEN)
#define P00_FUTEX_INLINE(NAME) p99_inline
 
#elif (defined(__linux__) && !defined(NO_FUTEX)) || defined(DOXYGEN)
typedef _Atomic(unsigned) p99_futex;
#define P00_FUTEX_INLINE(NAME) p99_inline
 
#else
typedef p99_futex_c11 p99_futex;
/* The C11 implementation needs setjmp in its internals so the
   functions must be implemented as weak symbols. */
#define P00_FUTEX_INLINE(NAME) P99_WEAK(NAME)
#endif
 
#ifdef P00_DOXYGEN
 
struct p99_futex { };
#endif
 
 
 
# define P99_FUTEX_MAX_WAITERS (INT_MAX+0U)
 
 
p99_inline p99_futex* p99_futex_init(p99_futex* p00_c, unsigned p00_ini);
 
p99_inline void p99_futex_destroy(p99_futex* p00_c);
 
P99_DEFARG_DOCU(p99_futex_add)
P00_FUTEX_INLINE(p99_futex_add) unsigned p99_futex_add(p99_futex volatile* p00_fut, unsigned p00_hmuch,
    unsigned p00_cstart, unsigned p00_clen,
    unsigned p00_wmin, unsigned p00_wmax);
 
#ifndef DOXYGEN
#define p99_futex_add(...) P99_CALL_DEFARG(p99_futex_add, 6, __VA_ARGS__)
#define p99_futex_add_defarg_3() 1u
#define p99_futex_add_defarg_4() 0u
#define p99_futex_add_defarg_5() P99_FUTEX_MAX_WAITERS
#endif
 
 
P00_FUTEX_INLINE(p99_futex_load) unsigned p99_futex_load(p99_futex volatile* p00_fut);
 
P99_DEFARG_DOCU(p99_futex_exchange)
P00_FUTEX_INLINE(p99_futex_exchange) unsigned p99_futex_exchange(p99_futex volatile* p00_fut, unsigned p00_desired,
    unsigned p00_cstart, unsigned p00_clen,
    unsigned p00_wmin, unsigned p00_wmax);
 
#ifndef DOXYGEN
#define p99_futex_exchange(...) P99_CALL_DEFARG(p99_futex_exchange, 6, __VA_ARGS__)
#define p99_futex_exchange_defarg_3() 1u
#define p99_futex_exchange_defarg_4() 0u
#define p99_futex_exchange_defarg_5() P99_FUTEX_MAX_WAITERS
#endif
 
P00_FUTEX_INLINE(p99_futex_wakeup)
void p99_futex_wakeup(p99_futex volatile* p00_fut,
                      unsigned p00_wmin, unsigned p00_wmax);
 
 
P00_FUTEX_INLINE(p99_futex_wait)
void p99_futex_wait(p99_futex volatile* p00_fut);
 
 
 
#ifdef DOXYGEN
 
P00_DOCUMENT_IDENTIFIER_ARGUMENT(P99_FUTEX_COMPARE_EXCHANGE, 1)
#define P99_FUTEX_COMPARE_EXCHANGE(FUTEX, ACT, EXPECTED, DESIRED, WAKEMIN, WAKEMAX)
#endif
 
#if (defined(__linux__) && !defined(NO_FUTEX)) || defined(DOXYGEN)
#include "p99_futex_linux.h"
#else
#include "p99_futex_c11.h"
#endif
 
 
#endif