bsProxyMod.c File Reference

Proxied interface module management operations. More...

#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <pthread.h>
#include <dlfcn.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/new.h"
#include "rnr/hash.h"
#include "rnr/dliststr.h"
#include "rnr/path.h"
#include "botsense/BotSense.h"
#include "botsense/bsProxyModIF.h"
#include "botsense/bsProxyMsgs.h"
#include "bsProxy.h"

Go to the source code of this file.

Macros
#define	DLL_EXT   ".so"
	standard dll library file name extension
#define	BS_AUX_LIBDIR   "/prj/lib"
	additional bsProxy library directory
#define	BS_PLUGIN_DIR   "."
	bsProxy module plugin subdirectory
#define	BSPROXY_MOD_HASH_MIN   32
	minimum hash table size
#define	BSPROXY_MOD_HASH_MAX   256
	maximum hash table size
#define	BSPROXY_MOD_LOG_ERROR(moduri, ecode, efmt, ...)
	Log Proxy Server Module Error. More...

Functions
static void	ModLock ()
	Lock module's global mutual exclusion.
static void	ModUnlock ()
	Unlock module's global mutual exclusion.
static bool_t	ModTryLock ()
	Try to lock module's global mutual exclusion. More...
static void	ModDllInit (DListStr_T *pDListLibPath)
static char *	ModDllNewCanonicalName (const char *sModName)
	Make DLL canonical file name. More...
static void *	ModDllOpen (const char *sModUri)
	Dynamically load bsProxy server compatible interface module library. More...
static void	ModDllClose (const char *sModUri, void *dllHandle)
	Unload the dynamic library from the application. More...
static void *	ModDllSym (BsProxyModIF_T *pModIF, const char *sSym)
	Get the address of where the module symbol is loaded into memory. More...
static void	ModDllDeleteIF (BsProxyModIF_T *pModIF)
	Delete module interface block. More...
static BsProxyModIF_T *	ModDllNewIF (const char *sModUri, void *dllHandle)
	Allocate an attached exported module interface block. More...
static void	ModHashDeleteData (void *sModUri, void *pModIF)
	Delete hash node data callback. More...
static int	ModHashAdd (const char *sModUri, BsProxyModIF_T *pModIF)
	Add the module data to the i/f module hash table. More...
static void	ModHashDelete (BsProxyModIF_T *pModIF)
	Remove and delete the module data from the i/f module hash table. More...
static BsProxyModIF_T *	ModHashGetIF (const char *sModUri)
	Get the interface module's i/f from the module hash table. More...
void	ModCbSendRsp (BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufRsp[], size_t uRspLen)
	Send module-specific repsonse callback function. More...
void	ModCbSendOkRsp (BsVConnHnd_T hndVConn, BsTid_T uTid)
	Send generic ok repsonse callback function. More...
void	ModCbSendErrorRsp (BsVConnHnd_T hndVConn, BsTid_T uTid, int nECode, const char *sErrFmt,...)
	Send generic error repsonse callback function. More...
BsModRsrcTbl_T *	ModCbRsrcTblNew (int nMaxResources)
	Allocatae a new module resource table of fixed size. More...
void	ModCbRsrcTblDelete (BsModRsrcTbl_T *pRsrcTbl)
	Delete an allocated resource table. More...
int	ModCbRsrcAdd (BsModRsrcTbl_T *pRsrcTbl, BsVConnHnd_T hndVConn, void *pRsrc)
	Add a new resource to the resource table. More...
void *	ModCbRsrcRemove (BsModRsrcTbl_T *pRsrcTbl, BsVConnHnd_T hndVConn)
	Remove a resource from the resource table. More...
const char *	ModCbGetDevUri (BsVConnHnd_T hndVConn, char dest[], size_t n)
	Copy the device URI associated with the virtual connection. More...
void	ModCbIterDelete (BsModIter_T *pIter)
	Delete the module iterator. More...
BsModIter_T *	ModCbIterNext (BsModIter_T *pIter)
	Get the next set of information given the iterator state. More...
BsModIter_T *	ModCbIterFirst (BsModIterOver_T eOver, const char *sPattern)
	Start an iterator over the virtual connections matching the given pattern. More...
void	ModOneTimeInit (DListStr_T *pDListLibPath)
	The bsProxy interface module handling one-time initialization. More...
char *	ModNewModUri (const char *sModName)
	Convert the module name to a quasi Uniform Resource Id. More...
BsProxyModIF_T *	ModGetLoadedIF (const char *sModUri)
	Get the defined interface from a previously loaded i/f module. More...
BsProxyModIF_T *	ModLoad (const char *sModUri)
	Load the interface module. More...
void	ModUnload (BsProxyModIF_T *pModIF)
	Unload the interface module. More...

Variables
static pthread_mutex_t	BsModMutex
	bsProxy module operations mutex
static hash_t *	BsModHashTbl
	i/f module hash table
static DListStr_T *	BsModDllPaths
	module search paths
static BsModProxyCb_T	BsModProxyCallbacks
	Interface module callbacks to bsProxy server services. More...

Detailed Description

Proxied interface module management operations.

LastChangedDate

2010-08-20 11:36:38 -0600 (Fri, 20 Aug 2010)

Rev

568

See also

http://www.yolinux.com/TUTORIALS/LibraryArchives-StaticAndDynamic.html

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

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

Definition in file bsProxyMod.c.

Macro Definition Documentation

#define BSPROXY_MOD_LOG_ERROR	(		moduri,
			ecode,
			efmt,
			...
	)

Value:

LOGERROR("%s: \"%s\": %s(ecode=%d): " efmt, \
      ServerHasName(), moduri, \
      bsStrError(ecode), (ecode>=0? ecode: -ecode), \
      ##__VA_ARGS__)

Log Proxy Server Module Error.

Parameters

moduri	Module URI string.
ecode

Definition at line 107 of file bsProxyMod.c.

Referenced by ModDllClose(), ModDllOpen(), ModDllSym(), and ModLoad().

Function Documentation

const char* ModCbGetDevUri	(	BsVConnHnd_T	hndVConn,
		char	dest[],
		size_t	n
	)

Copy the device URI associated with the virtual connection.

Parameters

	hndVConn	Virtual connection handle.
[out]	dest	Destination buffer.
	n	Size of buffer.

Returns

Pointer to destination buffer dest.

Definition at line 832 of file bsProxyMod.c.

References BsProxyVConn_T::m_pThCtl, _bsproxy_th_ctl::m_sDevUri, VConnAcquire(), and VConnRelease().

{
  BsProxyVConn_T  *pVConn;

  if( (pVConn = VConnAcquire(hndVConn)) != NULL )
  {
    strncpy(dest, pVConn->m_pThCtl->m_sDevUri, n);
    dest[n-1] = 0;
    VConnRelease(hndVConn);
  }
  else
  {
    dest[0] = 0;
  }

  return dest;
}

void ModCbIterDelete

(

BsModIter_T *

pIter

)

Delete the module iterator.

Parameters

pIter

Module iterator.

Definition at line 855 of file bsProxyMod.c.

References BsModIter_T::m_sDevUri, and BsModIter_T::m_sModUri.

Referenced by ModCbIterFirst(), and ModCbIterNext().

{
  if( pIter != NULL )
  {
    delete(pIter->m_sDevUri);
    delete(pIter->m_sModUri);
    delete(pIter);
  }
}

BsModIter_T* ModCbIterFirst	(	BsModIterOver_T	eOver,
		const char *	sPattern
	)

Start an iterator over the virtual connections matching the given pattern.

If a virtual connection match is found, an iterator is allocated and its data is filled with the first set of information.

The caller must delete the iterator by calling ModCbIterNext() until there are no more matches (auto-delete) or by calling ModCbIterDelete().

Parameters

eOver	What pattern to iterator over (see BsModIterOver_T).
sPattern	Device or module URI pattern string.

Returns

On success, returns the pointer to the allocacted module iterator.
On failure, NULL is returned.

Definition at line 959 of file bsProxyMod.c.

References BsModIterOverDevUri, BsModIterOverModUri, BsModIterOverVConn, BsModIter_T::m_eOver, BsModIter_T::m_hndVConn, BsModIter_T::m_rd, BsModIter_T::m_sDevUri, BsModIter_T::m_sModUri, ModCbIterDelete(), and ModCbIterNext().

{
  BsModIter_T  *pIter = NEW(BsModIter_T);

  pIter->m_eOver    = eOver;
  pIter->m_hndVConn = -1;
  pIter->m_sDevUri  = NULL;
  pIter->m_sModUri  = NULL;
  pIter->m_rd       = -1;

  switch( eOver )
  {
    case BsModIterOverDevUri:
      pIter->m_sDevUri = new_strdup(sPattern);
      return ModCbIterNext(pIter);
    case BsModIterOverModUri:
      pIter->m_sModUri = new_strdup(sPattern);
      return ModCbIterNext(pIter);
    case BsModIterOverVConn:
      return ModCbIterNext(pIter);
    default:
      ModCbIterDelete(pIter);
      return NULL;
  }
}

BsModIter_T* ModCbIterNext

(

BsModIter_T *

pIter

)

Get the next set of information given the iterator state.

If a virtual connection match is found, an iterator data is updated.

If no match is found, the iterator is auto-deleted.

Parameters

pIter

Initialized, allocated iterator.

Returns

On success, returns the pointer to the iterator.
On failure, NULL is returned.

Definition at line 877 of file bsProxyMod.c.

References BsModIterOverDevUri, BsModIterOverModUri, BsModIterOverVConn, BSPROXY_VCONN_NUMOF, BsModIter_T::m_eOver, BsModIter_T::m_hndVConn, BsProxyVConn_T::m_pModIF, BsProxyVConn_T::m_pThCtl, BsProxyVConn_T::m_rd, BsModIter_T::m_rd, _bsproxy_th_ctl::m_sDevUri, BsModIter_T::m_sDevUri, BsProxyModIF_T::m_sModUri, BsModIter_T::m_sModUri, ModCbIterDelete(), VConnAcquire(), and VConnRelease().

Referenced by ModCbIterFirst().

{
  BsVConnHnd_T    hndVConn;
  BsProxyVConn_T *pVConn;
  bool_t          bHasMatch = false;

  if( pIter == NULL )
  {
    return NULL;
  }

  for(hndVConn=pIter->m_hndVConn+1;
      (pIter!=NULL) && (hndVConn<BSPROXY_VCONN_NUMOF);
      ++hndVConn)
  {
    if( (pVConn = VConnAcquire(hndVConn)) != NULL )
    {
      switch( pIter->m_eOver )
      {
        case BsModIterOverDevUri:
          if( !strcmp(pVConn->m_pThCtl->m_sDevUri, pIter->m_sDevUri) )
          {
            pIter->m_hndVConn = hndVConn;
            delete(pIter->m_sModUri);
            pIter->m_sModUri = new_strdup(pVConn->m_pModIF->m_sModUri);
            pIter->m_rd = pVConn->m_rd;
            bHasMatch = true;
          }
          break;
        case BsModIterOverModUri:
          if( !strcmp(pVConn->m_pModIF->m_sModUri, pIter->m_sModUri) )
          {
            pIter->m_hndVConn = hndVConn;
            delete(pIter->m_sDevUri);
            pIter->m_sDevUri = new_strdup(pVConn->m_pThCtl->m_sDevUri);
            pIter->m_rd = pVConn->m_rd;
            bHasMatch = true;
          }
          break;
        case BsModIterOverVConn:
            pIter->m_hndVConn = hndVConn;
            delete(pIter->m_sDevUri);
            pIter->m_sDevUri = new_strdup(pVConn->m_pThCtl->m_sDevUri);
            delete(pIter->m_sModUri);
            pIter->m_sModUri = new_strdup(pVConn->m_pModIF->m_sModUri);
            pIter->m_rd = pVConn->m_rd;
            bHasMatch = true;
          break;
        default:
          ModCbIterDelete(pIter);
          pIter = NULL;
          break;
      }
      VConnRelease(hndVConn);
    }
  }

  if( !bHasMatch )
  {
    ModCbIterDelete(pIter);
    pIter = NULL;
  }

  return pIter;
}

int ModCbRsrcAdd	(	BsModRsrcTbl_T *	pRsrcTbl,
		BsVConnHnd_T	hndVConn,
		void *	pRsrc
	)

Add a new resource to the resource table.

Parameters

pRsrcTbl	Pointer to resource table.
hndVConn	Virtual connection handle.
pRsrc	Pointer to allocated resource associated with handle.

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 744 of file bsProxyMod.c.

References BS_ECODE_BAD_VCONN_HND, BS_ECODE_INTERNAL, BS_ECODE_NO_RSRC, BSMOD_IS_VCONN_HANDLE, BsModRsrcTbl_T::m_uInUseCount, BsModRsrcTbl_T::m_uMaxResources, BsModRsrcTbl_T::m_vecIndex, and BsModRsrcTbl_T::m_vecRsrc.

{
  int  index;

  // bad handle
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    return -BS_ECODE_BAD_VCONN_HND;
  }

  // no more resources available  
  else if( pRsrcTbl->m_uInUseCount >= pRsrcTbl->m_uMaxResources )
  {
    return -BS_ECODE_NO_RSRC;
  }

  // find empty slot in resource table
  for(index=0; index<pRsrcTbl->m_uMaxResources; ++index)
  {
    if( pRsrcTbl->m_vecRsrc[index] == NULL )
    {
      break;
    }
  }

  // internal error - log these
  if( (uint_t)index >= pRsrcTbl->m_uMaxResources )
  {
    LOGERROR("Internal module data corruption.");
    return -BS_ECODE_INTERNAL;
  }

  // add resource to resource table
  pRsrcTbl->m_vecRsrc[index]     = pRsrc;
  pRsrcTbl->m_vecIndex[hndVConn] = (byte_t)index;
  pRsrcTbl->m_uInUseCount++;

  return index;
}

void* ModCbRsrcRemove	(	BsModRsrcTbl_T *	pRsrcTbl,
		BsVConnHnd_T	hndVConn
	)

Remove a resource from the resource table.

The resource is not deleted.

Parameters

pRsrcTbl	Pointer to resource table.
hndVConn	Virtual connection handle.

Returns

On success, returns pointer to removed resource. On failure, NULL is returned.

Definition at line 795 of file bsProxyMod.c.

References BSMOD_IS_VCONN_HANDLE, BSMOD_RSRC_INDEX, BSPROXY_VCONN_UNDEF, BsModRsrcTbl_T::m_uInUseCount, BsModRsrcTbl_T::m_vecIndex, and BsModRsrcTbl_T::m_vecRsrc.

{
  int   index;
  void *pRsrc;

  // bad handle
  if( !BSMOD_IS_VCONN_HANDLE(hndVConn) )
  {
    return NULL;
  }

  // get resource index
  else if( (index = BSMOD_RSRC_INDEX(pRsrcTbl, hndVConn)) < 0 )
  {
    return NULL;
  }

  // removed resource
  pRsrc = pRsrcTbl->m_vecRsrc[index];

  // remove resource to resource table
  pRsrcTbl->m_vecRsrc[index]     = NULL;
  pRsrcTbl->m_vecIndex[hndVConn] = (byte_t)BSPROXY_VCONN_UNDEF;
  pRsrcTbl->m_uInUseCount--;

  return pRsrc;
}

void ModCbRsrcTblDelete

(

BsModRsrcTbl_T *

pRsrcTbl

)

Delete an allocated resource table.

Warning

Module-specific resources should be freed up prior to calling this function.

Parameters

pRsrcTbl

Pointer to resource table.

Definition at line 726 of file bsProxyMod.c.

References BsModRsrcTbl_T::m_vecRsrc.

{
  if( pRsrcTbl != NULL )
  {
    delete(pRsrcTbl->m_vecRsrc);
    delete(pRsrcTbl);
  }
}

BsModRsrcTbl_T* ModCbRsrcTblNew

(

int

nMaxResources

)

Allocatae a new module resource table of fixed size.

The resource table is indexed by the virtual connection handle.

Parameters

nMaxResources

Maximum number of simultaneous resources supported.

Returns

Pointer to allocated resource block.

Definition at line 703 of file bsProxyMod.c.

References BSPROXY_VCONN_UNDEF, BsModRsrcTbl_T::m_uInUseCount, BsModRsrcTbl_T::m_uMaxResources, BsModRsrcTbl_T::m_vecIndex, and BsModRsrcTbl_T::m_vecRsrc.

{
  BsModRsrcTbl_T *pRsrcTbl = NEW(BsModRsrcTbl_T);

  pRsrcTbl->m_vecRsrc = new(sizeof(void *) * (size_t)nMaxResources);

  memset(pRsrcTbl->m_vecIndex, BSPROXY_VCONN_UNDEF,
      sizeof(pRsrcTbl->m_vecIndex));

  pRsrcTbl->m_uMaxResources = (uint_t)nMaxResources;
  pRsrcTbl->m_uInUseCount   = 0;

  return pRsrcTbl;
}

void ModCbSendErrorRsp	(	BsVConnHnd_T	hndVConn,
		BsTid_T	uTid,
		int	nECode,
		const char *	sErrFmt,
			...
	)

Send generic error repsonse callback function.

Note

Service thread request handler has already locked the virtual connection.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
nECode	One of BotSense Error Codes.
sErrFmt	Error format string.
...	Format string variable arguments.

Definition at line 671 of file bsProxyMod.c.

References BS_ECODE_NO_VCONN, ClientSendVErrorRsp(), BsProxyVConn_T::m_hndClient, ServerHasName(), and VConnGet().

{
  BsProxyVConn_T *pVConn;
  va_list         ap;

  if( (pVConn = VConnGet(hndVConn)) != NULL )
  {
    va_start(ap, sErrFmt);
    ClientSendVErrorRsp(pVConn->m_hndClient, uTid, nECode, sErrFmt, ap);
    va_end(ap);
  }
  else
  {
    LOGERROR("%s: %s(ecode=%d): VConn=%d.",
      ServerHasName(), bsStrError(BS_ECODE_NO_VCONN), BS_ECODE_NO_VCONN,
      hndVConn);
  }
}

void ModCbSendOkRsp	(	BsVConnHnd_T	hndVConn,
		BsTid_T	uTid
	)

Send generic ok repsonse callback function.

Note

Service thread request handler has already locked the virtual connection.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.

Definition at line 643 of file bsProxyMod.c.

References BS_ECODE_NO_VCONN, ClientSendOkRsp(), BsProxyVConn_T::m_hndClient, ServerHasName(), and VConnGet().

{
  BsProxyVConn_T  *pVConn;

  if( (pVConn = VConnGet(hndVConn)) != NULL )
  {
    ClientSendOkRsp(pVConn->m_hndClient, uTid);
  }
  else
  {
    LOGERROR("%s: %s(ecode=%d): VConn=%d.",
      ServerHasName(), bsStrError(BS_ECODE_NO_VCONN), BS_ECODE_NO_VCONN,
      hndVConn);
  }
}

void ModCbSendRsp	(	BsVConnHnd_T	hndVConn,
		BsTid_T	uTid,
		BsMsgId_T	uMsgId,
		byte_t	bufRsp[],
		size_t	uRspLen
	)

Send module-specific repsonse callback function.

Note

Service thread request handler has already locked the virtual connection.

Parameters

hndVConn	Virtual connection handle.
uTid	Request-Response transaction id.
uMsgId	Response message id.
bufRsp	Packed repsonse message body.
uRspLen	Length of response in buffer (number of bytes).

Definition at line 614 of file bsProxyMod.c.

References BS_ECODE_NO_VCONN, ClientSendRsp(), BsProxyVConn_T::m_hndClient, ServerHasName(), and VConnGet().

{
  BsProxyVConn_T  *pVConn;

  if( (pVConn = VConnGet(hndVConn)) != NULL )
  {
    ClientSendRsp(pVConn->m_hndClient, hndVConn, uTid, uMsgId, bufRsp, uRspLen);
  }
  else
  {
    LOGERROR("%s: %s(ecode=%d): VConn=%d.",
      ServerHasName(), bsStrError(BS_ECODE_NO_VCONN), BS_ECODE_NO_VCONN,
      hndVConn);
  }
}

static void ModDllClose ( const char *  sModUri, void *  dllHandle  )

static

Unload the dynamic library from the application.

Note

The dlopen() and dlclose() functions only load/unload when a library iff the internal reference count is zero. However, bsProxy also needs to track the reference count, which the dl interface does not provide access to.

Parameters

sModUri	Expanded, canonical name of the interface module.
dllHandle	DLL handle.

Definition at line 344 of file bsProxyMod.c.

References BS_ECODE_NO_EXEC, and BSPROXY_MOD_LOG_ERROR.

Referenced by ModUnload().

{
  // clear any existing error
  dlerror();

  if( dlclose(dllHandle) != 0 )
  {
    BSPROXY_MOD_LOG_ERROR(sModUri, BS_ECODE_NO_EXEC, "%s.", dlerror());
  }
}

static void ModDllDeleteIF ( BsProxyModIF_T *  pModIF )

static

Delete module interface block.

Parameters

pModIF

Exported module interface.

Definition at line 396 of file bsProxyMod.c.

References BsProxyModIF_T::m_sModUri.

Referenced by ModDllNewIF(), ModHashDeleteData(), and ModLoad().

{
  if( pModIF != NULL )
  {
    delete((char *)pModIF->m_sModUri);
    delete(pModIF);
  }
}

static void ModDllInit ( DListStr_T *  pDListLibPath )

static

Initialize Dynamic Link Loader operating parameters.

Parameters

pDListLibPath

List of optional library search paths.

For i/f module search path order:

• command-line -L options in order listed
• XML configuration paths
• user's home lib directory if it exists
• BotSense library install library path
• default dlopen() locations (system dependent)

Definition at line 175 of file bsProxyMod.c.

References BS_AUX_LIBDIR, BS_PLUGIN_DIR, and BsModDllPaths.

Referenced by ModOneTimeInit().

{
  DListStrIter_T  iter;
  char           *sLibPath;
  char           *sPath;

  BsModDllPaths = DListStrNewDft();

  // Add command-line -L paths here
  for(sLibPath=DListStrIterDataFirst(pDListLibPath, &iter);
      sLibPath!=NULL;
      sLibPath=DListStrIterDataNext(&iter))
  {
    // canonicalize path name
    if( (sPath = NewSearchPathCanonicalized(sLibPath)) == NULL )
    {
      LOGDIAG2("Warning: \"%s\": Ignoring bad library path.", sLibPath);
    }
    else
    {
      DListStrAppend(BsModDllPaths, sPath);
    }
  }

  // RDK add xml config paths here

  // RDK add user's home/botsense/libs path here
 
  // Add installed prefix/lib/botsense/ path.
  if( (sPath = NewJoinedPath(BS_AUX_LIBDIR, BS_PLUGIN_DIR)) != NULL )
  {
    DListStrAppend(BsModDllPaths, sPath);
  }
}

static char* ModDllNewCanonicalName ( const char *  sModName )

static

Make DLL canonical file name.

The library path is expanded, canonicalized and any necessary file extension is appended.

Parameters

sModName

DLL library path name.

Returns

On success, an allocated, canonical library path name is returned.
On failure, NULL is returned.

Definition at line 222 of file bsProxyMod.c.

References DLL_EXT.

Referenced by ModNewModUri().

{
  char   *s = NULL;
  char   *t = NULL;
  size_t  m, n;

  // canonicalize module path name
  if( (s = NewSearchPathCanonicalized(sModName)) == NULL )
  {
    LOGERROR("NewSearchPathCanonicalized(\"%s\") failed.", sModName);
    return NULL;
  }

  m = strlen(s);
  n = strlen(DLL_EXT);

  // append library extension
  if( (DLL_EXT != NULL) && ((m <= n) || strncasecmp(s+m-n, DLL_EXT, n)) )
  {
    t = NEWSTR(m+n);
    sprintf(t, "%s%s", s, DLL_EXT);
    delete(s);
  }
  else
  {
    t = s;
  }

  return t;
}

static BsProxyModIF_T* ModDllNewIF ( const char *  sModUri, void *  dllHandle  )

static

Allocate an attached exported module interface block.

Note

dlsym() can return NULL with no errors if the symbol's value is NULL. Checking the dlerror() return is the safe way to determine if an error has occurred. However, a bsProxy compatible module's exported interface is required to be defined.

Parameters

sModUri	Expanded, canonical name of the interface module.
dllHandle	DLL handle.

Returns

On success, returns a pointer to the module's exported interface.
On failure, returns NULL.

Definition at line 420 of file bsProxyMod.c.

References BS_ECODE_BAD_MOD, BS_OK, BSMOD_SYM_CLOSE_S, BSMOD_SYM_EXIT_S, BSMOD_SYM_INFO_S, BSMOD_SYM_INIT_S, BSMOD_SYM_OPEN_S, BSMOD_SYM_REQUEST_S, BSMOD_SYM_TRACE_S, BsProxyModIF_T::m_dllHandle, BsProxyModIF_T::m_fnModClose, BsProxyModIF_T::m_fnModExit, BsProxyModIF_T::m_fnModInfo, BsProxyModIF_T::m_fnModInit, BsProxyModIF_T::m_fnModOpen, BsProxyModIF_T::m_fnModRequest, BsProxyModIF_T::m_fnModTrace, BsProxyModIF_T::m_sModUri, BsProxyModIF_T::m_uRefCnt, ModDllDeleteIF(), and ModDllSym().

Referenced by ModLoad().

{
  BsProxyModIF_T *pModIF = NEW(BsProxyModIF_T);
  int             rc = BS_OK;

  pModIF->m_sModUri   = new_strdup(sModUri);  // self reference
  pModIF->m_dllHandle = dllHandle;            // opaque dll handle
  pModIF->m_uRefCnt   = 1;                    // module reference count

  //
  // Init
  //
  pModIF->m_fnModInit = (BsModInitFunc_P)ModDllSym(pModIF, BSMOD_SYM_INIT_S);

  if( pModIF->m_fnModInit == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }

  //
  // Exit
  //
  pModIF->m_fnModExit = (BsModExitFunc_P)ModDllSym(pModIF, BSMOD_SYM_EXIT_S);

  if( pModIF->m_fnModExit == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }

  //
  // Open
  //
  pModIF->m_fnModOpen = (BsModOpenFunc_P)ModDllSym(pModIF, BSMOD_SYM_OPEN_S);

  if( pModIF->m_fnModOpen == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }

  //
  // Close
  //
  pModIF->m_fnModClose = (BsModCloseFunc_P)ModDllSym(pModIF, BSMOD_SYM_CLOSE_S);

  if( pModIF->m_fnModClose == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }


  //
  // Request
  //
  pModIF->m_fnModRequest = (BsModRequestFunc_P)ModDllSym(pModIF,
                                                         BSMOD_SYM_REQUEST_S);

  if( pModIF->m_fnModRequest == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }

  //
  // Trace
  //
  pModIF->m_fnModTrace = (BsModTraceFunc_P)ModDllSym(pModIF, BSMOD_SYM_TRACE_S);

  if( pModIF->m_fnModTrace == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }

  //
  // Info
  //
  pModIF->m_fnModInfo = (BsModInfoFunc_P)ModDllSym(pModIF, BSMOD_SYM_INFO_S);

  if( pModIF->m_fnModInfo == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
  }

  // Error clean up.
  if( rc < 0 )
  {
    ModDllDeleteIF(pModIF);
    pModIF = NULL;
  }

  return pModIF;
}

static void* ModDllOpen ( const char *  sModUri )

static

Dynamically load bsProxy server compatible interface module library.

If the module path name is absolute, the only library at that location is attempted to be loaded. Otherwise, a series of path locations are searched for the library.

Note

The dlopen() and dlclose() functions only load/unload when a library iff the internal reference count is zero. However, bsProxy also needs to track the reference count, which the dl interface does not provide access to.

Parameters

sModUri

Expanded, canonical name of the interface module.

Returns

On success, returns DLL handle.
On failure, returns NULL.

< paths dlist iterator

< a dll path

< fully qualified path name

< loaded dll handle

Definition at line 270 of file bsProxyMod.c.

References BS_ECODE_NO_MOD, BsModDllPaths, BSPROXY_MOD_LOG_ERROR, and ServerHasName().

Referenced by ModLoad().

{
  DListStrIter_T  iter;             ///< paths dlist iterator
  char           *sPath;            ///< a dll path
  char           *sFqPath;          ///< fully qualified path name
  void           *dllHandle = NULL; ///< loaded dll handle

  if( sModUri == NULL )
  {
    return NULL;
  }

  // clear any existing error
  dlerror();

  // 
  // Module path name is an absolute path. No search is made, simply let
  // dlopen() do the work.
  //
  if( PathIsAbsolute(sModUri) )
  {
    if( (sFqPath = NewRealPath(sModUri)) != NULL )
    {
      LOGDIAG3("%s: trying dlopen(\"%s\").", ServerHasName(), sFqPath);
      dllHandle = dlopen(sFqPath, RTLD_LAZY | RTLD_GLOBAL);
      delete(sFqPath);
    }
  }

  //
  // Search list of paths for the module's location and load.
  //
  else
  {
    for(sPath=DListStrIterDataFirst(BsModDllPaths, &iter), dllHandle=NULL;
        sPath!=NULL && dllHandle==NULL;
        sPath=DListStrIterDataNext(&iter))
    {
      if( (sFqPath = NewJoinedPath(sPath, sModUri)) != NULL )
      {
        LOGDIAG3("%s: trying dlopen(\"%s\").", ServerHasName(), sFqPath);
        dllHandle = dlopen(sFqPath, RTLD_LAZY | RTLD_GLOBAL);
        delete(sFqPath);
      }
    }

    //
    // Use dlopen() default search.
    //
    if( dllHandle == NULL )
    {
      LOGDIAG3("%s: trying dlopen(\"%s\").", ServerHasName(), sModUri);
      dllHandle = dlopen(sModUri, RTLD_LAZY | RTLD_GLOBAL);
    }
  }

  if( dllHandle == NULL )
  {
    BSPROXY_MOD_LOG_ERROR(sModUri, BS_ECODE_NO_MOD, "%s.", dlerror());
  }

  return dllHandle;
}

static void* ModDllSym ( BsProxyModIF_T *  pModIF, const char *  sSym  )

static

Get the address of where the module symbol is loaded into memory.

Parameters

pModIF	Exported module interface.
sSym	Symbol name.

Returns

On success, returns the symbol address.
On failure, NULL is returned.

Definition at line 365 of file bsProxyMod.c.

References BS_ECODE_BAD_MOD, BSPROXY_MOD_LOG_ERROR, BsProxyModIF_T::m_dllHandle, and BsProxyModIF_T::m_sModUri.

Referenced by ModDllNewIF().

{
  void  *pSym;
  char  *sEMsg;

  // clear any existing error
  dlerror();

  // get symbol address
  pSym = dlsym(pModIF->m_dllHandle, sSym);

  // error
  if( pSym == NULL )
  {
    sEMsg = dlerror();
    if( sEMsg == NULL )
    {
      sEMsg = "Not defined";
    }
    BSPROXY_MOD_LOG_ERROR(pModIF->m_sModUri, BS_ECODE_BAD_MOD,
                          "%s: %s.", sSym, sEMsg);
  }

  return pSym;
}

BsProxyModIF_T* ModGetLoadedIF

(

const char *

sModUri

)

Get the defined interface from a previously loaded i/f module.

Multi-Thread safe.

Parameters

sModUri

Interface module expanded, canonical name.

Returns

On success, returns a pointer to the module's exported interface.
Returns NULL if no interface is found.

Definition at line 1058 of file bsProxyMod.c.

References ModHashGetIF(), ModLock(), and ModUnlock().

Referenced by ClientSetTraceState().

{
  BsProxyModIF_T  *pModIF;

  ModLock();

  pModIF = ModHashGetIF(sModUri);

  ModUnlock();

  return pModIF;
}

static int ModHashAdd ( const char *  sModUri, BsProxyModIF_T *  pModIF  )

static

Add the module data to the i/f module hash table.

Parameters

sModUri	Allocated interface module hash table key.
pModIF	Allocated interface module hash table value.

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 538 of file bsProxyMod.c.

References BS_ECODE_NO_RSRC, BS_OK, BsModHashTbl, and ModHashDeleteData().

Referenced by ModLoad().

{
  char *sKey = new_strdup(sModUri);

  // insert into hash table, automatically allocating hnode_t
  if( !hash_insert(BsModHashTbl, sKey, pModIF) )
  {
    LOGERROR("hash_insert(%s,...) failed", sKey);
    ModHashDeleteData(sKey, pModIF);
    return -BS_ECODE_NO_RSRC;
  }

  return BS_OK;
}

static void ModHashDelete ( BsProxyModIF_T *  pModIF )

static

Remove and delete the module data from the i/f module hash table.

Parameters

pModIF

Allocated interface module hash table value.

Returns

On success, BS_OK is returned.
On error, the appropriate < 0 negated BotSense Error Code is returned.

Definition at line 560 of file bsProxyMod.c.

References BsModHashTbl, and BsProxyModIF_T::m_sModUri.

Referenced by ModUnload().

{
  hnode_t *pNode;

  if( pModIF == NULL )
  {
    return;
  }
  else if( (pNode = hash_lookup(BsModHashTbl, pModIF->m_sModUri)) != NULL )
  {
    hash_node_delete(BsModHashTbl, pNode);
  }
}

static void ModHashDeleteData ( void *  sModUri, void *  pModIF  )

static

Delete hash node data callback.

Both the key and value are dynamically allocated.

Parameters

sModUri	Interface module hash table key.
pModIF	Interface module hash table value.

Definition at line 524 of file bsProxyMod.c.

References ModDllDeleteIF().

Referenced by ModHashAdd(), and ModOneTimeInit().

{
  delete(sModUri);
  ModDllDeleteIF((BsProxyModIF_T *)pModIF);
}

static BsProxyModIF_T* ModHashGetIF ( const char *  sModUri )

static

Get the interface module's i/f from the module hash table.

Parameters

sModUri

Interface module hash table key.

Returns

On success, returns pointer to the module's exported interface.
On failure, returns NULL.

Definition at line 583 of file bsProxyMod.c.

References BsModHashTbl.

Referenced by ModGetLoadedIF(), ModLoad(), and ModUnload().

{
  hnode_t         *pNode;

  if( (pNode = hash_lookup(BsModHashTbl, sModUri)) == NULL )
  {
     return NULL;
  }
  else
  {
    return (BsProxyModIF_T *)hnode_get(pNode);
  }
}

BsProxyModIF_T* ModLoad

(

const char *

sModUri

)

Load the interface module.

The module's expanded, canonical name is determined, the dynamic library is loaded, the module's exported interface is attached, and the module's initialization routine is called.

The the same module is loaded again, the reference count is bumped and the already attached interface is returned.

Multi-Thread safe.

Parameters

sModUri

Interface module expanded, canonical name.

Returns

On success, returns a pointer to the module's exported interface.
On failure, returns NULL.

Definition at line 1089 of file bsProxyMod.c.

References BS_ECODE_BAD_MOD, BS_ECODE_NO_MOD, BS_ECODE_NO_RSRC, BS_OK, BSPROXY_MOD_LOG_ERROR, BsProxyModIF_T::m_fnModInit, BsProxyModIF_T::m_sModUri, BsProxyModIF_T::m_uRefCnt, ModDllDeleteIF(), ModDllNewIF(), ModDllOpen(), ModHashAdd(), ModHashGetIF(), ModLock(), and ModUnlock().

Referenced by ClientSetTraceState(), and VConnOpenDev().

{
  BsProxyModIF_T *pModIF      = NULL;
  void           *dllHandle   = NULL;
  int             rc;

  // lock global mutex
  ModLock();

  //
  // Check if module is already loaded.
  //
  if( (pModIF = ModHashGetIF(sModUri)) != NULL )
  {
    rc = BS_OK;
    pModIF->m_uRefCnt++;
    LOGDIAG1("Interface Module \"%s\" attached (refcnt=%u).",
          pModIF->m_sModUri, pModIF->m_uRefCnt);
  }

  //
  // Load the dynamic library.
  //
  else if( (dllHandle = ModDllOpen(sModUri)) == NULL )
  {
    rc = -BS_ECODE_NO_MOD;
    BSPROXY_MOD_LOG_ERROR(sModUri, rc, "Failed to open.");
  }

  //
  // Allocate new interface control blcok and attach module's exported
  // interface.
  //
  else if( (pModIF = ModDllNewIF(sModUri, dllHandle)) == NULL )
  {
    rc = -BS_ECODE_BAD_MOD;
    BSPROXY_MOD_LOG_ERROR(sModUri, rc, "Failed to get interface.");
  }

  //
  // Call the newly loaded module's exported initialization function to
  // initialize any module specific data and resources.
  //
  else if( (rc = pModIF->m_fnModInit(sModUri, &BsModProxyCallbacks)) < 0 )
  {
    rc = -BS_ECODE_BAD_MOD;
    BSPROXY_MOD_LOG_ERROR(sModUri, rc, "Failed to initialize.");
  }

  //
  // Add the module to the hash table (failure auto-deletes node data).
  //
  else if( (rc = ModHashAdd(sModUri, pModIF)) < 0 )
  {
    rc = -BS_ECODE_NO_RSRC;
    BSPROXY_MOD_LOG_ERROR(sModUri, rc, "Failed to add module to hash table.");
  }

  //
  // Successfully loaded new module.
  //
  else
  {
    rc = BS_OK;
    LOGDIAG1("Interface Module \"%s\" loaded (refcnt=%u).",
          pModIF->m_sModUri, pModIF->m_uRefCnt);
  }

  ModUnlock();

  //
  // Error clean up.
  //
  if( rc < 0 )
  {
    if( dllHandle != NULL )
    {
      dlclose(dllHandle);
      dllHandle = NULL;
    }

    if( pModIF != NULL )
    {
      ModDllDeleteIF(pModIF);
      pModIF = NULL;
    }
  }

  return pModIF;
}

char* ModNewModUri

(

const char *

sModName

)

Convert the module name to a quasi Uniform Resource Id.

Parameters

sModName

Module path name.

Returns

On success, an allocated, canonical library path name is returned.
On failure, NULL is returned.

Definition at line 1042 of file bsProxyMod.c.

References ModDllNewCanonicalName().

Referenced by ClientSetTraceState(), and VConnOpenDev().

{
  return ModDllNewCanonicalName(sModName);
}

void ModOneTimeInit

(

DListStr_T *

pDListLibPath

)

The bsProxy interface module handling one-time initialization.

Parameters

pDListLibPath

List of optional library search paths.

Definition at line 1013 of file bsProxyMod.c.

References BsModHashTbl, BsModMutex, BSPROXY_MOD_HASH_MAX, BSPROXY_MOD_HASH_MIN, ModDllInit(), and ModHashDeleteData().

Referenced by ClientSetTraceState(), and main().

{
  // create mutex
  pthread_mutex_init(&BsModMutex, NULL);
  
  BsModHashTbl = hash_table_create(
        true,                               // dynamic table sizing
        (hashcount_t)BSPROXY_MOD_HASH_MIN,  // minimum size
        (hashcount_t)BSPROXY_MOD_HASH_MAX,  // maximum size
        NULL,                               // use default comparator function
        NULL,                               // use default hashing function
        ModHashDeleteData);                 // hash node data deletion function

  // turn off most asserts()
  hash_set_self_verify(false);

  // initialize DLL environment
  ModDllInit(pDListLibPath);
}

static bool_t ModTryLock ( )

inlinestatic

Try to lock module's global mutual exclusion.

Returns

Returns true if lock is acquired. Otherwise returns false if mutex already locked.

Definition at line 153 of file bsProxyMod.c.

References BsModMutex.

{
  return pthread_mutex_trylock(&BsModMutex) == 0? true: false;
}

void ModUnload

(

BsProxyModIF_T *

pModIF

)

Unload the interface module.

The module's reference count is decremented. If the count is zero, then the module's exit routine is called and the module dynamic library is unloaded from bsProxy server application.

Multi-Thread safe.

Parameters

pModIF

Exported module interface.

Definition at line 1191 of file bsProxyMod.c.

References BsProxyModIF_T::m_dllHandle, BsProxyModIF_T::m_fnModExit, BsProxyModIF_T::m_sModUri, BsProxyModIF_T::m_uRefCnt, ModDllClose(), ModHashDelete(), ModHashGetIF(), ModLock(), and ModUnlock().

Referenced by ClientSetTraceState(), VConnClose(), and VConnOpenDev().

{

  ModLock();

  if( (pModIF = ModHashGetIF(pModIF->m_sModUri)) != NULL )
  {
    if( pModIF->m_uRefCnt > 0 )
    {
      pModIF->m_uRefCnt--;
    }

    if( pModIF->m_uRefCnt == 0 )
    {
      // call module specific exported exit function
      pModIF->m_fnModExit();

      // unload the dll
      ModDllClose(pModIF->m_sModUri, pModIF->m_dllHandle);

      LOGDIAG1("Interface Module \"%s\" unloaded (refcnt=%u).",
          pModIF->m_sModUri, pModIF->m_uRefCnt);

      // delete data
      ModHashDelete(pModIF);
    }
    else
    {
      LOGDIAG1("Interface Module \"%s\" detached (refcnt=%u).",
          pModIF->m_sModUri, pModIF->m_uRefCnt);
    }
  }

  ModUnlock();
}

Variable Documentation

BsModProxyCb_T BsModProxyCallbacks

static

Initial value:

=
{
  ModCbSendRsp,         
  ModCbSendOkRsp,       
  ModCbSendErrorRsp,    
  ModCbRsrcTblNew,      
  ModCbRsrcTblDelete,   
  ModCbRsrcAdd,         
  ModCbRsrcRemove,      
  ModCbGetDevUri,       
  ModCbIterFirst,       
  ModCbIterNext,        
  ModCbIterDelete       
}

Interface module callbacks to bsProxy server services.

Definition at line 988 of file bsProxyMod.c.