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/macros.h"
25 #include "rcutils/time.h"
28 
29 #ifdef __cplusplus
30 extern "C"
31 {
32 #endif
33 
34 #define RCUTILS_LOGGING_SEPARATOR_CHAR '.'
35 #define RCUTILS_LOGGING_SEPARATOR_STRING "."
36 
41 #define RCUTILS_DEFAULT_LOGGER_DEFAULT_LEVEL RCUTILS_LOG_SEVERITY_INFO
42 
46 
48 
106 
108 
131 
133 
152 
155 {
157  const char * function_name;
159  const char * file_name;
161  size_t line_number;
163 
166 {
173 };
174 
177 extern const char * const g_rcutils_log_severity_names[RCUTILS_LOG_SEVERITY_FATAL + 1];
178 
180 
200  const char * severity_string, rcutils_allocator_t allocator, int * severity);
201 
203 
212  const rcutils_log_location_t *, // location
213  int, // severity
214  const char *, // name
215  rcutils_time_point_value_t, // timestamp
216  const char *, // format
217  va_list * // args
218 );
219 
223 
225 
239 
241 
254 
256 
280  const rcutils_log_location_t * location,
281  int severity, const char * name, rcutils_time_point_value_t timestamp,
282  const char * msg, rcutils_char_array_t * logging_output);
283 
285 
293 
295 
309 
311 
328 
330 
352 int rcutils_logging_get_logger_level(const char * name);
353 
355 
377 int rcutils_logging_get_logger_leveln(const char * name, size_t name_length);
378 
380 
401 rcutils_ret_t rcutils_logging_set_logger_level(const char * name, int level);
402 
404 
420 bool rcutils_logging_logger_is_enabled_for(const char * name, int severity);
421 
423 
449 int rcutils_logging_get_logger_effective_level(const char * name);
450 
452 
472 void rcutils_log(
473  const rcutils_log_location_t * location,
474  int severity,
475  const char * name,
476  const char * format,
477  ...)
479 
481 
508  const rcutils_log_location_t * location,
509  int severity, const char * name, rcutils_time_point_value_t timestamp,
510  const char * format, va_list * args);
511 
518 #define RCUTILS_LOGGING_AUTOINIT \
519  if (RCUTILS_UNLIKELY(!g_rcutils_logging_initialized)) { \
520  rcutils_ret_t ret = rcutils_logging_initialize(); \
521  if (ret != RCUTILS_RET_OK) { \
522  RCUTILS_SAFE_FWRITE_TO_STDERR( \
523  "[rcutils|" __FILE__ ":" RCUTILS_STRINGIFY(__LINE__) \
524  "] error initializing logging: "); \
525  RCUTILS_SAFE_FWRITE_TO_STDERR(rcutils_get_error_string().str); \
526  RCUTILS_SAFE_FWRITE_TO_STDERR("\n"); \
527  rcutils_reset_error(); \
528  } \
529  }
530 
531 #ifdef __cplusplus
532 }
533 #endif
534 
535 #endif // RCUTILS__LOGGING_H_
rcutils_logging_logger_is_enabled_for
bool rcutils_logging_logger_is_enabled_for(const char *name, int severity)
Determine if a logger is enabled for a severity level.
rcutils_logging_severity_level_from_string
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).
rcutils_logging_initialize_with_allocator
rcutils_ret_t rcutils_logging_initialize_with_allocator(rcutils_allocator_t allocator)
Initialize the logging system using the specified allocator.
rcutils_logging_shutdown
rcutils_ret_t rcutils_logging_shutdown(void)
Shutdown the logging system.
rcutils_logging_set_logger_level
rcutils_ret_t rcutils_logging_set_logger_level(const char *name, int level)
Set the severity level for a logger.
rcutils_logging_get_default_logger_level
int rcutils_logging_get_default_logger_level()
Get the default level for loggers.
RCUTILS_ATTRIBUTE_PRINTF_FORMAT
#define RCUTILS_ATTRIBUTE_PRINTF_FORMAT(format_string_index, first_to_check_index)
Definition: macros.h:94
RCUTILS_LOG_SEVERITY_DEBUG
@ RCUTILS_LOG_SEVERITY_DEBUG
The debug log level.
Definition: logging.h:168
rcutils_logging_initialize
rcutils_ret_t rcutils_logging_initialize(void)
Initialize the logging system.
macros.h
rcutils_log_location_t
struct rcutils_log_location_t rcutils_log_location_t
The structure identifying the caller location in the source code.
rcutils_logging_get_logger_level
int rcutils_logging_get_logger_level(const char *name)
Get the severity level for a logger.
RCUTILS_LOG_SEVERITY
RCUTILS_LOG_SEVERITY
The severity levels of log messages / loggers.
Definition: logging.h:165
rcutils_logging_set_output_handler
void rcutils_logging_set_output_handler(rcutils_logging_output_handler_t function)
Set the current output handler.
rcutils_logging_output_handler_t
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:211
g_rcutils_logging_default_logger_level
int g_rcutils_logging_default_logger_level
The default severity level for loggers.
rcutils_log_location_t::function_name
const char * function_name
The name of the function containing the log call.
Definition: logging.h:157
RCUTILS_LOG_SEVERITY_INFO
@ RCUTILS_LOG_SEVERITY_INFO
The info log level.
Definition: logging.h:169
g_rcutils_logging_initialized
bool g_rcutils_logging_initialized
The flag if the logging system has been initialized.
rcutils_logging_get_output_handler
rcutils_logging_output_handler_t rcutils_logging_get_output_handler()
Get the current output handler.
time.h
g_rcutils_logging_output_handler
rcutils_logging_output_handler_t g_rcutils_logging_output_handler
The function pointer of the current output handler.
rcutils_ret_t
int rcutils_ret_t
Definition: rcutils_ret.h:23
rcutils_logging_console_output_handler
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.
rcutils_logging_get_logger_leveln
int rcutils_logging_get_logger_leveln(const char *name, size_t name_length)
Get the level for a logger and its name length.
rcutils_logging_set_default_logger_level
void rcutils_logging_set_default_logger_level(int level)
Set the default severity level for loggers.
RCUTILS_LOG_SEVERITY_UNSET
@ RCUTILS_LOG_SEVERITY_UNSET
The unset log level.
Definition: logging.h:167
rcutils_log
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_WARN_UNUSED
#define RCUTILS_WARN_UNUSED
Definition: macros.h:24
rcutils_ret.h
rcutils_time_point_value_t
int64_t rcutils_time_point_value_t
A single point in time, measured in nanoseconds since the Unix epoch.
Definition: time.h:46
RCUTILS_LOG_SEVERITY_FATAL
@ RCUTILS_LOG_SEVERITY_FATAL
The fatal log level.
Definition: logging.h:172
visibility_control.h
error_handling.h
rcutils_log_location_t
The structure identifying the caller location in the source code.
Definition: logging.h:154
rcutils_logging_format_message
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.
rcutils_allocator_t
Encapsulation of an allocator.
Definition: allocator.h:45
allocator.h
g_rcutils_log_severity_names
const char *const g_rcutils_log_severity_names[RCUTILS_LOG_SEVERITY_FATAL+1]
The names of severity levels.
RCUTILS_PUBLIC
#define RCUTILS_PUBLIC
Definition: visibility_control.h:23
RCUTILS_LOG_SEVERITY_ERROR
@ RCUTILS_LOG_SEVERITY_ERROR
The error log level.
Definition: logging.h:171
RCUTILS_LOG_SEVERITY_WARN
@ RCUTILS_LOG_SEVERITY_WARN
The warn log level.
Definition: logging.h:170
va_list
rcutils_char_array_t
Definition: char_array.h:29
rcutils_logging_get_logger_effective_level
int rcutils_logging_get_logger_effective_level(const char *name)
Determine the effective level for a logger.
rcutils_log_location_t::line_number
size_t line_number
The line number containing the log call.
Definition: logging.h:161
rcutils_log_location_t::file_name
const char * file_name
The name of the source file containing the log call.
Definition: logging.h:159