lib/ovsdb-error.h

   1 /* Copyright (c) 2009, 2010, 2011, 2016, 2017 Nicira, 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
  16 #ifndef OVSDB_ERROR_H
  17 #define OVSDB_ERROR_H 1
  18
  19 #include "compiler.h"
  20
  21 struct json;
  22
  23 struct ovsdb_error *ovsdb_error(const char *tag, const char *details, ...)
  24     OVS_PRINTF_FORMAT(2, 3)
  25     OVS_WARN_UNUSED_RESULT;
  26 struct ovsdb_error *ovsdb_io_error(int error, const char *details, ...)
  27     OVS_PRINTF_FORMAT(2, 3)
  28     OVS_WARN_UNUSED_RESULT;
  29 struct ovsdb_error *ovsdb_syntax_error(const struct json *, const char *tag,
  30                                        const char *details, ...)
  31     OVS_PRINTF_FORMAT(3, 4)
  32     OVS_WARN_UNUSED_RESULT;
  33
  34 struct ovsdb_error *ovsdb_wrap_error(struct ovsdb_error *error,
  35                                      const char *details, ...)
  36     OVS_PRINTF_FORMAT(2, 3);
  37
  38 struct ovsdb_error *ovsdb_internal_error(struct ovsdb_error *error,
  39                                          const char *file, int line,
  40                                          const char *details, ...)
  41     OVS_PRINTF_FORMAT(4, 5)
  42     OVS_WARN_UNUSED_RESULT;
  43
  44 struct ovsdb_error *ovsdb_perm_error(const char *details, ...)
  45     OVS_PRINTF_FORMAT(1, 2)
  46     OVS_WARN_UNUSED_RESULT;
  47
  48 /* Returns a pointer to an ovsdb_error that represents an internal error for
  49  * the current file name and line number with MSG as the associated message.
  50  * The caller is responsible for freeing the internal error. */
  51 #define OVSDB_BUG(MSG)                                      \
  52     ovsdb_internal_error(NULL, __FILE__, __LINE__, "%s", MSG)
  53
  54 /* Returns a pointer to an ovsdb_error that represents an internal error for
  55  * the current file name and line number, with MSG as the associated message.
  56  * If ERROR is nonnull then the internal error is wrapped around ERROR.  Takes
  57  * ownership of ERROR.  The caller is responsible for freeing the returned
  58  * error. */
  59 #define OVSDB_WRAP_BUG(MSG, ERROR)                          \
  60     ovsdb_internal_error(ERROR, __FILE__, __LINE__, "%s", MSG)
  61
  62 void ovsdb_error_destroy(struct ovsdb_error *);
  63 struct ovsdb_error *ovsdb_error_clone(const struct ovsdb_error *)
  64     OVS_WARN_UNUSED_RESULT;
  65
  66 char *ovsdb_error_to_string(const struct ovsdb_error *);
  67 char *ovsdb_error_to_string_free(struct ovsdb_error *);
  68 struct json *ovsdb_error_to_json(const struct ovsdb_error *);
  69 struct json *ovsdb_error_to_json_free(struct ovsdb_error *);
  70
  71 const char *ovsdb_error_get_tag(const struct ovsdb_error *);
  72
  73 void ovsdb_error_assert(struct ovsdb_error *);
  74
  75 #endif /* ovsdb-error.h */