include/got_error.h

   1 /*
   2  * Copyright (c) 2018, 2019, 2020 Stefan Sperling <stsp@openbsd.org>
   3  * Copyright (c) 2020 Ori Bernstein <ori@openbsd.org>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* Error codes */
  19 #define GOT_ERR_OK              0
  20 #define GOT_ERR_ERRNO           1
  21 #define GOT_ERR_NOT_GIT_REPO    2
  22 #define GOT_ERR_BAD_FILETYPE    3
  23 #define GOT_ERR_BAD_PATH        4
  24 #define GOT_ERR_NOT_REF         5
  25 #define GOT_ERR_IO              6
  26 #define GOT_ERR_EOF             7
  27 #define GOT_ERR_DECOMPRESSION   8
  28 #define GOT_ERR_NO_SPACE        9
  29 #define GOT_ERR_BAD_OBJ_HDR     10
  30 #define GOT_ERR_OBJ_TYPE        11
  31 #define GOT_ERR_BAD_OBJ_DATA    12
  32 #define GOT_ERR_AMBIGUOUS_ID    13
  33 #define GOT_ERR_BAD_PACKIDX     14
  34 #define GOT_ERR_PACKIDX_CSUM    15
  35 #define GOT_ERR_BAD_PACKFILE    16
  36 #define GOT_ERR_NO_OBJ          17
  37 #define GOT_ERR_NOT_IMPL        18
  38 #define GOT_ERR_OBJ_NOT_PACKED  19
  39 #define GOT_ERR_BAD_DELTA_CHAIN 20
  40 #define GOT_ERR_BAD_DELTA       21
  41 #define GOT_ERR_COMPRESSION     22
  42 #define GOT_ERR_BAD_OBJ_ID_STR  23
  43 #define GOT_ERR_WORKTREE_EXISTS 26
  44 #define GOT_ERR_WORKTREE_META   27
  45 #define GOT_ERR_WORKTREE_VERS   28
  46 #define GOT_ERR_WORKTREE_BUSY   29
  47 #define GOT_ERR_DIR_OBSTRUCTED  30
  48 #define GOT_ERR_FILE_OBSTRUCTED 31
  49 #define GOT_ERR_RECURSION       32
  50 #define GOT_ERR_TIMEOUT         33
  51 #define GOT_ERR_INTERRUPT       34
  52 #define GOT_ERR_PRIVSEP_READ    35
  53 #define GOT_ERR_PRIVSEP_LEN     36
  54 #define GOT_ERR_PRIVSEP_PIPE    37
  55 #define GOT_ERR_PRIVSEP_NO_FD   38
  56 #define GOT_ERR_PRIVSEP_MSG     39
  57 #define GOT_ERR_PRIVSEP_DIED    40
  58 #define GOT_ERR_PRIVSEP_EXIT    41
  59 #define GOT_ERR_PACK_OFFSET     42
  60 #define GOT_ERR_OBJ_EXISTS      43
  61 #define GOT_ERR_BAD_OBJ_ID      44
  62 #define GOT_ERR_ITER_BUSY       45
  63 #define GOT_ERR_ITER_COMPLETED  46
  64 #define GOT_ERR_RANGE           47
  65 #define GOT_ERR_EXPECTED        48 /* for use in regress tests only */
  66 #define GOT_ERR_CANCELLED       49
  67 #define GOT_ERR_NO_TREE_ENTRY   50
  68 #define GOT_ERR_FILEIDX_SIG     51
  69 #define GOT_ERR_FILEIDX_VER     52
  70 #define GOT_ERR_FILEIDX_CSUM    53
  71 #define GOT_ERR_PATH_PREFIX     54
  72 #define GOT_ERR_ANCESTRY        55
  73 #define GOT_ERR_FILEIDX_BAD     56
  74 #define GOT_ERR_BAD_REF_DATA    57
  75 #define GOT_ERR_TREE_DUP_ENTRY  58
  76 #define GOT_ERR_DIR_DUP_ENTRY   59
  77 #define GOT_ERR_NOT_WORKTREE    60
  78 #define GOT_ERR_UUID_VERSION    61
  79 #define GOT_ERR_UUID_INVALID    62
  80 #define GOT_ERR_UUID            63
  81 #define GOT_ERR_LOCKFILE_TIMEOUT 64
  82 #define GOT_ERR_BAD_REF_NAME    65
  83 #define GOT_ERR_WORKTREE_REPO   66
  84 #define GOT_ERR_FILE_MODIFIED   67
  85 #define GOT_ERR_FILE_STATUS     68
  86 #define GOT_ERR_COMMIT_CONFLICT 69
  87 #define GOT_ERR_BAD_REF_TYPE    70
  88 #define GOT_ERR_COMMIT_NO_AUTHOR 71
  89 #define GOT_ERR_COMMIT_HEAD_CHANGED 72
  90 #define GOT_ERR_COMMIT_OUT_OF_DATE 73
  91 #define GOT_ERR_COMMIT_MSG_EMPTY 74
  92 #define GOT_ERR_DIR_NOT_EMPTY   75
  93 #define GOT_ERR_COMMIT_NO_CHANGES 76
  94 #define GOT_ERR_BRANCH_MOVED    77
  95 #define GOT_ERR_OBJ_TOO_LARGE   78
  96 #define GOT_ERR_SAME_BRANCH     79
  97 #define GOT_ERR_ROOT_COMMIT     80
  98 #define GOT_ERR_MIXED_COMMITS   81
  99 #define GOT_ERR_CONFLICTS       82
 100 #define GOT_ERR_BRANCH_EXISTS   83
 101 #define GOT_ERR_MODIFIED        84
 102 #define GOT_ERR_NOT_REBASING    85
 103 /* 86 is currently unused */
 104 #define GOT_ERR_REBASE_COMMITID 87
 105 #define GOT_ERR_REBASING        88
 106 #define GOT_ERR_REBASE_PATH     89
 107 #define GOT_ERR_NOT_HISTEDIT    90
 108 #define GOT_ERR_EMPTY_HISTEDIT  91
 109 #define GOT_ERR_NO_HISTEDIT_CMD 92
 110 #define GOT_ERR_HISTEDIT_SYNTAX 93
 111 #define GOT_ERR_HISTEDIT_CANCEL 94
 112 /* 95 is currently unused */
 113 #define GOT_ERR_HISTEDIT_BUSY   96
 114 #define GOT_ERR_HISTEDIT_CMD    97
 115 #define GOT_ERR_HISTEDIT_PATH   98
 116 #define GOT_ERR_PACKFILE_CSUM   99
 117 #define GOT_ERR_COMMIT_BRANCH   100
 118 #define GOT_ERR_FILE_STAGED     101
 119 #define GOT_ERR_STAGE_NO_CHANGE 102
 120 #define GOT_ERR_STAGE_CONFLICT  103
 121 #define GOT_ERR_STAGE_OUT_OF_DATE 104
 122 #define GOT_ERR_FILE_NOT_STAGED 105
 123 #define GOT_ERR_STAGED_PATHS    106
 124 #define GOT_ERR_PATCH_CHOICE    107
 125 #define GOT_ERR_COMMIT_NO_EMAIL 108
 126 #define GOT_ERR_TAG_EXISTS      109
 127 #define GOT_ERR_GIT_REPO_FORMAT 110
 128 #define GOT_ERR_REBASE_REQUIRED 111
 129 #define GOT_ERR_REGEX           112
 130 #define GOT_ERR_REF_NAME_MINUS  113
 131 #define GOT_ERR_GITCONFIG_SYNTAX 114
 132 #define GOT_ERR_REBASE_OUT_OF_DATE 115
 133 #define GOT_ERR_CACHE_DUP_ENTRY 116
 134 /* 117 is currently unused */
 135 #define GOT_ERR_FETCH_FAILED    118
 136 #define GOT_ERR_PARSE_URI       119
 137 #define GOT_ERR_BAD_PROTO       120
 138 #define GOT_ERR_ADDRINFO        121
 139 #define GOT_ERR_BAD_PACKET      122
 140 #define GOT_ERR_NO_REMOTE       123
 141 #define GOT_ERR_FETCH_NO_BRANCH 124
 142 #define GOT_ERR_FETCH_BAD_REF   125
 143 #define GOT_ERR_TREE_ENTRY_TYPE 126
 144 #define GOT_ERR_PARSE_CONFIG    127
 145 #define GOT_ERR_NO_CONFIG_FILE  128
 146 #define GOT_ERR_BAD_SYMLINK     129
 147 #define GOT_ERR_GIT_REPO_EXT    130
 148 #define GOT_ERR_CANNOT_PACK     131
 149 #define GOT_ERR_LONELY_PACKIDX  132
 150 #define GOT_ERR_OBJ_CSUM        133
 151 #define GOT_ERR_SEND_BAD_REF    134
 152 #define GOT_ERR_SEND_FAILED     135
 153 #define GOT_ERR_SEND_EMPTY      136
 154 #define GOT_ERR_SEND_ANCESTRY   137
 155 #define GOT_ERR_CAPA_DELETE_REFS 138
 156 #define GOT_ERR_SEND_DELETE_REF 139
 157 #define GOT_ERR_SEND_TAG_EXISTS 140
 158 #define GOT_ERR_NOT_MERGING     141
 159 #define GOT_ERR_MERGE_OUT_OF_DATE 142
 160 #define GOT_ERR_MERGE_STAGED_PATHS 143
 161 #define GOT_ERR_MERGE_BUSY      144
 162 #define GOT_ERR_MERGE_PATH      145
 163 #define GOT_ERR_FILE_BINARY     146
 164 #define GOT_ERR_PATCH_MALFORMED 147
 165 #define GOT_ERR_PATCH_TRUNCATED 148
 166 #define GOT_ERR_NO_PATCH        149
 167 #define GOT_ERR_HUNK_FAILED     150
 168 #define GOT_ERR_PATCH_FAILED    151
 169 #define GOT_ERR_FILEIDX_DUP_ENTRY 152
 170 #define GOT_ERR_PIN_PACK        153
 171 #define GOT_ERR_BAD_TAG_SIGNATURE 154
 172 #define GOT_ERR_VERIFY_TAG_SIGNATURE 155
 173 #define GOT_ERR_SIGNING_TAG     156
 174 #define GOT_ERR_BAD_OPTION 157
 175 #define GOT_ERR_BAD_QUERYSTRING 158
 176 #define GOT_ERR_INTEGRATE_BRANCH 159
 177 #define GOT_ERR_BAD_REQUEST     160
 178 #define GOT_ERR_CLIENT_ID       161
 179 #define GOT_ERR_REPO_TEMPFILE   162
 180 #define GOT_ERR_REFS_PROTECTED  163
 181 #define GOT_ERR_REF_PROTECTED   164
 182 #define GOT_ERR_REF_BUSY        165
 183 #define GOT_ERR_COMMIT_BAD_AUTHOR 166
 184 #define GOT_ERR_UID             167
 185 #define GOT_ERR_GID             168
 186 #define GOT_ERR_NO_PROG         169
 187 #define GOT_ERR_MERGE_COMMIT_OUT_OF_DATE 170
 188 #define GOT_ERR_BUNDLE_FORMAT 171
 189 #define GOT_ERR_BAD_KEYWORD     172
 190
 191 struct got_error {
 192         int code;
 193         const char *msg;
 194 };
 195
 196 #define GOT_ERR_MAX_MSG_SIZE    4080 /* includes '\0' */
 197
 198 /*
 199  * Get an error object from the above list, for a given error code.
 200  * The error message is fixed.
 201  */
 202 const struct got_error *got_error(int);
 203
 204 /*
 205  * Get an error object from the above list, for a given error code.
 206  * Use the specified error message instead of the default one.
 207  * Caution: If the message buffer lives in dynamically allocated memory,
 208  * then this memory likely won't be freed.
 209  */
 210 const struct got_error *got_error_msg(int, const char *);
 211
 212 /*
 213  * Get a statically allocated error object with code GOT_ERR_ERRNO
 214  * and an error message obtained from strerror(3), prefixed with a
 215  * string.
 216  */
 217 const struct got_error *got_error_from_errno(const char *);
 218
 219 /*
 220  * Get a statically allocated error object with code GOT_ERR_ERRNO
 221  * and an error message obtained from strerror(3), prefixed with two
 222  * strings.
 223  */
 224 const struct got_error *got_error_from_errno2(const char *, const char *);
 225
 226 /*
 227  * Get a statically allocated error object with code GOT_ERR_ERRNO
 228  * and an error message obtained from strerror(3), prefixed with three
 229  * strings.
 230  */
 231 const struct got_error *got_error_from_errno3(const char *, const char *,
 232     const char *);
 233
 234 /*
 235  * Get a statically allocated error object with code GOT_ERR_ERRNO
 236  * and an error message obtained from strerror(3), prefixed with a
 237  * string built with vsnprintf(3) from the provided format string
 238  * and the variable-length list of additional arguments.
 239  */
 240 const struct got_error *got_error_from_errno_fmt(const char *, ...);
 241
 242 /*
 243  * Set errno to the specified error code and return a statically
 244  * allocated error object with code GOT_ERR_ERRNO and an error
 245  * message obtained from strerror(3), optionally prefixed with a
 246  * string.
 247  */
 248 const struct got_error *got_error_set_errno(int, const char *);
 249
 250 /*
 251  * If ferror(3) indicates an error status for the FILE, obtain an error
 252  * from got_error_from_errno(). Else, obtain the error via got_error()
 253  * with the error code provided in the second argument.
 254  */
 255 const struct got_error *got_ferror(FILE *, int);
 256
 257 /*
 258  * Obtain an error with code GOT_ERR_NO_OBJ and an error message which
 259  * contains the specified object ID. The message buffer is statically
 260  * allocated; future invocations of this function will overwrite the
 261  * message set during earlier invocations.
 262  */
 263 struct got_object_id; /* forward declaration */
 264 const struct got_error *got_error_no_obj(struct got_object_id *);
 265
 266 /*
 267  * Obtain an error with code GOT_ERR_OBJ_CSUM and an error message which
 268  * contains the specified object ID. The message buffer is statically
 269  * allocated; future invocations of this function will overwrite the
 270  * message set during earlier invocations.
 271  */
 272 const struct got_error *got_error_checksum(struct got_object_id *);
 273
 274 /*
 275  * Obtain an error with code GOT_ERR_NOT_REF and an error message which
 276  * contains the specified reference name. The message buffer is statically
 277  * allocated; future invocations of this function will overwrite the
 278  * message set during earlier invocations.
 279  */
 280 const struct got_error *got_error_not_ref(const char *);
 281
 282 /* Return an error based on a uuid(3) status code. */
 283 const struct got_error *got_error_uuid(uint32_t, const char *);
 284
 285 /* Return an error with a path prefixed to the error message. */
 286 const struct got_error *got_error_path(const char *, int);
 287
 288 /*
 289  * Return an error with an error message prefix built by vsnprintf(3)
 290  * from the provided format string and the variable-length list of
 291  * additional arguments.
 292 */
 293 const struct got_error *got_error_fmt(int, const char *, ...)
 294         __attribute__((__format__ (printf, 2, 3)));
 295
 296 /*
 297  * Check whether open(2) with O_NOFOLLOW failed on a symlink.
 298  * This must be called directly after open(2) because it uses errno!
 299  */
 300 int got_err_open_nofollow_on_symlink(void);