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