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