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>
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_sha1.h"
38 #define nitems(_a) (sizeof(_a) / sizeof((_a)[0]))
41 static const struct got_error got_errors[] = {
42 { GOT_ERR_OK, "no error occured?!?" },
43 { GOT_ERR_ERRNO, "see errno" },
44 { GOT_ERR_NOT_GIT_REPO, "no git repository found" },
45 { GOT_ERR_BAD_FILETYPE, "bad file type" },
46 { GOT_ERR_BAD_PATH, "bad path" },
47 { GOT_ERR_NOT_REF, "no such reference found" },
48 { GOT_ERR_IO, "input/output error" },
49 { GOT_ERR_EOF, "unexpected end of file" },
50 { GOT_ERR_DECOMPRESSION,"decompression failed" },
51 { GOT_ERR_NO_SPACE, "buffer too small" },
52 { GOT_ERR_BAD_OBJ_HDR, "bad object header" },
53 { GOT_ERR_OBJ_TYPE, "wrong type of object" },
54 { GOT_ERR_BAD_OBJ_DATA, "bad object data" },
55 { GOT_ERR_AMBIGUOUS_ID, "ambiguous object ID" },
56 { GOT_ERR_BAD_PACKIDX, "bad pack index file" },
57 { GOT_ERR_PACKIDX_CSUM, "pack index file checksum error" },
58 { GOT_ERR_BAD_PACKFILE, "bad pack file" },
59 { GOT_ERR_NO_OBJ, "object not found" },
60 { GOT_ERR_NOT_IMPL, "feature not implemented" },
61 { GOT_ERR_OBJ_NOT_PACKED,"object is not packed" },
62 { GOT_ERR_BAD_DELTA_CHAIN,"bad delta chain" },
63 { GOT_ERR_BAD_DELTA, "bad delta" },
64 { GOT_ERR_COMPRESSION, "compression failed" },
65 { GOT_ERR_BAD_OBJ_ID_STR,"bad object id string" },
66 { GOT_ERR_WORKTREE_EXISTS,"worktree already exists" },
67 { GOT_ERR_WORKTREE_META,"bad worktree meta data" },
68 { GOT_ERR_WORKTREE_VERS,"unsupported worktree format version" },
69 { GOT_ERR_WORKTREE_BUSY,"worktree already locked" },
70 { GOT_ERR_FILE_OBSTRUCTED,"file is obstructed" },
71 { GOT_ERR_RECURSION, "recursion limit reached" },
72 { GOT_ERR_TIMEOUT, "operation timed out" },
73 { GOT_ERR_INTERRUPT, "operation interrupted" },
74 { GOT_ERR_PRIVSEP_READ, "no data received in imsg" },
75 { GOT_ERR_PRIVSEP_LEN, "unexpected amount of data received in imsg" },
76 { GOT_ERR_PRIVSEP_PIPE, "privsep peer process closed pipe" },
77 { GOT_ERR_PRIVSEP_NO_FD,"privsep file descriptor unavailable" },
78 { GOT_ERR_PRIVSEP_MSG, "received unexpected privsep message" },
79 { GOT_ERR_PRIVSEP_DIED, "unprivileged process died unexpectedly" },
80 { GOT_ERR_PRIVSEP_EXIT, "bad exit code from unprivileged process" },
81 { GOT_ERR_PACK_OFFSET, "bad offset in pack file" },
82 { GOT_ERR_OBJ_EXISTS, "object already exists" },
83 { GOT_ERR_BAD_OBJ_ID, "bad object id" },
84 { GOT_ERR_ITER_BUSY, "iteration already in progress" },
85 { GOT_ERR_ITER_COMPLETED,"iteration completed" },
86 { GOT_ERR_RANGE, "value out of range" },
87 { GOT_ERR_EXPECTED, "expected an error but have no error" },
88 { GOT_ERR_CANCELLED, "operation in progress has been cancelled" },
89 { GOT_ERR_NO_TREE_ENTRY,"no such entry found in tree" },
90 { GOT_ERR_FILEIDX_SIG, "bad file index signature" },
91 { GOT_ERR_FILEIDX_VER, "unknown file index format version" },
92 { GOT_ERR_FILEIDX_CSUM, "bad file index checksum" },
93 { GOT_ERR_PATH_PREFIX, "worktree already contains items from a "
94 "different path prefix" },
95 { GOT_ERR_ANCESTRY, "target commit is on a different branch" },
96 { GOT_ERR_FILEIDX_BAD, "file index is corrupt" },
97 { GOT_ERR_BAD_REF_DATA, "could not parse reference data" },
98 { GOT_ERR_TREE_DUP_ENTRY,"duplicate entry in tree object" },
99 { GOT_ERR_DIR_DUP_ENTRY,"duplicate entry in directory" },
100 { GOT_ERR_NOT_WORKTREE, "no got work tree found" },
101 { GOT_ERR_UUID_VERSION, "bad uuid version" },
102 { GOT_ERR_UUID_INVALID, "uuid invalid" },
103 { GOT_ERR_UUID, "uuid error" },
104 { GOT_ERR_LOCKFILE_TIMEOUT,"lockfile timeout" },
105 { GOT_ERR_BAD_REF_NAME, "bad reference name" },
106 { GOT_ERR_WORKTREE_REPO,"cannot create worktree inside a git repository" },
107 { GOT_ERR_FILE_MODIFIED,"file contains modifications" },
108 { GOT_ERR_FILE_STATUS, "file has unexpected status" },
109 { GOT_ERR_COMMIT_CONFLICT,"cannot commit file in conflicted status" },
110 { GOT_ERR_BAD_REF_TYPE, "bad reference type" },
111 { GOT_ERR_COMMIT_NO_AUTHOR,"GOT_AUTHOR environment variable is not set" },
112 { GOT_ERR_COMMIT_HEAD_CHANGED, "branch head in repository has changed "
113 "while commit was in progress" },
114 { GOT_ERR_COMMIT_OUT_OF_DATE, "work tree must be updated before these "
115 "changes can be committed" },
116 { GOT_ERR_COMMIT_MSG_EMPTY, "commit message cannot be empty" },
117 { GOT_ERR_DIR_NOT_EMPTY, "directory exists and is not empty" },
118 { GOT_ERR_COMMIT_NO_CHANGES, "no changes to commit" },
119 { GOT_ERR_BRANCH_MOVED, "work tree's head reference now points to a "
120 "different branch; new head reference and/or update -b required" },
121 { GOT_ERR_OBJ_TOO_LARGE, "object too large" },
122 { GOT_ERR_SAME_BRANCH, "commit is already contained in this branch" },
123 { GOT_ERR_ROOT_COMMIT, "specified commit has no parent commit" },
124 { GOT_ERR_MIXED_COMMITS,"work tree contains files from multiple "
125 "base commits; the entire work tree must be updated first" },
126 { GOT_ERR_CONFLICTS, "work tree contains conflicted files; these "
127 "conflicts must be resolved first" },
128 { GOT_ERR_BRANCH_EXISTS,"specified branch already exists" },
129 { GOT_ERR_MODIFIED, "work tree contains local changes; these "
130 "changes must be committed or reverted first" },
131 { GOT_ERR_NOT_REBASING, "rebase operation not in progress" },
132 { GOT_ERR_EMPTY_REBASE, "no commits to rebase" },
133 { GOT_ERR_REBASE_COMMITID,"rebase commit ID mismatch" },
134 { GOT_ERR_REBASING, "a rebase operation is in progress in this "
135 "work tree and must be continued or aborted first" },
136 { GOT_ERR_REBASE_PATH, "cannot rebase branch which contains "
137 "changes outside of this work tree's path prefix" },
138 { GOT_ERR_NOT_HISTEDIT, "histedit operation not in progress" },
139 { GOT_ERR_EMPTY_HISTEDIT,"no commits to edit; perhaps the work tree "
140 "must be updated to an older commit first" },
141 { GOT_ERR_NO_HISTEDIT_CMD,"no histedit commands provided" },
142 { GOT_ERR_HISTEDIT_SYNTAX,"syntax error in histedit command list" },
143 { GOT_ERR_HISTEDIT_CANCEL,"histedit operation cancelled" },
144 { 95, "unused error code" },
145 { GOT_ERR_HISTEDIT_BUSY,"histedit operation is in progress in this "
146 "work tree and must be continued or aborted first" },
147 { GOT_ERR_HISTEDIT_CMD, "bad histedit command" },
148 { GOT_ERR_HISTEDIT_PATH, "cannot edit branch history which contains "
149 "changes outside of this work tree's path prefix" },
150 { 99, "unused error code" },
151 { GOT_ERR_COMMIT_BRANCH, "will not commit to a branch outside the "
152 "\"refs/heads/\" reference namespace" },
153 { GOT_ERR_FILE_STAGED, "file is staged" },
154 { GOT_ERR_STAGE_NO_CHANGE, "no changes to stage" },
155 { GOT_ERR_STAGE_CONFLICT, "cannot stage file in conflicted status" },
156 { GOT_ERR_STAGE_OUT_OF_DATE, "work tree must be updated before "
157 "changes can be staged" },
158 { GOT_ERR_FILE_NOT_STAGED, "file is not staged" },
159 { GOT_ERR_STAGED_PATHS, "work tree contains files with staged "
160 "changes; these changes must be committed or unstaged first" },
161 { GOT_ERR_PATCH_CHOICE, "invalid patch choice" },
162 { GOT_ERR_COMMIT_NO_EMAIL, "commit author's email address is required "
163 "for compatibility with Git" },
164 { GOT_ERR_TAG_EXISTS,"specified tag already exists" },
165 { GOT_ERR_GIT_REPO_FORMAT,"unknown git repository format version" },
166 { GOT_ERR_REBASE_REQUIRED,"specified branch must be rebased first" },
167 { GOT_ERR_REGEX, "regular expression error" },
168 { GOT_ERR_REF_NAME_MINUS, "reference name may not start with '-'" },
169 { GOT_ERR_GITCONFIG_SYNTAX, "gitconfig syntax error" },
170 { GOT_ERR_REBASE_OUT_OF_DATE, "work tree must be updated before it "
171 "can be used to rebase a branch" },
172 { GOT_ERR_CACHE_DUP_ENTRY, "duplicate cache entry" },
173 { GOT_ERR_QUERYSTRING, "bad querystring" },
174 { GOT_ERR_FETCH_FAILED, "fetch failed" },
175 { GOT_ERR_PARSE_URI, "failed to parse uri" },
176 { GOT_ERR_BAD_PROTO, "unknown protocol" },
177 { GOT_ERR_ADDRINFO, "getaddrinfo failed" },
178 { GOT_ERR_BAD_PACKET, "bad packet received" },
179 { GOT_ERR_NO_REMOTE, "remote repository not found" },
180 { GOT_ERR_FETCH_NO_BRANCH, "could not find any branches to fetch" },
181 { GOT_ERR_FETCH_BAD_REF, "reference cannot be fetched" },
182 { GOT_ERR_TREE_ENTRY_TYPE, "unexpected tree entry type" },
183 { GOT_ERR_PARSE_CONFIG, "configuration file syntax error" },
184 { GOT_ERR_NO_CONFIG_FILE, "configuration file doesn't exit" },
185 { GOT_ERR_BAD_SYMLINK, "symbolic link points outside of paths under "
187 { GOT_ERR_GIT_REPO_EXT, "unsupported repository format extension" },
188 { GOT_ERR_CANNOT_PACK, "not enough objects to pack" },
189 { GOT_ERR_LONELY_PACKIDX, "pack index has no corresponding pack file; "
190 "pack file must be restored or 'gotadmin cleanup -p' must be run" },
191 { GOT_ERR_OBJ_CSUM, "bad object checksum" },
192 { GOT_ERR_SEND_BAD_REF, "reference cannot be sent" },
193 { GOT_ERR_SEND_FAILED, "could not send pack file" },
194 { GOT_ERR_SEND_EMPTY, "no references to send" },
195 { GOT_ERR_SEND_ANCESTRY, "fetch and rebase required" },
196 { GOT_ERR_CAPA_DELETE_REFS, "server cannot delete references" },
197 { GOT_ERR_SEND_DELETE_REF, "reference cannot be deleted" },
198 { GOT_ERR_SEND_TAG_EXISTS, "tag already exists on server" },
199 { GOT_ERR_NOT_MERGING, "merge operation not in progress" },
200 { GOT_ERR_MERGE_OUT_OF_DATE, "work tree must be updated before it "
201 "can be used to merge a branch" },
202 { GOT_ERR_MERGE_STAGED_PATHS, "work tree contains files with staged "
203 "changes; these changes must be unstaged before merging can "
205 { GOT_ERR_MERGE_COMMIT_OUT_OF_DATE, "merging cannot proceed because "
206 "the work tree is no longer up-to-date; merge must be aborted "
208 { GOT_ERR_MERGE_BUSY,"a merge operation is in progress in this "
209 "work tree and must be continued or aborted first" },
210 { GOT_ERR_MERGE_PATH, "cannot merge branch which contains "
211 "changes outside of this work tree's path prefix" },
212 { GOT_ERR_FILE_BINARY, "found a binary file instead of text" },
213 { GOT_ERR_PATCH_MALFORMED, "malformed patch" },
214 { GOT_ERR_PATCH_TRUNCATED, "patch truncated" },
215 { GOT_ERR_NO_PATCH, "no patch found" },
216 { GOT_ERR_HUNK_FAILED, "hunk failed to apply" },
217 { GOT_ERR_PATCH_FAILED, "patch failed to apply" },
218 { GOT_ERR_FILEIDX_DUP_ENTRY, "duplicate file index entry" },
219 { GOT_ERR_PIN_PACK, "could not pin pack file" },
220 { GOT_ERR_BAD_TAG_SIGNATURE, "invalid tag signature" },
221 { GOT_ERR_VERIFY_TAG_SIGNATURE, "cannot verify signature" },
222 { GOT_ERR_SIGNING_TAG, "unable to sign tag" },
223 { GOT_ERR_COMMIT_REDUNDANT_AUTHOR, "specified author is equal to the "
225 { GOT_ERR_BAD_QUERYSTRING, "invalid query string" },
228 static struct got_custom_error {
229 struct got_error err;
233 static struct got_custom_error *
236 static unsigned int idx;
237 return &custom_errors[(idx++) % nitems(custom_errors)];
240 const struct got_error *
245 if (code == GOT_ERR_PRIVSEP_LEN) abort();
246 for (i = 0; i < nitems(got_errors); i++) {
247 if (code == got_errors[i].code)
248 return &got_errors[i];
254 const struct got_error *
255 got_error_msg(int code, const char *msg)
257 struct got_custom_error *cerr = get_custom_err();
258 struct got_error *err = &cerr->err;
261 for (i = 0; i < nitems(got_errors); i++) {
262 if (code == got_errors[i].code) {
264 strlcpy(cerr->msg, msg, sizeof(cerr->msg));
265 err->msg = cerr->msg;
273 const struct got_error *
274 got_error_from_errno(const char *prefix)
276 struct got_custom_error *cerr = get_custom_err();
277 struct got_error *err = &cerr->err;
280 strerror_r(errno, strerr, sizeof(strerr));
281 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", prefix, strerr);
283 err->code = GOT_ERR_ERRNO;
284 err->msg = cerr->msg;
288 const struct got_error *
289 got_error_from_errno2(const char *prefix, const char *prefix2)
291 struct got_custom_error *cerr = get_custom_err();
292 struct got_error *err = &cerr->err;
295 strerror_r(errno, strerr, sizeof(strerr));
296 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s: %s", prefix, prefix2,
299 err->code = GOT_ERR_ERRNO;
300 err->msg = cerr->msg;
304 const struct got_error *
305 got_error_from_errno3(const char *prefix, const char *prefix2,
308 struct got_custom_error *cerr = get_custom_err();
309 struct got_error *err = &cerr->err;
312 strerror_r(errno, strerr, sizeof(strerr));
313 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s: %s: %s", prefix,
314 prefix2, prefix3, strerr);
316 err->code = GOT_ERR_ERRNO;
317 err->msg = cerr->msg;
321 const struct got_error *
322 got_error_from_errno_fmt(const char *fmt, ...)
324 struct got_custom_error *cerr = get_custom_err();
325 struct got_error *err = &cerr->err;
326 char buf[PATH_MAX * 4];
331 vsnprintf(buf, sizeof(buf), fmt, ap);
334 strerror_r(errno, strerr, sizeof(strerr));
335 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", buf, strerr);
337 err->code = GOT_ERR_ERRNO;
338 err->msg = cerr->msg;
342 const struct got_error *
343 got_error_set_errno(int code, const char *prefix)
346 return got_error_from_errno(prefix);
349 const struct got_error *
350 got_ferror(FILE *f, int code)
353 return got_error_from_errno("");
354 return got_error(code);
357 const struct got_error *
358 got_error_no_obj(struct got_object_id *id)
360 char msg[sizeof("object not found") + SHA1_DIGEST_STRING_LENGTH];
361 char id_str[SHA1_DIGEST_STRING_LENGTH];
364 if (!got_sha1_digest_to_str(id->sha1, id_str, sizeof(id_str)))
365 return got_error(GOT_ERR_NO_OBJ);
367 ret = snprintf(msg, sizeof(msg), "object %s not found", id_str);
368 if (ret < 0 || (size_t)ret >= sizeof(msg))
369 return got_error(GOT_ERR_NO_OBJ);
371 return got_error_msg(GOT_ERR_NO_OBJ, msg);
374 const struct got_error *
375 got_error_not_ref(const char *refname)
377 char msg[sizeof("reference not found") + 1004];
380 ret = snprintf(msg, sizeof(msg), "reference %s not found", refname);
381 if (ret < 0 || (size_t)ret >= sizeof(msg))
382 return got_error(GOT_ERR_NOT_REF);
384 return got_error_msg(GOT_ERR_NOT_REF, msg);
387 const struct got_error *
388 got_error_uuid(uint32_t uuid_status, const char *prefix)
390 switch (uuid_status) {
393 case uuid_s_bad_version:
394 return got_error(GOT_ERR_UUID_VERSION);
395 case uuid_s_invalid_string_uuid:
396 return got_error(GOT_ERR_UUID_INVALID);
397 case uuid_s_no_memory:
398 return got_error_set_errno(ENOMEM, prefix);
400 return got_error(GOT_ERR_UUID);
404 const struct got_error *
405 got_error_path(const char *path, int code)
407 struct got_custom_error *cerr = get_custom_err();
408 struct got_error *err = &cerr->err;
411 for (i = 0; i < nitems(got_errors); i++) {
412 if (code == got_errors[i].code) {
414 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", path,
416 err->msg = cerr->msg;
424 const struct got_error *
425 got_error_fmt(int code, const char *fmt, ...)
427 struct got_custom_error *cerr = get_custom_err();
428 struct got_error *err = &cerr->err;
429 char buf[PATH_MAX * 4];
434 vsnprintf(buf, sizeof(buf), fmt, ap);
437 for (i = 0; i < nitems(got_errors); i++) {
438 if (code == got_errors[i].code) {
440 snprintf(cerr->msg, sizeof(cerr->msg), "%s: %s", buf,
442 err->msg = cerr->msg;
451 got_err_open_nofollow_on_symlink(void)
454 * Check whether open(2) with O_NOFOLLOW failed on a symlink.
455 * Posix mandates ELOOP and OpenBSD follows it. Others return
456 * different error codes. We carry this workaround to help the
457 * portable version a little.
459 return (errno == ELOOP
