Annotation of libaitio/inc/aitsess.h, revision 1.1.2.2
1.1.2.1 misho 1: /*************************************************************************
2: * (C) 2008 AITNET ltd - Sofia/Bulgaria - <misho@aitbg.com>
3: * by Michael Pounov <misho@openbsd-bg.org>
4: *
5: * $Author: misho $
1.1.2.2 ! misho 6: * $Id: aitsess.h,v 1.1.2.1 2013/03/13 14:16:12 misho Exp $
1.1.2.1 misho 7: *
8: **************************************************************************
9: The ELWIX and AITNET software is distributed under the following
10: terms:
11:
12: All of the documentation and software included in the ELWIX and AITNET
13: Releases is copyrighted by ELWIX - Sofia/Bulgaria <info@elwix.org>
14:
15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
16: by Michael Pounov <misho@elwix.org>. All rights reserved.
17:
18: Redistribution and use in source and binary forms, with or without
19: modification, are permitted provided that the following conditions
20: are met:
21: 1. Redistributions of source code must retain the above copyright
22: notice, this list of conditions and the following disclaimer.
23: 2. Redistributions in binary form must reproduce the above copyright
24: notice, this list of conditions and the following disclaimer in the
25: documentation and/or other materials provided with the distribution.
26: 3. All advertising materials mentioning features or use of this software
27: must display the following acknowledgement:
28: This product includes software developed by Michael Pounov <misho@elwix.org>
29: ELWIX - Embedded LightWeight unIX and its contributors.
30: 4. Neither the name of AITNET nor the names of its contributors
31: may be used to endorse or promote products derived from this software
32: without specific prior written permission.
33:
34: THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND
35: ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36: IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37: ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
38: FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
39: DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
40: OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
41: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
42: LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
43: OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44: SUCH DAMAGE.
45: */
46: #ifndef __AITSESS_H
47: #define __AITSESS_H
48:
49:
50: #include <pthread.h>
51: #include <assert.h>
52: #include <semaphore.h>
53: #include <elwix.h>
54:
55: #define SHARED_UNKNOWN -1
56: #define SHARED_IPC 0
57: #define SHARED_MAP 1
58:
59: #define IS_VAL 0x0
60: #define IS_ADD 0x40000000
61: #define IS_DEF 0x80000000
62:
63: #define ISNEW(x) (((x) & IS_ADD) == IS_ADD)
64: #define ISDEF(x) (((x) & IS_DEF) == IS_DEF)
65:
66: #define MAX_ATTRIBUTE 64
67: #define MAX_SEMNAME 14
68:
69:
70: /* Shared memory session */
71:
72: typedef struct tagSess {
73: key_t key;
74: char type;
75: char zcpy;
76:
77: char name[BUFSIZ];
78: off_t eom;
79: void *addr;
80: off_t offset;
81: union {
82: int shmid;
83: int fd;
84: } mem;
85: union {
86: int semid;
87: sem_t *sid;
88: } id;
89:
90: struct {
91: int (*create)(int, long, void *, ...);
92: void (*destroy)(void *);
93: void *(*attach)(void *, void *);
94: void (*detach)(void *);
95: void (*notSem)(void *);
96: int (*isSemOK)(void *);
97: int (*incSem)(void *);
98: int (*decSem)(void *);
99: } sess;
100: } ait_sess_t;
101:
102:
103: /*
104: * sess_initSession() - Initializing session structure,
105: * if session file not exists creating with specified tech
106: *
107: * @id = Technology using in session. SHARED_IPC IPC tech or SHARED_MAP BSD MemoryMap tech
108: * @csFName = Session filename for build key and identified
109: * @Sess = Session item, if =NULL allocate memory for session after use must be free!
110: * return: 0 OK new key created, -1 error: no memory or file not created, 1 OK key finded
111: */
112: int sess_initSession(int id, const char *csFName, ait_sess_t ** __restrict Sess);
113: /*
114: * sess_freeSession() - Free allocated memory for session item and delete session file if present name
115: *
116: * @Sess = Session item
117: * return: none
118: */
119: void sess_freeSession(ait_sess_t ** __restrict Sess);
120:
121: /*
122: * map_createSession() - MMAP Created session and allocated resources
123: *
124: * @nSeed = Seed for securing key, if =-1 must add ready for use key
125: * @nSize = Allocated shared memory size in bytes
126: * @Sess = Session item
127: * @... = If nSeed == -1 add ready for use key value
128: * return: 0 Ok successful, -1 error: not allocated resources
129: */
130: int map_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...);
131: /*
132: * map_destroySession() - MMAP free shared resources
133: *
134: * @Sess = Session item
135: * return: none
136: */
137: void map_destroySession(ait_sess_t * __restrict Sess);
138:
139: /*
140: * ipc_createSession() - IPC Created session and allocated resources
141: *
142: * @nSeed = Seed for securing key, if =-1 must add ready for use key
143: * @nSize = Allocated shared memory size in bytes
144: * @Sess = Session item
145: * @... = If nSeed == -1 add ready for use key value
146: * return: 0 Ok successful, -1 error: not allocated resources
147: */
148: int ipc_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...);
149: /*
150: * ipc_destroySession() - IPC free shared resources
151: *
152: * @Sess = Session item
153: * return: none
154: */
155: void ipc_destroySession(ait_sess_t * __restrict Sess);
156:
157: /*
158: * map_attachSession() - MMAP Attach to shared memory & return begin address
159: *
160: * @s = Session item
161: * @procMem = Custom start address (optionl) *default must be 0*
162: * return: NULL failed attach, !=NULL begin address of memory
163: */
164: void *map_attachSession(ait_sess_t * __restrict s, void *procMem);
165: /*
166: * map_detachSession() - MMAP Detach from shared memory
167: *
168: * @s = Session item
169: * return: none
170: */
171: void map_detachSession(ait_sess_t * __restrict s);
172:
173: /*
174: * ipc_attachSession() - IPC Attach to shared memory & return begin address
175: *
176: * @s = Session item
177: * @procMem = Custom start address (optionl) *default must be 0*
178: * return: NULL failed attach, !=NULL begin address of memory
179: */
180: void *ipc_attachSession(ait_sess_t * __restrict s, void *procMem);
181: /*
182: * ipc_detachSession() - IPC Detach from shared memory
183: *
184: * @s = Session item
185: * return: none
186: */
187: void ipc_detachSession(ait_sess_t * __restrict s);
188:
189: /*
190: * sess_isAttached() - Check for attached shared memory
191: *
192: * @s = Session item
193: * return: -1 null session item, 0 not attached, 1 attached memory
194: */
195: inline int sess_isAttached(ait_sess_t * __restrict s);
196:
197:
198: /*
199: * map_notSemaphore() - MMAP negative block if semaphore isn`t signaled
200: *
201: * @s = Session item
202: * return: none
203: */
204: void map_notSemaphore(ait_sess_t * __restrict s);
205: /*
206: * map_isSemaphoreOK() - MMAP Check semaphore
207: *
208: * @s = Session item
209: * return: -1 error: can`t return semaphore, 0 = false, 1 = true
210: */
211: int map_isSemaphoreOK(ait_sess_t * __restrict s);
212: /*
213: * map_incSemaphore() - MMAP unblock semaphore, increment semaphore
214: *
215: * @s = Session item
216: * return: 0 Ok, -1 error: can`t increment
217: */
218: int map_incSemaphore(ait_sess_t * __restrict s);
219: /*
220: * map_decSemaphore() - MMAP block semaphore, decrement semaphore
221: *
222: * @s = Session item
223: * return: 0 Ok, -1 error: can`t decrement
224: */
225: int map_decSemaphore(ait_sess_t * __restrict s);
226:
227: /*
228: * ipc_notSemaphore() - IPC negative block if semaphore isn`t signaled
229: *
230: * @s = Session item
231: * return: none
232: */
233: void ipc_notSemaphore(ait_sess_t * __restrict s);
234: /*
235: * ipc_isSemaphoreOK() - IPC Check semaphore
236: *
237: * @s = Session item
238: * return: -1 error: can`t return semaphore, 0 = false, 1 = true
239: */
240: int ipc_isSemaphoreOK(ait_sess_t * __restrict s);
241: /*
242: * ipc_incSemaphore() - IPC unblock semaphore, increment semaphore
243: *
244: * @s = Session item
245: * return: 0 Ok, -1 error: can`t increment
246: */
247: int ipc_incSemaphore(ait_sess_t * __restrict s);
248: /*
249: * ipc_decSemaphore() - IPC block semaphore, decrement semaphore
250: *
251: * @s = Session item
252: * return: 0 Ok, -1 error: can`t decrement
253: */
254: int ipc_decSemaphore(ait_sess_t * __restrict s);
255:
256:
257: /* --------------------------------------------------------- */
258:
259: #define ALLOC_MEMORY(sd, siz, s, ...) (assert((s)), (s)->sess.create((sd), \
260: (siz), (s), ## __VA_ARGS__))
261: #define ATTACH_MEMORY(s) (assert((s)), (s)->sess.attach((s), NULL))
262: #define DETACH_MEMORY(s) do { assert((s)); (s)->sess.detach((s)); } while(0)
263: #define FREE_MEMORY(s) do { assert((s)); (s)->sess.destroy((s)); } while(0)
264:
265: #define IS_SEMOK(s) (assert((s)), (s)->sess.isSemOK((s)))
266: #define INC_SEM(s) (assert((s)), (s)->sess.incSem((s)))
267: #define DEC_SEM(s) (assert((s)), (s)->sess.decSem((s)))
268: #define NOT_SEM(s) do { assert((s)); (s)->sess.notSem((s)); } while(0)
269:
270: /* --------------------------------------------------------- */
271:
272: /*
273: * sess_FreeValues() - Free all values from value array allocated from sess_GetValues()
274: *
275: * @ppsVals = Array strings
276: * return: none
277: */
278: inline void sess_FreeValues(char *** __restrict ppsVals);
279: /*
280: * sess_GetValues() - Get all values from session shared memory
281: *
282: * @s = Session item
283: * @ppsVals = Return array strings
284: * return: -1 error: in parameter, !=-1 count of returned strings in ppsVals
285: * (must be sess_FreeValues after use!)
286: */
287: int sess_GetValues(ait_sess_t * __restrict s, char ***ppsVals);
288: /*
289: * sess_GetValue() - Get value from session shared memory from attribute
290: *
291: * @s = Session item
292: * @csAttr = Attribute for search
293: * @psVal = Return string buffer
294: * @pnLen = Length of return string buffer,
295: // *{pnLen} input is max_size of buffer & output is really taken bytes
296: * return: 0 not found, -1 error: in parameter, >0 get position,
297: * if define item merged with IS_DEF
298: */
299: int sess_GetValue(ait_sess_t * __restrict s, const char *csAttr, char *psVal, int *pnLen);
300: /*
301: * sess_DelValue() - Delete item from session shared memory
302: *
303: * @s = Session item
304: * @csAttr = Attribute for erasing
305: * return: 0 Ok, -1 error: in parameter
306: */
307: int sess_DelValue(ait_sess_t * __restrict s, const char *csAttr);
308: /*
309: * sess_SetValue() - Set item into session shared memory or update if exists
310: *
311: * @s = Session item
312: * @csAttr = Attribute
313: * @psVal = Value
314: * return: 0 nothing, -1 error: in parameter,
315: >0 set position, if add item merged with IS_ADD and if define item merged with IS_DEF
316: */
317: int sess_SetValue(ait_sess_t * __restrict s, const char *csAttr, const char *psVal);
318:
319: /*
320: * sess_prepareSession() - Attach to shared memory and de-marshaling data
321: *
322: * @s = Session
323: * @useDirect = Use direct shared memory if !=0 or snapshot of data to array
324: * return: NULL error or no data, !=NULL array with variables,
325: * after use must free resources with sess_doneSession()
326: */
327: array_t *sess_prepareSession(ait_sess_t * __restrict s, char useDirect);
328: /*
329: * sess_doneSession() - Free resources allocated with sess_prepareSession()
330: *
331: * @s = Session
332: * @arr = Array with variables for free
333: * return: none
334: */
335: void sess_doneSession(ait_sess_t * __restrict s, array_t ** __restrict arr);
336: /*
337: * sess_commitSession() - Commit data to shared memory
338: *
339: * @s = Session
340: * @arr = Array with variables for save
341: * return -1 error or !=-1 size of stored variables into shared memory
342: */
343: int sess_commitSession(ait_sess_t * __restrict s, array_t * __restrict arr);
344:
345:
346: #endif
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to aitsess.h CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / libaitio / inc