rtxContext.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXCONTEXT_H_
#define _RTXCONTEXT_H_

#include "rtxsrc/rtxDList.h"
#include "rtxsrc/rtxStack.h"

#define OSRTENCBUFSIZ 1024    /* dynamic encode buffer extent size     */

/* run-time error info structures */

#define OSRTERRSTKSIZ   8       /* error stack size                     */
#define OSRTMAXERRPRM   5       /* maximum error parameters             */

typedef struct {
   const OSUTF8CHAR* module;
   OSINT32      lineno;
} OSRTErrLocn;

typedef struct {
   OSRTErrLocn  stack[OSRTERRSTKSIZ];
   OSINT16      status;
   OSUINT8      stkx;
   OSUINT8      parmcnt;
   OSUTF8CHAR*  parms[OSRTMAXERRPRM];
   OSUTF8CHAR*  elemName;
   OSBOOL       fatal;         /* true if fatal error; false is non-fatal.
                                 Non-fatal errors do not prevent an operation
                                 from continuing, but are genuine errors.
                               */
} OSRTErrInfo;

typedef struct {
   OSRTDList list;              /* list of errors */
   OSRTErrInfo reserved;        /* error info elem, used if nomem to alloc */
   OSRTDListNode reservedNode;  /* node placeholder for errInfo elem       */
} OSRTErrInfoList;

typedef struct {
   OSOCTET*     data;           /* pointer to start of data buffer      */
   OSSIZE       byteIndex;      /* byte index                           */
   OSSIZE       size;           /* current buffer size                  */
   OSINT16      bitOffset;      /* current bit offset (8 - 1)           */
   OSBOOL       dynamic;        /* is buffer dynamic?                   */
   OSBOOL       aligned;        /* is buffer byte aligned?              */
} OSRTBuffer;

typedef OSUINT32 OSRTFLAGS;

typedef struct {
   OSSIZE      byteIndex;      /* byte index                           */
   OSINT16     bitOffset;      /* current bit offset (8 - 1)           */
   OSRTFLAGS   flags;          /* flag bits                            */
} OSRTBufSave;


typedef struct {
   OSSIZE byteIndex;
   OSINT16 bitOffset;   /*8..1*/
} OSBufferIndex;


/* OSRTCTXT flag mask values : bits 32 - 16 are for common flags, bits  */
/* 15 - 0 are reserved for application specific flags                   */

#define OSDIAG          0x80000000  /* diagnostic tracing enabled       */
#define OSTRACE         0x40000000  /* tracing enabled                  */
#define OSDISSTRM       0x20000000  /* disable stream encode/decode     */
#define OSNOSTRMBACKOFF 0x08000000  /* stream mark/reset funcs is not used */
#define OS3GMOBORIG     0x04000000  /* 3G mobile-originated (net to MS) */
/*
OSCONTCLOSED: Flag indicating nothing more should be encoded to the current
container.  This is set when a variable length field whose encoding space is
determined by the container is encoded.
Used by 3GPP encoders.
*/
#define OSCONTCLOSED    0x02000000  /* 3G container closed.             */
#define OSRESERVED1     0x01000000  /* reserved                         */
#define OSBUFSYSALLOC   0x00800000  /* ctxt buf allocated using sys alloc */
#define OSLICCHECKIN    0x00400000  /* check in ifloat license on free  */

#define OSNOWHITESPACE    0x00400000  /* Turn off indentation whitesapce */

struct OSCTXT;
typedef int (*OSFreeCtxtAppInfoPtr)(struct OSCTXT* pctxt);

typedef int (*OSResetCtxtAppInfoPtr)(struct OSCTXT* pctxt);

typedef void (*OSFreeCtxtGlobalPtr)(struct OSCTXT* pctxt);

/* Alias for __cdecl modifier; if __cdecl keyword is not supported,
 * redefine it as empty macro. */

#if !defined(OSCDECL)
#if defined(_MSC_VER) || defined(__BORLANDC__)
#define OSCDECL __cdecl
#else
#define OSCDECL
#endif
#endif /* OSCDECL */

#define pLicInfo pli709

typedef struct OSCTXT {          /* run-time context block               */
   void*         pMemHeap;       /* internal message memory heap         */
   OSRTBuffer    buffer;         /* data buffer                          */
   OSRTBufSave   savedInfo;      /* saved buffer info                    */
   OSRTErrInfoList errInfo;      /* run-time error info                  */
   OSUINT32      initCode;       /* code double word to indicate init    */
   OSRTFLAGS     flags;          /* flag bits                            */
   OSOCTET       level;          /* nesting level                        */
   OSOCTET       state;          /* encode/decode process state          */
   OSOCTET       diagLevel;      /* diagnostic trace level               */
   OSOCTET       lastChar;       /* last char/byte written or read       */
#ifndef _NO_STREAM
   struct OSRTSTREAM* pStream;   /* Stream                               */
#else
   void*         pStream;        /* Stream placeholder                   */
#endif /* _NO_STREAM */
   struct OSRTPrintStream *pPrintStrm; /* Print Stream                   */
   OSRTDList elemNameStack;      /* element name stack                   */
#ifndef _OS_NOPATTERN
   OSRTDList regExpCache;        /* compiled regular expression cache    */
#endif

   OSRTStack containerEndIndexStack;

   const OSOCTET* key;           /* pointer to run-time key data         */
   OSSIZE        keylen;         /* run-time key length                  */
   OSVoidPtr     pXMLInfo;       /* XML specific info                    */
   OSVoidPtr     pEXIInfo;       /* EXI specific info                    */
   OSVoidPtr     pASN1Info;      /* ASN.1 specific info                  */
   OSVoidPtr     pLicInfo;       /* License specific info                */
   OSVoidPtr     pUserData;      /* User defined data                    */
   OSVoidPtr     pGlobalData;    /* Global constant data                 */
   struct OS3GPPSecParams* p3gppSec;  /* 3GPP Security parameters        */
   OSFreeCtxtGlobalPtr gblFreeFunc; /* Global free function              */
   OSVoidPtr     ssl;            /* SSL stack endpoint                   */
   struct OSRTDiagBitFieldList* pBitFldList; /* Bit field trace list     */
   OSUINT16      indent;         /* total # of spaces to indent.  Used by
                                    print-to-stream, JSON encoding, and possibly
                                    others. */
   OSUINT16      version;        /* Protocol version                     */
} OSCTXT;

#define OSRT_GET_FIRST_ERROR_INFO(pctxt) \
(((pctxt)->errInfo.list.head == 0) ? (OSRTErrInfo*)0 : \
(OSRTErrInfo*)((pctxt)->errInfo.list.head->data))

#define OSRT_GET_LAST_ERROR_INFO(pctxt) \
(((pctxt)->errInfo.list.tail == 0) ? (OSRTErrInfo*)0 : \
(OSRTErrInfo*)((pctxt)->errInfo.list.tail->data))

#ifndef _NO_STREAM

#define OSRTISSTREAM(pctxt) \
((pctxt)->pStream != 0 && !((pctxt)->flags & OSDISSTRM))

#define OSRTISBUFSTREAM(pctxt) \
(OSRTISSTREAM(pctxt) && (0 != ((pctxt)->pStream->flags & OSRTSTRMF_BUFFERED)))

#else /* _NO_STREAM */

#define OSRTISSTREAM(pctxt) FALSE
#define OSRTISBUFSTREAM(pctxt) FALSE

#endif /* _NO_STREAM */

#define OSRTBUFCUR(pctxt)   (pctxt)->buffer.data[(pctxt)->buffer.byteIndex]
#define OSRTBUFPTR(pctxt)   &(pctxt)->buffer.data[(pctxt)->buffer.byteIndex]
#define OSRTBUFFER(pctxt)   (pctxt)->buffer.data
#define OSRTBUFSIZE(pctxt)  (pctxt)->buffer.size

#define OSRTBUFSAVE(pctxt) { \
(pctxt)->savedInfo.byteIndex = (pctxt)->buffer.byteIndex; \
(pctxt)->savedInfo.flags = (pctxt)->flags; }

#define OSRTBUFSAVE2(pctxt,pSavedBuf) { \
(pSavedBuf)->byteIndex = (pctxt)->buffer.byteIndex; \
(pSavedBuf)->bitOffset = (pctxt)->buffer.bitOffset; \
(pSavedBuf)->flags = (pctxt)->flags; }

#define OSRTBUFRESTORE(pctxt) { \
(pctxt)->buffer.byteIndex = (pctxt)->savedInfo.byteIndex; \
(pctxt)->flags = (pctxt)->savedInfo.flags; }

#define OSRTBUFRESTORE2(pctxt,pSavedBuf) { \
(pctxt)->buffer.byteIndex = (pSavedBuf)->byteIndex; \
(pctxt)->buffer.bitOffset = (pSavedBuf)->bitOffset; \
(pctxt)->flags = (pSavedBuf)->flags; }

#define OSRTBYTEALIGNED(pctxt) \
((pctxt)->buffer.bitOffset == 8 || (pctxt)->buffer.bitOffset == 0)

/* Pointers to C Run-Time memory allocation functions */

typedef void *(OSCDECL *OSMallocFunc ) (OSSIZE size);
typedef void *(OSCDECL *OSReallocFunc) (void *ptr, OSSIZE size);
typedef void  (OSCDECL *OSFreeFunc   ) (void *ptr);

#ifdef __cplusplus
extern "C" {
#endif

#ifndef rtxInitContext
EXTERNRT int rtxInitContext (OSCTXT* pctxt);
#endif

EXTERNRT int rtxInitContextExt (OSCTXT* pctxt,
                                OSMallocFunc malloc_func,
                                OSReallocFunc realloc_func,
                                OSFreeFunc free_func);

EXTERNRT int rtxInitThreadContext (OSCTXT* pctxt, const OSCTXT* pSrcCtxt);

EXTERNRT int rtxInitContextUsingKey
(OSCTXT* pctxt, const OSOCTET* key, OSSIZE keylen);

EXTERNRT int rtxInitContextBuffer
(OSCTXT* pctxt, OSOCTET* bufaddr, OSSIZE bufsiz);

EXTERNRT int rtxCtxtSetBufPtr
(OSCTXT* pctxt, OSOCTET* bufaddr, OSSIZE bufsiz);

#define rtxCtxtGetMsgPtr(pctxt) (pctxt)->buffer.data

#define rtxCtxtGetMsgLen(pctxt) (pctxt)->buffer.byteIndex

EXTERNRT OSSIZE rtxCtxtGetBitOffset (OSCTXT* pctxt);

EXTERNRT int rtxCtxtSetBitOffset (OSCTXT* pctxt, OSSIZE offset);

EXTERNRT OSSIZE rtxCtxtGetIOByteCount (OSCTXT* pctxt);

EXTERNRT int rtxCheckContext (OSCTXT* pctxt);

EXTERNRT void rtxFreeContext (OSCTXT* pctxt);

EXTERNRT void rtxCopyContext (OSCTXT* pdest, OSCTXT* psrc);

EXTERNRT void rtxCtxtSetFlag (OSCTXT* pctxt, OSUINT32 mask);

EXTERNRT void rtxCtxtClearFlag (OSCTXT* pctxt, OSUINT32 mask);

#define rtxCtxtTestFlag(pctxt,mask) (((pctxt)->flags & mask) != 0)

EXTERNRT int rtxCtxtPushArrayElemName
(OSCTXT* pctxt, const OSUTF8CHAR* elemName, OSSIZE idx);

EXTERNRT int rtxCtxtPushElemName (OSCTXT* pctxt, const OSUTF8CHAR* elemName);

EXTERNRT int rtxCtxtPushElemNameCopy
(OSCTXT* pctxt, const OSUTF8CHAR* elemName);

EXTERNRT int rtxCtxtPushTypeName (OSCTXT* pctxt, const OSUTF8CHAR* typeName);

EXTERNRT OSBOOL rtxCtxtPopArrayElemName (OSCTXT* pctxt);

EXTERNRT const OSUTF8CHAR* rtxCtxtPopElemName (OSCTXT* pctxt);

EXTERNRT void rtxCtxtPopElemNameCopy (OSCTXT* pctxt);

EXTERNRT const OSUTF8CHAR* rtxCtxtPopTypeName (OSCTXT* pctxt);

#define rtxCtxtPeekElemName(pctxt) \
(((pctxt)->elemNameStack.count > 0) ? \
 (const OSUTF8CHAR*)(pctxt)->elemNameStack.tail->data : (const OSUTF8CHAR*)0)


EXTERNRT OSBOOL rtxCtxtContainerHasRemBits(OSCTXT* pctxt);

EXTERNRT OSBOOL rtxCtxtContainerEnd(OSCTXT* pctxt);

EXTERNRT OSSIZE rtxCtxtGetContainerRemBits(OSCTXT* pctxt);

EXTERNRT int rtxCtxtPushContainerBytes(OSCTXT* pctxt, OSSIZE bytes);

EXTERNRT int rtxCtxtPushContainerBits(OSCTXT* pctxt, OSSIZE bits);


EXTERNRT void rtxCtxtPopContainer(OSCTXT* pctxt);

EXTERNRT void rtxCtxtPopAllContainers(OSCTXT* pctxt);

EXTERNRT int rtxPreInitContext (OSCTXT* pctxt);
EXTERNRT void rtxCtxtSetMemHeap (OSCTXT* pctxt, OSCTXT* pSrcCtxt);

EXTERNRT void rtxMemHeapSetFlags (OSCTXT* pctxt, OSUINT32 flags);

EXTERNRT void  rtxMemHeapClearFlags (OSCTXT* pctxt, OSUINT32 flags);

#define rtxByteAlign(pctxt) \
if ((pctxt)->buffer.bitOffset != 8) { \
(pctxt)->buffer.byteIndex++; (pctxt)->buffer.bitOffset = 8; }

EXTERNRT int rtxCtxtMarkBitPos (OSCTXT* pctxt, OSSIZE* ppos);

EXTERNRT int rtxCtxtResetToBitPos (OSCTXT* pctxt, OSSIZE pos);

EXTERNRT int rtxMarkPos (OSCTXT* pctxt, OSSIZE* ppos);

EXTERNRT int rtxResetToPos (OSCTXT* pctxt, OSSIZE pos);

EXTERNRT const char* rtxCtxtGetExpDateStr
(OSCTXT* pctxt, char* buf, OSSIZE bufsiz);

#define rtxCtxtSetProtocolVersion(pctxt,value) (pctxt)->version = value

EXTERNRT void rtxLicenseClose(void);


#define rtxMarkBitPos(pctxt,ppos,pbitoff) \
(*(pbitoff) = (OSUINT8) (pctxt)->buffer.bitOffset, rtxMarkPos (pctxt, ppos))

#define rtxResetToBitPos(pctxt,pos,bitoff) \
((pctxt)->buffer.bitOffset = (OSUINT8) bitoff, rtxResetToPos (pctxt, pos))

#ifndef _COMPACT
#define RTXCTXTPUSHARRAYELEMNAME(pctxt,name,idx)   \
rtxCtxtPushArrayElemName(pctxt,OSUTF8(name),idx)

#define RTXCTXTPOPARRAYELEMNAME(pctxt) \
rtxCtxtPopArrayElemName(pctxt)

#define RTXCTXTPUSHELEMNAME(pctxt,name) \
rtxCtxtPushElemName(pctxt,OSUTF8(name))

#define RTXCTXTPOPELEMNAME(pctxt) \
rtxCtxtPopElemName(pctxt)

#define RTXCTXTPUSHTYPENAME(pctxt,name) \
rtxCtxtPushTypeName(pctxt,OSUTF8(name))

#define RTXCTXTPOPTYPENAME(pctxt) \
rtxCtxtPopTypeName(pctxt)
#else
#define RTXCTXTPUSHARRAYELEMNAME(pctxt,name,idx)
#define RTXCTXTPOPARRAYELEMNAME(pctxt)
#define RTXCTXTPUSHELEMNAME(pctxt,name)
#define RTXCTXTPOPELEMNAME(pctxt)
#define RTXCTXTPUSHTYPENAME(pctxt,name)
#define RTXCTXTPOPTYPENAME(pctxt)
#endif

#ifdef __cplusplus
}
#endif

#endif