errors: tighten up git_error_state OOMs a bit more When an error state is an OOM, make sure that we treat is specially and do not try to free it.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
diff --git a/src/clone.c b/src/clone.c
index 070daf9..6b4b7ae 100644
--- a/src/clone.c
+++ b/src/clone.c
@@ -440,14 +440,14 @@ int git_clone(
if (error != 0) {
git_error_state last_error = {0};
- giterr_capture(&last_error, error);
+ giterr_state_capture(&last_error, error);
git_repository_free(repo);
repo = NULL;
(void)git_futils_rmdir_r(local_path, NULL, rmdir_flags);
- giterr_restore(&last_error);
+ giterr_state_restore(&last_error);
}
*out = repo;
diff --git a/src/common.h b/src/common.h
index 2b1dedc..6dca36f 100644
--- a/src/common.h
+++ b/src/common.h
@@ -141,20 +141,25 @@ void giterr_system_set(int code);
* Structure to preserve libgit2 error state
*/
typedef struct {
- int error_code;
+ int error_code;
+ unsigned int oom : 1;
git_error error_msg;
} git_error_state;
/**
* Capture current error state to restore later, returning error code.
- * If `error_code` is zero, this does nothing and returns zero.
+ * If `error_code` is zero, this does not clear the current error state.
+ * You must either restore this error state, or free it.
*/
-int giterr_capture(git_error_state *state, int error_code);
+extern int giterr_state_capture(git_error_state *state, int error_code);
/**
* Restore error state to a previous value, returning saved error code.
*/
-int giterr_restore(git_error_state *state);
+extern int giterr_state_restore(git_error_state *state);
+
+/** Free an error state. */
+extern void giterr_state_free(git_error_state *state);
/**
* Check a versioned structure for validity
diff --git a/src/errors.c b/src/errors.c
index 973326c..91acc35 100644
--- a/src/errors.c
+++ b/src/errors.c
@@ -131,53 +131,65 @@ void giterr_clear(void)
#endif
}
-static int giterr_detach(git_error *cpy)
+const git_error *giterr_last(void)
+{
+ return GIT_GLOBAL->last_error;
+}
+
+int giterr_state_capture(git_error_state *state, int error_code)
{
git_error *error = GIT_GLOBAL->last_error;
- git_buf *buf = &GIT_GLOBAL->error_buf;
+ git_buf *error_buf = &GIT_GLOBAL->error_buf;
- assert(cpy);
+ memset(state, 0, sizeof(git_error_state));
- if (!error)
- return -1;
+ if (!error_code)
+ return 0;
+
+ state->error_code = error_code;
+ state->oom = (error == &g_git_oom_error);
- cpy->message = git_buf_detach(buf);
- cpy->klass = error->klass;
+ if (error) {
+ state->error_msg.klass = error->klass;
- if (error != &g_git_oom_error) {
- error->message = NULL;
+ if (state->oom)
+ state->error_msg.message = g_git_oom_error.message;
+ else
+ state->error_msg.message = git_buf_detach(error_buf);
}
- giterr_clear();
- return 0;
+ giterr_clear();
+ return error_code;
}
-const git_error *giterr_last(void)
+int giterr_state_restore(git_error_state *state)
{
- return GIT_GLOBAL->last_error;
-}
+ int ret = 0;
-int giterr_capture(git_error_state *state, int error_code)
-{
- state->error_code = error_code;
- if (error_code)
- giterr_detach(&state->error_msg);
- return error_code;
-}
+ giterr_clear();
-int giterr_restore(git_error_state *state)
-{
- if (state && state->error_code && state->error_msg.message) {
- if (state->error_msg.message == g_git_oom_error.message) {
+ if (state && state->error_msg.message) {
+ if (state->oom)
giterr_set_oom();
- } else {
+ else
set_error(state->error_msg.klass, state->error_msg.message);
- }
+
+ ret = state->error_code;
+ memset(state, 0, sizeof(git_error_state));
}
- else
- giterr_clear();
- return state ? state->error_code : 0;
+ return ret;
+}
+
+void giterr_state_free(git_error_state *state)
+{
+ if (!state)
+ return;
+
+ if (!state->oom)
+ git__free(state->error_msg.message);
+
+ memset(state, 0, sizeof(git_error_state));
}
int giterr_system_last(void)
diff --git a/src/index.c b/src/index.c
index 73f0b3d..e424698 100644
--- a/src/index.c
+++ b/src/index.c
@@ -1286,13 +1286,13 @@ int git_index_add_bypath(git_index *index, const char *path)
git_submodule *sm;
git_error_state err;
- giterr_capture(&err, ret);
+ giterr_state_capture(&err, ret);
ret = git_submodule_lookup(&sm, INDEX_OWNER(index), path);
if (ret == GIT_ENOTFOUND)
- return giterr_restore(&err);
+ return giterr_state_restore(&err);
- git__free(err.error_msg.message);
+ giterr_state_free(&err);
/*
* EEXISTS means that there is a repository at that path, but it's not known
diff --git a/src/iterator.c b/src/iterator.c
index cf51a34..900ffdc 100644
--- a/src/iterator.c
+++ b/src/iterator.c
@@ -1120,7 +1120,7 @@ static int fs_iterator__expand_dir(fs_iterator *fi)
if (error < 0) {
git_error_state last_error = { 0 };
- giterr_capture(&last_error, error);
+ giterr_state_capture(&last_error, error);
/* these callbacks may clear the error message */
fs_iterator__free_frame(ff);
@@ -1128,7 +1128,7 @@ static int fs_iterator__expand_dir(fs_iterator *fi)
/* next time return value we skipped to */
fi->base.flags &= ~GIT_ITERATOR_FIRST_ACCESS;
- return giterr_restore(&last_error);
+ return giterr_state_restore(&last_error);
}
if (ff->entries.length == 0) {
diff --git a/tests/core/errors.c b/tests/core/errors.c
index 25bbbd5..ab18951 100644
--- a/tests/core/errors.c
+++ b/tests/core/errors.c
@@ -93,23 +93,44 @@ void test_core_errors__restore(void)
giterr_clear();
cl_assert(giterr_last() == NULL);
- cl_assert_equal_i(0, giterr_capture(&err_state, 0));
+ cl_assert_equal_i(0, giterr_state_capture(&err_state, 0));
memset(&err_state, 0x0, sizeof(git_error_state));
giterr_set(42, "Foo: %s", "bar");
- cl_assert_equal_i(-1, giterr_capture(&err_state, -1));
+ cl_assert_equal_i(-1, giterr_state_capture(&err_state, -1));
cl_assert(giterr_last() == NULL);
giterr_set(99, "Bar: %s", "foo");
- giterr_restore(&err_state);
+ giterr_state_restore(&err_state);
cl_assert_equal_i(42, giterr_last()->klass);
cl_assert_equal_s("Foo: bar", giterr_last()->message);
}
+void test_core_errors__free_state(void)
+{
+ git_error_state err_state = {0};
+
+ giterr_clear();
+
+ giterr_set(42, "Foo: %s", "bar");
+ cl_assert_equal_i(-1, giterr_state_capture(&err_state, -1));
+
+ giterr_set(99, "Bar: %s", "foo");
+
+ giterr_state_free(&err_state);
+
+ cl_assert_equal_i(99, giterr_last()->klass);
+ cl_assert_equal_s("Bar: foo", giterr_last()->message);
+
+ giterr_state_restore(&err_state);
+
+ cl_assert(giterr_last() == NULL);
+}
+
void test_core_errors__restore_oom(void)
{
git_error_state err_state = {0};
@@ -121,11 +142,13 @@ void test_core_errors__restore_oom(void)
oom_error = giterr_last();
cl_assert(oom_error);
- cl_assert_equal_i(-1, giterr_capture(&err_state, -1));
+ cl_assert_equal_i(-1, giterr_state_capture(&err_state, -1));
cl_assert(giterr_last() == NULL);
+ cl_assert_equal_i(GITERR_NOMEMORY, err_state.error_msg.klass);
+ cl_assert_equal_s("Out of memory", err_state.error_msg.message);
- giterr_restore(&err_state);
+ giterr_state_restore(&err_state);
cl_assert(giterr_last()->klass == GITERR_NOMEMORY);
cl_assert_(giterr_last() == oom_error, "static oom error not restored");