lwpa_log.h

/******************************************************************************
 * Copyright 2018 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of lwpa. For more information, go to:
 * https://github.com/ETCLabs/lwpa
 ******************************************************************************/
 
/* lwpa_log.h: Common logging functions. */
#ifndef _LWPA_LOG_H_
#define _LWPA_LOG_H_
 
#include <stdarg.h>
#include <stddef.h>
#include "lwpa_bool.h"
 
/* clang-format off */
 
#define LWPA_LOG_KERN (0 << 3)      
#define LWPA_LOG_USER (1 << 3)      
#define LWPA_LOG_MAIL (2 << 3)      
#define LWPA_LOG_DAEMON (3 << 3)    
#define LWPA_LOG_AUTH (4 << 3)      
#define LWPA_LOG_SYSLOG (5 << 3)    
#define LWPA_LOG_LPR (6 << 3)       
#define LWPA_LOG_NEWS (7 << 3)      
#define LWPA_LOG_UUCP (8 << 3)      
#define LWPA_LOG_CRON (9 << 3)      
#define LWPA_LOG_AUTHPRIV (10 << 3) 
#define LWPA_LOG_FTP (11 << 3)      
#define LWPA_LOG_LOCAL0 (16 << 3) 
#define LWPA_LOG_LOCAL1 (17 << 3) 
#define LWPA_LOG_LOCAL2 (18 << 3) 
#define LWPA_LOG_LOCAL3 (19 << 3) 
#define LWPA_LOG_LOCAL4 (20 << 3) 
#define LWPA_LOG_LOCAL5 (21 << 3) 
#define LWPA_LOG_LOCAL6 (22 << 3) 
#define LWPA_LOG_LOCAL7 (23 << 3) 
#define LWPA_LOG_NFACILITIES 24 
#define LWPA_LOG_FACMASK 0x03f8 /* Mask to extract facility part of a
                                   prival. */
#define LWPA_LOG_FAC(p) (((p)&LWPA_LOG_FACMASK) >> 3)
 
#define LWPA_LOG_EMERG 0   
#define LWPA_LOG_ALERT 1   
#define LWPA_LOG_CRIT 2    
#define LWPA_LOG_ERR 3     
#define LWPA_LOG_WARNING 4 
#define LWPA_LOG_NOTICE 5  
#define LWPA_LOG_INFO 6    
#define LWPA_LOG_DEBUG 7   
#define LWPA_LOG_PRIMASK 0x07 /* mask to extract priority part (internal) */
#define LWPA_LOG_PRI(p) ((p)&LWPA_LOG_PRIMASK) /* extract priority */
#define LWPA_LOG_MAKEPRI(fac, pri) (((fac) << 3) | (pri))
 
#define LWPA_LOG_MASK(pri) (1 << (pri)) /* mask for one priority */
#define LWPA_LOG_UPTO(pri) \
  ((1 << ((pri) + 1)) - 1) /* all priorities through pri */
 
#define LWPA_LOG_HOSTNAME_MAX_LEN 256 
#define LWPA_LOG_APP_NAME_MAX_LEN 49  
#define LWPA_LOG_PROCID_MAX_LEN 129   
#define LWPA_LOG_MSG_MAX_LEN 480
 
/* clang-format on */
 
#define LWPA_LOG_TIMESTAMP_LEN (10 /*Date*/ + 1 /*T*/ + 12 /*Time*/ + 6 /*Offset*/ + 1 /*Nullterm*/)
 
#define LWPA_SYSLOG_HEADER_MAX_LEN                                                                   \
  (5 /*PRIVAL*/ + 3 /*Version*/ + 1 /*SP*/ + (LWPA_LOG_TIMESTAMP_LEN - 1) /*Timestamp*/ + 1 /*SP*/ + \
   (LWPA_LOG_HOSTNAME_MAX_LEN - 1) + 1 /*SP*/ + (LWPA_LOG_APP_NAME_MAX_LEN - 1) + 1 /*SP*/ +         \
   (LWPA_LOG_PROCID_MAX_LEN - 1) + 1 /*SP*/ + 1 /*MSGID*/ + 1 /*SP*/ + 1 /*STRUCTURED-DATA*/ + 1 /*SP*/)
 
#define LWPA_SYSLOG_STR_MIN_LEN LWPA_SYSLOG_HEADER_MAX_LEN
#define LWPA_HUMAN_LOG_STR_MIN_LEN LWPA_LOG_TIMESTAMP_LEN
 
#define LWPA_SYSLOG_STR_MAX_LEN (LWPA_SYSLOG_HEADER_MAX_LEN + LWPA_LOG_MSG_MAX_LEN)
 
#define LWPA_HUMAN_LOG_STR_MAX_LEN ((LWPA_LOG_TIMESTAMP_LEN - 1) + 1 /*SP*/ + LWPA_LOG_MSG_MAX_LEN)
 
typedef struct LwpaLogTimeParams
{
  int year;
  int month;
  int day;
  int hour;
  int minute;
  int second;
  int msec;
  int utc_offset;
} LwpaLogTimeParams;
 
typedef void (*lwpa_log_callback)(void *context, const char *syslog_str, const char *human_str, const char *raw_str);
 
typedef void (*lwpa_log_time_fn)(void *context, LwpaLogTimeParams *time_params);
 
typedef enum
{
  kLwpaLogCreateSyslog,
  kLwpaLogCreateHumanReadableLog,
  kLwpaLogCreateBoth
} lwpa_log_action_t;
 
typedef struct LwpaSyslogParams
{
  int facility;
  char hostname[LWPA_LOG_HOSTNAME_MAX_LEN];
  char app_name[LWPA_LOG_APP_NAME_MAX_LEN];
  char procid[LWPA_LOG_PROCID_MAX_LEN];
} LwpaSyslogParams;
 
typedef struct LwpaLogParams
{
  lwpa_log_action_t action;
  lwpa_log_callback log_fn;
  LwpaSyslogParams syslog_params;
  int log_mask;
  lwpa_log_time_fn time_fn;
  void *context;
} LwpaLogParams;
 
#define lwpa_setlogmask(logparamsptr, newlogmask) ((logparamsptr)->log_mask = newlogmask)
 
#define lwpa_canlog(logparamsptr, pri) ((LWPA_LOG_MASK(pri) & (logparamsptr)->log_mask) != 0)
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* The various compiler ifdefs are to use each compiler's method of checking printf-style
 * arguments. */
 
#ifdef __ICCARM__
#pragma __printf_args
#endif
bool lwpa_create_syslog_str(char *buf, size_t buflen, const LwpaLogTimeParams *time,
                            const LwpaSyslogParams *syslog_params, int pri, const char *format, ...)
#ifdef __GNUC__
    __attribute__((__format__(__printf__, 6, 7)))
#endif
    ;
 
#ifdef __ICCARM__
#pragma __printf_args
#endif
bool lwpa_create_human_log_str(char *buf, size_t buflen, const LwpaLogTimeParams *time, const char *format, ...)
#ifdef __GNUC__
    __attribute__((__format__(__printf__, 4, 5)))
#endif
    ;
 
void lwpa_sanitize_syslog_params(LwpaSyslogParams *params);
bool lwpa_validate_log_params(LwpaLogParams *params);
 
#ifdef __ICCARM__
#pragma __printf_args
#endif
void lwpa_log(const LwpaLogParams *params, int pri, const char *format, ...)
#ifdef __GNUC__
    __attribute__((__format__(__printf__, 3, 4)))
#endif
    ;
 
void lwpa_vlog(const LwpaLogParams *params, int pri, const char *format, va_list args);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _LWPA_LOG_H_ */