nmLibInternal.c File Reference

Internal intra-library definitions. More...

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <libgen.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/netmsgs.h"
#include "nmLibInternal.h"

Go to the source code of this file.

Macros
#define	_NMSET_VAL(_this, pv, T)   (T)(_this.m_bits & NMBITS_HAS_CONST? (T)(_this.m_valConst): *((T*)pv))
	Set field value. More...
#define	_NMCHK_MIN(fname, _this, v, T, fmt)
	Check value is ≥ minimum. More...
#define	_NMCHK_MAX(fname, _this, v, T, fmt)
	Check value is ≤ maximum. More...

Functions
int	nmSetU8 (const NMFieldDef_T *pFieldDef, void *pValIn, byte_t *pValOut)
	Helper function to set an unsigned 8-bit integer. More...
int	nmSetS8 (const NMFieldDef_T *pFieldDef, void *pValIn, signed char *pValOut)
	Helper function to set a signed 8-bit integer. More...
int	nmSetU16 (const NMFieldDef_T *pFieldDef, void *pValIn, ushort_t *pValOut)
	Helper function to set an unsigned 16-bit integer. More...
int	nmSetS16 (const NMFieldDef_T *pFieldDef, void *pValIn, short *pValOut)
	Helper function to set a signed 16-bit integer. More...
int	nmSetU32 (const NMFieldDef_T *pFieldDef, void *pValIn, uint_t *pValOut)
	Helper function to set an unsigned 32-bit integer. More...
int	nmSetS32 (const NMFieldDef_T *pFieldDef, void *pValIn, int *pValOut)
	Helper function to set a signed 32-bit integer. More...
int	nmSetU64 (const NMFieldDef_T *pFieldDef, void *pValIn, ulonglong_t *pValOut)
	Helper function to set an unsigned 64-bit integer. More...
int	nmSetS64 (const NMFieldDef_T *pFieldDef, void *pValIn, long long *pValOut)
	Helper function to set a signed 64-bit integer. More...
int	nmSetF32 (const NMFieldDef_T *pFieldDef, void *pValIn, float *pValOut)
	Helper function to set a 32-bit floating point number. More...
int	nmSetF64 (const NMFieldDef_T *pFieldDef, void *pValIn, double *pValOut)
	Helper function to set a 64-bit floating point number. More...
void	nmTraceField (const NMFieldDef_T *pFieldDef, byte_t buf[], size_t uCount, uint_t uDepth, const char *sFmt,...)
	Trace packing/unpacking of a message field. More...

Variables
const int	NMHashOffset = (int)NMFTypeBool
	hash base offset
const int	NMHashNoIdx = 0xff
	hash no index value
const byte_t	NMHashTbl []
const size_t	NMHashNumEntries = arraysize(NMHashTbl)

Detailed Description

Internal intra-library definitions.

LastChangedDate

2010-02-12 14:27:57 -0700 (Fri, 12 Feb 2010)

Rev

247

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2009-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file nmLibInternal.c.

Macro Definition Documentation

#define _NMCHK_MAX	(		fname,
			_this,
			v,
			T,
			fmt
	)

Value:

do \
  { \
    if( _this.m_bits & NMBITS_HAS_MAX ) \
    { \
      if( (v) > (T)(_this.m_valMax) ) \
      { \
        NMLIB_RAISE_ERROR(NM_ECODE_RANGE, "%s val=" fmt " > max=" fmt, \
            fname, v, (T)(_this.m_valMax)); \
      } \
    } \
  } while(0)

Check value is ≤ maximum.

Note

Out-of-range violation results is calling function return.

Parameters

fname	This field's string name.
_this	This field's specific information.
v	Field value.
T	Field C type.
fmt	Format string on error.

Definition at line 112 of file nmLibInternal.c.

Referenced by nmSetF32(), nmSetF64(), nmSetS16(), nmSetS32(), nmSetS64(), nmSetS8(), nmSetU16(), nmSetU32(), nmSetU64(), and nmSetU8().

#define _NMCHK_MIN	(		fname,
			_this,
			v,
			T,
			fmt
	)

Value:

do \
  { \
    if( _this.m_bits & NMBITS_HAS_MIN ) \
    { \
      if( (v) < (T)(_this.m_valMin) ) \
      { \
        NMLIB_RAISE_ERROR(NM_ECODE_RANGE, "%s val=" fmt " < min=" fmt, \
            fname, v, (T)(_this.m_valMin)); \
      } \
    } \
  } while(0)

Check value is ≥ minimum.

Note

Out-of-range violation results is calling function return.

Parameters

fname	This field's string name.
_this	This field's specific information.
v	Field value.
T	Field C type.
fmt	Format string on error.

Definition at line 88 of file nmLibInternal.c.

Referenced by nmSetF32(), nmSetF64(), nmSetS16(), nmSetS32(), nmSetS64(), nmSetS8(), nmSetU16(), nmSetU32(), nmSetU64(), and nmSetU8().

#define _NMSET_VAL	(		_this,
			pv,
			T
	)		(T)(_this.m_bits & NMBITS_HAS_CONST? (T)(_this.m_valConst): *((T*)pv))

Set field value.

Parameters

_this	This field's specific information.
pv	Pointer to field value.
T	Field C type.

Definition at line 74 of file nmLibInternal.c.

Referenced by nmSetF32(), nmSetF64(), nmSetS16(), nmSetS32(), nmSetS64(), nmSetS8(), nmSetU16(), nmSetU32(), nmSetU64(), and nmSetU8().

Function Documentation

int nmSetF32	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		float *	pValOut
	)

Helper function to set a 32-bit floating point number.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 443 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, NMFieldThis_T::m_f32, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, and NM_OK.

Referenced by nmPackFlatF32(), and nmPackITVF32().

{
  float val;

  // set value, override if constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_f32, pValIn, float);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_f32, val, float, "%f");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_f32, val, float, "%f");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetF64	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		double *	pValOut
	)

Helper function to set a 64-bit floating point number.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 474 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, NMFieldThis_T::m_f64, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, and NM_OK.

Referenced by nmPackFlatF64(), and nmPackITVF64().

{
  double  val;

  // set value, override if constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_f64, pValIn, double);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_f64, val, double, "%f");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_f64, val, double, "%f");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetS16	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		short *	pValOut
	)

Helper function to set a signed 16-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 282 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u16, and NM_OK.

Referenced by nmPackFlatS16(), and nmPackITVS16().

{
  short       val;

  // set value, override if is constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u16, pValIn, short);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u16, val, short, "%hd");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u16, val, short, "%hd");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetS32	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		int *	pValOut
	)

Helper function to set a signed 32-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 344 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u32, and NM_OK.

Referenced by nmPackFlatS32(), and nmPackITVS32().

{
  int         val;

  // set value, override if constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u32, pValIn, int);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u32, val, int, "%d");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u32, val, int, "%d");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetS64	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		long long *	pValOut
	)

Helper function to set a signed 64-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 410 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u64, and NM_OK.

Referenced by nmPackFlatS64(), and nmPackITVS64().

{
  long long   val;

  // set value, override if constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u64, pValIn, long long);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u64,
      val, long long, "%hhu");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u64,
      val, long long, "%hhu");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetS8	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		signed char *	pValOut
	)

Helper function to set a signed 8-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 216 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u8, and NM_OK.

Referenced by nmPackFlatS8(), and nmPackITVS8().

{
  signed char val;

  // set value, override if is constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u8, pValIn, signed char);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u8,
      val, signed char, "%hhd");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u8,
      val, signed char, "%hhd");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetU16	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		ushort_t *	pValOut
	)

Helper function to set an unsigned 16-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 249 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u16, and NM_OK.

Referenced by nmPackFlatU16(), and nmPackITVU16().

{
  ushort_t    val;

  // set value, override if is constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u16, pValIn, ushort_t);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u16,
      val, ushort_t, "%hu");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u16,
      val, ushort_t, "%hu");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetU32	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		uint_t *	pValOut
	)

Helper function to set an unsigned 32-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 313 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u32, and NM_OK.

Referenced by nmPackFlatU32(), and nmPackITVU32().

{
  uint_t      val;

  // set value, override if is constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u32, pValIn, uint_t);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u32, val, uint_t, "%u");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u32, val, uint_t, "%u");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetU64	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		ulonglong_t *	pValOut
	)

Helper function to set an unsigned 64-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 375 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u64, and NM_OK.

Referenced by nmPackFlatU64(), and nmPackITVU64().

{
  ulonglong_t  val;

  // set value, override if constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u64, pValIn, ulonglong_t);

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u64,
      val, ulonglong_t, "%llu");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u64,
      val, ulonglong_t, "%llu");

  // set
  *pValOut = val;

  return NM_OK;
}

int nmSetU8	(	const NMFieldDef_T *	pFieldDef,
		void *	pValIn,
		byte_t *	pValOut
	)

Helper function to set an unsigned 8-bit integer.

Parameters

	pFieldDef	Pointer to message field definition.
[in]	pValIn	Pointer to field value.
[out]	pValOut	Pointer to constrained, assigned field value.

Returns

On success, returns NM_OK.
On error, the appropriate negated netmsgs error code ( < 0) is returned.

Definition at line 182 of file nmLibInternal.c.

References _NMCHK_MAX, _NMCHK_MIN, _NMSET_VAL, _nm_field_def_struct::m_sFName, _nm_field_def_struct::m_this, NMFieldThis_T::m_u8, and NM_OK.

Referenced by nmPackFlatU8(), and nmPackITVU8().

{
  byte_t      val;

  // set value, override if is constant value
  val = _NMSET_VAL(pFieldDef->m_this.m_u8, pValIn, byte_t);
  //val = (pFieldDef->m_this.m_u8.m_bits & NMBITS_HAS_CONST? 
  //    (byte_t)(pFieldDef->m_this.m_u8.m_valConst):
  //    *((byte_t*)pValIn))

  // check against minimum limits
  _NMCHK_MIN(pFieldDef->m_sFName, pFieldDef->m_this.m_u8, val, byte_t, "%hhu");

  // check against maximum limits
  _NMCHK_MAX(pFieldDef->m_sFName, pFieldDef->m_this.m_u8, val, byte_t, "%hhu");

  // set
  *pValOut = val;

  return NM_OK;
}

void nmTraceField	(	const NMFieldDef_T *	pFieldDef,
		byte_t	buf[],
		size_t	uCount,
		uint_t	uDepth,
		const char *	sFmt,
			...
	)

Trace packing/unpacking of a message field.

Parameters

pFieldDef	Pointer to field definition.
buf	Packed/unpacked buffer.
uCount	Number of bytes in buffer to trace.
uDepth	Depth of field in recursive definition.
sFmt	Field representation format string.
...	Field representation variable arguments.

Definition at line 504 of file nmLibInternal.c.

References _nm_field_def_struct::m_eFId, _nm_field_def_struct::m_eFType, _nm_field_def_struct::m_sFName, NMFID_NONE, and nmPrintBuf().

{
  va_list ap;
  char    bufRepr[256];
  uint_t  uIndent;
  int     n;

  va_start(ap, sFmt);
  vsnprintf(bufRepr, sizeof(bufRepr), sFmt, ap);
  va_end(ap);
  bufRepr[sizeof(bufRepr)-1] = 0;

  uIndent = uDepth * 2;

  if( pFieldDef != NULL )
  {
    // "normal"
    if( pFieldDef->m_eFId != NMFID_NONE )
    {
      n = fprintf(stderr, "%*s%c:%s(%u) = %s: ",
          uIndent, "", pFieldDef->m_eFType, pFieldDef->m_sFName,
          pFieldDef->m_eFId, bufRepr);
    }
    // vector items have no field ids
    else
    {
      n = fprintf(stderr, "%*s[%c]: = %s: ",
          uIndent, "", pFieldDef->m_eFType, bufRepr);
    }
  }
  else
  {
    n = fprintf(stderr, "%*s%s: ", uDepth*2, "", bufRepr);
  }

  if( uCount > 0 )
  {
    if( n > 36 )
    {
      fprintf(stderr, "\n");
      n = 0;
    }

    fprintf(stderr, "%*s", 38-n, "");
    nmPrintBuf(stderr, NULL, buf, uCount, 8, 38);
  }
  fprintf(stderr, "\n");
}

Variable Documentation

const size_t NMHashNumEntries = arraysize(NMHashTbl)

number of hash entries

Definition at line 168 of file nmLibInternal.c.

Referenced by NMHashFType().

const byte_t NMHashTbl[]

Initial value:

=
{
  
            0,    0xff, 0xff, 1,    0xff, 0xff, 0xff, 2,

  
            0xff, 3,    4,    0xff, 0xff, 0xff, 0xff, 0xff,

  
            0xff, 5,    6,    0xff, 0xff, 0xff, 0xff, 0xff,

  
            0xff, 0xff, 0xff, 0xff, 7,    0xff, 0xff, 0xff,

  
            0xff, 0xff, 0xff, 8,    9,    0xff, 0xff, 10,

  
            0xff, 11,   12,   0xff, 0xff, 0xff, 0xff, 0xff,

  
            0xff, 13,   14,   0xff, 15,   0xff, 0xff, 0xff,

  
            0xff, 16,   0xff, 0xff, 17
}

Field Type Hash Table.

Maps field type to zero base index.

Note

The table is hand-crafted to optimize access speed.

Definition at line 140 of file nmLibInternal.c.

Referenced by NMHashFType().