msgLog.h File Reference

Go to the source code of this file.

Functions
void	msgLogInit (const char *ident)
void	msgLogCleanup (void)
void	msgLogNodeIdSet (long nodeid)
void	msgLogPidSet (long pid)
void	msgLogLocalEchoSet (int enable)
void	msgLogResetMsgCount (long count)
long	msgLogGetMsgCount ()
void	logDebugLevelSet (unsigned int level)
void	logMaxRepRateSet (long max_dt_ns)
void	logCritical (const char *fmt,...)
void	logError (const char *fmt,...)
void	logWarn (const char *fmt,...)
void	logNotice (const char *fmt,...)
void	logInfo (const char *fmt,...)
void	logDebug (unsigned int level, const char *fmt,...)

---

Function Documentation

void logCritical	(	const char *	fmt,
			...
	)

Definition at line 571 of file msgLog.c.

References logMessage().

                                       {

    va_list args;
    va_start(args, fmt);
    logMessage(LOG_CRIT, fmt, args);
    va_end(args);

} /* logCritical */

void logDebug	(	unsigned int	level,
		const char *	fmt,
			...
	)

Definition at line 667 of file msgLog.c.

References lDebugLevel, and logMessage().

                                                        {

    va_list args;

    /* 
     * Check requested level against threshold - values < 1 are
     * prohibited and reset to one to avoid situation where some
     * debug messages always get through.
     */
    if (level < 1) {
       level = 1;
    }
    if (level <= lDebugLevel) {
       va_start(args, fmt);
       logMessage(LOG_DEBUG, fmt, args);
       va_end(args);
    }

} /* logDebug */

void logDebugLevelSet

(

unsigned int

level

)

Definition at line 518 of file msgLog.c.

References lDebugLevel.

{

   lDebugLevel = level;

} /* logDebugLevelSet */

void logError	(	const char *	fmt,
			...
	)

Definition at line 590 of file msgLog.c.

References logMessage().

                                    {
    
    va_list args;
    va_start(args, fmt);
    logMessage(LOG_ERR, fmt, args);    
    va_end(args);

} /* logError */

void logInfo	(	const char *	fmt,
			...
	)

Definition at line 647 of file msgLog.c.

References logMessage().

                                   {

    va_list args;
    va_start(args, fmt);
    logMessage(LOG_INFO, fmt, args);
    va_end(args);

} /* logInfo */

void logMaxRepRateSet

(

long

max_dt_ns

)

Definition at line 498 of file msgLog.c.

References lMaxRptDt.

{
  lMaxRptDt = max_dt_ns;
}

void logNotice	(	const char *	fmt,
			...
	)

Definition at line 628 of file msgLog.c.

References logMessage().

                                     {

    va_list args;
    va_start(args, fmt);
    logMessage(LOG_NOTICE, fmt, args);
    va_end(args);

} /* logNotice */

void logWarn	(	const char *	fmt,
			...
	)

Definition at line 609 of file msgLog.c.

References logMessage().

                                   {

    va_list args;
    va_start(args, fmt);
    logMessage(LOG_WARNING, fmt, args);
    va_end(args);

} /* logWarn */

void msgLogCleanup

(

void

)

Definition at line 389 of file msgLog.c.

References lSocket.

{

#ifdef VxWorks
    /* Clean up any existing msgLogger task and message queue */
    if (lMsgLogTaskId != NULL) {
        taskDelete(lMsgLogTaskId);
        lMsgLogTaskId = NULL;
    }
    if (lMsgLogQId != NULL) {
        msgQDelete(lMsgLogQId);
        lMsgLogQId = NULL;
    }
#endif

#ifndef USESYSLOG
    /* Close the UDP socket if it is open */
    if (lSocket != 0) {
      close(lSocket);
      lSocket = 0;
    }
#endif

} /* msgLogCleanup */

long msgLogGetMsgCount

(

)

Definition at line 546 of file msgLog.c.

References mdMsgLogHeader_t::count, mdMsgLogBuffer_t::hdr, and lBuffer.

{
#ifndef USESYSLOG
#ifndef VxWorks
  return (lBuffer.hdr.count);
#endif
#else
  return -1;
#endif
} /*  msgLogResetMsgCount */

void msgLogInit

(

const char *

ident

)

Definition at line 219 of file msgLog.c.

References mdMsgLogHeader_t::count, DAQ_LOG_FACILITY, DAQ_MSG_IP, ERROR, mdMsgLogBuffer_t::hdr, lastMessageTime, lBuffer, lDebugLevel, lMsgLocalEcho, lServerAddr, lSocket, MINOS_UNIDENTIFIED_CLIENT, MSGLOG_DEFAULT_IP, MSGLOG_MAXNAME, MSGLOG_PORT, NATIVE_MSG, mdMsgLogHeader_t::nodeFrom, mdMsgLogHeader_t::pid, port, and mdMsgLogHeader_t::prcName.

{

#ifdef USESYSLOG
#ifdef VxWorks    
    /* Do nothing */
#else /* !VxWorks */
    openlog(ident, LOG_PERROR | LOG_PID, DAQ_LOG_FACILITY);
#endif /* VxWorks */

#else /* !USESYSLOG */

  const char* ip;
  const char* portenv;
  int port;
  int sockAddrSize;
  int pid;

  /*set last message time to 01/01/70
   * this way first message is always sent */
  lastMessageTime.tv_sec = 0; 
  lastMessageTime.tv_nsec = 0;

  sockAddrSize = sizeof(struct sockaddr_in);

  /* Clear socket address structure */
  bzero((char *)&lServerAddr, sockAddrSize);

  /* 
   * For VxWorks we pull the message server IP address directly from
   * the boot parameters. Otherwise, the server name/IP is resolved from
   * environment variables or falls back to the local host 
   */
#ifdef VxWorks
  {
      char bootString[BOOT_LINE_SIZE];
      BOOT_PARAMS bootParams;

      /* 
       * Get the msgLogger IP adddress from the "other" field of the boot
       * parameters
       */
      sysNvRamGet(bootString, BOOT_LINE_SIZE, 0);
      bootStringToStruct(bootString, &bootParams);
      ip = (char *)&(bootParams.other);
      port = MSGLOG_PORT;

      if ((lServerAddr.sin_addr.s_addr = inet_addr(ip)) == ERROR) {
          NATIVE_MSG("msgLogInit: bad server name from boot params: %s", ip);
          return;
      }
      pid = taskIdSelf();

      /* Clean up any existing msgLogger task and message queue */
      if (lMsgLogTaskId != NULL) {
          NATIVE_MSG("msgLogInit: deleting existing message logger task (tid=0x%x)\n", lMsgLogTaskId);
          taskDelete(lMsgLogTaskId);
          lMsgLogTaskId = NULL;
      }
      if (lMsgLogQId != NULL) {
          NATIVE_MSG("msgLogInit: deleting existing message logger queue (id=0x%x)\n", lMsgLogQId);
          msgQDelete(lMsgLogQId);
          lMsgLogQId = NULL;
      }

      /* Create the message queue for the logging task */
      lMsgLogQId = msgQCreate(MSGQ_MAX_MSGS, sizeof(mdMsgLogBuffer), MSG_Q_FIFO);
      if (lMsgLogQId == NULL) {
          NATIVE_MSG("msgLogInit: msgQCreate failed: %s", strerror(errno));
          return;
      }
      /* Spawn the message logging task */
      lMsgLogTaskId = taskSpawn("tMsgLogger", TASK_PRIORITY_MSGLOGGER, 0, 
                                TASK_SIZE_MSGLOGGER, (FUNCPTR)tMsgLogger,
                                0,0,0,0,0,0,0,0,0,0);
      if (lMsgLogTaskId == ERROR) {
          NATIVE_MSG("msgLogInit: task creation failed: %s", strerror(errno));
          return;
      }
  }
#else /* !Vxworks */
  {
      struct hostent     *host_ptr; /*the host add*/

      /* 
       * Pull the msg logger IP address and port from env vars, otherwise
       * take the default values
       */      
      ip = getenv(DAQ_MSG_IP);
      if (ip == NULL) {
          ip = MSGLOG_DEFAULT_IP;
      }
      portenv = getenv("DAQ_MSG_PORT");
      if ( portenv == NULL){
          port = MSGLOG_PORT;
      } else {
          sscanf(portenv, "%d", &port);
      }
  
      /* Resolve server hostname to address */
      host_ptr = gethostbyname(ip);
      if(!host_ptr ||host_ptr->h_addrtype != AF_INET ){
          NATIVE_MSG( "msgLogInit: bad server name/address: %s , %s",ip, strerror(errno));
          return;
      }
      memcpy(&lServerAddr.sin_addr.s_addr, host_ptr->h_addr, host_ptr->h_length);
      if(lServerAddr.sin_addr.s_addr == INADDR_NONE)
        {
          NATIVE_MSG( "msgLogInit: unresolved server address, unable to open msgLog socket\n");
          return;
        }

      /* Get current process ID */ 
      pid = getpid();
  
      /* Open syslog connection for fallback (native) messages */
      openlog(ident, LOG_PERROR | LOG_PID, DAQ_LOG_FACILITY);
  }
#endif /* VxWorks */

  /* Fill in port and type in socket address structure */
  /* lServerAddr.sin_len    = (unsigned char)sockAddrSize; */
  lServerAddr.sin_family = AF_INET;
  lServerAddr.sin_port   = htons(port);

  /* Close the old socket if it exists */
  if (lSocket != 0) {
    NATIVE_MSG("msgLogInit: closing existing message logger socket (id=0x%x)\n", lSocket);
    close(lSocket);
    lSocket = 0;
  }

  /* Create the UDP datagram socket */
  lSocket = socket(AF_INET, SOCK_DGRAM, 0);
  if(lSocket == -1) {
      NATIVE_MSG("msgLogInit: socket() failed: %s", strerror(errno));
      return;
  }
    
  /* Initialise message header */
  lBuffer.hdr.pid = pid;
  lBuffer.hdr.count = 0;
  lBuffer.hdr.nodeFrom = MINOS_UNIDENTIFIED_CLIENT;
  strncpy(lBuffer.hdr.prcName, ident, MSGLOG_MAXNAME);

  /* Set local message echoing off by default */
  lMsgLocalEcho = 0;

#endif /* USESYSLOG */
  
  /* Set default debug level to zero */
  lDebugLevel = 0;

  return;

} /* msgLogInit */

void msgLogLocalEchoSet

(

int

enable

)

Definition at line 475 of file msgLog.c.

References lMsgLocalEcho.

{
#ifdef USESYSLOG
  
#else   
  lMsgLocalEcho = enable;
#endif
  return;

} /* msgLogLocalEchoSet */

void msgLogNodeIdSet

(

long

nodeid

)

Definition at line 427 of file msgLog.c.

References mdMsgLogBuffer_t::hdr, lBuffer, and mdMsgLogHeader_t::nodeFrom.

{
#ifdef USESYSLOG
  
#else   
  lBuffer.hdr.nodeFrom = nodeId;
#endif
  return;

} /* msgLoNodeIdSet */

void msgLogPidSet

(

long

pid

)

Definition at line 451 of file msgLog.c.

References mdMsgLogBuffer_t::hdr, lBuffer, and mdMsgLogHeader_t::pid.

{
#ifdef USESYSLOG
  
#else   
  lBuffer.hdr.pid = pid;
#endif
  return;

} /* msgLogPidSet */

void msgLogResetMsgCount

(

long

count

)

Definition at line 537 of file msgLog.c.

References mdMsgLogHeader_t::count, mdMsgLogBuffer_t::hdr, and lBuffer.

{
#ifndef USESYSLOG
#ifndef VxWorks
  lBuffer.hdr.count = count;
#endif
#endif
} /*  msgLogResetMsgCount */

---