aboutsummaryrefslogtreecommitdiffstats
path: root/VES5.0/evel/evel-library/code/evel_library/evel_logging.c
blob: 6dabc6380d288d5c74a39ec4c80e4ab19e364bad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/**************************************************************************//**
 * @file
 * Wrapper for event logging built on syslog.
 *
 * License
 * -------
 *
 * Copyright(c) <2016>, AT&T Intellectual Property.  All other rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:  This product includes
 *    software developed by the AT&T.
 * 4. Neither the name of AT&T nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY AT&T INTELLECTUAL PROPERTY ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL AT&T INTELLECTUAL PROPERTY BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *****************************************************************************/

#include <string.h>
#include <assert.h>
#include <syslog.h>
#include <stdlib.h>
#include <sys/time.h>

#include <curl/curl.h>

#include "evel.h"


/*****************************************************************************/
/* Debug settings.  Logging is done through macros so these need to be       */
/* externally visible.                                                       */
/*****************************************************************************/
EVEL_LOG_LEVELS debug_level = EVEL_LOG_DEBUG;
//static char *syslog_ident = "evel";
int debug_indent = 0;

/*****************************************************************************/
/* Buffers for error strings from this library.                              */
/*****************************************************************************/
static char evel_err_string[EVEL_MAX_ERROR_STRING_LEN] = "<NULL>";


/**************************************************************************//**
 * Initialize logging
 *
 * @param[in] level  The debugging level - one of ::EVEL_LOG_LEVELS.
 * @param[in] ident  The identifier for our logs.
 *****************************************************************************/
void log_initialize(EVEL_LOG_LEVELS level, const char * ident)
{
  assert(level < EVEL_LOG_MAX);
  assert(ident != NULL);

  debug_level = level;
  openlog(ident, LOG_PID, LOG_USER);
}

/**************************************************************************//**
 * Descriptive text for library errors.
 *
 * Return a text error string that relates to the last failure.  May be
 * "<null>" but will never be NULL.
 *
 * @returns   Text error string.
 *
 * @note      Must not be freed!
 *****************************************************************************/
const char * evel_error_string(void)
{
  return(evel_err_string);
}

/***************************************************************************//*
 * Store the formatted string into the static error string and log the error.
 *
 * @param format  Error string in standard printf format.
 * @param ...     Variable parameters to be substituted into the format string.
 *****************************************************************************/
void log_error_state(char * format, ...)
{
  va_list largs;

  assert(format != NULL);
  va_start(largs, format);
  vsnprintf(evel_err_string, EVEL_MAX_ERROR_STRING_LEN, format, largs);
  va_end(largs);
  EVEL_ERROR("%s", evel_err_string);
}


/**************************************************************************//**
 *  Generate a debug log.
 *
 *  Provides an interface to syslog with formatting of the nesting level
 *  so that it's easier to see function entry/exit.
 *
 *  @param[in]  level   The debug level - see ::EVEL_LOG_LEVELS.
 *  @param[in]  format  The output formatting in printf style.
 *  @param[in]  ...     Variable arguments as specified in the format string.
 *****************************************************************************/
void log_debug(EVEL_LOG_LEVELS level, char * format, ...)
{
  va_list largs;
  int priority;
  char indent_fmt[1024];
  char *syslog_fmt = NULL;

  /***************************************************************************/
  /* Test assumptions.                                                       */
  /***************************************************************************/
  assert(format != NULL);
  assert(level <= EVEL_LOG_MAX);

  if (level >= debug_level)
  {
    if ((debug_level == EVEL_LOG_INFO) || (debug_indent == 0))
    {
      /***********************************************************************/
      /* Just use the format as is.                                          */
      /***********************************************************************/
      syslog_fmt = format;
    }
    else
    {
      /***********************************************************************/
      /* Combine the format with a preceding number of indent markers.       */
      /***********************************************************************/
      sprintf(indent_fmt, "%.*s%s",
              debug_indent,
              INDENT_SEPARATORS,
              format);
      syslog_fmt = indent_fmt;
    }

    /*************************************************************************/
    /* Work out the syslog priority value.                                   */
    /*************************************************************************/
    switch (level)
    {
    case EVEL_LOG_ERROR:
      priority = LOG_ERR;
      break;

    case EVEL_LOG_INFO:
      priority = LOG_INFO;
      break;

    case EVEL_LOG_DEBUG:
    case EVEL_LOG_SPAMMY:
    default:
      priority = LOG_DEBUG;
      break;
    }

    /*************************************************************************/
    /* Write the log to the file next, which requires the var args list.     */
    /*************************************************************************/
    va_start(largs, format);
    vsyslog(priority, syslog_fmt, largs);
    va_end(largs);
  }
}