libmetal
condition.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Xilinx Inc. and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of Xilinx nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without
16  * specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 /*
32  * @file generic/condition.h
33  * @brief Generic condition variable primitives for libmetal.
34  */
35 
36 #ifndef __METAL_CONDITION__H__
37 #error "Include metal/condition.h instead of metal/generic/condition.h"
38 #endif
39 
40 #ifndef __METAL_GENERIC_CONDITION__H__
41 #define __METAL_GENERIC_CONDITION__H__
42 
43 #include <unistd.h>
44 #include "metal/atomic.h"
45 #include <stdint.h>
46 #include <limits.h>
47 #include <errno.h>
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 struct metal_condition {
54  metal_mutex_t *m;
60  atomic_int v;
61 };
62 
64 #define METAL_CONDITION_INIT { NULL, ATOMIC_VAR_INIT(0) }
65 
66 static inline void metal_condition_init(struct metal_condition *cv)
67 {
68  cv->m = NULL;
69  atomic_init(&cv->v, 0);
70 }
71 
72 static inline int metal_condition_signal(struct metal_condition *cv)
73 {
74  if (!cv)
75  return -EINVAL;
76 
78  atomic_fetch_add(&cv->v, 1);
79  return 0;
80 }
81 
82 static inline int metal_condition_broadcast(struct metal_condition *cv)
83 {
84  return metal_condition_signal(cv);
85 }
86 
87 
88 #ifdef __cplusplus
89 }
90 #endif
91 
92 #endif /* __METAL_GENERIC_CONDITION__H__ */
#define atomic_init(OBJ, VAL)
Definition: atomic.h:75
static int metal_condition_signal(struct metal_condition *cv)
Definition: condition.h:72
static int metal_condition_broadcast(struct metal_condition *cv)
Definition: condition.h:82
atomic_int v
Definition: condition.h:56
Definition: condition.h:49
static void metal_condition_init(struct metal_condition *cv)
Definition: condition.h:66
#define atomic_fetch_add(OBJ, VAL)
Definition: atomic.h:118
Definition: mutex.h:52
metal_mutex_t * m
Definition: condition.h:50
int atomic_int
Definition: atomic.h:48