include/babeltrace2/func-status.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
   5  */
   6
   7 /* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
   8
   9 /*
  10  * No include guards here: it is safe to include this file multiple
  11  * times.
  12  */
  13
  14 #ifndef __BT_IN_BABELTRACE_H
  15 # error "Please include <babeltrace2/babeltrace.h> instead."
  16 #endif
  17
  18 /*
  19  * This is NOT part of the API.
  20  *
  21  * Do NOT use a `__BT_FUNC_STATUS_*` value in user code: this inhibits
  22  * precious type checking.
  23  */
  24
  25 /* Value is too large for the given data type */
  26 #ifndef __BT_FUNC_STATUS_OVERFLOW_ERROR
  27 # define __BT_FUNC_STATUS_OVERFLOW_ERROR        -75
  28 #endif
  29
  30 /* Memory allocation error */
  31 #ifndef __BT_FUNC_STATUS_MEMORY_ERROR
  32 # define __BT_FUNC_STATUS_MEMORY_ERROR          -12
  33 #endif
  34
  35 /* User function error */
  36 #ifndef __BT_FUNC_STATUS_USER_ERROR
  37 # define __BT_FUNC_STATUS_USER_ERROR            -2
  38 #endif
  39
  40 /* General error */
  41 #ifndef __BT_FUNC_STATUS_ERROR
  42 # define __BT_FUNC_STATUS_ERROR                 -1
  43 #endif
  44
  45 /* Saul Goodman */
  46 #ifndef __BT_FUNC_STATUS_OK
  47 # define __BT_FUNC_STATUS_OK                    0
  48 #endif
  49
  50 /* End of iteration/consumption */
  51 #ifndef __BT_FUNC_STATUS_END
  52 # define __BT_FUNC_STATUS_END                   1
  53 #endif
  54
  55 /* Something can't be found */
  56 #ifndef __BT_FUNC_STATUS_NOT_FOUND
  57 # define __BT_FUNC_STATUS_NOT_FOUND             2
  58 #endif
  59
  60 /* Object is interrupted */
  61 #ifndef __BT_FUNC_STATUS_INTERRUPTED
  62 # define __BT_FUNC_STATUS_INTERRUPTED           4
  63 #endif
  64
  65 /* No match found */
  66 #ifndef __BT_FUNC_STATUS_NO_MATCH
  67 # define __BT_FUNC_STATUS_NO_MATCH              6
  68 #endif
  69
  70 /* Try operation again later */
  71 #ifndef __BT_FUNC_STATUS_AGAIN
  72 # define __BT_FUNC_STATUS_AGAIN                 11
  73 #endif
  74
  75 /* Unknown query object */
  76 #ifndef __BT_FUNC_STATUS_UNKNOWN_OBJECT
  77 # define __BT_FUNC_STATUS_UNKNOWN_OBJECT        42
  78 #endif