rcutils  master
C API providing common utilities and data structures.
logging.h
Go to the documentation of this file.
1 // Copyright 2017 Open Source Robotics Foundation, Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef RCUTILS__LOGGING_H_
16 #define RCUTILS__LOGGING_H_
17 
18 #include <stdarg.h>
19 #include <stdbool.h>
20 #include <stdio.h>
21 
22 #include "rcutils/allocator.h"
23 #include "rcutils/error_handling.h"
24 #include "rcutils/time.h"
27 
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
33 #define RCUTILS_LOGGING_SEPARATOR_CHAR '.'
34 #define RCUTILS_LOGGING_SEPARATOR_STRING "."
35 
40 #define RCUTILS_DEFAULT_LOGGER_DEFAULT_LEVEL RCUTILS_LOG_SEVERITY_INFO
41 
45 
47 
105 
107 
130 
132 
151 
154 {
156  const char * function_name;
158  const char * file_name;
160  size_t line_number;
162 
165 {
172 };
173 
176 
178 
198  const char * severity_string, rcutils_allocator_t allocator, int * severity);
199 
201 
210  const rcutils_log_location_t *, // location
211  int, // severity
212  const char *, // name
213  rcutils_time_point_value_t, // timestamp
214  const char *, // format
215  va_list * // args
216 );
217 
221 
223 
237 
239 
252 
254 
279  const rcutils_log_location_t * location,
280  int severity, const char * name, rcutils_time_point_value_t timestamp,
281  const char * msg, rcutils_char_array_t * logging_output);
282 
284 
292 
294 
308 
310 
327 
329 
351 int rcutils_logging_get_logger_level(const char * name);
352 
354 
376 int rcutils_logging_get_logger_leveln(const char * name, size_t name_length);
377 
379 
400 rcutils_ret_t rcutils_logging_set_logger_level(const char * name, int level);
401 
403 
419 bool rcutils_logging_logger_is_enabled_for(const char * name, int severity);
420 
422 
448 int rcutils_logging_get_logger_effective_level(const char * name);
449 
451 
471 void rcutils_log(
472  const rcutils_log_location_t * location,
473  int severity,
474  const char * name,
475  const char * format,
476  ...)
478 
480 
506  const rcutils_log_location_t * location,
507  int severity, const char * name, rcutils_time_point_value_t timestamp,
508  const char * format, va_list * args);
509 
510 // Provide the compiler with branch prediction information
511 #ifndef _WIN32
512 
516 # define RCUTILS_LIKELY(x) __builtin_expect((x), 1)
517 
521 # define RCUTILS_UNLIKELY(x) __builtin_expect((x), 0)
522 #else
523 
527 # define RCUTILS_LIKELY(x) (x)
528 
532 # define RCUTILS_UNLIKELY(x) (x)
533 #endif // _WIN32
534 
541 #define RCUTILS_LOGGING_AUTOINIT \
542  if (RCUTILS_UNLIKELY(!g_rcutils_logging_initialized)) { \
543  rcutils_ret_t ret = rcutils_logging_initialize(); \
544  if (ret != RCUTILS_RET_OK) { \
545  RCUTILS_SAFE_FWRITE_TO_STDERR( \
546  "[rcutils|" __FILE__ ":" RCUTILS_STRINGIFY(__LINE__) \
547  "] error initializing logging: "); \
548  RCUTILS_SAFE_FWRITE_TO_STDERR(rcutils_get_error_string().str); \
549  RCUTILS_SAFE_FWRITE_TO_STDERR("\n"); \
550  rcutils_reset_error(); \
551  } \
552  }
553 
554 #ifdef __cplusplus
555 }
556 #endif
557 
558 #endif // RCUTILS__LOGGING_H_
const char * g_rcutils_log_severity_names[RCUTILS_LOG_SEVERITY_FATAL+1]
The names of severity levels.
int rcutils_logging_get_logger_leveln(const char *name, size_t name_length)
Get the level for a logger and its name length.
rcutils_ret_t rcutils_logging_shutdown(void)
Shutdown the logging system.
rcutils_ret_t rcutils_logging_format_message(const rcutils_log_location_t *location, int severity, const char *name, rcutils_time_point_value_t timestamp, const char *msg, rcutils_char_array_t *logging_output)
Formats a log message according to RCUTILS_CONSOLE_OUTPUT_FORMAT.
Definition: char_array.h:29
The info log level.
Definition: logging.h:168
The warn log level.
Definition: logging.h:169
The unset log level.
Definition: logging.h:166
rcutils_ret_t rcutils_logging_initialize(void)
Initialize the logging system.
int rcutils_ret_t
Definition: rcutils_ret.h:23
rcutils_ret_t rcutils_logging_severity_level_from_string(const char *severity_string, rcutils_allocator_t allocator, int *severity)
Get a severity value from its string representation (e.g. DEBUG).
bool g_rcutils_logging_initialized
The flag if the logging system has been initialized.
void rcutils_logging_set_output_handler(rcutils_logging_output_handler_t function)
Set the current output handler.
int64_t rcutils_time_point_value_t
A single point in time, measured in nanoseconds since the Unix epoch.
Definition: time.h:44
size_t line_number
The line number containing the log call.
Definition: logging.h:160
#define RCUTILS_ATTRIBUTE_PRINTF_FORMAT(format_string_index, first_to_check_index)
Definition: macros.h:91
int g_rcutils_logging_default_logger_level
The default severity level for loggers.
Encapsulation of an allocator.
Definition: allocator.h:45
void rcutils_log(const rcutils_log_location_t *location, int severity, const char *name, const char *format,...) RCUTILS_ATTRIBUTE_PRINTF_FORMAT(4
Log a message.
rcutils_ret_t rcutils_logging_set_logger_level(const char *name, int level)
Set the severity level for a logger.
rcutils_logging_output_handler_t rcutils_logging_get_output_handler()
Get the current output handler.
void rcutils_logging_set_default_logger_level(int level)
Set the default severity level for loggers.
RCUTILS_LOG_SEVERITY
The severity levels of log messages / loggers.
Definition: logging.h:164
const char * file_name
The name of the source file containing the log call.
Definition: logging.h:158
The structure identifying the caller location in the source code.
Definition: logging.h:153
void void rcutils_logging_console_output_handler(const rcutils_log_location_t *location, int severity, const char *name, rcutils_time_point_value_t timestamp, const char *format, va_list *args)
The default output handler outputs log messages to the standard streams.
#define RCUTILS_WARN_UNUSED
Definition: macros.h:24
#define RCUTILS_PUBLIC
Definition: visibility_control.h:48
The fatal log level.
Definition: logging.h:171
rcutils_ret_t rcutils_logging_initialize_with_allocator(rcutils_allocator_t allocator)
Initialize the logging system using the specified allocator.
bool rcutils_logging_logger_is_enabled_for(const char *name, int severity)
Determine if a logger is enabled for a severity level.
int rcutils_logging_get_logger_effective_level(const char *name)
Determine the effective level for a logger.
struct rcutils_log_location_t rcutils_log_location_t
The structure identifying the caller location in the source code.
rcutils_logging_output_handler_t g_rcutils_logging_output_handler
The function pointer of the current output handler.
void(* rcutils_logging_output_handler_t)(const rcutils_log_location_t *, int, const char *, rcutils_time_point_value_t, const char *, va_list *)
The function signature to log messages.
Definition: logging.h:209
The debug log level.
Definition: logging.h:167
const char * function_name
The name of the function containing the log call.
Definition: logging.h:156
int rcutils_logging_get_default_logger_level()
Get the default level for loggers.
The error log level.
Definition: logging.h:170
int rcutils_logging_get_logger_level(const char *name)
Get the severity level for a logger.