Annotation of libaitsess/inc/aitsess.h, revision 1.4.2.1
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.2.1 ! misho 6: * $Id: aitsess.h,v 1.4 2012/02/10 23:38:30 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:
1.4.2.1 ! misho 69: /* Memory pool */
! 70:
! 71: #define MEM_BUCKETS 28 /* 32 bits - 4 bits = 28 items in bucket array */
! 72:
! 73: struct tagAlloc {
! 74: char alloc_name[MAX_ATTRIBUTE];
! 75: volatile unsigned int alloc_flags;
! 76:
! 77: unsigned int *alloc_mem;
! 78:
! 79: TAILQ_ENTRY(tagAlloc) alloc_node;
! 80: };
! 81: typedef TAILQ_HEAD(, tagAlloc) mpool_bucket_t;
! 82:
! 83: typedef struct _tagMPool {
! 84: pthread_mutex_t pool_mtx;
! 85:
! 86: struct {
! 87: unsigned long alloc;
! 88: unsigned long free;
! 89: unsigned long cache;
! 90: } pool_calls;
! 91: struct {
! 92: unsigned long alloc;
! 93: unsigned long free;
! 94: unsigned long cache;
! 95: } pool_bytes;
! 96: struct {
! 97: unsigned long max;
! 98: unsigned long curr;
! 99: unsigned long inact;
! 100: } pool_quota;
! 101:
! 102: /* pool buckets */
! 103: mpool_bucket_t pool_active[MEM_BUCKETS];
! 104: mpool_bucket_t pool_inactive[MEM_BUCKETS];
! 105: } mpool_t;
! 106: #define mpool_lock(x) (assert((x)), pthread_mutex_lock(&(x)->pool_mtx))
! 107: #define mpool_unlock(x) (assert((x)), pthread_mutex_unlock(&(x)->pool_mtx))
! 108:
! 109: /* Shared memory session */
1.1 misho 110:
1.4 misho 111: typedef struct tagSess {
1.1 misho 112: key_t key;
1.4 misho 113: char type;
114: char zcpy;
115:
116: char name[BUFSIZ];
1.1 misho 117: off_t eom;
118: void *addr;
119: off_t offset;
120: union {
121: int shmid;
122: int fd;
123: } mem;
124: union {
125: int semid;
126: sem_t *sid;
127: } id;
1.4 misho 128:
129: struct {
130: int (*create)(int, long, void *, ...);
131: void (*destroy)(void *);
132: void *(*attach)(void *, void *);
133: void (*detach)(void *);
134: void (*notSem)(void *);
135: int (*isSemOK)(void *);
136: int (*incSem)(void *);
137: int (*decSem)(void *);
138: } sess;
139: } ait_sess_t;
1.1 misho 140:
141:
142: // -------------------------------------------------------
143: // sess_GetErrno() Get error code of last operation
144: inline int sess_GetErrno();
145: // sess_GetError() Get error text of last operation
146: inline const char *sess_GetError();
1.4 misho 147: // sess_SetErr() Set error to variables for internal use!!!
148: inline void sess_SetErr(int eno, char *estr, ...);
1.1 misho 149: // -------------------------------------------------------
150:
151:
152: /*
1.4.2.1 ! misho 153: * mpool_init() - Init memory pool
! 154: *
! 155: * return: =NULL error or !=NULL new allocated pool
! 156: */
! 157: mpool_t *mpool_init(void);
! 158: /*
! 159: * mpool_destroy() - Destroy memory pool
! 160: *
! 161: * @mp = Memory pool
! 162: * return: none
! 163: */
! 164: void mpool_destroy(mpool_t ** __restrict mp);
! 165: /*
! 166: * mpool_malloc() - Memory allocation
! 167: *
! 168: * @mp = Memory pool
! 169: * @size = Size
! 170: * @memname = Optional memory block name
! 171: * return: NULL error or !=NULL ok allocated memory
! 172: */
! 173: void *mpool_malloc(mpool_t * __restrict mp, unsigned int size, const char *memname);
! 174: /*
! 175: * mpool_free() Free allocated memory with mpool_alloc()
! 176: *
! 177: * @mp = Memory pool
! 178: * @data = Allocated memory data
! 179: * @purge = if !=0 force release memory block
! 180: * return: <0 error or 0 ok released memory block
! 181: */
! 182: int mpool_free(mpool_t * __restrict mp, void * __restrict data, int purge);
! 183: /*
! 184: * mpool_free2() Free allocated memory with mpool_alloc() by size and memory name
! 185: *
! 186: * @mp = Memory pool
! 187: * @size = Allocated memory data size
! 188: * @memname = Memory name
! 189: * @purge = if !=0 force release memory block
! 190: * return: <0 error or 0 ok released memory block
! 191: */
! 192: int mpool_free2(mpool_t * __restrict mp, u_int size, const char *memname, int purge);
! 193: /*
! 194: * mpool_getmembynam() Find allocated memory block by size and memory name
! 195: *
! 196: * @mp = Memory pool
! 197: * @size = Memory size
! 198: * @memname = Memory name
! 199: * return: NULL error or not found and !=NULL allocated memory
! 200: */
! 201: inline struct tagAlloc *mpool_getmembynam(mpool_t * __restrict mp, u_int size, const char *memname);
! 202:
! 203:
! 204: /*
1.4 misho 205: * sess_initSession() Initializing session structure, if session file not exists creating with specified tech
206: *
207: * @id = Technology using in session. SHARED_IPC IPC tech orSHARED_MAP BSD MemoryMap tech
1.1 misho 208: * @csFName = Session filename for build key and identified
1.3 misho 209: * @Sess = Session item, if =NULL allocate memory for session after use must be free!
1.1 misho 210: * return: 0 OK new key created, -1 error: no memory or file not created, 1 OK key finded
1.4 misho 211: */
212: int sess_initSession(int id, const char *csFName, ait_sess_t ** __restrict Sess);
1.1 misho 213: /*
1.4 misho 214: * sess_freeSession() Free allocated memory for session item and delete session file if present name
215: *
1.1 misho 216: * @Sess = Session item
1.4 misho 217: * return: none
218: */
219: void sess_freeSession(ait_sess_t ** __restrict Sess);
220:
1.1 misho 221:
222: /*
223: * map_createSession() MMAP Created session and allocated resources
1.4 misho 224: *
225: * @nSeed = Seed for securing key, if =-1 must add ready for use key
226: * @nSize = Allocated shared memory size in bytes
1.1 misho 227: * @Sess = Session item
1.4 misho 228: * @... = If nSeed == -1 add ready for use key value
1.1 misho 229: * return: 0 Ok successful, -1 error: not allocated resources
1.4 misho 230: */
231: int map_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...);
1.1 misho 232: /*
233: * map_destroySession() MMAP free shared resources
1.4 misho 234: *
1.1 misho 235: * @Sess = Session item
1.4 misho 236: * return: none
237: */
238: void map_destroySession(ait_sess_t * __restrict Sess);
1.1 misho 239:
240: /*
241: * ipc_createSession() IPC Created session and allocated resources
1.4 misho 242: *
243: * @nSeed = Seed for securing key, if =-1 must add ready for use key
244: * @nSize = Allocated shared memory size in bytes
1.1 misho 245: * @Sess = Session item
1.4 misho 246: * @... = If nSeed == -1 add ready for use key value
1.1 misho 247: * return: 0 Ok successful, -1 error: not allocated resources
1.4 misho 248: */
249: int ipc_createSession(int nSeed, long nSize, ait_sess_t * __restrict Sess, ...);
1.1 misho 250: /*
251: * ipc_destroySession() IPC free shared resources
1.4 misho 252: *
1.1 misho 253: * @Sess = Session item
1.4 misho 254: * return: none
255: */
256: void ipc_destroySession(ait_sess_t * __restrict Sess);
1.1 misho 257:
258: /*
259: * map_attachSession() MMAP Attach to shared memory & return begin address
1.4 misho 260: *
1.1 misho 261: * @s = Session item
262: * @procMem = Custom start address (optionl) *default must be 0*
263: * return: NULL failed attach, !=NULL begin address of memory
1.4 misho 264: */
265: void *map_attachSession(ait_sess_t * __restrict s, void *procMem);
1.1 misho 266: /*
267: * map_detachSession() MMAP Detach from shared memory
1.4 misho 268: *
1.1 misho 269: * @s = Session item
1.4 misho 270: * return: none
271: */
272: void map_detachSession(ait_sess_t * __restrict s);
1.1 misho 273:
274: /*
275: * ipc_attachSession() IPC Attach to shared memory & return begin address
1.4 misho 276: *
1.1 misho 277: * @s = Session item
278: * @procMem = Custom start address (optionl) *default must be 0*
279: * return: NULL failed attach, !=NULL begin address of memory
1.4 misho 280: */
281: void *ipc_attachSession(ait_sess_t * __restrict s, void *procMem);
1.1 misho 282: /*
283: * ipc_detachSession() IPC Detach from shared memory
1.4 misho 284: *
1.1 misho 285: * @s = Session item
1.4 misho 286: * return: none
287: */
288: void ipc_detachSession(ait_sess_t * __restrict s);
1.1 misho 289:
290: /*
1.4 misho 291: * sess_isAttached() Check for attached shared memory
292: *
1.2 misho 293: * @s = Session item
294: * return: -1 null session item, 0 not attached, 1 attached memory
1.4 misho 295: */
296: inline int sess_isAttached(ait_sess_t * __restrict s);
1.2 misho 297:
298:
299: /*
1.1 misho 300: * map_notSemaphore() MMAP negative block if semaphore isn`t signaled
1.4 misho 301: *
1.1 misho 302: * @s = Session item
1.4 misho 303: * return: none
304: */
305: void map_notSemaphore(ait_sess_t * __restrict s);
1.1 misho 306: /*
1.4 misho 307: * map_isSemaphoreOK() MMAP Check semaphore
308: *
1.1 misho 309: * @s = Session item
310: * return: -1 error: can`t return semaphore, 0 = false, 1 = true
1.4 misho 311: */
312: int map_isSemaphoreOK(ait_sess_t * __restrict s);
1.1 misho 313: /*
1.4 misho 314: * map_incSemaphore() MMAP unblock semaphore, increment semaphore
315: *
1.1 misho 316: * @s = Session item
317: * return: 0 Ok, -1 error: can`t increment
1.4 misho 318: */
319: int map_incSemaphore(ait_sess_t * __restrict s);
1.1 misho 320: /*
321: * map_decSemaphore() MMAP block semaphore, decrement semaphore
1.4 misho 322: *
1.1 misho 323: * @s = Session item
324: * return: 0 Ok, -1 error: can`t decrement
1.4 misho 325: */
326: int map_decSemaphore(ait_sess_t * __restrict s);
1.1 misho 327:
328: /*
329: * ipc_notSemaphore() IPC negative block if semaphore isn`t signaled
1.4 misho 330: *
1.1 misho 331: * @s = Session item
1.4 misho 332: * return: none
333: */
334: void ipc_notSemaphore(ait_sess_t * __restrict s);
1.1 misho 335: /*
1.4 misho 336: * ipc_isSemaphoreOK() IPC Check semaphore
337: *
1.1 misho 338: * @s = Session item
339: * return: -1 error: can`t return semaphore, 0 = false, 1 = true
1.4 misho 340: */
341: int ipc_isSemaphoreOK(ait_sess_t * __restrict s);
1.1 misho 342: /*
1.4 misho 343: * ipc_incSemaphore() IPC unblock semaphore, increment semaphore
344: *
1.1 misho 345: * @s = Session item
346: * return: 0 Ok, -1 error: can`t increment
1.4 misho 347: */
348: int ipc_incSemaphore(ait_sess_t * __restrict s);
1.1 misho 349: /*
350: * ipc_decSemaphore() IPC block semaphore, decrement semaphore
1.4 misho 351: *
1.1 misho 352: * @s = Session item
353: * return: 0 Ok, -1 error: can`t decrement
1.4 misho 354: */
355: int ipc_decSemaphore(ait_sess_t * __restrict s);
356:
357:
358: /* --------------------------------------------------------- */
1.1 misho 359:
1.4 misho 360: #define ALLOC_MEMORY(sd, siz, s, ...) (assert((s)), (s)->sess.create((sd), \
361: (siz), (s), ## __VA_ARGS__))
362: #define ATTACH_MEMORY(s) (assert((s)), (s)->sess.attach((s), NULL))
363: #define DETACH_MEMORY(s) do { assert((s)); (s)->sess.detach((s)); } while(0)
364: #define FREE_MEMORY(s) do { assert((s)); (s)->sess.destroy((s)); } while(0)
1.2 misho 365:
1.4 misho 366: #define IS_SEMOK(s) (assert((s)), (s)->sess.isSemOK((s)))
367: #define INC_SEM(s) (assert((s)), (s)->sess.incSem((s)))
368: #define DEC_SEM(s) (assert((s)), (s)->sess.decSem((s)))
369: #define NOT_SEM(s) do { assert((s)); (s)->sess.notSem((s)); } while(0)
1.1 misho 370:
1.4 misho 371: /* --------------------------------------------------------- */
1.1 misho 372:
373: /*
1.2 misho 374: * sess_FreeValues() Free all values from value array allocated from sess_GetValues()
1.4 misho 375: *
1.2 misho 376: * @ppsVals = Array strings
377: * return: none
1.4 misho 378: */
1.2 misho 379: inline void sess_FreeValues(char *** __restrict ppsVals);
380: /*
381: * sess_GetValues() Get all values from session shared memory
1.4 misho 382: *
1.2 misho 383: * @s = Session item
384: * @ppsVals = Return array strings
385: * return: -1 error: in parameter, !=-1 count of returned strings in ppsVals (must be free after use!)
1.4 misho 386: */
387: int sess_GetValues(ait_sess_t * __restrict s, char ***ppsVals);
1.2 misho 388: /*
1.1 misho 389: * sess_GetValue() Get value from session shared memory from attribute
1.4 misho 390: *
1.1 misho 391: * @s = Session item
392: * @csAttr = Attribute for search
393: * @psVal = Return string buffer
394: * @pnLen = Length of return string buffer,
395: // *{pnLen} input is max_size of buffer & output is really taken bytes
396: * return: 0 not found, -1 error: in parameter, >0 get position, if define item merged with IS_DEF
1.4 misho 397: */
398: int sess_GetValue(ait_sess_t * __restrict s, const char *csAttr, char *psVal, int *pnLen);
1.1 misho 399: /*
400: * sess_DelValue() Delete item from session shared memory
1.4 misho 401: *
1.1 misho 402: * @s = Session item
403: * @csAttr = Attribute for erasing
404: * return: 0 Ok, -1 error: in parameter
1.4 misho 405: */
406: int sess_DelValue(ait_sess_t * __restrict s, const char *csAttr);
1.1 misho 407: /*
408: * sess_SetValue() Set item into session shared memory or update if find it
1.4 misho 409: *
1.1 misho 410: * @s = Session item
411: * @csAttr = Attribute
412: * @psVal = Value
413: * return: 0 nothing, -1 error: in parameter,
414: >0 set position, if add item merged with IS_ADD and if define item merged with IS_DEF
1.4 misho 415: */
416: int sess_SetValue(ait_sess_t * __restrict s, const char *csAttr, const char *psVal);
417:
418: /*
419: * sess_prepareSession() Attach to shared memory and de-marshaling data
420: *
421: * @s = Session
422: * @useDirect = Use direct shared memory if !=0 or snapshot of data to array
423: * return: NULL error or no data, !=NULL array with variables,
424: * after use must free resources with sess_doneSession()
425: */
426: array_t *sess_prepareSession(ait_sess_t * __restrict s, char useDirect);
427: /*
428: * sess_doneSession() Free resources allocated with sess_prepareSession()
429: *
430: * @s = Session
431: * @arr = Array with variables for free
432: * return: none
433: */
434: void sess_doneSession(ait_sess_t * __restrict s, array_t ** __restrict arr);
435: /*
436: * sess_commitSession() Commit data to shared memory
437: *
438: * @s = Session
439: * @arr = Array with variables for save
440: * return -1 error or !=-1 size of stored variables into shared memory
441: */
442: int sess_commitSession(ait_sess_t * __restrict s, array_t * __restrict arr);
1.1 misho 443:
444:
445: #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