2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 7b19e0f1 2017-11-05 stsp * Permission to use, copy, modify, and distribute this software for any
5 7b19e0f1 2017-11-05 stsp * purpose with or without fee is hereby granted, provided that the above
6 7b19e0f1 2017-11-05 stsp * copyright notice and this permission notice appear in all copies.
8 7b19e0f1 2017-11-05 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 7b19e0f1 2017-11-05 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 7b19e0f1 2017-11-05 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 7b19e0f1 2017-11-05 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 7b19e0f1 2017-11-05 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 7b19e0f1 2017-11-05 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 7b19e0f1 2017-11-05 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 4027f31a 2017-11-04 stsp /* Error codes */
18 0a585a0d 2018-03-17 stsp #define GOT_ERR_OK 0
19 0a585a0d 2018-03-17 stsp #define GOT_ERR_ERRNO 1
20 a1fd68d8 2018-01-12 stsp #define GOT_ERR_NOT_GIT_REPO 2
21 a1fd68d8 2018-01-12 stsp #define GOT_ERR_NOT_ABSPATH 3
22 a1fd68d8 2018-01-12 stsp #define GOT_ERR_BAD_PATH 4
23 a1fd68d8 2018-01-12 stsp #define GOT_ERR_NOT_REF 5
24 a1fd68d8 2018-01-12 stsp #define GOT_ERR_IO 6
25 a1fd68d8 2018-01-12 stsp #define GOT_ERR_EOF 7
26 a1fd68d8 2018-01-12 stsp #define GOT_ERR_DECOMPRESSION 8
27 a1fd68d8 2018-01-12 stsp #define GOT_ERR_NO_SPACE 9
28 a1fd68d8 2018-01-12 stsp #define GOT_ERR_BAD_OBJ_HDR 10
29 a1fd68d8 2018-01-12 stsp #define GOT_ERR_OBJ_TYPE 11
30 a1fd68d8 2018-01-12 stsp #define GOT_ERR_BAD_OBJ_DATA 12
31 d1688ce0 2019-02-05 stsp /* 13 is currently free for re-use */
32 a1fd68d8 2018-01-12 stsp #define GOT_ERR_BAD_PACKIDX 14
33 a1fd68d8 2018-01-12 stsp #define GOT_ERR_PACKIDX_CSUM 15
34 a1fd68d8 2018-01-12 stsp #define GOT_ERR_BAD_PACKFILE 16
35 a1fd68d8 2018-01-12 stsp #define GOT_ERR_NO_OBJ 17
36 a487c1d0 2018-01-14 stsp #define GOT_ERR_NOT_IMPL 18
37 3ee5fc21 2018-01-17 stsp #define GOT_ERR_OBJ_NOT_PACKED 19
38 96f5e8b3 2018-01-23 stsp #define GOT_ERR_BAD_DELTA_CHAIN 20
39 885d3e02 2018-01-27 stsp #define GOT_ERR_BAD_DELTA 21
40 885d3e02 2018-01-27 stsp #define GOT_ERR_COMPRESSION 22
41 59ece79d 2018-02-12 stsp #define GOT_ERR_BAD_OBJ_ID_STR 23
42 86c3caaf 2018-03-09 stsp #define GOT_ERR_WORKTREE_EXISTS 26
43 09fe317a 2018-03-11 stsp #define GOT_ERR_WORKTREE_META 27
44 6d9d28c3 2018-03-11 stsp #define GOT_ERR_WORKTREE_VERS 28
45 6d9d28c3 2018-03-11 stsp #define GOT_ERR_WORKTREE_BUSY 29
46 9d31a1d8 2018-03-11 stsp #define GOT_ERR_DIR_OBSTRUCTED 30
47 9d31a1d8 2018-03-11 stsp #define GOT_ERR_FILE_OBSTRUCTED 31
48 5b7e13a7 2018-04-02 stsp #define GOT_ERR_RECURSION 32
49 2178c42e 2018-04-22 stsp #define GOT_ERR_TIMEOUT 33
50 2178c42e 2018-04-22 stsp #define GOT_ERR_INTERRUPT 34
51 2178c42e 2018-04-22 stsp #define GOT_ERR_PRIVSEP_READ 35
52 2178c42e 2018-04-22 stsp #define GOT_ERR_PRIVSEP_LEN 36
53 2178c42e 2018-04-22 stsp #define GOT_ERR_PRIVSEP_PIPE 37
54 2178c42e 2018-04-22 stsp #define GOT_ERR_PRIVSEP_NO_FD 38
55 8c580685 2018-04-22 stsp #define GOT_ERR_PRIVSEP_MSG 39
56 b419fc47 2018-04-26 stsp #define GOT_ERR_PRIVSEP_DIED 40
57 b419fc47 2018-04-26 stsp #define GOT_ERR_PRIVSEP_EXIT 41
58 0c048b15 2018-04-27 stsp #define GOT_ERR_PACK_OFFSET 42
59 54be8251 2018-06-04 stsp #define GOT_ERR_OBJ_EXISTS 43
60 54be8251 2018-06-04 stsp #define GOT_ERR_BAD_OBJ_ID 44
61 372ccdbb 2018-06-10 stsp #define GOT_ERR_ITER_NEED_MORE 45
62 9ba79e04 2018-06-11 stsp #define GOT_ERR_ITER_COMPLETED 46
63 730c718b 2018-06-21 stsp #define GOT_ERR_RANGE 47
64 89817b30 2018-11-11 stsp #define GOT_ERR_EXPECTED 48 /* for use in regress tests only */
65 99437157 2018-11-11 stsp #define GOT_ERR_CANCELLED 49
66 d1451975 2018-11-11 stsp #define GOT_ERR_NO_TREE_ENTRY 50
67 52a74475 2018-12-24 stsp #define GOT_ERR_FILEIDX_SIG 51
68 52a74475 2018-12-24 stsp #define GOT_ERR_FILEIDX_VER 52
69 52a74475 2018-12-24 stsp #define GOT_ERR_FILEIDX_CSUM 53
70 49520a32 2018-12-29 stsp #define GOT_ERR_PATH_PREFIX 54
71 be7061eb 2018-12-30 stsp #define GOT_ERR_ANCESTRY 55
72 27793341 2019-01-12 stsp #define GOT_ERR_FILEIDX_BAD 56
73 a808cfa5 2019-02-03 stsp #define GOT_ERR_BAD_REF_DATA 57
74 f5d3d7af 2019-02-05 stsp #define GOT_ERR_TREE_DUP_ENTRY 58
75 f5d3d7af 2019-02-05 stsp #define GOT_ERR_DIR_DUP_ENTRY 59
76 247140b2 2019-02-05 stsp #define GOT_ERR_NOT_WORKTREE 60
77 09589288 2019-03-10 stsp #define GOT_ERR_UUID_VERSION 61
78 09589288 2019-03-10 stsp #define GOT_ERR_UUID_INVALID 62
79 09589288 2019-03-10 stsp #define GOT_ERR_UUID 63
80 01b7ba6b 2019-03-11 stsp #define GOT_ERR_LOCKFILE_TIMEOUT 64
81 f77a24b0 2019-03-11 stsp #define GOT_ERR_BAD_REF_NAME 65
82 0c48fee2 2019-03-11 stsp #define GOT_ERR_WORKTREE_REPO 66
83 2ec1f75b 2019-03-26 stsp #define GOT_ERR_FILE_MODIFIED 67
84 2ec1f75b 2019-03-26 stsp #define GOT_ERR_FILE_STATUS 68
85 c4296144 2019-05-09 stsp #define GOT_ERR_COMMIT_CONFLICT 69
86 b249b824 2019-05-09 stsp #define GOT_ERR_BAD_REF_TYPE 70
87 35bd8fed 2019-05-09 stsp #define GOT_ERR_COMMIT_NO_AUTHOR 71
88 09f5bd90 2019-05-09 stsp #define GOT_ERR_COMMIT_HEAD_CHANGED 72
89 819f385b 2019-05-10 stsp #define GOT_ERR_COMMIT_OUT_OF_DATE 73
90 33ad4cbe 2019-05-12 jcs #define GOT_ERR_COMMIT_MSG_EMPTY 74
91 33ad4cbe 2019-05-12 jcs #define GOT_ERR_DIR_NOT_EMPTY 75
92 33ad4cbe 2019-05-12 jcs #define GOT_ERR_COMMIT_NO_CHANGES 76
93 a367ff0f 2019-05-14 stsp #define GOT_ERR_BRANCH_MOVED 77
95 4027f31a 2017-11-04 stsp static const struct got_error {
97 4027f31a 2017-11-04 stsp const char *msg;
98 4027f31a 2017-11-04 stsp } got_errors[] = {
99 0a585a0d 2018-03-17 stsp { GOT_ERR_OK, "no error occured?!?" },
100 f334529e 2018-01-12 stsp { GOT_ERR_ERRNO, "see errno" },
101 4027f31a 2017-11-04 stsp { GOT_ERR_NOT_GIT_REPO, "no git repository found" },
102 4027f31a 2017-11-04 stsp { GOT_ERR_NOT_ABSPATH, "absolute path expected" },
103 4027f31a 2017-11-04 stsp { GOT_ERR_BAD_PATH, "bad path" },
104 4027f31a 2017-11-04 stsp { GOT_ERR_NOT_REF, "no such reference found" },
105 ab9a70b2 2017-11-06 stsp { GOT_ERR_IO, "input/output error" },
106 ab9a70b2 2017-11-06 stsp { GOT_ERR_EOF, "unexpected end of file" },
107 ab9a70b2 2017-11-06 stsp { GOT_ERR_DECOMPRESSION,"decompression failed" },
108 ab9a70b2 2017-11-06 stsp { GOT_ERR_NO_SPACE, "buffer too small" },
109 ab9a70b2 2017-11-06 stsp { GOT_ERR_BAD_OBJ_HDR, "bad object header" },
110 d1cda826 2017-11-06 stsp { GOT_ERR_OBJ_TYPE, "wrong type of object" },
111 d1cda826 2017-11-06 stsp { GOT_ERR_BAD_OBJ_DATA, "bad object data" },
112 d1688ce0 2019-02-05 stsp { 13, "unused error code" },
113 0a0a3048 2018-01-10 stsp { GOT_ERR_BAD_PACKIDX, "bad pack index file" },
114 0ebaf008 2018-01-10 stsp { GOT_ERR_PACKIDX_CSUM, "pack index file checksum error" },
115 a1fd68d8 2018-01-12 stsp { GOT_ERR_BAD_PACKFILE, "bad pack file" },
116 a1fd68d8 2018-01-12 stsp { GOT_ERR_NO_OBJ, "object not found" },
117 a487c1d0 2018-01-14 stsp { GOT_ERR_NOT_IMPL, "feature not implemented" },
118 3ee5fc21 2018-01-17 stsp { GOT_ERR_OBJ_NOT_PACKED,"object is not packed" },
119 96f5e8b3 2018-01-23 stsp { GOT_ERR_BAD_DELTA_CHAIN,"bad delta chain" },
120 59ece79d 2018-02-12 stsp { GOT_ERR_BAD_DELTA, "bad delta" },
121 59ece79d 2018-02-12 stsp { GOT_ERR_COMPRESSION, "compression failed" },
122 59ece79d 2018-02-12 stsp { GOT_ERR_BAD_OBJ_ID_STR,"bad object id string" },
123 86c3caaf 2018-03-09 stsp { GOT_ERR_WORKTREE_EXISTS,"worktree already exists" },
124 09fe317a 2018-03-11 stsp { GOT_ERR_WORKTREE_META,"bad worktree meta data" },
125 6d9d28c3 2018-03-11 stsp { GOT_ERR_WORKTREE_VERS,"unsupported worktree format version" },
126 6d9d28c3 2018-03-11 stsp { GOT_ERR_WORKTREE_BUSY,"worktree already locked" },
127 95edb37e 2019-03-28 stsp { GOT_ERR_FILE_OBSTRUCTED,"file is obstructed" },
128 5b7e13a7 2018-04-02 stsp { GOT_ERR_RECURSION, "recursion limit reached" },
129 2178c42e 2018-04-22 stsp { GOT_ERR_TIMEOUT, "operation timed out" },
130 2178c42e 2018-04-22 stsp { GOT_ERR_INTERRUPT, "operation interrupted" },
131 55afbf19 2018-09-08 stsp { GOT_ERR_PRIVSEP_READ, "no data received in imsg" },
132 55afbf19 2018-09-08 stsp { GOT_ERR_PRIVSEP_LEN, "unexpected amount of data received in imsg" },
133 55afbf19 2018-09-08 stsp { GOT_ERR_PRIVSEP_PIPE, "privsep peer process closed pipe" },
134 55afbf19 2018-09-08 stsp { GOT_ERR_PRIVSEP_NO_FD,"privsep file descriptor unavailable" },
135 4c838a52 2018-12-23 stsp { GOT_ERR_PRIVSEP_MSG, "received unexpected privsep message" },
136 54be8251 2018-06-04 stsp { GOT_ERR_PRIVSEP_DIED, "unprivileged process died unexpectedly" },
137 54be8251 2018-06-04 stsp { GOT_ERR_PRIVSEP_EXIT, "bad exit code from unprivileged process" },
138 54be8251 2018-06-04 stsp { GOT_ERR_PACK_OFFSET, "bad offset in pack file" },
139 54be8251 2018-06-04 stsp { GOT_ERR_OBJ_EXISTS, "object already exists" },
140 54be8251 2018-06-04 stsp { GOT_ERR_BAD_OBJ_ID, "bad object id" },
141 372ccdbb 2018-06-10 stsp { GOT_ERR_ITER_NEED_MORE,"more items needed to continue iteration" },
142 9ba79e04 2018-06-11 stsp { GOT_ERR_ITER_COMPLETED,"iteration completed" },
143 730c718b 2018-06-21 stsp { GOT_ERR_RANGE, "value out of range" },
144 89817b30 2018-11-11 stsp { GOT_ERR_EXPECTED, "expected an error but have no error" },
145 99437157 2018-11-11 stsp { GOT_ERR_CANCELLED, "operation in progress has been cancelled" },
146 d1451975 2018-11-11 stsp { GOT_ERR_NO_TREE_ENTRY,"no such entry found in tree" },
147 52a74475 2018-12-24 stsp { GOT_ERR_FILEIDX_SIG, "bad file index signature" },
148 52a74475 2018-12-24 stsp { GOT_ERR_FILEIDX_VER, "unknown file index format version" },
149 52a74475 2018-12-24 stsp { GOT_ERR_FILEIDX_CSUM, "bad file index checksum" },
150 49520a32 2018-12-29 stsp { GOT_ERR_PATH_PREFIX, "worktree already contains items from a "
151 49520a32 2018-12-29 stsp "different path prefix" },
152 a367ff0f 2019-05-14 stsp { GOT_ERR_ANCESTRY, "target commit is on a different branch" },
153 27793341 2019-01-12 stsp { GOT_ERR_FILEIDX_BAD, "file index is corrupt" },
154 a808cfa5 2019-02-03 stsp { GOT_ERR_BAD_REF_DATA, "could not parse reference data" },
155 f5d3d7af 2019-02-05 stsp { GOT_ERR_TREE_DUP_ENTRY,"duplicate entry in tree object" },
156 f5d3d7af 2019-02-05 stsp { GOT_ERR_DIR_DUP_ENTRY,"duplicate entry in directory" },
157 247140b2 2019-02-05 stsp { GOT_ERR_NOT_WORKTREE, "no got work tree found" },
158 09589288 2019-03-10 stsp { GOT_ERR_UUID_VERSION, "bad uuid version" },
159 09589288 2019-03-10 stsp { GOT_ERR_UUID_INVALID, "uuid invalid" },
160 09589288 2019-03-10 stsp { GOT_ERR_UUID, "uuid error" },
161 01b7ba6b 2019-03-11 stsp { GOT_ERR_LOCKFILE_TIMEOUT,"lockfile timeout" },
162 f77a24b0 2019-03-11 stsp { GOT_ERR_BAD_REF_NAME, "bad reference name" },
163 0c48fee2 2019-03-11 stsp { GOT_ERR_WORKTREE_REPO,"cannot create worktree inside a git repository" },
164 2ec1f75b 2019-03-26 stsp { GOT_ERR_FILE_MODIFIED,"file contains modifications" },
165 2ec1f75b 2019-03-26 stsp { GOT_ERR_FILE_STATUS, "file has unexpected status" },
166 c4296144 2019-05-09 stsp { GOT_ERR_COMMIT_CONFLICT,"cannot commit file in conflicted status" },
167 b249b824 2019-05-09 stsp { GOT_ERR_BAD_REF_TYPE, "bad reference type" },
168 35bd8fed 2019-05-09 stsp { GOT_ERR_COMMIT_NO_AUTHOR,"GOT_AUTHOR environment variable is not set" },
169 09f5bd90 2019-05-09 stsp { GOT_ERR_COMMIT_HEAD_CHANGED, "branch head in repository has changed "
170 09f5bd90 2019-05-09 stsp "while commit was in progress" },
171 819f385b 2019-05-10 stsp { GOT_ERR_COMMIT_OUT_OF_DATE, "work tree must be updated before these "
172 819f385b 2019-05-10 stsp "changes can be committed" },
173 33ad4cbe 2019-05-12 jcs { GOT_ERR_COMMIT_MSG_EMPTY, "commit message cannot be empty" },
174 196d54c7 2019-05-15 stsp { GOT_ERR_DIR_NOT_EMPTY, "directory exists and is not empty" },
175 33ad4cbe 2019-05-12 jcs { GOT_ERR_COMMIT_NO_CHANGES, "no changes to commit" },
176 a367ff0f 2019-05-14 stsp { GOT_ERR_BRANCH_MOVED, "work tree's branch reference has moved; "
177 a367ff0f 2019-05-14 stsp "new branch or rebase required" },
181 0c60ce5a 2018-04-02 stsp * Get an error object from the above list, for a given error code.
182 0c60ce5a 2018-04-02 stsp * The error message is fixed.
184 0c60ce5a 2018-04-02 stsp const struct got_error *got_error(int);
187 91a3d81f 2018-11-11 stsp * Get an error object from the above list, for a given error code.
188 91a3d81f 2018-11-11 stsp * Use the specified error message instead of the default one.
189 91a3d81f 2018-11-11 stsp * Caution: If the message buffer lives in dynamically allocated memory,
190 91a3d81f 2018-11-11 stsp * then this memory likely won't be freed.
192 91a3d81f 2018-11-11 stsp const struct got_error *got_error_msg(int, const char *);
195 0c60ce5a 2018-04-02 stsp * Get a statically allocated error object with code GOT_ERR_ERRNO
196 230a42bd 2019-05-11 jcs * and an error message obtained from strerror(3), prefixed with a
199 638f9024 2019-05-13 stsp const struct got_error *got_error_from_errno(const char *);
202 48b8b0eb 2019-05-11 jcs * Get a statically allocated error object with code GOT_ERR_ERRNO
203 230a42bd 2019-05-11 jcs * and an error message obtained from strerror(3), prefixed with two
206 638f9024 2019-05-13 stsp const struct got_error *got_error_from_errno2(const char *, const char *);
209 230a42bd 2019-05-11 jcs * Get a statically allocated error object with code GOT_ERR_ERRNO
210 230a42bd 2019-05-11 jcs * and an error message obtained from strerror(3), prefixed with three
213 638f9024 2019-05-13 stsp const struct got_error *got_error_from_errno3(const char *, const char *,
214 230a42bd 2019-05-11 jcs const char *);
217 1a76625f 2018-10-22 stsp * Set errno to the specified error code and return a statically
218 1a76625f 2018-10-22 stsp * allocated error object with code GOT_ERR_ERRNO and an error
219 2af4a041 2019-05-11 jcs * message obtained from strerror(3), optionally prefixed with a
222 2af4a041 2019-05-11 jcs const struct got_error *got_error_set_errno(int, const char *);
225 0c60ce5a 2018-04-02 stsp * If ferror(3) indicates an error status for the FILE, obtain an error
226 638f9024 2019-05-13 stsp * from got_error_from_errno(). Else, obtain the error via got_error()
227 0c60ce5a 2018-04-02 stsp * with the error code provided in the second argument.
229 8251fdbc 2018-01-12 stsp const struct got_error *got_ferror(FILE *, int);
232 91a3d81f 2018-11-11 stsp * Obtain an error with code GOT_ERR_NO_OBJ and an error message which
233 91a3d81f 2018-11-11 stsp * contains the specified object ID. The message buffer is statically
234 91a3d81f 2018-11-11 stsp * allocated; future invocations of this function will overwrite the
235 91a3d81f 2018-11-11 stsp * message set during earlier invocations.
237 91a3d81f 2018-11-11 stsp struct got_object_id; /* forward declaration */
238 91a3d81f 2018-11-11 stsp const struct got_error *got_error_no_obj(struct got_object_id *);
241 2aa0475c 2019-02-03 stsp * Obtain an error with code GOT_ERR_NOT_REF and an error message which
242 2aa0475c 2019-02-03 stsp * contains the specified reference name. The message buffer is statically
243 2aa0475c 2019-02-03 stsp * allocated; future invocations of this function will overwrite the
244 2aa0475c 2019-02-03 stsp * message set during earlier invocations.
246 2aa0475c 2019-02-03 stsp const struct got_error *got_error_not_ref(const char *);
248 09589288 2019-03-10 stsp /* Return an error based on a uuid(3) status code. */
249 09589288 2019-03-10 stsp const struct got_error *got_error_uuid(uint32_t);
251 df056ada 2019-05-15 stsp /* Return an error with a path prefixed to the error message. */
252 df056ada 2019-05-15 stsp const struct got_error *got_error_path(const char *, int);
