2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-28 21:07:47 +00:00
ovs/lib/ovsdb-error.h
Ben Pfaff 1dd5b71d14 ovsdb: Improve error reporting for some internal errors.
Sometimes internal errors are generated based on an originating error.  In
these cases we were just throwing this information away.  This commit adds
this information to the internal error report so that the error will be
easier to track down.

I haven't actually seen a situation like this come up.
2011-03-10 11:23:59 -08:00

70 lines
2.7 KiB
C

/* Copyright (c) 2009, 2010, 2011 Nicira Networks
*
* 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.
*/
#ifndef OVSDB_ERROR_H
#define OVSDB_ERROR_H 1
#include "compiler.h"
struct json;
struct ovsdb_error *ovsdb_error(const char *tag, const char *details, ...)
PRINTF_FORMAT(2, 3)
WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_io_error(int error, const char *details, ...)
PRINTF_FORMAT(2, 3)
WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_syntax_error(const struct json *, const char *tag,
const char *details, ...)
PRINTF_FORMAT(3, 4)
WARN_UNUSED_RESULT;
struct ovsdb_error *ovsdb_wrap_error(struct ovsdb_error *error,
const char *details, ...)
PRINTF_FORMAT(2, 3);
struct ovsdb_error *ovsdb_internal_error(struct ovsdb_error *error,
const char *file, int line,
const char *details, ...)
PRINTF_FORMAT(4, 5)
WARN_UNUSED_RESULT;
/* Returns a pointer to an ovsdb_error that represents an internal error for
* the current file name and line number with MSG as the associated message.
* The caller is responsible for freeing the internal error. */
#define OVSDB_BUG(MSG) \
ovsdb_internal_error(NULL, __FILE__, __LINE__, "%s", MSG)
/* Returns a pointer to an ovsdb_error that represents an internal error for
* the current file name and line number, with MSG as the associated message.
* If ERROR is nonnull then the internal error is wrapped around ERROR. Takes
* ownership of ERROR. The caller is responsible for freeing the returned
* error. */
#define OVSDB_WRAP_BUG(MSG, ERROR) \
ovsdb_internal_error(ERROR, __FILE__, __LINE__, "%s", MSG)
void ovsdb_error_destroy(struct ovsdb_error *);
struct ovsdb_error *ovsdb_error_clone(const struct ovsdb_error *)
WARN_UNUSED_RESULT;
char *ovsdb_error_to_string(const struct ovsdb_error *);
struct json *ovsdb_error_to_json(const struct ovsdb_error *);
const char *ovsdb_error_get_tag(const struct ovsdb_error *);
void ovsdb_error_assert(struct ovsdb_error *);
#endif /* ovsdb-error.h */