error_handling.h

Go to the documentation of this file.

// Copyright 2014 Open Source Robotics Foundation, 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.

// Note: migrated from rmw/error_handling.h in 2017-04

#ifndef RCUTILS__ERROR_HANDLING_H_
#define RCUTILS__ERROR_HANDLING_H_

#ifdef __cplusplus
extern "C"
{
#endif

#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "rcutils/allocator.h"
#include "rcutils/format_string.h"
#include "rcutils/macros.h"
#include "rcutils/types/rcutils_ret.h"
#include "rcutils/visibility_control.h"

typedef struct rcutils_error_state_t
{
  const char * message;
  const char * file;
  size_t line_number;
  rcutils_allocator_t allocator;
} rcutils_error_state_t;

// TODO(dhood): use __STDC_LIB_EXT1__ if/when supported in other implementations.
#if defined(_WIN32)
// Limit the buffer size in the `fwrite` call to give an upper bound to buffer overrun in the case
// of non-null terminated `msg`.
#define RCUTILS_SAFE_FWRITE_TO_STDERR(msg) fwrite(msg, sizeof(char), strnlen_s(msg, 4096), stderr)
#else
#define RCUTILS_SAFE_FWRITE_TO_STDERR(msg) fwrite(msg, sizeof(char), strlen(msg), stderr)
#endif


RCUTILS_PUBLIC
RCUTILS_WARN_UNUSED
rcutils_ret_t
rcutils_error_state_copy(const rcutils_error_state_t * src, rcutils_error_state_t * dst);

RCUTILS_PUBLIC
void
rcutils_error_state_fini(rcutils_error_state_t * error_state);


RCUTILS_PUBLIC
void
rcutils_set_error_state(
  const char * error_string, const char * file, size_t line_number, rcutils_allocator_t allocator);


#define RCUTILS_CHECK_ARGUMENT_FOR_NULL(argument, error_return_type, allocator) \
  RCUTILS_CHECK_FOR_NULL_WITH_MSG(argument, #argument " argument is null", \
    return error_return_type, allocator)


#define RCUTILS_CHECK_FOR_NULL_WITH_MSG(value, msg, error_statement, allocator) \
  if (NULL == value) { \
    RCUTILS_SET_ERROR_MSG(msg, allocator); \
    error_statement; \
  }


#define RCUTILS_SET_ERROR_MSG(msg, allocator) \
  rcutils_set_error_state(msg, __FILE__, __LINE__, allocator);


#define RCUTILS_SET_ERROR_MSG_WITH_FORMAT_STRING(allocator, format_string, ...) \
  do { \
    char * output_msg = NULL; \
    output_msg = rcutils_format_string(allocator, format_string, __VA_ARGS__); \
    if (output_msg) { \
      RCUTILS_SET_ERROR_MSG(output_msg, allocator); \
      allocator.deallocate(output_msg, allocator.state); \
    } else { \
      RCUTILS_SAFE_FWRITE_TO_STDERR("Failed to allocate memory for error message\n"); \
    } \
  } while (false)

RCUTILS_PUBLIC
bool
rcutils_error_is_set(void);


RCUTILS_PUBLIC
const rcutils_error_state_t *
rcutils_get_error_state(void);


RCUTILS_PUBLIC
const char *
rcutils_get_error_string(void);


RCUTILS_PUBLIC
const char *
rcutils_get_error_string_safe(void);

RCUTILS_PUBLIC
void
rcutils_reset_error(void);

#ifdef __cplusplus
}
#endif

#endif  // RCUTILS__ERROR_HANDLING_H_