2 * Copyright (c) 2018, 2019, 2020 Stefan Sperling <stsp@openbsd.org>
3 * Copyright (c) 2020 Ori Bernstein <ori@openbsd.org>
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.
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.
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
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 #define GOT_ERR_EMPTY_REBASE 86
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 /* 99 is currently unused */
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 #define GOT_ERR_QUERYSTRING 117
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
150 static const struct got_error {
154 { GOT_ERR_OK, "no error occured?!?" },
155 { GOT_ERR_ERRNO, "see errno" },
156 { GOT_ERR_NOT_GIT_REPO, "no git repository found" },
157 { GOT_ERR_BAD_FILETYPE, "bad file type" },
158 { GOT_ERR_BAD_PATH, "bad path" },
159 { GOT_ERR_NOT_REF, "no such reference found" },
160 { GOT_ERR_IO, "input/output error" },
161 { GOT_ERR_EOF, "unexpected end of file" },
162 { GOT_ERR_DECOMPRESSION,"decompression failed" },
163 { GOT_ERR_NO_SPACE, "buffer too small" },
164 { GOT_ERR_BAD_OBJ_HDR, "bad object header" },
165 { GOT_ERR_OBJ_TYPE, "wrong type of object" },
166 { GOT_ERR_BAD_OBJ_DATA, "bad object data" },
167 { GOT_ERR_AMBIGUOUS_ID, "ambiguous object ID" },
168 { GOT_ERR_BAD_PACKIDX, "bad pack index file" },
169 { GOT_ERR_PACKIDX_CSUM, "pack index file checksum error" },
170 { GOT_ERR_BAD_PACKFILE, "bad pack file" },
171 { GOT_ERR_NO_OBJ, "object not found" },
172 { GOT_ERR_NOT_IMPL, "feature not implemented" },
173 { GOT_ERR_OBJ_NOT_PACKED,"object is not packed" },
174 { GOT_ERR_BAD_DELTA_CHAIN,"bad delta chain" },
175 { GOT_ERR_BAD_DELTA, "bad delta" },
176 { GOT_ERR_COMPRESSION, "compression failed" },
177 { GOT_ERR_BAD_OBJ_ID_STR,"bad object id string" },
178 { GOT_ERR_WORKTREE_EXISTS,"worktree already exists" },
179 { GOT_ERR_WORKTREE_META,"bad worktree meta data" },
180 { GOT_ERR_WORKTREE_VERS,"unsupported worktree format version" },
181 { GOT_ERR_WORKTREE_BUSY,"worktree already locked" },
182 { GOT_ERR_FILE_OBSTRUCTED,"file is obstructed" },
183 { GOT_ERR_RECURSION, "recursion limit reached" },
184 { GOT_ERR_TIMEOUT, "operation timed out" },
185 { GOT_ERR_INTERRUPT, "operation interrupted" },
186 { GOT_ERR_PRIVSEP_READ, "no data received in imsg" },
187 { GOT_ERR_PRIVSEP_LEN, "unexpected amount of data received in imsg" },
188 { GOT_ERR_PRIVSEP_PIPE, "privsep peer process closed pipe" },
189 { GOT_ERR_PRIVSEP_NO_FD,"privsep file descriptor unavailable" },
190 { GOT_ERR_PRIVSEP_MSG, "received unexpected privsep message" },
191 { GOT_ERR_PRIVSEP_DIED, "unprivileged process died unexpectedly" },
192 { GOT_ERR_PRIVSEP_EXIT, "bad exit code from unprivileged process" },
193 { GOT_ERR_PACK_OFFSET, "bad offset in pack file" },
194 { GOT_ERR_OBJ_EXISTS, "object already exists" },
195 { GOT_ERR_BAD_OBJ_ID, "bad object id" },
196 { GOT_ERR_ITER_BUSY, "iteration already in progress" },
197 { GOT_ERR_ITER_COMPLETED,"iteration completed" },
198 { GOT_ERR_RANGE, "value out of range" },
199 { GOT_ERR_EXPECTED, "expected an error but have no error" },
200 { GOT_ERR_CANCELLED, "operation in progress has been cancelled" },
201 { GOT_ERR_NO_TREE_ENTRY,"no such entry found in tree" },
202 { GOT_ERR_FILEIDX_SIG, "bad file index signature" },
203 { GOT_ERR_FILEIDX_VER, "unknown file index format version" },
204 { GOT_ERR_FILEIDX_CSUM, "bad file index checksum" },
205 { GOT_ERR_PATH_PREFIX, "worktree already contains items from a "
206 "different path prefix" },
207 { GOT_ERR_ANCESTRY, "target commit is on a different branch" },
208 { GOT_ERR_FILEIDX_BAD, "file index is corrupt" },
209 { GOT_ERR_BAD_REF_DATA, "could not parse reference data" },
210 { GOT_ERR_TREE_DUP_ENTRY,"duplicate entry in tree object" },
211 { GOT_ERR_DIR_DUP_ENTRY,"duplicate entry in directory" },
212 { GOT_ERR_NOT_WORKTREE, "no got work tree found" },
213 { GOT_ERR_UUID_VERSION, "bad uuid version" },
214 { GOT_ERR_UUID_INVALID, "uuid invalid" },
215 { GOT_ERR_UUID, "uuid error" },
216 { GOT_ERR_LOCKFILE_TIMEOUT,"lockfile timeout" },
217 { GOT_ERR_BAD_REF_NAME, "bad reference name" },
218 { GOT_ERR_WORKTREE_REPO,"cannot create worktree inside a git repository" },
219 { GOT_ERR_FILE_MODIFIED,"file contains modifications" },
220 { GOT_ERR_FILE_STATUS, "file has unexpected status" },
221 { GOT_ERR_COMMIT_CONFLICT,"cannot commit file in conflicted status" },
222 { GOT_ERR_BAD_REF_TYPE, "bad reference type" },
223 { GOT_ERR_COMMIT_NO_AUTHOR,"GOT_AUTHOR environment variable is not set" },
224 { GOT_ERR_COMMIT_HEAD_CHANGED, "branch head in repository has changed "
225 "while commit was in progress" },
226 { GOT_ERR_COMMIT_OUT_OF_DATE, "work tree must be updated before these "
227 "changes can be committed" },
228 { GOT_ERR_COMMIT_MSG_EMPTY, "commit message cannot be empty" },
229 { GOT_ERR_DIR_NOT_EMPTY, "directory exists and is not empty" },
230 { GOT_ERR_COMMIT_NO_CHANGES, "no changes to commit" },
231 { GOT_ERR_BRANCH_MOVED, "work tree's head reference now points to a "
232 "different branch; new head reference and/or update -b required" },
233 { GOT_ERR_OBJ_TOO_LARGE, "object too large" },
234 { GOT_ERR_SAME_BRANCH, "commit is already contained in this branch" },
235 { GOT_ERR_ROOT_COMMIT, "specified commit has no parent commit" },
236 { GOT_ERR_MIXED_COMMITS,"work tree contains files from multiple "
237 "base commits; the entire work tree must be updated first" },
238 { GOT_ERR_CONFLICTS, "work tree contains conflicted files; these "
239 "conflicts must be resolved first" },
240 { GOT_ERR_BRANCH_EXISTS,"specified branch already exists" },
241 { GOT_ERR_MODIFIED, "work tree contains local changes; these "
242 "changes must be committed or reverted first" },
243 { GOT_ERR_NOT_REBASING, "rebase operation not in progress" },
244 { GOT_ERR_EMPTY_REBASE, "no commits to rebase" },
245 { GOT_ERR_REBASE_COMMITID,"rebase commit ID mismatch" },
246 { GOT_ERR_REBASING, "a rebase operation is in progress in this "
247 "work tree and must be continued or aborted first" },
248 { GOT_ERR_REBASE_PATH, "cannot rebase branch which contains "
249 "changes outside of this work tree's path prefix" },
250 { GOT_ERR_NOT_HISTEDIT, "histedit operation not in progress" },
251 { GOT_ERR_EMPTY_HISTEDIT,"no commits to edit; perhaps the work tree "
252 "must be updated to an older commit first" },
253 { GOT_ERR_NO_HISTEDIT_CMD,"no histedit commands provided" },
254 { GOT_ERR_HISTEDIT_SYNTAX,"syntax error in histedit command list" },
255 { GOT_ERR_HISTEDIT_CANCEL,"histedit operation cancelled" },
256 { 95, "unused error code" },
257 { GOT_ERR_HISTEDIT_BUSY,"histedit operation is in progress in this "
258 "work tree and must be continued or aborted first" },
259 { GOT_ERR_HISTEDIT_CMD, "bad histedit command" },
260 { GOT_ERR_HISTEDIT_PATH, "cannot edit branch history which contains "
261 "changes outside of this work tree's path prefix" },
262 { 99, "unused error code" },
263 { GOT_ERR_COMMIT_BRANCH, "will not commit to a branch outside the "
264 "\"refs/heads/\" reference namespace" },
265 { GOT_ERR_FILE_STAGED, "file is staged" },
266 { GOT_ERR_STAGE_NO_CHANGE, "no changes to stage" },
267 { GOT_ERR_STAGE_CONFLICT, "cannot stage file in conflicted status" },
268 { GOT_ERR_STAGE_OUT_OF_DATE, "work tree must be updated before "
269 "changes can be staged" },
270 { GOT_ERR_FILE_NOT_STAGED, "file is not staged" },
271 { GOT_ERR_STAGED_PATHS, "work tree contains files with staged "
272 "changes; these changes must be committed or unstaged first" },
273 { GOT_ERR_PATCH_CHOICE, "invalid patch choice" },
274 { GOT_ERR_COMMIT_NO_EMAIL,"GOT_AUTHOR environment variable contains "
275 "no email address; an email address is required for compatibility "
277 { GOT_ERR_TAG_EXISTS,"specified tag already exists" },
278 { GOT_ERR_GIT_REPO_FORMAT,"unknown git repository format version" },
279 { GOT_ERR_REBASE_REQUIRED,"specified branch must be rebased first" },
280 { GOT_ERR_REGEX, "regular expression error" },
281 { GOT_ERR_REF_NAME_MINUS, "reference name may not start with '-'" },
282 { GOT_ERR_GITCONFIG_SYNTAX, "gitconfig syntax error" },
283 { GOT_ERR_REBASE_OUT_OF_DATE, "work tree must be updated before it "
284 "can be used to rebase a branch" },
285 { GOT_ERR_CACHE_DUP_ENTRY, "duplicate cache entry" },
286 { GOT_ERR_QUERYSTRING, "bad querystring" },
287 { GOT_ERR_FETCH_FAILED, "fetch failed" },
288 { GOT_ERR_PARSE_URI, "failed to parse uri" },
289 { GOT_ERR_BAD_PROTO, "unknown protocol" },
290 { GOT_ERR_ADDRINFO, "getaddrinfo failed" },
291 { GOT_ERR_BAD_PACKET, "bad packet received" },
292 { GOT_ERR_NO_REMOTE, "remote repository not found" },
293 { GOT_ERR_FETCH_NO_BRANCH, "could not find any branches to fetch" },
294 { GOT_ERR_FETCH_BAD_REF, "reference cannot be fetched" },
295 { GOT_ERR_TREE_ENTRY_TYPE, "unexpected tree entry type" },
296 { GOT_ERR_PARSE_CONFIG, "configuration file syntax error" },
297 { GOT_ERR_NO_CONFIG_FILE, "configuration file doesn't exit" },
298 { GOT_ERR_BAD_SYMLINK, "symbolic link points outside of paths under "
300 { GOT_ERR_GIT_REPO_EXT, "unsupported repository format extension" },
301 { GOT_ERR_CANNOT_PACK, "not enough objects to pack" },
305 * Get an error object from the above list, for a given error code.
306 * The error message is fixed.
308 const struct got_error *got_error(int);
311 * Get an error object from the above list, for a given error code.
312 * Use the specified error message instead of the default one.
313 * Caution: If the message buffer lives in dynamically allocated memory,
314 * then this memory likely won't be freed.
316 const struct got_error *got_error_msg(int, const char *);
319 * Get a statically allocated error object with code GOT_ERR_ERRNO
320 * and an error message obtained from strerror(3), prefixed with a
323 const struct got_error *got_error_from_errno(const char *);
326 * Get a statically allocated error object with code GOT_ERR_ERRNO
327 * and an error message obtained from strerror(3), prefixed with two
330 const struct got_error *got_error_from_errno2(const char *, const char *);
333 * Get a statically allocated error object with code GOT_ERR_ERRNO
334 * and an error message obtained from strerror(3), prefixed with three
337 const struct got_error *got_error_from_errno3(const char *, const char *,
341 * Get a statically allocated error object with code GOT_ERR_ERRNO
342 * and an error message obtained from strerror(3), prefixed with a
343 * string built with vsnprintf(3) from the provided format string
344 * and the variable-length list of additional arguments.
346 const struct got_error *got_error_from_errno_fmt(const char *, ...);
349 * Set errno to the specified error code and return a statically
350 * allocated error object with code GOT_ERR_ERRNO and an error
351 * message obtained from strerror(3), optionally prefixed with a
354 const struct got_error *got_error_set_errno(int, const char *);
357 * If ferror(3) indicates an error status for the FILE, obtain an error
358 * from got_error_from_errno(). Else, obtain the error via got_error()
359 * with the error code provided in the second argument.
361 const struct got_error *got_ferror(FILE *, int);
364 * Obtain an error with code GOT_ERR_NO_OBJ and an error message which
365 * contains the specified object ID. The message buffer is statically
366 * allocated; future invocations of this function will overwrite the
367 * message set during earlier invocations.
369 struct got_object_id; /* forward declaration */
370 const struct got_error *got_error_no_obj(struct got_object_id *);
373 * Obtain an error with code GOT_ERR_NOT_REF and an error message which
374 * contains the specified reference name. The message buffer is statically
375 * allocated; future invocations of this function will overwrite the
376 * message set during earlier invocations.
378 const struct got_error *got_error_not_ref(const char *);
380 /* Return an error based on a uuid(3) status code. */
381 const struct got_error *got_error_uuid(uint32_t, const char *);
383 /* Return an error with a path prefixed to the error message. */
384 const struct got_error *got_error_path(const char *, int);
387 * Return an error with an error message prefix built by vsnprintf(3)
388 * from the provided format string and the variable-length list of
389 * additional arguments.
391 const struct got_error *got_error_fmt(int, const char *, ...);
