libmetal
shmem.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, 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 shmem.h
33  * @brief Shared memory primitives for libmetal.
34  */
35 
36 #ifndef __METAL_SHMEM__H__
37 #define __METAL_SHMEM__H__
38 
39 #include "metal/io.h"
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
50  const char *name;
52  struct metal_list node;
53 };
54 
67 extern int metal_shmem_open(const char *name, size_t size,
68  struct metal_io_region **io);
69 
81 extern int metal_shmem_register_generic(struct metal_generic_shmem *shmem);
82 
83 #ifdef METAL_INTERNAL
84 
96 int metal_shmem_open_generic(const char *name, size_t size,
97  struct metal_io_region **result);
98 
99 #endif
100 
103 #ifdef __cplusplus
104 }
105 #endif
106 
107 #endif /* __METAL_SHMEM__H__ */
struct metal_list node
Definition: shmem.h:52
Definition: shmem.h:49
int metal_shmem_register_generic(struct metal_generic_shmem *shmem)
Statically register a generic shared memory region.
Definition: shmem.c:41
Definition: list.h:48
const char * name
Definition: shmem.h:50
struct metal_io_region io
Definition: shmem.h:51
Definition: io.h:86
int metal_shmem_open_generic(const char *name, size_t size, struct metal_io_region **result)
Definition: shmem.c:54
int metal_shmem_open(const char *name, size_t size, struct metal_io_region **io)
Open a libmetal shared memory segment.
Definition: shmem.c:38