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