bsProxyRequest.c File Reference

BotSense bsProxy server-terminated requests. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/new.h"
#include "botsense/BotSense.h"
#include "botsense/bsProxyModIF.h"
#include "botsense/bsProxyMsgs.h"
#include "bsProxy.h"
#include "version.h"

Go to the source code of this file.

Functions
static int	ReqLoopback (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to perform a loopback. More...
static int	ReqSetLogging (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to set the server's logging level. More...
static int	ReqMsgTrace (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to set server or client terminated message tracing. More...
static int	ReqGetVersion (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to get the server's version. More...
static int	ReqDevOpen (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to open a proxied device virtual connection. More...
static int	ReqDevClose (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to close a device virtual connection. More...
static int	ReqGetVConnList (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to get the list of all of the client's opened virtual connection handles. More...
static int	ReqGetVConnInfo (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen, bool_t bTrace)
	Service client's request to get a virtual connection's information. More...
int	ServerRequest (BsProxyClientHnd_T hndClient, BsVConnHnd_T hndVConn, BsTid_T uTid, BsMsgId_T uMsgId, byte_t bufReq[], size_t uReqLen)
	Server service thread request handler. More...

Detailed Description

BotSense bsProxy server-terminated requests.

LastChangedDate

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

Rev

568

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

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

Definition in file bsProxyRequest.c.

Function Documentation

static int ReqDevClose ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to close a device virtual connection.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 394 of file bsProxyRequest.c.

References BS_ECODE_BAD_MSG, BS_ECODE_SERVER_BAD_CLIENT, BS_OK, BSPROXY_SEND_ERROR_RSP, BSPROXY_SEND_NMERROR_RSP, BsProxyUnpackReqDevClose(), ClientAcquire(), ClientRelease(), ClientSendOkRsp(), BsProxyClientCtl_T::m_uRefCnt, BsProxyReqDevClose_T::m_vconn, and VConnClose().

Referenced by ServerRequest().

{
  BsProxyReqDevClose_T  msgReq;
  BsProxyClientCtl_T   *pClient;
  int                   rc;

  //
  // Unpack client request.
  //
  rc = BsProxyUnpackReqDevClose(bufReq, uReqLen, &msgReq, bTrace);

  if( rc < 0 )
  {
    BSPROXY_SEND_NMERROR_RSP(hndClient, hndVConn, uTid, rc, "MsgId=%u", uMsgId);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Execute client request.
  //

  //
  // Acquire the client, locking it from other threads. If it cannot be
  // acquired, the client has a bad connection or is disconnected and is (being)
  // unregistered. Don't send response message.
  //
  if( (pClient = ClientAcquire(hndClient)) == NULL )
  {
    return -BS_ECODE_SERVER_BAD_CLIENT;
  }

  if( (rc = VConnClose(hndClient, msgReq.m_vconn)) == BS_OK )
  {
    pClient->m_uRefCnt--;
  }

  // Unlock the client. Response message may now be sent on this client.
  ClientRelease(hndClient);

  if( rc < 0 )
  {
    BSPROXY_SEND_ERROR_RSP(hndClient, hndVConn, uTid, rc,
        "VConn=%d", (int)msgReq.m_vconn);
    return -rc;
  }

  //
  // Send server response.
  //
  return ClientSendOkRsp(hndClient, uTid);
}

static int ReqDevOpen ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to open a proxied device virtual connection.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 302 of file bsProxyRequest.c.

References BS_ECODE_BAD_MSG, BS_ECODE_SERVER_BAD_CLIENT, BSPROXY_SEND_ERROR_RSP, BSPROXY_SEND_NMERROR_RSP, BsProxyMsgIdRspDevOpen, BsProxyUnpackReqDevOpen(), ClientAcquire(), ClientRelease(), ClientSendServerRsp(), BsProxyReqDevOpen_T::m_argbuf, BsProxyReqDevOpen_T::m_count, BsProxyReqDevOpen_T::m_devname, BsProxyReqDevOpen_T::m_modname, BsProxyReqDevOpen_T::m_trace, BsProxyClientCtl_T::m_uRefCnt, BsProxyRspDevOpen_T::m_vconn, BsProxyReqDevOpen_T::u, and VConnOpenDev().

Referenced by ServerRequest().

{
  static BsProxyMsgId_T uMsgIdRsp = BsProxyMsgIdRspDevOpen;

  BsProxyReqDevOpen_T   msgReq;
  BsProxyRspDevOpen_T   msgRsp;
  BsProxyClientCtl_T   *pClient;
  int                   n;
  int                   rc;

  //
  // Unpack client request.
  //
  rc = BsProxyUnpackReqDevOpen(bufReq, uReqLen, &msgReq, bTrace);

  if( rc < 0 )
  {
    BSPROXY_SEND_NMERROR_RSP(hndClient, hndVConn, uTid, rc, "MsgId=%u", uMsgId);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Execute client request.
  //

  //
  // Acquire the client, locking it from other threads. If it cannot be
  // acquired, the client has a bad connection or is disconnected and is
  // (being) unregistered. Don't send response message.
  //
  if( (pClient = ClientAcquire(hndClient)) == NULL )
  {
    return -BS_ECODE_SERVER_BAD_CLIENT;
  }

  //
  // Open a new virtual connection.
  //
  n = VConnOpenDev(hndClient, msgReq.m_devname, msgReq.m_modname,
                 msgReq.m_argbuf.u.m_buf, (size_t)msgReq.m_argbuf.m_count,
                 msgReq.m_trace);

  if( n >= 0 )
  {
    pClient->m_uRefCnt++;
  }

  // Unlock the client. Response message may now be sent on this client.
  ClientRelease(hndClient);

  if( n < 0 )
  {
    BSPROXY_SEND_ERROR_RSP(hndClient, hndVConn, uTid, n,
        "DevName=%s, ModName=%s", msgReq.m_devname, msgReq.m_modname);
    return -n;
  }

  //
  // Fill in response.
  //
  msgRsp.m_vconn = (byte_t)n;

  //
  // Send server response.
  //
  rc = ClientSendServerRsp(hndClient, uTid, uMsgIdRsp, &msgRsp);

  return rc;
}

static int ReqGetVConnInfo ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to get a virtual connection's information.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 530 of file bsProxyRequest.c.

References BS_ECODE_BAD_MSG, BSPROXY_RSPGETVCONNINFO_CLIENT_LEN, BSPROXY_RSPGETVCONNINFO_DEVURI_LEN, BSPROXY_RSPGETVCONNINFO_MODDATE_LEN, BSPROXY_RSPGETVCONNINFO_MODURI_LEN, BSPROXY_RSPGETVCONNINFO_MODVER_LEN, BSPROXY_SEND_NMERROR_RSP, BsProxyMsgIdRspGetVConnInfo, BsProxyUnpackReqGetVConnInfo(), ClientHasName(), ClientSendServerRsp(), BsModInfo_T::date, BsProxyRspGetVConnInfo_T::m_client, BsProxyRspGetVConnInfo_T::m_devuri, BsProxyModIF_T::m_fnModInfo, BsProxyVConn_T::m_hndVConn, BsProxyRspGetVConnInfo_T::m_moddate, BsProxyRspGetVConnInfo_T::m_moduri, BsProxyRspGetVConnInfo_T::m_modver, BsProxyVConn_T::m_pModIF, BsProxyVConn_T::m_pThCtl, BsProxyVConn_T::m_rd, BsProxyRspGetVConnInfo_T::m_rd, _bsproxy_th_ctl::m_sDevUri, BsProxyModIF_T::m_sModUri, BsProxyReqGetVConnInfo_T::m_vconn, BsProxyRspGetVConnInfo_T::m_vconn, VConnAcquire(), VConnRelease(), and BsModInfo_T::version.

Referenced by ServerRequest().

{
  static BsProxyMsgId_T uMsgIdRsp = BsProxyMsgIdRspGetVConnInfo;

  BsProxyReqGetVConnInfo_T  msgReq;
  BsProxyRspGetVConnInfo_T  msgRsp;
  BsProxyVConn_T           *pVConn;
  const BsModInfo_T        *pModInfo;
  int                       rc;

  //
  // Unpack client request.
  //
  rc = BsProxyUnpackReqGetVConnInfo(bufReq, uReqLen, &msgReq, bTrace);

  if( rc < 0 )
  {
    BSPROXY_SEND_NMERROR_RSP(hndClient, hndVConn, uTid, rc, "MsgId=%u", uMsgId);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Execute client request.
  //

  if( (pVConn = VConnAcquire(msgReq.m_vconn)) != NULL )
  {
    msgRsp.m_vconn  = (byte_t)pVConn->m_hndVConn;
    msgRsp.m_rd     = pVConn->m_rd;
    strcpy_s(msgRsp.m_client, BSPROXY_RSPGETVCONNINFO_CLIENT_LEN+1,
                ClientHasName(hndClient));
    strcpy_s(msgRsp.m_devuri, BSPROXY_RSPGETVCONNINFO_DEVURI_LEN+1,
                pVConn->m_pThCtl->m_sDevUri);
    strcpy_s(msgRsp.m_moduri, BSPROXY_RSPGETVCONNINFO_MODURI_LEN+1,
                pVConn->m_pModIF->m_sModUri);

    pModInfo = pVConn->m_pModIF->m_fnModInfo();

    strcpy_s(msgRsp.m_modver, BSPROXY_RSPGETVCONNINFO_MODVER_LEN+1,
                pModInfo->version);
    strcpy_s(msgRsp.m_moddate, BSPROXY_RSPGETVCONNINFO_MODDATE_LEN+1,
                pModInfo->date);

    VConnRelease(msgReq.m_vconn);
  }

  //
  // Send server response.
  //
  rc = ClientSendServerRsp(hndClient, uTid, uMsgIdRsp, &msgRsp);

  return rc;
}

static int ReqGetVConnList ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to get the list of all of the client's opened virtual connection handles.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 469 of file bsProxyRequest.c.

References BSPROXY_VCONN_MOD_MAX, BSPROXY_VCONN_MOD_MIN, BsProxyMsgIdRspGetVConnList, ClientSendServerRsp(), BsProxyRspGetVConnList_T::m_count, BsProxyVConn_T::m_hndClient, BsProxyRspGetVConnList_T::m_vconn, BsProxyRspGetVConnList_T::u, VConnAcquire(), and VConnRelease().

Referenced by ServerRequest().

{
  static BsProxyMsgId_T uMsgIdRsp = BsProxyMsgIdRspGetVConnList;

  BsProxyRspGetVConnList_T  msgRsp;
  BsProxyVConn_T           *pVConn;
  int                       n, i;
  int                       rc;

  //
  // Execute client request.
  //

  //
  // Loop through the device virtual connections.
  //
  for(i=0, n=BSPROXY_VCONN_MOD_MIN; n<=BSPROXY_VCONN_MOD_MAX; ++n)
  {
    if( (pVConn = VConnAcquire(n)) != NULL )
    {
      // pointers point to the same client allocated object
      if( pVConn->m_hndClient == hndClient )
      {
        msgRsp.m_vconn.u.m_buf[i++] = (byte_t)n;
      }
      VConnRelease(n);
    }
  }

  msgRsp.m_vconn.m_count = (size_t)i;

  //
  // Send server response.
  //
  rc = ClientSendServerRsp(hndClient, uTid, uMsgIdRsp, &msgRsp);

  return rc;
}

static int ReqGetVersion ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to get the server's version.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 261 of file bsProxyRequest.c.

References BSPROXY_RSPGETVERSION_VERSION_LEN, BsProxyMsgIdRspGetVersion, ClientSendServerRsp(), BsProxyRspGetVersion_T::m_version, PKG_TIMESTAMP, and PKG_VERSION.

Referenced by ServerRequest().

{
  static BsProxyMsgId_T uMsgIdRsp = BsProxyMsgIdRspGetVersion;

  BsProxyRspGetVersion_T  msgRsp;
  int                     rc;

  //  Get the version strings.
  sprintf_s(msgRsp.m_version, BSPROXY_RSPGETVERSION_VERSION_LEN+1,
            "bsProxy %s %s", PKG_VERSION, PKG_TIMESTAMP);

  //
  // Send server response.
  //
  rc = ClientSendServerRsp(hndClient, uTid, uMsgIdRsp, &msgRsp);

  return rc;
}

static int ReqLoopback ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to perform a loopback.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 85 of file bsProxyRequest.c.

References BS_ECODE_BAD_MSG, BSPROXY_REQLOOPBACK_CDATA_LEN, BSPROXY_RSPLOOPBACK_CDATA_LEN, BSPROXY_SEND_NMERROR_RSP, BsProxyMsgIdRspLoopback, BsProxyUnpackReqLoopback(), ClientHasName(), ClientSendServerRsp(), BsProxyReqLoopback_T::m_cdata, and BsProxyRspLoopback_T::m_cdata.

Referenced by ServerRequest().

{
  static BsProxyMsgId_T uMsgIdRsp = BsProxyMsgIdRspLoopback;

  BsProxyReqLoopback_T  msgReq;
  BsProxyRspLoopback_T  msgRsp;
  int                   rc;

  //
  // Unpack client request.
  //
  rc = BsProxyUnpackReqLoopback(bufReq, uReqLen, &msgReq, bTrace);

  if( rc < 0 )
  {
    BSPROXY_SEND_NMERROR_RSP(hndClient, hndVConn, uTid, rc, "MsgId=%u", uMsgId);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Execute client request.
  //
  msgReq.m_cdata[BSPROXY_REQLOOPBACK_CDATA_LEN] = 0;

  // print to standard error
  fprintf(stderr, "%s: %s\n", ClientHasName(hndClient), msgReq.m_cdata);

  //
  // Fill in response.
  //
  strcpy_s(msgRsp.m_cdata, BSPROXY_RSPLOOPBACK_CDATA_LEN+1, msgReq.m_cdata);

  //
  // Send server response.
  //
  rc = ClientSendServerRsp(hndClient, uTid, uMsgIdRsp, &msgRsp);

  return rc;
}

static int ReqMsgTrace ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to set server or client terminated message tracing.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 197 of file bsProxyRequest.c.

References BS_ECODE_BAD_MSG, BS_ECODE_NO_VCONN, BSPROXY_SEND_ERROR_RSP, BSPROXY_SEND_NMERROR_RSP, BSPROXY_VCONN_SERVER, BsProxyUnpackReqMsgTrace(), ClientSendOkRsp(), ClientSetTraceState(), BsProxyModIF_T::m_fnModTrace, BsProxyVConn_T::m_pModIF, BsProxyReqMsgTrace_T::m_trace, BsProxyReqMsgTrace_T::m_vconn, VConnAcquire(), and VConnRelease().

Referenced by ServerRequest().

{
  BsProxyReqMsgTrace_T  msgReq;
  BsProxyVConn_T       *pVConn;
  int                   rc;

  //
  // Unpack client request.
  //
  rc = BsProxyUnpackReqMsgTrace(bufReq, uReqLen, &msgReq, bTrace);

  if( rc < 0 )
  {
    BSPROXY_SEND_NMERROR_RSP(hndClient, hndVConn, uTid, rc, "MsgId=%u", uMsgId);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Execute client request.
  //
  if( msgReq.m_vconn == BSPROXY_VCONN_SERVER )
  {
    ClientSetTraceState(hndClient, msgReq.m_trace);
  }
  else if( (pVConn = VConnAcquire(msgReq.m_vconn)) == NULL )
  {
    BSPROXY_SEND_ERROR_RSP(hndClient, hndVConn, uTid, BS_ECODE_NO_VCONN,
        "VConn=%d", msgReq.m_vconn);
    return -BS_ECODE_NO_VCONN;
  }
  else
  {
    pVConn->m_pModIF->m_fnModTrace(msgReq.m_vconn, msgReq.m_trace);
    VConnRelease(msgReq.m_vconn);
  }

  //
  // Send server response.
  //
  return ClientSendOkRsp(hndClient, uTid);
}

static int ReqSetLogging ( BsProxyClientHnd_T  hndClient, BsVConnHnd_T  hndVConn, BsTid_T  uTid, BsMsgId_T  uMsgId, byte_t  bufReq[], size_t  uReqLen, bool_t  bTrace  )

static

Service client's request to set the server's logging level.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 147 of file bsProxyRequest.c.

References BS_ECODE_BAD_MSG, BSPROXY_SEND_NMERROR_RSP, BsProxyUnpackReqSetLogging(), ClientSendOkRsp(), and BsProxyReqSetLogging_T::m_level.

Referenced by ServerRequest().

{
  BsProxyReqSetLogging_T  msgReq;
  int                     rc;

  //
  // Unpack client request.
  //
  rc = BsProxyUnpackReqSetLogging(bufReq, uReqLen, &msgReq, bTrace);

  if( rc < 0 )
  {
    BSPROXY_SEND_NMERROR_RSP(hndClient, hndVConn, uTid, rc, "MsgId=%u", uMsgId);
    return -BS_ECODE_BAD_MSG;
  }

  //
  // Execute client request.
  //
  LOG_SET_THRESHOLD(msgReq.m_level);

  //
  // Send server response.
  //
  return ClientSendOkRsp(hndClient, uTid);
}

int ServerRequest	(	BsProxyClientHnd_T	hndClient,
		BsVConnHnd_T	hndVConn,
		BsTid_T	uTid,
		BsMsgId_T	uMsgId,
		byte_t	bufReq[],
		size_t	uReqLen
	)

Server service thread request handler.

Execution Context:

Server service thread.

Parameters

hndClient

Definition at line 610 of file bsProxyRequest.c.

References BS_ECODE_UNKNOWN_REQ, BSPROXY_SEND_ERROR_RSP, BsProxyMsgIdReqDevClose, BsProxyMsgIdReqDevOpen, BsProxyMsgIdReqGetVConnInfo, BsProxyMsgIdReqGetVConnList, BsProxyMsgIdReqGetVersion, BsProxyMsgIdReqLoopback, BsProxyMsgIdReqMsgTrace, BsProxyMsgIdReqSetLogging, ClientGetTraceState(), ReqDevClose(), ReqDevOpen(), ReqGetVConnInfo(), ReqGetVConnList(), ReqGetVersion(), ReqLoopback(), ReqMsgTrace(), and ReqSetLogging().

Referenced by ClientSetTraceState(), and ThCreateServerThread().

{
  bool_t bServerTrace = ClientGetTraceState(hndClient);

  switch( uMsgId )
  {
    case BsProxyMsgIdReqLoopback:
      return ReqLoopback(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                        bServerTrace);

    case BsProxyMsgIdReqSetLogging:
      return ReqSetLogging(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                            bServerTrace);

    case BsProxyMsgIdReqMsgTrace:
      return ReqMsgTrace(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                          bServerTrace);

    case BsProxyMsgIdReqGetVersion:
      return ReqGetVersion(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                          bServerTrace);

    case BsProxyMsgIdReqDevOpen:
      return ReqDevOpen(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                          bServerTrace);

    case BsProxyMsgIdReqDevClose:
      return ReqDevClose(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                          bServerTrace);

    case BsProxyMsgIdReqGetVConnList:
      return ReqGetVConnList(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                              bServerTrace);

    case BsProxyMsgIdReqGetVConnInfo:
      return ReqGetVConnInfo(hndClient, hndVConn, uTid, uMsgId, bufReq, uReqLen,
                              bServerTrace);

    default:
      BSPROXY_SEND_ERROR_RSP(hndClient, hndVConn, uTid, BS_ECODE_UNKNOWN_REQ,
          "MsgId=%u", uMsgId);
      return -BS_ECODE_UNKNOWN_REQ;
  }
}