include/babeltrace2/func-status.h

   1 /*
   2  * No include guards here: it is safe to include this file multiple
   3  * times.
   4  */
   5
   6 /*
   7  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  */
  27
  28 #ifndef __BT_IN_BABELTRACE_H
  29 # error "Please include <babeltrace2/babeltrace.h> instead."
  30 #endif
  31
  32 /*
  33  * This is NOT part of the API.
  34  *
  35  * Do NOT use a `__BT_FUNC_STATUS_*` value in user code: this inhibits
  36  * precious type checking.
  37  */
  38
  39 /* Value is too large for the given data type */
  40 #ifndef __BT_FUNC_STATUS_OVERFLOW
  41 # define __BT_FUNC_STATUS_OVERFLOW              -75
  42 #endif
  43
  44 /* Invalid query parameters */
  45 #ifndef __BT_FUNC_STATUS_INVALID_PARAMS
  46 # define __BT_FUNC_STATUS_INVALID_PARAMS        -24
  47 #endif
  48
  49 /* Invalid query object */
  50 #ifndef __BT_FUNC_STATUS_INVALID_OBJECT
  51 # define __BT_FUNC_STATUS_INVALID_OBJECT        -23
  52 #endif
  53
  54 /* Memory allocation error */
  55 #ifndef __BT_FUNC_STATUS_MEMORY_ERROR
  56 # define __BT_FUNC_STATUS_MEMORY_ERROR          -12
  57 #endif
  58
  59 /* General error */
  60 #ifndef __BT_FUNC_STATUS_ERROR
  61 # define __BT_FUNC_STATUS_ERROR                 -1
  62 #endif
  63
  64 /* Saul Goodman */
  65 #ifndef __BT_FUNC_STATUS_OK
  66 # define __BT_FUNC_STATUS_OK                    0
  67 #endif
  68
  69 /* End of iteration/consumption */
  70 #ifndef __BT_FUNC_STATUS_END
  71 # define __BT_FUNC_STATUS_END                   1
  72 #endif
  73
  74 /* Something can't be found */
  75 #ifndef __BT_FUNC_STATUS_NOT_FOUND
  76 # define __BT_FUNC_STATUS_NOT_FOUND             2
  77 #endif
  78
  79 /* Object is interrupted */
  80 #ifndef __BT_FUNC_STATUS_INTERRUPTED
  81 # define __BT_FUNC_STATUS_INTERRUPTED           4
  82 #endif
  83
  84 /* Try operation again later */
  85 #ifndef __BT_FUNC_STATUS_AGAIN
  86 # define __BT_FUNC_STATUS_AGAIN                 11
  87 #endif