Blob


1 /*
2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3 *
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.
7 *
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.
15 */
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_object_parse.h"
37 #ifndef nitems
38 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
39 #endif
41 #if defined(__GLIBC__)
42 /*
43 * The autoconf test for strerror_r is broken in current versions
44 * of autoconf: https://savannah.gnu.org/support/?110367
45 */
46 char *__xpg_strerror_r(int, char *, size_t);
47 #define strerror_r __xpg_strerror_r
48 #endif
50 static const struct got_error got_errors[] = {
51 { GOT_ERR_OK, "no error occured?!?" },
52 { GOT_ERR_ERRNO, "see errno" },
53 { GOT_ERR_NOT_GIT_REPO, "no git repository found" },
54 { GOT_ERR_BAD_FILETYPE, "bad file type" },
55 { GOT_ERR_BAD_PATH, "bad path" },
56 { GOT_ERR_NOT_REF, "no such reference found" },
57 { GOT_ERR_IO, "input/output error" },
58 { GOT_ERR_EOF, "unexpected end of file" },
59 { GOT_ERR_DECOMPRESSION,"decompression failed" },
60 { GOT_ERR_NO_SPACE, "buffer too small" },
61 { GOT_ERR_BAD_OBJ_HDR, "bad object header" },
62 { GOT_ERR_OBJ_TYPE, "wrong type of object" },
63 { GOT_ERR_BAD_OBJ_DATA, "bad object data" },
64 { GOT_ERR_AMBIGUOUS_ID, "ambiguous object ID" },
65 { GOT_ERR_BAD_PACKIDX, "bad pack index file" },
66 { GOT_ERR_PACKIDX_CSUM, "pack index file checksum error" },
67 { GOT_ERR_BAD_PACKFILE, "bad pack file" },
68 { GOT_ERR_NO_OBJ, "object not found" },
69 { GOT_ERR_NOT_IMPL, "feature not implemented" },
70 { GOT_ERR_OBJ_NOT_PACKED,"object is not packed" },
71 { GOT_ERR_BAD_DELTA_CHAIN,"bad delta chain" },
72 { GOT_ERR_BAD_DELTA, "bad delta" },
73 { GOT_ERR_COMPRESSION, "compression failed" },
74 { GOT_ERR_BAD_OBJ_ID_STR,"bad object id string" },
75 { GOT_ERR_WORKTREE_EXISTS,"worktree already exists" },
76 { GOT_ERR_WORKTREE_META,"bad worktree meta data" },
77 { GOT_ERR_WORKTREE_VERS,"unsupported worktree format version" },
78 { GOT_ERR_WORKTREE_BUSY,"worktree already locked" },
79 { GOT_ERR_FILE_OBSTRUCTED,"file is obstructed" },
80 { GOT_ERR_RECURSION, "recursion limit reached" },
81 { GOT_ERR_TIMEOUT, "operation timed out" },
82 { GOT_ERR_INTERRUPT, "operation interrupted" },
83 { GOT_ERR_PRIVSEP_READ, "no data received in imsg" },
84 { GOT_ERR_PRIVSEP_LEN, "unexpected amount of data received in imsg" },
85 { GOT_ERR_PRIVSEP_PIPE, "privsep peer process closed pipe" },
86 { GOT_ERR_PRIVSEP_NO_FD,"privsep file descriptor unavailable" },
87 { GOT_ERR_PRIVSEP_MSG, "received unexpected privsep message" },
88 { GOT_ERR_PRIVSEP_DIED, "unprivileged process died unexpectedly" },
89 { GOT_ERR_PRIVSEP_EXIT, "bad exit code from unprivileged process" },
90 { GOT_ERR_PACK_OFFSET, "bad offset in pack file" },
91 { GOT_ERR_OBJ_EXISTS, "object already exists" },
92 { GOT_ERR_BAD_OBJ_ID, "bad object id" },
93 { GOT_ERR_ITER_BUSY, "iteration already in progress" },
94 { GOT_ERR_ITER_COMPLETED,"iteration completed" },
95 { GOT_ERR_RANGE, "value out of range" },
96 { GOT_ERR_EXPECTED, "expected an error but have no error" },
97 { GOT_ERR_CANCELLED, "operation in progress has been cancelled" },
98 { GOT_ERR_NO_TREE_ENTRY,"no such entry found in tree" },
99 { GOT_ERR_FILEIDX_SIG, "bad file index signature" },
100 { GOT_ERR_FILEIDX_VER, "unknown file index format version" },
101 { GOT_ERR_FILEIDX_CSUM, "bad file index checksum" },
102 { GOT_ERR_PATH_PREFIX, "worktree already contains items from a "
103 "different path prefix" },
104 { GOT_ERR_ANCESTRY, "target commit is on a different branch" },
105 { GOT_ERR_FILEIDX_BAD, "file index is corrupt" },
106 { GOT_ERR_BAD_REF_DATA, "could not parse reference data" },
107 { GOT_ERR_TREE_DUP_ENTRY,"duplicate entry in tree object" },
108 { GOT_ERR_DIR_DUP_ENTRY,"duplicate entry in directory" },
109 { GOT_ERR_NOT_WORKTREE, "no got work tree found" },
110 { GOT_ERR_UUID_VERSION, "bad uuid version" },
111 { GOT_ERR_UUID_INVALID, "uuid invalid" },
112 { GOT_ERR_UUID, "uuid error" },
113 { GOT_ERR_LOCKFILE_TIMEOUT,"lockfile timeout" },
114 { GOT_ERR_BAD_REF_NAME, "bad reference name" },
115 { GOT_ERR_WORKTREE_REPO,"cannot create worktree inside a git repository" },
116 { GOT_ERR_FILE_MODIFIED,"file contains modifications" },
117 { GOT_ERR_FILE_STATUS, "file has unexpected status" },
118 { GOT_ERR_COMMIT_CONFLICT,"cannot commit file in conflicted status" },
119 { GOT_ERR_BAD_REF_TYPE, "bad reference type" },
120 { GOT_ERR_COMMIT_NO_AUTHOR,"GOT_AUTHOR environment variable is not set" },
121 { GOT_ERR_COMMIT_HEAD_CHANGED, "branch head in repository has changed "
122 "while commit was in progress" },
123 { GOT_ERR_COMMIT_OUT_OF_DATE, "work tree must be updated before these "
124 "changes can be committed" },
125 { GOT_ERR_COMMIT_MSG_EMPTY, "commit message cannot be empty" },
126 { GOT_ERR_DIR_NOT_EMPTY, "directory exists and is not empty" },
127 { GOT_ERR_COMMIT_NO_CHANGES, "no changes to commit" },
128 { GOT_ERR_BRANCH_MOVED, "work tree's head reference now points to a "
129 "different branch; new head reference and/or update -b required" },
130 { GOT_ERR_OBJ_TOO_LARGE, "object too large" },
131 { GOT_ERR_SAME_BRANCH, "commit is already contained in this branch" },
132 { GOT_ERR_ROOT_COMMIT, "specified commit has no parent commit" },
133 { GOT_ERR_MIXED_COMMITS,"work tree contains files from multiple "
134 "base commits; the entire work tree must be updated first" },
135 { GOT_ERR_CONFLICTS, "work tree contains conflicted files; these "
136 "conflicts must be resolved first" },
137 { GOT_ERR_BRANCH_EXISTS,"specified branch already exists" },
138 { GOT_ERR_MODIFIED, "work tree contains local changes; these "
139 "changes must be committed or reverted first" },
140 { GOT_ERR_NOT_REBASING, "rebase operation not in progress" },
141 { GOT_ERR_REBASE_COMMITID,"rebase commit ID mismatch" },
142 { GOT_ERR_REBASING, "a rebase operation is in progress in this "
143 "work tree and must be continued or aborted first" },
144 { GOT_ERR_REBASE_PATH, "cannot rebase branch which contains "
145 "changes outside of this work tree's path prefix" },
146 { GOT_ERR_NOT_HISTEDIT, "histedit operation not in progress" },
147 { GOT_ERR_EMPTY_HISTEDIT,"no commits to edit; perhaps the work tree "
148 "must be updated to an older commit first" },
149 { GOT_ERR_NO_HISTEDIT_CMD,"no histedit commands provided" },
150 { GOT_ERR_HISTEDIT_SYNTAX,"syntax error in histedit command list" },
151 { GOT_ERR_HISTEDIT_CANCEL,"histedit operation cancelled" },
152 { 95, "unused error code" },
153 { GOT_ERR_HISTEDIT_BUSY,"histedit operation is in progress in this "
154 "work tree and must be continued or aborted first" },
155 { GOT_ERR_HISTEDIT_CMD, "bad histedit command" },
156 { GOT_ERR_HISTEDIT_PATH, "cannot edit branch history which contains "
157 "changes outside of this work tree's path prefix" },
158 { GOT_ERR_PACKFILE_CSUM, "pack file checksum error" },
159 { GOT_ERR_COMMIT_BRANCH, "will not commit to a branch outside the "
160 "\"refs/heads/\" reference namespace" },
161 { GOT_ERR_FILE_STAGED, "file is staged" },
162 { GOT_ERR_STAGE_NO_CHANGE, "no changes to stage" },
163 { GOT_ERR_STAGE_CONFLICT, "cannot stage file in conflicted status" },
164 { GOT_ERR_STAGE_OUT_OF_DATE, "work tree must be updated before "
165 "changes can be staged" },
166 { GOT_ERR_FILE_NOT_STAGED, "file is not staged" },
167 { GOT_ERR_STAGED_PATHS, "work tree contains files with staged "
168 "changes; these changes must be committed or unstaged first" },
169 { GOT_ERR_PATCH_CHOICE, "invalid patch choice" },
170 { GOT_ERR_COMMIT_NO_EMAIL, "commit author's email address is required "
171 "for compatibility with Git" },
172 { GOT_ERR_TAG_EXISTS,"specified tag already exists" },
173 { GOT_ERR_GIT_REPO_FORMAT,"unknown git repository format version" },
174 { GOT_ERR_REBASE_REQUIRED,"specified branch must be rebased first" },
175 { GOT_ERR_REGEX, "regular expression error" },
176 { GOT_ERR_REF_NAME_MINUS, "reference name may not start with '-'" },
177 { GOT_ERR_GITCONFIG_SYNTAX, "gitconfig syntax error" },
178 { GOT_ERR_REBASE_OUT_OF_DATE, "work tree must be updated before it "
179 "can be used to rebase a branch" },
180 { GOT_ERR_CACHE_DUP_ENTRY, "duplicate cache entry" },
181 { GOT_ERR_QUERYSTRING, "bad querystring" },
182 { GOT_ERR_FETCH_FAILED, "fetch failed" },
183 { GOT_ERR_PARSE_URI, "failed to parse uri" },
184 { GOT_ERR_BAD_PROTO, "unknown protocol" },
185 { GOT_ERR_ADDRINFO, "getaddrinfo failed" },
186 { GOT_ERR_BAD_PACKET, "bad packet received" },
187 { GOT_ERR_NO_REMOTE, "remote repository not found" },
188 { GOT_ERR_FETCH_NO_BRANCH, "could not find any branches to fetch" },
189 { GOT_ERR_FETCH_BAD_REF, "reference cannot be fetched" },
190 { GOT_ERR_TREE_ENTRY_TYPE, "unexpected tree entry type" },
191 { GOT_ERR_PARSE_CONFIG, "configuration file syntax error" },
192 { GOT_ERR_NO_CONFIG_FILE, "configuration file doesn't exit" },
193 { GOT_ERR_BAD_SYMLINK, "symbolic link points outside of paths under "
194 "version control" },
195 { GOT_ERR_GIT_REPO_EXT, "unsupported repository format extension" },
196 { GOT_ERR_CANNOT_PACK, "not enough objects to pack" },
197 { GOT_ERR_LONELY_PACKIDX, "pack index has no corresponding pack file; "
198 "pack file must be restored or 'gotadmin cleanup -p' must be run" },
199 { GOT_ERR_OBJ_CSUM, "bad object checksum" },
200 { GOT_ERR_SEND_BAD_REF, "reference cannot be sent" },
201 { GOT_ERR_SEND_FAILED, "could not send pack file" },
202 { GOT_ERR_SEND_EMPTY, "no references to send" },
203 { GOT_ERR_SEND_ANCESTRY, "fetch and rebase required" },
204 { GOT_ERR_CAPA_DELETE_REFS, "server cannot delete references" },
205 { GOT_ERR_SEND_DELETE_REF, "reference cannot be deleted" },
206 { GOT_ERR_SEND_TAG_EXISTS, "tag already exists on server" },
207 { GOT_ERR_NOT_MERGING, "merge operation not in progress" },
208 { GOT_ERR_MERGE_OUT_OF_DATE, "work tree must be updated before it "
209 "can be used to merge a branch" },
210 { GOT_ERR_MERGE_STAGED_PATHS, "work tree contains files with staged "
211 "changes; these changes must be unstaged before merging can "
212 "proceed" },
213 { GOT_ERR_MERGE_COMMIT_OUT_OF_DATE, "merging cannot proceed because "
214 "the work tree is no longer up-to-date; merge must be aborted "
215 "and retried" },
216 { GOT_ERR_MERGE_BUSY,"a merge operation is in progress in this "
217 "work tree and must be continued or aborted first" },
218 { GOT_ERR_MERGE_PATH, "cannot merge branch which contains "
219 "changes outside of this work tree's path prefix" },
220 { GOT_ERR_FILE_BINARY, "found a binary file instead of text" },
221 { GOT_ERR_PATCH_MALFORMED, "malformed patch" },
222 { GOT_ERR_PATCH_TRUNCATED, "patch truncated" },
223 { GOT_ERR_NO_PATCH, "no patch found" },
224 { GOT_ERR_HUNK_FAILED, "hunk failed to apply" },
225 { GOT_ERR_PATCH_FAILED, "patch failed to apply" },
226 { GOT_ERR_FILEIDX_DUP_ENTRY, "duplicate file index entry" },
227 { GOT_ERR_PIN_PACK, "could not pin pack file" },
228 { GOT_ERR_BAD_TAG_SIGNATURE, "invalid tag signature" },
229 { GOT_ERR_VERIFY_TAG_SIGNATURE, "cannot verify signature" },
230 { GOT_ERR_SIGNING_TAG, "unable to sign tag" },
231 { GOT_ERR_BAD_QUERYSTRING, "invalid query string" },
232 { GOT_ERR_INTEGRATE_BRANCH, "will not integrate into a reference "
233 "outside the \"refs/heads/\" reference namespace" },
234 { GOT_ERR_BAD_REQUEST, "unexpected request received" },
235 { GOT_ERR_CLIENT_ID, "unknown client identifier" },
236 { GOT_ERR_REPO_TEMPFILE, "no repository tempfile available" },
237 { GOT_ERR_REFS_PROTECTED, "reference namespace is protected" },
238 { GOT_ERR_REF_PROTECTED, "reference is protected" },
239 { GOT_ERR_REF_BUSY, "reference cannot be updated; please try again" },
240 { GOT_ERR_COMMIT_BAD_AUTHOR, "commit author formatting would "
241 "make Git unhappy" },
242 { GOT_ERR_UID, "bad user ID" },
243 { GOT_ERR_GID, "bad group ID" },
244 { GOT_ERR_NO_PROG, "command not found or not accessible" },
245 };
247 static struct got_custom_error {
248 struct got_error err;
249 char msg[GOT_ERR_MAX_MSG_SIZE];
250 } custom_errors[16];
252 static struct got_custom_error *
253 get_custom_err(void)
255 static unsigned int idx;
256 return &custom_errors[(idx++) % nitems(custom_errors)];
259 const struct got_error *
260 got_error(int code)
262 size_t i;
264 for (i = 0; i < nitems(got_errors); i++) {
265 if (code == got_errors[i].code)
266 return &got_errors[i];
269 abort();
272 const struct got_error *
273 got_error_msg(int code, const char *msg)
275 struct got_custom_error *cerr = get_custom_err();
276 struct got_error *err = &cerr->err;
277 size_t i;
279 for (i = 0; i < nitems(got_errors); i++) {
280 if (code == got_errors[i].code) {
281 err->code = code;
282 strlcpy(cerr->msg, msg, sizeof(cerr->msg));
283 err->msg = cerr->msg;
284 return err;
288 abort();
291 const struct got_error *
292 got_error_from_errno(const char *prefix)
294 struct got_custom_error *cerr = get_custom_err();
295 struct got_error *err = &cerr->err;
296 char strerr[128];
298 strerror_r(errno, strerr, sizeof(strerr));
299 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", prefix, strerr);
301 err->code = GOT_ERR_ERRNO;
302 err->msg = cerr->msg;
303 return err;
306 const struct got_error *
307 got_error_from_errno2(const char *prefix, const char *prefix2)
309 struct got_custom_error *cerr = get_custom_err();
310 struct got_error *err = &cerr->err;
311 char strerr[128];
313 strerror_r(errno, strerr, sizeof(strerr));
314 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s: %s", prefix, prefix2,
315 strerr);
317 err->code = GOT_ERR_ERRNO;
318 err->msg = cerr->msg;
319 return err;
322 const struct got_error *
323 got_error_from_errno3(const char *prefix, const char *prefix2,
324 const char *prefix3)
326 struct got_custom_error *cerr = get_custom_err();
327 struct got_error *err = &cerr->err;
328 char strerr[128];
330 strerror_r(errno, strerr, sizeof(strerr));
331 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s: %s: %s", prefix,
332 prefix2, prefix3, strerr);
334 err->code = GOT_ERR_ERRNO;
335 err->msg = cerr->msg;
336 return err;
339 const struct got_error *
340 got_error_from_errno_fmt(const char *fmt, ...)
342 struct got_custom_error *cerr = get_custom_err();
343 struct got_error *err = &cerr->err;
344 char buf[PATH_MAX * 4];
345 char strerr[128];
346 va_list ap;
348 va_start(ap, fmt);
349 vsnprintf(buf, sizeof(buf), fmt, ap);
350 va_end(ap);
352 strerror_r(errno, strerr, sizeof(strerr));
353 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", buf, strerr);
355 err->code = GOT_ERR_ERRNO;
356 err->msg = cerr->msg;
357 return err;
360 const struct got_error *
361 got_error_set_errno(int code, const char *prefix)
363 errno = code;
364 return got_error_from_errno(prefix);
367 const struct got_error *
368 got_ferror(FILE *f, int code)
370 if (ferror(f))
371 return got_error_from_errno("");
372 return got_error(code);
375 const struct got_error *
376 got_error_no_obj(struct got_object_id *id)
378 char id_str[GOT_OBJECT_ID_HEX_MAXLEN];
379 char msg[sizeof("object not found") + sizeof(id_str)];
380 int ret;
382 if (!got_object_id_hex(id, id_str, sizeof(id_str)))
383 return got_error(GOT_ERR_NO_OBJ);
385 ret = snprintf(msg, sizeof(msg), "object %s not found", id_str);
386 if (ret < 0 || (size_t)ret >= sizeof(msg))
387 return got_error(GOT_ERR_NO_OBJ);
389 return got_error_msg(GOT_ERR_NO_OBJ, msg);
392 const struct got_error *
393 got_error_checksum(struct got_object_id *id)
395 char id_str[GOT_OBJECT_ID_HEX_MAXLEN];
396 char msg[sizeof("checksum failure for object ") + sizeof(id_str)];
397 int ret;
399 if (!got_object_id_hex(id, id_str, sizeof(id_str)))
400 return got_error(GOT_ERR_OBJ_CSUM);
402 ret = snprintf(msg, sizeof(msg), "checksum failure for object %s",
403 id_str);
404 if (ret < 0 || (size_t)ret >= sizeof(msg))
405 return got_error(GOT_ERR_OBJ_CSUM);
407 return got_error_msg(GOT_ERR_OBJ_CSUM, msg);
410 const struct got_error *
411 got_error_not_ref(const char *refname)
413 char msg[sizeof("reference not found") + 1004];
414 int ret;
416 ret = snprintf(msg, sizeof(msg), "reference %s not found", refname);
417 if (ret < 0 || (size_t)ret >= sizeof(msg))
418 return got_error(GOT_ERR_NOT_REF);
420 return got_error_msg(GOT_ERR_NOT_REF, msg);
423 const struct got_error *
424 got_error_uuid(uint32_t uuid_status, const char *prefix)
426 switch (uuid_status) {
427 case uuid_s_ok:
428 return NULL;
429 case uuid_s_bad_version:
430 return got_error(GOT_ERR_UUID_VERSION);
431 case uuid_s_invalid_string_uuid:
432 return got_error(GOT_ERR_UUID_INVALID);
433 case uuid_s_no_memory:
434 return got_error_set_errno(ENOMEM, prefix);
435 default:
436 return got_error(GOT_ERR_UUID);
440 const struct got_error *
441 got_error_path(const char *path, int code)
443 struct got_custom_error *cerr = get_custom_err();
444 struct got_error *err = &cerr->err;
445 size_t i;
447 for (i = 0; i < nitems(got_errors); i++) {
448 if (code == got_errors[i].code) {
449 err->code = code;
450 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", path,
451 got_errors[i].msg);
452 err->msg = cerr->msg;
453 return err;
457 abort();
460 const struct got_error *
461 got_error_fmt(int code, const char *fmt, ...)
463 struct got_custom_error *cerr = get_custom_err();
464 struct got_error *err = &cerr->err;
465 char buf[PATH_MAX * 4];
466 va_list ap;
467 size_t i;
469 va_start(ap, fmt);
470 vsnprintf(buf, sizeof(buf), fmt, ap);
471 va_end(ap);
473 for (i = 0; i < nitems(got_errors); i++) {
474 if (code == got_errors[i].code) {
475 err->code = code;
476 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", buf,
477 got_errors[i].msg);
478 err->msg = cerr->msg;
479 return err;
483 abort();
486 int
487 got_err_open_nofollow_on_symlink(void)
489 /*
490 * Check whether open(2) with O_NOFOLLOW failed on a symlink.
491 * Posix mandates ELOOP and OpenBSD follows it. Others return
492 * different error codes. We carry this workaround to help the
493 * portable version a little.
494 */
495 return (errno == ELOOP
496 #ifdef EMLINK
497 || errno == EMLINK
498 #endif
499 #ifdef EFTYPE
500 || errno == EFTYPE
501 #endif
502 );