slight code simplification, seeing that clear_meta(NULL) is fine
[got-portable.git] / lib / error.c
bloba983354f342d03a44ca16cbc218c0893b984f89c
1 /*
2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <sys/queue.h>
19 #include <errno.h>
20 #include <limits.h>
21 #include <stdarg.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <zlib.h>
27 #include "got_compat.h"
29 #include "got_error.h"
30 #include "got_object.h"
32 #include "got_lib_delta.h"
33 #include "got_lib_inflate.h"
34 #include "got_lib_object.h"
35 #include "got_lib_hash.h"
36 #include "got_lib_object_parse.h"
38 #ifndef nitems
39 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
40 #endif
42 #if defined(__GLIBC__)
44 * The autoconf test for strerror_r is broken in current versions
45 * of autoconf: https://savannah.gnu.org/support/?110367
47 char *__xpg_strerror_r(int, char *, size_t);
48 #define strerror_r __xpg_strerror_r
49 #endif
51 static const struct got_error got_errors[] = {
52 { GOT_ERR_OK, "no error occurred?!?" },
53 { GOT_ERR_ERRNO, "see errno" },
54 { GOT_ERR_NOT_GIT_REPO, "no git repository found" },
55 { GOT_ERR_BAD_FILETYPE, "bad file type" },
56 { GOT_ERR_BAD_PATH, "bad path" },
57 { GOT_ERR_NOT_REF, "no such reference found" },
58 { GOT_ERR_IO, "input/output error" },
59 { GOT_ERR_EOF, "unexpected end of file" },
60 { GOT_ERR_DECOMPRESSION,"decompression failed" },
61 { GOT_ERR_NO_SPACE, "buffer too small" },
62 { GOT_ERR_BAD_OBJ_HDR, "bad object header" },
63 { GOT_ERR_OBJ_TYPE, "wrong type of object" },
64 { GOT_ERR_BAD_OBJ_DATA, "bad object data" },
65 { GOT_ERR_AMBIGUOUS_ID, "ambiguous object ID" },
66 { GOT_ERR_BAD_PACKIDX, "bad pack index file" },
67 { GOT_ERR_PACKIDX_CSUM, "pack index file checksum error" },
68 { GOT_ERR_BAD_PACKFILE, "bad pack file" },
69 { GOT_ERR_NO_OBJ, "object not found" },
70 { GOT_ERR_NOT_IMPL, "feature not implemented" },
71 { GOT_ERR_OBJ_NOT_PACKED,"object is not packed" },
72 { GOT_ERR_BAD_DELTA_CHAIN,"bad delta chain" },
73 { GOT_ERR_BAD_DELTA, "bad delta" },
74 { GOT_ERR_COMPRESSION, "compression failed" },
75 { GOT_ERR_BAD_OBJ_ID_STR,"bad object id string" },
76 { GOT_ERR_WORKTREE_EXISTS,"worktree already exists" },
77 { GOT_ERR_WORKTREE_META,"bad worktree meta data" },
78 { GOT_ERR_WORKTREE_VERS,"unsupported worktree format version" },
79 { GOT_ERR_WORKTREE_BUSY,"worktree already locked" },
80 { GOT_ERR_FILE_OBSTRUCTED,"file is obstructed" },
81 { GOT_ERR_RECURSION, "recursion limit reached" },
82 { GOT_ERR_TIMEOUT, "operation timed out" },
83 { GOT_ERR_INTERRUPT, "operation interrupted" },
84 { GOT_ERR_PRIVSEP_READ, "no data received in imsg" },
85 { GOT_ERR_PRIVSEP_LEN, "unexpected amount of data received in imsg" },
86 { GOT_ERR_PRIVSEP_PIPE, "privsep peer process closed pipe" },
87 { GOT_ERR_PRIVSEP_NO_FD,"privsep file descriptor unavailable" },
88 { GOT_ERR_PRIVSEP_MSG, "received unexpected privsep message" },
89 { GOT_ERR_PRIVSEP_DIED, "unprivileged process died unexpectedly" },
90 { GOT_ERR_PRIVSEP_EXIT, "bad exit code from unprivileged process" },
91 { GOT_ERR_PACK_OFFSET, "bad offset in pack file" },
92 { GOT_ERR_OBJ_EXISTS, "object already exists" },
93 { GOT_ERR_BAD_OBJ_ID, "bad object id" },
94 { GOT_ERR_OBJECT_FORMAT, "object format not supported" },
95 { GOT_ERR_ITER_COMPLETED,"iteration completed" },
96 { GOT_ERR_RANGE, "value out of range" },
97 { GOT_ERR_EXPECTED, "expected an error but have no error" },
98 { GOT_ERR_CANCELLED, "operation in progress has been cancelled" },
99 { GOT_ERR_NO_TREE_ENTRY,"no such entry found in tree" },
100 { GOT_ERR_FILEIDX_SIG, "bad file index signature" },
101 { GOT_ERR_FILEIDX_VER, "unknown file index format version" },
102 { GOT_ERR_FILEIDX_CSUM, "bad file index checksum" },
103 { GOT_ERR_PATH_PREFIX, "worktree already contains items from a "
104 "different path prefix" },
105 { GOT_ERR_ANCESTRY, "target commit is on a different branch" },
106 { GOT_ERR_FILEIDX_BAD, "file index is corrupt" },
107 { GOT_ERR_BAD_REF_DATA, "could not parse reference data" },
108 { GOT_ERR_TREE_DUP_ENTRY,"duplicate entry in tree object" },
109 { GOT_ERR_DIR_DUP_ENTRY,"duplicate entry in directory" },
110 { GOT_ERR_NOT_WORKTREE, "no work tree found" },
111 { GOT_ERR_UUID_VERSION, "bad uuid version" },
112 { GOT_ERR_UUID_INVALID, "uuid invalid" },
113 { GOT_ERR_UUID, "uuid error" },
114 { GOT_ERR_LOCKFILE_TIMEOUT,"lockfile timeout" },
115 { GOT_ERR_BAD_REF_NAME, "bad reference name" },
116 { GOT_ERR_WORKTREE_REPO,"cannot create worktree inside a git repository" },
117 { GOT_ERR_FILE_MODIFIED,"file contains modifications" },
118 { GOT_ERR_FILE_STATUS, "file has unexpected status" },
119 { GOT_ERR_COMMIT_CONFLICT,"cannot commit file in conflicted status" },
120 { GOT_ERR_BAD_REF_TYPE, "bad reference type" },
121 { GOT_ERR_COMMIT_NO_AUTHOR,"GOT_AUTHOR environment variable is not set" },
122 { GOT_ERR_COMMIT_HEAD_CHANGED, "branch head in repository has changed "
123 "while commit was in progress" },
124 { GOT_ERR_COMMIT_OUT_OF_DATE, "work tree must be updated before these "
125 "changes can be committed" },
126 { GOT_ERR_COMMIT_MSG_EMPTY, "commit message cannot be empty" },
127 { GOT_ERR_DIR_NOT_EMPTY, "directory exists and is not empty" },
128 { GOT_ERR_COMMIT_NO_CHANGES, "no changes to commit" },
129 { GOT_ERR_BRANCH_MOVED, "work tree's head reference now points to a "
130 "different branch; new head reference and/or update -b required" },
131 { GOT_ERR_OBJ_TOO_LARGE, "object too large" },
132 { GOT_ERR_SAME_BRANCH, "commit is already contained in this branch" },
133 { GOT_ERR_ROOT_COMMIT, "specified commit has no parent commit" },
134 { GOT_ERR_MIXED_COMMITS,"work tree contains files from multiple "
135 "base commits; the entire work tree must be updated first" },
136 { GOT_ERR_CONFLICTS, "work tree contains conflicted files; these "
137 "conflicts must be resolved first" },
138 { GOT_ERR_BRANCH_EXISTS,"specified branch already exists" },
139 { GOT_ERR_MODIFIED, "work tree contains local changes; these "
140 "changes must be committed or reverted first" },
141 { GOT_ERR_NOT_REBASING, "rebase operation not in progress" },
142 { GOT_ERR_REBASE_COMMITID,"rebase commit ID mismatch" },
143 { GOT_ERR_WRONG_BRANCH, "update -b required" },
144 { GOT_ERR_REBASING, "a rebase operation is in progress in this "
145 "work tree and must be continued or aborted first" },
146 { GOT_ERR_REBASE_PATH, "cannot rebase branch which contains "
147 "changes outside of this work tree's path prefix" },
148 { GOT_ERR_NOT_HISTEDIT, "histedit operation not in progress" },
149 { GOT_ERR_EMPTY_HISTEDIT,"no commits to edit; perhaps the work tree "
150 "must be updated to an older commit first" },
151 { GOT_ERR_NO_HISTEDIT_CMD,"no histedit commands provided" },
152 { GOT_ERR_HISTEDIT_SYNTAX,"syntax error in histedit command list" },
153 { GOT_ERR_HISTEDIT_CANCEL,"histedit operation cancelled" },
154 { 95, "unused error code" },
155 { GOT_ERR_HISTEDIT_BUSY,"histedit operation is in progress in this "
156 "work tree and must be continued or aborted first" },
157 { GOT_ERR_HISTEDIT_CMD, "bad histedit command" },
158 { GOT_ERR_HISTEDIT_PATH, "cannot edit branch history which contains "
159 "changes outside of this work tree's path prefix" },
160 { GOT_ERR_PACKFILE_CSUM, "pack file checksum error" },
161 { GOT_ERR_COMMIT_BRANCH, "will not commit to a branch outside the "
162 "\"refs/heads/\" reference namespace" },
163 { GOT_ERR_FILE_STAGED, "file is staged" },
164 { GOT_ERR_STAGE_NO_CHANGE, "no changes to stage" },
165 { GOT_ERR_STAGE_CONFLICT, "cannot stage file in conflicted status" },
166 { GOT_ERR_STAGE_OUT_OF_DATE, "work tree must be updated before "
167 "changes can be staged" },
168 { GOT_ERR_FILE_NOT_STAGED, "file is not staged" },
169 { GOT_ERR_STAGED_PATHS, "work tree contains files with staged "
170 "changes; these changes must be committed or unstaged first" },
171 { GOT_ERR_PATCH_CHOICE, "invalid patch choice" },
172 { GOT_ERR_COMMIT_NO_EMAIL, "commit author's email address is required "
173 "for compatibility with Git" },
174 { GOT_ERR_TAG_EXISTS,"specified tag already exists" },
175 { GOT_ERR_GIT_REPO_FORMAT,"unknown git repository format version" },
176 { GOT_ERR_REBASE_REQUIRED,"specified branch must be rebased first" },
177 { GOT_ERR_REGEX, "regular expression error" },
178 { GOT_ERR_REF_NAME_MINUS, "reference name may not start with '-'" },
179 { GOT_ERR_GITCONFIG_SYNTAX, "gitconfig syntax error" },
180 { GOT_ERR_REBASE_OUT_OF_DATE, "work tree must be updated before it "
181 "can be used to rebase a branch" },
182 { GOT_ERR_CACHE_DUP_ENTRY, "duplicate cache entry" },
183 { GOT_ERR_FETCH_FAILED, "fetch failed" },
184 { GOT_ERR_PARSE_URI, "failed to parse uri" },
185 { GOT_ERR_BAD_PROTO, "unknown protocol" },
186 { GOT_ERR_ADDRINFO, "getaddrinfo failed" },
187 { GOT_ERR_BAD_PACKET, "bad packet received" },
188 { GOT_ERR_NO_REMOTE, "remote repository not found" },
189 { GOT_ERR_FETCH_NO_BRANCH, "could not find any branches to fetch" },
190 { GOT_ERR_FETCH_BAD_REF, "reference cannot be fetched" },
191 { GOT_ERR_TREE_ENTRY_TYPE, "unexpected tree entry type" },
192 { GOT_ERR_PARSE_CONFIG, "configuration file syntax error" },
193 { GOT_ERR_NO_CONFIG_FILE, "configuration file doesn't exit" },
194 { GOT_ERR_BAD_SYMLINK, "symbolic link points outside of paths under "
195 "version control" },
196 { GOT_ERR_GIT_REPO_EXT, "unsupported repository format extension" },
197 { GOT_ERR_CANNOT_PACK, "not enough objects to pack" },
198 { GOT_ERR_LONELY_PACKIDX, "pack index has no corresponding pack file; "
199 "pack file must be restored or 'gotadmin cleanup -p' must be run" },
200 { GOT_ERR_OBJ_CSUM, "bad object checksum" },
201 { GOT_ERR_SEND_BAD_REF, "reference cannot be sent" },
202 { GOT_ERR_SEND_FAILED, "could not send pack file" },
203 { GOT_ERR_SEND_EMPTY, "no references to send" },
204 { GOT_ERR_SEND_ANCESTRY, "branch on server has a different ancestry; either fetch changes from server and then rebase or merge local branch before sending, or ignore ancestry with send -f (can lead to data loss on server)" },
205 { GOT_ERR_CAPA_DELETE_REFS, "server cannot delete references" },
206 { GOT_ERR_SEND_DELETE_REF, "reference cannot be deleted" },
207 { GOT_ERR_SEND_TAG_EXISTS, "tag already exists on server" },
208 { GOT_ERR_NOT_MERGING, "merge operation not in progress" },
209 { GOT_ERR_MERGE_OUT_OF_DATE, "work tree must be updated before it "
210 "can be used to merge a branch" },
211 { GOT_ERR_MERGE_STAGED_PATHS, "work tree contains files with staged "
212 "changes; these changes must be unstaged before merging can "
213 "proceed" },
214 { GOT_ERR_MERGE_BUSY,"a merge operation is in progress in this "
215 "work tree and must be continued or aborted first" },
216 { GOT_ERR_MERGE_PATH, "cannot merge branch which contains "
217 "changes outside of this work tree's path prefix" },
218 { GOT_ERR_FILE_BINARY, "found a binary file instead of text" },
219 { GOT_ERR_PATCH_MALFORMED, "malformed patch" },
220 { GOT_ERR_PATCH_TRUNCATED, "patch truncated" },
221 { GOT_ERR_NO_PATCH, "no patch found" },
222 { GOT_ERR_HUNK_FAILED, "hunk failed to apply" },
223 { GOT_ERR_PATCH_FAILED, "patch failed to apply" },
224 { GOT_ERR_FILEIDX_DUP_ENTRY, "duplicate file index entry" },
225 { GOT_ERR_PIN_PACK, "could not pin pack file" },
226 { GOT_ERR_BAD_TAG_SIGNATURE, "invalid tag signature" },
227 { GOT_ERR_VERIFY_TAG_SIGNATURE, "cannot verify signature" },
228 { GOT_ERR_SIGNING_TAG, "unable to sign tag" },
229 { GOT_ERR_BAD_OPTION, "option cannot be used" },
230 { GOT_ERR_BAD_QUERYSTRING, "invalid query string" },
231 { GOT_ERR_INTEGRATE_BRANCH, "will not integrate into a reference "
232 "outside the \"refs/heads/\" reference namespace" },
233 { GOT_ERR_BAD_REQUEST, "unexpected request received" },
234 { GOT_ERR_CLIENT_ID, "unknown client identifier" },
235 { GOT_ERR_REPO_TEMPFILE, "no repository tempfile available" },
236 { GOT_ERR_REFS_PROTECTED, "reference namespace is protected" },
237 { GOT_ERR_REF_PROTECTED, "reference is protected" },
238 { GOT_ERR_REF_BUSY, "reference cannot be updated; please try again" },
239 { GOT_ERR_COMMIT_BAD_AUTHOR, "commit author formatting would "
240 "make Git unhappy" },
241 { GOT_ERR_UID, "bad user ID" },
242 { GOT_ERR_GID, "bad group ID" },
243 { GOT_ERR_NO_PROG, "command not found or not accessible" },
244 { GOT_ERR_MERGE_COMMIT_OUT_OF_DATE, "merging cannot proceed because "
245 "the work tree is no longer up-to-date; merge must be aborted "
246 "and retried" },
247 { GOT_ERR_BUNDLE_FORMAT, "unknown git bundle version" },
248 { GOT_ERR_BAD_KEYWORD, "invalid commit keyword" },
249 { GOT_ERR_UNKNOWN_CAPA, "unknown capability" },
252 static struct got_custom_error {
253 struct got_error err;
254 char msg[GOT_ERR_MAX_MSG_SIZE];
255 } custom_errors[16];
257 static struct got_custom_error *
258 get_custom_err(void)
260 static unsigned int idx;
261 return &custom_errors[(idx++) % nitems(custom_errors)];
264 const struct got_error *
265 got_error(int code)
267 size_t i;
269 for (i = 0; i < nitems(got_errors); i++) {
270 if (code == got_errors[i].code)
271 return &got_errors[i];
274 abort();
277 const struct got_error *
278 got_error_msg(int code, const char *msg)
280 struct got_custom_error *cerr = get_custom_err();
281 struct got_error *err = &cerr->err;
282 size_t i;
284 for (i = 0; i < nitems(got_errors); i++) {
285 if (code == got_errors[i].code) {
286 err->code = code;
287 strlcpy(cerr->msg, msg, sizeof(cerr->msg));
288 err->msg = cerr->msg;
289 return err;
293 abort();
296 const struct got_error *
297 got_error_from_errno(const char *prefix)
299 struct got_custom_error *cerr = get_custom_err();
300 struct got_error *err = &cerr->err;
301 char strerr[128];
303 strerror_r(errno, strerr, sizeof(strerr));
304 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", prefix, strerr);
306 err->code = GOT_ERR_ERRNO;
307 err->msg = cerr->msg;
308 return err;
311 const struct got_error *
312 got_error_from_errno2(const char *prefix, const char *prefix2)
314 struct got_custom_error *cerr = get_custom_err();
315 struct got_error *err = &cerr->err;
316 char strerr[128];
318 strerror_r(errno, strerr, sizeof(strerr));
319 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s: %s", prefix, prefix2,
320 strerr);
322 err->code = GOT_ERR_ERRNO;
323 err->msg = cerr->msg;
324 return err;
327 const struct got_error *
328 got_error_from_errno3(const char *prefix, const char *prefix2,
329 const char *prefix3)
331 struct got_custom_error *cerr = get_custom_err();
332 struct got_error *err = &cerr->err;
333 char strerr[128];
335 strerror_r(errno, strerr, sizeof(strerr));
336 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s: %s: %s", prefix,
337 prefix2, prefix3, strerr);
339 err->code = GOT_ERR_ERRNO;
340 err->msg = cerr->msg;
341 return err;
344 const struct got_error *
345 got_error_from_errno_fmt(const char *fmt, ...)
347 struct got_custom_error *cerr = get_custom_err();
348 struct got_error *err = &cerr->err;
349 char buf[PATH_MAX * 4];
350 char strerr[128];
351 va_list ap;
353 va_start(ap, fmt);
354 vsnprintf(buf, sizeof(buf), fmt, ap);
355 va_end(ap);
357 strerror_r(errno, strerr, sizeof(strerr));
358 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", buf, strerr);
360 err->code = GOT_ERR_ERRNO;
361 err->msg = cerr->msg;
362 return err;
365 const struct got_error *
366 got_error_set_errno(int code, const char *prefix)
368 errno = code;
369 return got_error_from_errno(prefix);
372 const struct got_error *
373 got_ferror(FILE *f, int code)
375 if (ferror(f))
376 return got_error_from_errno("");
377 return got_error(code);
380 const struct got_error *
381 got_error_no_obj(struct got_object_id *id)
383 char id_str[GOT_OBJECT_ID_HEX_MAXLEN];
384 char msg[sizeof("object not found") + sizeof(id_str)];
385 int ret;
387 if (!got_object_id_hex(id, id_str, sizeof(id_str)))
388 return got_error(GOT_ERR_NO_OBJ);
390 ret = snprintf(msg, sizeof(msg), "object %s not found", id_str);
391 if (ret < 0 || (size_t)ret >= sizeof(msg))
392 return got_error(GOT_ERR_NO_OBJ);
394 return got_error_msg(GOT_ERR_NO_OBJ, msg);
397 const struct got_error *
398 got_error_checksum(struct got_object_id *id)
400 char id_str[GOT_OBJECT_ID_HEX_MAXLEN];
401 char msg[sizeof("checksum failure for object ") + sizeof(id_str)];
402 int ret;
404 if (!got_object_id_hex(id, id_str, sizeof(id_str)))
405 return got_error(GOT_ERR_OBJ_CSUM);
407 ret = snprintf(msg, sizeof(msg), "checksum failure for object %s",
408 id_str);
409 if (ret < 0 || (size_t)ret >= sizeof(msg))
410 return got_error(GOT_ERR_OBJ_CSUM);
412 return got_error_msg(GOT_ERR_OBJ_CSUM, msg);
415 const struct got_error *
416 got_error_not_ref(const char *refname)
418 char msg[sizeof("reference not found") + 1004];
419 int ret;
421 ret = snprintf(msg, sizeof(msg), "reference %s not found", refname);
422 if (ret < 0 || (size_t)ret >= sizeof(msg))
423 return got_error(GOT_ERR_NOT_REF);
425 return got_error_msg(GOT_ERR_NOT_REF, msg);
428 const struct got_error *
429 got_error_uuid(uint32_t uuid_status, const char *prefix)
431 switch (uuid_status) {
432 case uuid_s_ok:
433 return NULL;
434 case uuid_s_bad_version:
435 return got_error(GOT_ERR_UUID_VERSION);
436 case uuid_s_invalid_string_uuid:
437 return got_error(GOT_ERR_UUID_INVALID);
438 case uuid_s_no_memory:
439 return got_error_set_errno(ENOMEM, prefix);
440 default:
441 return got_error(GOT_ERR_UUID);
445 const struct got_error *
446 got_error_path(const char *path, int code)
448 struct got_custom_error *cerr = get_custom_err();
449 struct got_error *err = &cerr->err;
450 size_t i;
452 for (i = 0; i < nitems(got_errors); i++) {
453 if (code == got_errors[i].code) {
454 err->code = code;
455 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", path,
456 got_errors[i].msg);
457 err->msg = cerr->msg;
458 return err;
462 abort();
465 const struct got_error *
466 got_error_fmt(int code, const char *fmt, ...)
468 struct got_custom_error *cerr = get_custom_err();
469 struct got_error *err = &cerr->err;
470 char buf[PATH_MAX * 4];
471 va_list ap;
472 size_t i;
474 va_start(ap, fmt);
475 vsnprintf(buf, sizeof(buf), fmt, ap);
476 va_end(ap);
478 for (i = 0; i < nitems(got_errors); i++) {
479 if (code == got_errors[i].code) {
480 err->code = code;
481 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", buf,
482 got_errors[i].msg);
483 err->msg = cerr->msg;
484 return err;
488 abort();
492 got_err_open_nofollow_on_symlink(void)
495 * Check whether open(2) with O_NOFOLLOW failed on a symlink.
496 * Posix mandates ELOOP and OpenBSD follows it. Others return
497 * different error codes. We carry this workaround to help the
498 * portable version a little.
500 return (errno == ELOOP
501 #ifdef EMLINK
502 || errno == EMLINK
503 #endif
504 #ifdef EFTYPE
505 || errno == EFTYPE
506 #endif