Annotation of libaitsess/inc/aitsess.h, revision 1.6
1.2 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.6 ! misho 6: * $Id: aitsess.h,v 1.5.2.1 2012/05/23 10:53:18 misho Exp $
1.2 misho 7: *
1.3 misho 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:
1.5 misho 15: Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
1.3 misho 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: */
1.1 misho 46: #ifndef __AITSESS_H
47: #define __AITSESS_H
48:
49:
1.5 misho 50: #include <pthread.h>
1.3 misho 51: #include <assert.h>
1.1 misho 52: #include <semaphore.h>
1.4 misho 53: #include <aitio.h>
1.1 misho 54:
1.4 misho 55: #define SHARED_UNKNOWN -1
56: #define SHARED_IPC 0
57: #define SHARED_MAP 1
1.1 misho 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:
1.4 misho 66: #define MAX_ATTRIBUTE 64
1.1 misho 67: #define MAX_SEMNAME 14
68:
1.5 misho 69:
70: /* Shared memory session */
1.1 misho 71:
1.4 misho 72: typedef struct tagSess {
1.1 misho 73: key_t key;
1.4 misho 74: char type;
75: char zcpy;
76:
77: char name[BUFSIZ];
1.1 misho 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;
1.4 misho 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;
1.1 misho 101:
102:
103: // sess_GetErrno() Get error code of last operation
104: inline int sess_GetErrno();
105: // sess_GetError() Get error text of last operation
106: inline const char *sess_GetError();
1.4 misho 107: // sess_SetErr() Set error to variables for internal use!!!
108: inline void sess_SetErr(int eno, char *estr, ...);
1.5 misho 109:
110:
111: /*
1.4 misho 112: * sess_initSession() Initializing session structure, if session file not exists creating with specified tech
113: *
114: * @id = Technology using in session. SHARED_IPC IPC tech orSHARED_MAP BSD MemoryMap tech
1.1 misho 115: * @csFName = Session filename for build key and identified
1.3 misho 116: * @Sess = Session item, if =NULL allocate memory for session after use must be free!
1.1 misho 117: * return: 0 OK new key created, -1 error: no memory or file not created, 1 OK key finded
1.4 misho 118: */
119: int sess_initSession(int id, const char *csFName, ait_sess_t ** __restrict Sess);
1.1 misho 120: /*
1.4 misho 121: * sess_freeSession() Free allocated memory for session item and delete session file if present name
122: *
1.1 misho 123: * @Sess = Session item
1.4 misho 124: * return: none
125: */
126: void sess_freeSession(ait_sess_t ** __restrict Sess);
127:
1.1 misho 128: /*
129: * map_createSession() MMAP Created session and allocated resources
1.4 misho 130: *
131: * @nSeed = Seed for securing key, if =-1 must add ready for use key
132: * @nSize = Allocated shared memory size in bytes
1.1 misho 133: * @Sess = Session item
1.4 misho 134: * @... = If nSeed == -1 add ready for use key value
1.1 misho 135: * return: 0 Ok successful, -1 error: not allocated resources
1.4 misho 136: */
137: int map_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...);
1.1 misho 138: /*
139: * map_destroySession() MMAP free shared resources
1.4 misho 140: *
1.1 misho 141: * @Sess = Session item
1.4 misho 142: * return: none
143: */
144: void map_destroySession(ait_sess_t * __restrict Sess);
1.1 misho 145:
146: /*
147: * ipc_createSession() IPC Created session and allocated resources
1.4 misho 148: *
149: * @nSeed = Seed for securing key, if =-1 must add ready for use key
150: * @nSize = Allocated shared memory size in bytes
1.1 misho 151: * @Sess = Session item
1.4 misho 152: * @... = If nSeed == -1 add ready for use key value
1.1 misho 153: * return: 0 Ok successful, -1 error: not allocated resources
1.4 misho 154: */
155: int ipc_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...);
1.1 misho 156: /*
157: * ipc_destroySession() IPC free shared resources
1.4 misho 158: *
1.1 misho 159: * @Sess = Session item
1.4 misho 160: * return: none
161: */
162: void ipc_destroySession(ait_sess_t * __restrict Sess);
1.1 misho 163:
164: /*
165: * map_attachSession() MMAP Attach to shared memory & return begin address
1.4 misho 166: *
1.1 misho 167: * @s = Session item
168: * @procMem = Custom start address (optionl) *default must be 0*
169: * return: NULL failed attach, !=NULL begin address of memory
1.4 misho 170: */
171: void *map_attachSession(ait_sess_t * __restrict s, void *procMem);
1.1 misho 172: /*
173: * map_detachSession() MMAP Detach from shared memory
1.4 misho 174: *
1.1 misho 175: * @s = Session item
1.4 misho 176: * return: none
177: */
178: void map_detachSession(ait_sess_t * __restrict s);
1.1 misho 179:
180: /*
181: * ipc_attachSession() IPC Attach to shared memory & return begin address
1.4 misho 182: *
1.1 misho 183: * @s = Session item
184: * @procMem = Custom start address (optionl) *default must be 0*
185: * return: NULL failed attach, !=NULL begin address of memory
1.4 misho 186: */
187: void *ipc_attachSession(ait_sess_t * __restrict s, void *procMem);
1.1 misho 188: /*
189: * ipc_detachSession() IPC Detach from shared memory
1.4 misho 190: *
1.1 misho 191: * @s = Session item
1.4 misho 192: * return: none
193: */
194: void ipc_detachSession(ait_sess_t * __restrict s);
1.1 misho 195:
196: /*
1.4 misho 197: * sess_isAttached() Check for attached shared memory
198: *
1.2 misho 199: * @s = Session item
200: * return: -1 null session item, 0 not attached, 1 attached memory
1.4 misho 201: */
202: inline int sess_isAttached(ait_sess_t * __restrict s);
1.2 misho 203:
204:
205: /*
1.1 misho 206: * map_notSemaphore() MMAP negative block if semaphore isn`t signaled
1.4 misho 207: *
1.1 misho 208: * @s = Session item
1.4 misho 209: * return: none
210: */
211: void map_notSemaphore(ait_sess_t * __restrict s);
1.1 misho 212: /*
1.4 misho 213: * map_isSemaphoreOK() MMAP Check semaphore
214: *
1.1 misho 215: * @s = Session item
216: * return: -1 error: can`t return semaphore, 0 = false, 1 = true
1.4 misho 217: */
218: int map_isSemaphoreOK(ait_sess_t * __restrict s);
1.1 misho 219: /*
1.4 misho 220: * map_incSemaphore() MMAP unblock semaphore, increment semaphore
221: *
1.1 misho 222: * @s = Session item
223: * return: 0 Ok, -1 error: can`t increment
1.4 misho 224: */
225: int map_incSemaphore(ait_sess_t * __restrict s);
1.1 misho 226: /*
227: * map_decSemaphore() MMAP block semaphore, decrement semaphore
1.4 misho 228: *
1.1 misho 229: * @s = Session item
230: * return: 0 Ok, -1 error: can`t decrement
1.4 misho 231: */
232: int map_decSemaphore(ait_sess_t * __restrict s);
1.1 misho 233:
234: /*
235: * ipc_notSemaphore() IPC negative block if semaphore isn`t signaled
1.4 misho 236: *
1.1 misho 237: * @s = Session item
1.4 misho 238: * return: none
239: */
240: void ipc_notSemaphore(ait_sess_t * __restrict s);
1.1 misho 241: /*
1.4 misho 242: * ipc_isSemaphoreOK() IPC Check semaphore
243: *
1.1 misho 244: * @s = Session item
245: * return: -1 error: can`t return semaphore, 0 = false, 1 = true
1.4 misho 246: */
247: int ipc_isSemaphoreOK(ait_sess_t * __restrict s);
1.1 misho 248: /*
1.4 misho 249: * ipc_incSemaphore() IPC unblock semaphore, increment semaphore
250: *
1.1 misho 251: * @s = Session item
252: * return: 0 Ok, -1 error: can`t increment
1.4 misho 253: */
254: int ipc_incSemaphore(ait_sess_t * __restrict s);
1.1 misho 255: /*
256: * ipc_decSemaphore() IPC block semaphore, decrement semaphore
1.4 misho 257: *
1.1 misho 258: * @s = Session item
259: * return: 0 Ok, -1 error: can`t decrement
1.4 misho 260: */
261: int ipc_decSemaphore(ait_sess_t * __restrict s);
262:
263:
264: /* --------------------------------------------------------- */
1.1 misho 265:
1.4 misho 266: #define ALLOC_MEMORY(sd, siz, s, ...) (assert((s)), (s)->sess.create((sd), \
267: (siz), (s), ## __VA_ARGS__))
268: #define ATTACH_MEMORY(s) (assert((s)), (s)->sess.attach((s), NULL))
269: #define DETACH_MEMORY(s) do { assert((s)); (s)->sess.detach((s)); } while(0)
270: #define FREE_MEMORY(s) do { assert((s)); (s)->sess.destroy((s)); } while(0)
1.2 misho 271:
1.4 misho 272: #define IS_SEMOK(s) (assert((s)), (s)->sess.isSemOK((s)))
273: #define INC_SEM(s) (assert((s)), (s)->sess.incSem((s)))
274: #define DEC_SEM(s) (assert((s)), (s)->sess.decSem((s)))
275: #define NOT_SEM(s) do { assert((s)); (s)->sess.notSem((s)); } while(0)
1.1 misho 276:
1.4 misho 277: /* --------------------------------------------------------- */
1.1 misho 278:
279: /*
1.2 misho 280: * sess_FreeValues() Free all values from value array allocated from sess_GetValues()
1.4 misho 281: *
1.2 misho 282: * @ppsVals = Array strings
283: * return: none
1.4 misho 284: */
1.2 misho 285: inline void sess_FreeValues(char *** __restrict ppsVals);
286: /*
287: * sess_GetValues() Get all values from session shared memory
1.4 misho 288: *
1.2 misho 289: * @s = Session item
290: * @ppsVals = Return array strings
291: * return: -1 error: in parameter, !=-1 count of returned strings in ppsVals (must be free after use!)
1.4 misho 292: */
293: int sess_GetValues(ait_sess_t * __restrict s, char ***ppsVals);
1.2 misho 294: /*
1.1 misho 295: * sess_GetValue() Get value from session shared memory from attribute
1.4 misho 296: *
1.1 misho 297: * @s = Session item
298: * @csAttr = Attribute for search
299: * @psVal = Return string buffer
300: * @pnLen = Length of return string buffer,
301: // *{pnLen} input is max_size of buffer & output is really taken bytes
302: * return: 0 not found, -1 error: in parameter, >0 get position, if define item merged with IS_DEF
1.4 misho 303: */
304: int sess_GetValue(ait_sess_t * __restrict s, const char *csAttr, char *psVal, int *pnLen);
1.1 misho 305: /*
306: * sess_DelValue() Delete item from session shared memory
1.4 misho 307: *
1.1 misho 308: * @s = Session item
309: * @csAttr = Attribute for erasing
310: * return: 0 Ok, -1 error: in parameter
1.4 misho 311: */
312: int sess_DelValue(ait_sess_t * __restrict s, const char *csAttr);
1.1 misho 313: /*
314: * sess_SetValue() Set item into session shared memory or update if find it
1.4 misho 315: *
1.1 misho 316: * @s = Session item
317: * @csAttr = Attribute
318: * @psVal = Value
319: * return: 0 nothing, -1 error: in parameter,
320: >0 set position, if add item merged with IS_ADD and if define item merged with IS_DEF
1.4 misho 321: */
322: int sess_SetValue(ait_sess_t * __restrict s, const char *csAttr, const char *psVal);
323:
324: /*
325: * sess_prepareSession() Attach to shared memory and de-marshaling data
326: *
327: * @s = Session
328: * @useDirect = Use direct shared memory if !=0 or snapshot of data to array
329: * return: NULL error or no data, !=NULL array with variables,
330: * after use must free resources with sess_doneSession()
331: */
332: array_t *sess_prepareSession(ait_sess_t * __restrict s, char useDirect);
333: /*
334: * sess_doneSession() Free resources allocated with sess_prepareSession()
335: *
336: * @s = Session
337: * @arr = Array with variables for free
338: * return: none
339: */
340: void sess_doneSession(ait_sess_t * __restrict s, array_t ** __restrict arr);
341: /*
342: * sess_commitSession() Commit data to shared memory
343: *
344: * @s = Session
345: * @arr = Array with variables for save
346: * return -1 error or !=-1 size of stored variables into shared memory
347: */
348: int sess_commitSession(ait_sess_t * __restrict s, array_t * __restrict arr);
1.1 misho 349:
350:
351: #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 -] / libaitsess / inc