--- libaitsess/inc/aitsess.h 2008/08/28 13:18:30 1.1.1.1 +++ libaitsess/inc/aitsess.h 2011/09/07 16:08:41 1.3.2.2 @@ -1,10 +1,58 @@ +/************************************************************************* +* (C) 2008 AITNET ltd - Sofia/Bulgaria - +* by Michael Pounov +* +* $Author: misho $ +* $Id: aitsess.h,v 1.3.2.2 2011/09/07 16:08:41 misho Exp $ +* +************************************************************************** +The ELWIX and AITNET software is distributed under the following +terms: + +All of the documentation and software included in the ELWIX and AITNET +Releases is copyrighted by ELWIX - Sofia/Bulgaria + +Copyright 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 + by Michael Pounov . All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: +This product includes software developed by Michael Pounov +ELWIX - Embedded LightWeight unIX and its contributors. +4. Neither the name of AITNET nor the names of its contributors + may be used to endorse or promote products derived from this software + without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY AITNET AND CONTRIBUTORS ``AS IS'' AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGE. +*/ #ifndef __AITSESS_H #define __AITSESS_H +#include #include #include +#include +#define SHARED_UNKNOWN 0 #define SHARED_IPC 1 #define SHARED_MAP 2 @@ -15,13 +63,14 @@ #define ISNEW(x) (((x) & IS_ADD) == IS_ADD) #define ISDEF(x) (((x) & IS_DEF) == IS_DEF) -#define MAX_ATTRIBUTE 63 +#define MAX_ATTRIBUTE 64 #define MAX_SEMNAME 14 typedef struct _tagSess { key_t key; u_char type; + u_char zcopy; off_t eom; void *addr; off_t offset; @@ -41,17 +90,20 @@ typedef struct _tagSess { inline int sess_GetErrno(); // sess_GetError() Get error text of last operation inline const char *sess_GetError(); +// sess_SetErr() Set error to variables for internal use!!! +inline void sess_SetErr(int eno, char *estr, ...); // ------------------------------------------------------- /* * initSession() Initializing session structure, if session file not exists creating with specified tech - * @cnID = Technology using in session. SHARED_IPC IPC tech; SHARED_MAP BSD MemoryMap tech + * @pnID = Technology using in session. + SHARED_IPC IPC tech; SHARED_MAP BSD MemoryMap tech or if =NULL SHARED_IPC * @csFName = Session filename for build key and identified - * @Sess = Session item + * @Sess = Session item, if =NULL allocate memory for session after use must be free! * return: 0 OK new key created, -1 error: no memory or file not created, 1 OK key finded */ -inline int initSession(const int cnID, const char *csFName, tagSess ** __restrict Sess); +inline int initSession(int *pnID, const char *csFName, tagSess ** __restrict Sess); /* * freeSession() Free allocated memory for session item and delete session file if present name * @csFName = Session filename for delete, if NULL nothing delete @@ -118,6 +170,14 @@ inline void *ipc_attachSession(tagSess * __restrict s, inline void ipc_detachSession(tagSess * __restrict s); /* + * isAttached() Check for mapped/(attached) shared memory + * @s = Session item + * return: -1 null session item, 0 not attached, 1 attached memory +*/ +inline int isAttached(tagSess * __restrict s); + + +/* * map_notSemaphore() MMAP negative block if semaphore isn`t signaled * @s = Session item */ @@ -165,13 +225,14 @@ inline int ipc_addSemaphore(tagSess * __restrict s); */ inline int ipc_decSemaphore(tagSess * __restrict s); + // --------------------------------------------------------- // // Lazy macros for lazy programmers :-) by Michael Pounov; Optimizing work with sessions! // -#define DESTROY_SESSION(fname, s) do { \ - switch ((s)->type) { \ +#define DESTROY_SESSION(fname, s) do { assert((s)); assert((*s)); \ + switch (((*s))->type) { \ case SHARED_IPC: \ ipc_destroySession((fname), (s)); \ break; \ @@ -181,18 +242,18 @@ inline int ipc_decSemaphore(tagSess * __restrict s); } \ } while(0) -#define ATTACH_MEMORY(s, shared) do { \ +#define ATTACH_MEMORY(s) do { assert((s)); \ switch ((s)->type) { \ case SHARED_IPC: \ - (shared) = ipc_attachSession((s), 0); \ + ipc_attachSession((s), 0); \ break; \ case SHARED_MAP: \ - (shared) = map_attachSession((s), 0); \ + map_attachSession((s), 0); \ break; \ } \ } while(0) -#define DETACH_MEMORY(s) do { \ +#define DETACH_MEMORY(s) do { assert((s)); \ switch ((s)->type) { \ case SHARED_IPC: \ ipc_detachSession((s)); \ @@ -203,7 +264,7 @@ inline int ipc_decSemaphore(tagSess * __restrict s); } \ } while(0) -#define NOT_SEMAPHORE(s) do { \ +#define NOT_SEMAPHORE(s) do { assert((s)); \ switch ((s)->type) { \ case SHARED_IPC: \ ipc_notSemaphore((s)); \ @@ -214,7 +275,7 @@ inline int ipc_decSemaphore(tagSess * __restrict s); } \ } while(0) -#define IS_SEMAPHORED(s, ret) do { \ +#define IS_SEMAPHORED(s, ret) do { assert((s)); \ switch ((s)->type) { \ case SHARED_IPC: \ (ret) = ipc_isSemaphored((s)); \ @@ -227,7 +288,7 @@ inline int ipc_decSemaphore(tagSess * __restrict s); } \ } while(0) -#define ADD_SEMAPHORE(s, ret) do { \ +#define ADD_SEMAPHORE(s, ret) do { assert((s)); \ switch ((s)->type) { \ case SHARED_IPC: \ (ret) = ipc_addSemaphore((s)); \ @@ -240,7 +301,7 @@ inline int ipc_decSemaphore(tagSess * __restrict s); } \ } while(0) -#define DEC_SEMAPHORE(s, ret) do { \ +#define DEC_SEMAPHORE(s, ret) do { assert((s)); \ switch ((s)->type) { \ case SHARED_IPC: \ (ret) = ipc_decSemaphore((s)); \ @@ -256,6 +317,19 @@ inline int ipc_decSemaphore(tagSess * __restrict s); // --------------------------------------------------------- /* + * sess_FreeValues() Free all values from value array allocated from sess_GetValues() + * @ppsVals = Array strings + * return: none +*/ +inline void sess_FreeValues(char *** __restrict ppsVals); +/* + * sess_GetValues() Get all values from session shared memory + * @s = Session item + * @ppsVals = Return array strings + * return: -1 error: in parameter, !=-1 count of returned strings in ppsVals (must be free after use!) +*/ +int sess_GetValues(tagSess * __restrict s, char ***ppsVals); +/* * sess_GetValue() Get value from session shared memory from attribute * @s = Session item * @csAttr = Attribute for search @@ -281,6 +355,29 @@ int sess_DelValue(tagSess * __restrict s, const char * >0 set position, if add item merged with IS_ADD and if define item merged with IS_DEF */ int sess_SetValue(tagSess * __restrict s, const char *csAttr, const char *psVal); + +/* + * sess_prepareSession() Attach to shared memory and de-marshaling data + * @s = Session + * @useDirect = Use direct shared memory if !=0 or snapshot of data to array + * return: NULL error or no data, !=NULL array with variables, + * after use must free resources with sess_doneSession() + */ +array_t *sess_prepareSession(tagSess * __restrict s, unsigned char useDirect); +/* + * sess_doneSession() Free resources allocated with sess_prepareSession() + * @s = Session + * @arr = Array with variables for free + * return: none + */ +void sess_doneSession(tagSess * __restrict s, array_t ** __restrict arr); +/* + * sess_commitSession() Commit data to shared memory + * @s = Session + * @arr = Array with variables for save + * return -1 error or !=-1 size of stored variables into shared memory + */ +int sess_commitSession(tagSess * __restrict s, array_t * __restrict arr); #endif