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