1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/**
* @file
*
* @brief Internal Support for POSIX Shared Memory
*/
/*
* Copyright (c) 2016 Gedare Bloom.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _RTEMS_POSIX_SHM_H
#define _RTEMS_POSIX_SHM_H
#include <rtems/score/object.h>
#include <rtems/score/threadq.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup POSIXShmPrivate POSIX Shared Memory Private Support
*
* @ingroup POSIXAPI
*
* Internal implementation support for POSIX shared memory.
* @{
*/
typedef struct POSIX_Shm_Object_operations POSIX_Shm_Object_operations;
extern const POSIX_Shm_Object_operations _POSIX_Shm_Object_operations;
/**
* @brief Encapsulation for the storage and manipulation of shm objects.
*/
typedef struct {
/**
* @brief The handle is private for finding object storage.
*/
void *handle;
/**
* @brief The number of bytes allocated to the object. A size of 0 with
* a handle of NULL means no object is allocated.
*/
size_t size;
/**
* @brief Implementation-specific operations on shm objects.
*/
const POSIX_Shm_Object_operations *ops;
} POSIX_Shm_Object;
/**
* @brief Operations on POSIX Shared Memory Objects.
*/
struct POSIX_Shm_Object_operations {
/**
* @brief Allocates a new @a shm_obj with initial @a size.
*
* New shared memory is initialized to zeroes.
*
* Returns 0 for success.
*/
int ( *object_create ) ( POSIX_Shm_Object *shm_obj, size_t size );
/**
* @brief Changes the @a shm_obj size to @a size.
*
* Zeroes out the portion of the shared memory object that shrinks or grows.
*
* Returns 0 for success.
*/
int ( *object_resize ) ( POSIX_Shm_Object *shm_obj, size_t size );
/**
* @brief Deletes the @a shm_obj.
*
* Zeroes out the memory.
*
* Returns 0 for success.
*/
int ( *object_delete ) ( POSIX_Shm_Object *shm_obj );
/**
* @brief Copies up to @count bytes of the @a shm_obj data into @a buf.
*
* Returns the number of bytes read (copied) into @a buf.
*/
int ( *object_read ) ( POSIX_Shm_Object *shm_obj, void *buf, size_t count );
/**
* @brief Maps a shared memory object.
*
* Establishes a memory mapping between the shared memory object and the
* caller.
*
* Returns the mapped address of the object.
*/
void * ( *object_mmap ) ( POSIX_Shm_Object *shm_obj, size_t len, int prot, off_t off);
};
/**
* @brief Control for a POSIX Shared Memory Object
*/
typedef struct {
Objects_Control Object;
Thread_queue_Control Wait_queue;
int reference_count;
POSIX_Shm_Object shm_object;
uid_t uid;
gid_t gid;
mode_t mode;
int oflag;
time_t atime;
time_t mtime;
time_t ctime;
} POSIX_Shm_Control;
/**
* @brief object_create operation for shm objects stored in RTEMS Workspace.
*/
extern int _POSIX_Shm_Object_create_from_workspace(
POSIX_Shm_Object *shm_obj,
size_t size
);
/**
* @brief object_delete operation for shm objects stored in RTEMS Workspace.
*/
extern int _POSIX_Shm_Object_delete_from_workspace( POSIX_Shm_Object *shm_obj );
/**
* @brief object_resize operation for shm objects stored in RTEMS Workspace.
*/
extern int _POSIX_Shm_Object_resize_from_workspace(
POSIX_Shm_Object *shm_obj,
size_t size
);
/**
* @brief object_read operation for shm objects stored in RTEMS Workspace.
*/
extern int _POSIX_Shm_Object_read_from_workspace(
POSIX_Shm_Object *shm_obj,
void *buf,
size_t count
);
/**
* @brief object_mmap operation for shm objects stored in RTEMS Workspace.
*/
extern void * _POSIX_Shm_Object_mmap_from_workspace(
POSIX_Shm_Object *shm_obj,
size_t len,
int prot,
off_t off
);
/**
* @brief object_create operation for shm objects stored in C program heap.
*/
extern int _POSIX_Shm_Object_create_from_heap(
POSIX_Shm_Object *shm_obj,
size_t size
);
/**
* @brief object_delete operation for shm objects stored in C program heap.
*/
extern int _POSIX_Shm_Object_delete_from_heap( POSIX_Shm_Object *shm_obj );
/**
* @brief object_resize operation for shm objects stored in C program heap.
*/
extern int _POSIX_Shm_Object_resize_from_heap(
POSIX_Shm_Object *shm_obj,
size_t size
);
/**
* @brief object_read operation for shm objects stored in C program heap.
*/
extern int _POSIX_Shm_Object_read_from_heap(
POSIX_Shm_Object *shm_obj,
void *buf,
size_t count
);
/**
* @brief object_mmap operation for shm objects stored in C program heap.
*/
extern void * _POSIX_Shm_Object_mmap_from_heap(
POSIX_Shm_Object *shm_obj,
size_t len,
int prot,
off_t off
);
/** @} */
#ifdef __cplusplus
}
#endif
#endif
|
