blob: 119972ee16f89f629e96b552e520f0b8190e54a7 [file] [log] [blame]
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001#include "../cache.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -07002#include "../config.h"
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003#include "../refs.h"
4#include "refs-internal.h"
Michael Haggerty958f9642017-04-16 08:41:31 +02005#include "ref-cache.h"
Michael Haggerty67be7c52017-06-23 09:01:37 +02006#include "packed-backend.h"
Michael Haggerty3bc581b2016-06-18 06:15:15 +02007#include "../iterator.h"
Michael Haggerty2880d162016-06-18 06:15:19 +02008#include "../dir-iterator.h"
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01009#include "../lockfile.h"
10#include "../object.h"
11#include "../dir.h"
Jeff Kingfb9c2d22018-03-30 14:35:12 -040012#include "../chdir-notify.h"
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +020013#include "worktree.h"
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010014
Michael Haggerty5ac95fe2017-11-05 09:42:05 +010015/*
16 * This backend uses the following flags in `ref_update::flags` for
17 * internal bookkeeping purposes. Their numerical values must not
Michael Haggerty91774af2017-11-05 09:42:06 +010018 * conflict with REF_NO_DEREF, REF_FORCE_CREATE_REFLOG, REF_HAVE_NEW,
Michael Haggertyacedcde2017-11-05 09:42:07 +010019 * REF_HAVE_OLD, or REF_IS_PRUNING, which are also stored in
Michael Haggerty5ac95fe2017-11-05 09:42:05 +010020 * `ref_update::flags`.
21 */
22
23/*
24 * Used as a flag in ref_update::flags when a loose ref is being
Michael Haggerty91774af2017-11-05 09:42:06 +010025 * pruned. This flag must only be used when REF_NO_DEREF is set.
Michael Haggerty5ac95fe2017-11-05 09:42:05 +010026 */
Michael Haggertyacedcde2017-11-05 09:42:07 +010027#define REF_IS_PRUNING (1 << 4)
Michael Haggerty5ac95fe2017-11-05 09:42:05 +010028
29/*
30 * Flag passed to lock_ref_sha1_basic() telling it to tolerate broken
31 * refs (i.e., because the reference is about to be deleted anyway).
32 */
33#define REF_DELETING (1 << 5)
34
35/*
36 * Used as a flag in ref_update::flags when the lockfile needs to be
37 * committed.
38 */
39#define REF_NEEDS_COMMIT (1 << 6)
40
41/*
Michael Haggerty5ac95fe2017-11-05 09:42:05 +010042 * Used as a flag in ref_update::flags when the ref_update was via an
43 * update to HEAD.
44 */
45#define REF_UPDATE_VIA_HEAD (1 << 8)
46
47/*
48 * Used as a flag in ref_update::flags when the loose reference has
49 * been deleted.
50 */
51#define REF_DELETED_LOOSE (1 << 9)
52
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010053struct ref_lock {
54 char *ref_name;
Jeff Kingee4d8e42017-09-05 08:15:15 -040055 struct lock_file lk;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010056 struct object_id old_oid;
57};
58
Michael Haggerty00eebe32016-09-04 18:08:11 +020059struct files_ref_store {
60 struct ref_store base;
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +070061 unsigned int store_flags;
Michael Haggerty32c597e2017-02-10 12:16:16 +010062
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +070063 char *gitcommondir;
Nguyễn Thái Ngọc Duy33dfb9f2017-03-26 09:42:18 +070064
Michael Haggerty7c22bc82017-04-16 08:41:32 +020065 struct ref_cache *loose;
Michael Haggerty55c6bc32017-05-22 16:17:40 +020066
Michael Haggertye0cc8ac2017-06-23 09:01:38 +020067 struct ref_store *packed_ref_store;
Michael Haggerty00eebe32016-09-04 18:08:11 +020068};
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010069
Michael Haggerty65a0a8e2016-09-04 18:08:09 +020070static void clear_loose_ref_cache(struct files_ref_store *refs)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010071{
72 if (refs->loose) {
Michael Haggerty7c22bc82017-04-16 08:41:32 +020073 free_ref_cache(refs->loose);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010074 refs->loose = NULL;
75 }
76}
77
Jeff Kinga2d51562016-01-22 17:29:30 -050078/*
79 * Create a new submodule ref cache and add it to the internal
80 * set of caches.
81 */
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +070082static struct ref_store *files_ref_store_create(const char *gitdir,
83 unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010084{
Michael Haggerty00eebe32016-09-04 18:08:11 +020085 struct files_ref_store *refs = xcalloc(1, sizeof(*refs));
86 struct ref_store *ref_store = (struct ref_store *)refs;
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +070087 struct strbuf sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010088
Han-Wen Nienhuys5085aef2020-08-19 14:27:57 +000089 ref_store->gitdir = xstrdup(gitdir);
Michael Haggertyfbfd0a22017-02-10 12:16:17 +010090 base_ref_store_init(ref_store, &refs_be_files);
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +070091 refs->store_flags = flags;
Jeff Kinga2d51562016-01-22 17:29:30 -050092
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +070093 get_common_dir_noenv(&sb, gitdir);
94 refs->gitcommondir = strbuf_detach(&sb, NULL);
95 strbuf_addf(&sb, "%s/packed-refs", refs->gitcommondir);
Michael Haggertye0d48392017-06-23 09:01:22 +020096 refs->packed_ref_store = packed_ref_store_create(sb.buf, flags);
97 strbuf_release(&sb);
Jeff Kinga2d51562016-01-22 17:29:30 -050098
Han-Wen Nienhuys5085aef2020-08-19 14:27:57 +000099 chdir_notify_reparent("files-backend $GIT_DIR", &refs->base.gitdir);
Jeff Kingfb9c2d22018-03-30 14:35:12 -0400100 chdir_notify_reparent("files-backend $GIT_COMMONDIR",
101 &refs->gitcommondir);
102
Michael Haggerty00eebe32016-09-04 18:08:11 +0200103 return ref_store;
Jeff Kinga2d51562016-01-22 17:29:30 -0500104}
105
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100106/*
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700107 * Die if refs is not the main ref store. caller is used in any
108 * necessary error messages.
Michael Haggerty32c597e2017-02-10 12:16:16 +0100109 */
110static void files_assert_main_repository(struct files_ref_store *refs,
111 const char *caller)
112{
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700113 if (refs->store_flags & REF_STORE_MAIN)
114 return;
115
Johannes Schindelin033abf92018-05-02 11:38:39 +0200116 BUG("operation %s only allowed for main ref store", caller);
Michael Haggerty32c597e2017-02-10 12:16:16 +0100117}
118
119/*
Michael Haggerty00eebe32016-09-04 18:08:11 +0200120 * Downcast ref_store to files_ref_store. Die if ref_store is not a
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700121 * files_ref_store. required_flags is compared with ref_store's
122 * store_flags to ensure the ref_store has all required capabilities.
123 * "caller" is used in any necessary error messages.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100124 */
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700125static struct files_ref_store *files_downcast(struct ref_store *ref_store,
126 unsigned int required_flags,
127 const char *caller)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100128{
Michael Haggerty32c597e2017-02-10 12:16:16 +0100129 struct files_ref_store *refs;
130
Michael Haggerty00eebe32016-09-04 18:08:11 +0200131 if (ref_store->be != &refs_be_files)
Johannes Schindelin033abf92018-05-02 11:38:39 +0200132 BUG("ref_store is type \"%s\" not \"files\" in %s",
Michael Haggerty00eebe32016-09-04 18:08:11 +0200133 ref_store->be->name, caller);
Michael Haggerty2eed2782016-06-18 06:15:12 +0200134
Michael Haggerty32c597e2017-02-10 12:16:16 +0100135 refs = (struct files_ref_store *)ref_store;
Michael Haggerty2eed2782016-06-18 06:15:12 +0200136
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700137 if ((refs->store_flags & required_flags) != required_flags)
Johannes Schindelin033abf92018-05-02 11:38:39 +0200138 BUG("operation %s requires abilities 0x%x, but only have 0x%x",
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700139 caller, required_flags, refs->store_flags);
Michael Haggerty32c597e2017-02-10 12:16:16 +0100140
141 return refs;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100142}
143
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200144static void files_reflog_path_other_worktrees(struct files_ref_store *refs,
145 struct strbuf *sb,
146 const char *refname)
147{
148 const char *real_ref;
149 const char *worktree_name;
150 int length;
151
152 if (parse_worktree_ref(refname, &worktree_name, &length, &real_ref))
153 BUG("refname %s is not a other-worktree ref", refname);
154
155 if (worktree_name)
156 strbuf_addf(sb, "%s/worktrees/%.*s/logs/%s", refs->gitcommondir,
157 length, worktree_name, real_ref);
158 else
159 strbuf_addf(sb, "%s/logs/%s", refs->gitcommondir,
160 real_ref);
161}
162
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +0700163static void files_reflog_path(struct files_ref_store *refs,
164 struct strbuf *sb,
165 const char *refname)
166{
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700167 switch (ref_type(refname)) {
168 case REF_TYPE_PER_WORKTREE:
169 case REF_TYPE_PSEUDOREF:
Han-Wen Nienhuys5085aef2020-08-19 14:27:57 +0000170 strbuf_addf(sb, "%s/logs/%s", refs->base.gitdir, refname);
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700171 break;
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200172 case REF_TYPE_OTHER_PSEUDOREF:
173 case REF_TYPE_MAIN_PSEUDOREF:
Nguyễn Thái Ngọc Duy46c0eb52018-11-25 05:58:16 +0100174 files_reflog_path_other_worktrees(refs, sb, refname);
175 break;
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700176 case REF_TYPE_NORMAL:
177 strbuf_addf(sb, "%s/logs/%s", refs->gitcommondir, refname);
178 break;
179 default:
Johannes Schindelin033abf92018-05-02 11:38:39 +0200180 BUG("unknown ref type %d of ref %s",
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700181 ref_type(refname), refname);
182 }
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +0700183}
184
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700185static void files_ref_path(struct files_ref_store *refs,
186 struct strbuf *sb,
187 const char *refname)
188{
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700189 switch (ref_type(refname)) {
190 case REF_TYPE_PER_WORKTREE:
191 case REF_TYPE_PSEUDOREF:
Han-Wen Nienhuys5085aef2020-08-19 14:27:57 +0000192 strbuf_addf(sb, "%s/%s", refs->base.gitdir, refname);
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700193 break;
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200194 case REF_TYPE_MAIN_PSEUDOREF:
195 if (!skip_prefix(refname, "main-worktree/", &refname))
196 BUG("ref %s is not a main pseudoref", refname);
197 /* fallthrough */
198 case REF_TYPE_OTHER_PSEUDOREF:
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700199 case REF_TYPE_NORMAL:
200 strbuf_addf(sb, "%s/%s", refs->gitcommondir, refname);
201 break;
202 default:
Johannes Schindelin033abf92018-05-02 11:38:39 +0200203 BUG("unknown ref type %d of ref %s",
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700204 ref_type(refname), refname);
205 }
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700206}
207
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100208/*
Nguyễn Thái Ngọc Duyb9317d52019-03-07 19:29:17 +0700209 * Manually add refs/bisect, refs/rewritten and refs/worktree, which, being
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700210 * per-worktree, might not appear in the directory listing for
211 * refs/ in the main repo.
212 */
213static void add_per_worktree_entries_to_dir(struct ref_dir *dir, const char *dirname)
214{
Nguyễn Thái Ngọc Duyb9317d52019-03-07 19:29:17 +0700215 const char *prefixes[] = { "refs/bisect/", "refs/worktree/", "refs/rewritten/" };
Nguyễn Thái Ngọc Duy90d31ff2019-03-07 19:29:16 +0700216 int ip;
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700217
218 if (strcmp(dirname, "refs/"))
219 return;
220
Nguyễn Thái Ngọc Duy90d31ff2019-03-07 19:29:16 +0700221 for (ip = 0; ip < ARRAY_SIZE(prefixes); ip++) {
222 const char *prefix = prefixes[ip];
223 int prefix_len = strlen(prefix);
224 struct ref_entry *child_entry;
225 int pos;
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700226
Nguyễn Thái Ngọc Duy90d31ff2019-03-07 19:29:16 +0700227 pos = search_ref_dir(dir, prefix, prefix_len);
228 if (pos >= 0)
229 continue;
230 child_entry = create_dir_entry(dir->cache, prefix, prefix_len, 1);
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700231 add_entry_to_dir(dir, child_entry);
232 }
233}
234
235/*
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100236 * Read the loose references from the namespace dirname into dir
237 * (without recursing). dirname must end with '/'. dir must be the
238 * directory entry corresponding to dirname.
239 */
Michael Haggertydf308752017-04-16 08:41:34 +0200240static void loose_fill_ref_dir(struct ref_store *ref_store,
241 struct ref_dir *dir, const char *dirname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100242{
Michael Haggertydf308752017-04-16 08:41:34 +0200243 struct files_ref_store *refs =
244 files_downcast(ref_store, REF_STORE_READ, "fill_ref_dir");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100245 DIR *d;
246 struct dirent *de;
247 int dirnamelen = strlen(dirname);
248 struct strbuf refname;
249 struct strbuf path = STRBUF_INIT;
250 size_t path_baselen;
251
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700252 files_ref_path(refs, &path, dirname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100253 path_baselen = path.len;
254
255 d = opendir(path.buf);
256 if (!d) {
257 strbuf_release(&path);
258 return;
259 }
260
261 strbuf_init(&refname, dirnamelen + 257);
262 strbuf_add(&refname, dirname, dirnamelen);
263
264 while ((de = readdir(d)) != NULL) {
brian m. carlson4417df82017-05-06 22:10:24 +0000265 struct object_id oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100266 struct stat st;
267 int flag;
268
269 if (de->d_name[0] == '.')
270 continue;
271 if (ends_with(de->d_name, ".lock"))
272 continue;
273 strbuf_addstr(&refname, de->d_name);
274 strbuf_addstr(&path, de->d_name);
275 if (stat(path.buf, &st) < 0) {
276 ; /* silently ignore */
277 } else if (S_ISDIR(st.st_mode)) {
278 strbuf_addch(&refname, '/');
279 add_entry_to_dir(dir,
Michael Haggertye00d1a42017-04-16 08:41:33 +0200280 create_dir_entry(dir->cache, refname.buf,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100281 refname.len, 1));
282 } else {
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700283 if (!refs_resolve_ref_unsafe(&refs->base,
Michael Haggerty3c0cb0c2017-02-09 21:53:52 +0100284 refname.buf,
285 RESOLVE_REF_READING,
brian m. carlson49e61472017-10-15 22:07:09 +0000286 &oid, &flag)) {
brian m. carlson4417df82017-05-06 22:10:24 +0000287 oidclr(&oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100288 flag |= REF_ISBROKEN;
brian m. carlson4417df82017-05-06 22:10:24 +0000289 } else if (is_null_oid(&oid)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100290 /*
291 * It is so astronomically unlikely
Michael Haggerty78fb4572017-11-05 09:42:09 +0100292 * that null_oid is the OID of an
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100293 * actual object that we consider its
294 * appearance in a loose reference
295 * file to be repo corruption
296 * (probably due to a software bug).
297 */
298 flag |= REF_ISBROKEN;
299 }
300
301 if (check_refname_format(refname.buf,
302 REFNAME_ALLOW_ONELEVEL)) {
303 if (!refname_is_safe(refname.buf))
304 die("loose refname is dangerous: %s", refname.buf);
brian m. carlson4417df82017-05-06 22:10:24 +0000305 oidclr(&oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100306 flag |= REF_BAD_NAME | REF_ISBROKEN;
307 }
308 add_entry_to_dir(dir,
Michael Haggertyc1da06c2017-05-22 16:17:53 +0200309 create_ref_entry(refname.buf, &oid, flag));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100310 }
311 strbuf_setlen(&refname, dirnamelen);
312 strbuf_setlen(&path, path_baselen);
313 }
314 strbuf_release(&refname);
315 strbuf_release(&path);
316 closedir(d);
Michael Haggertye3bf2982017-04-16 08:41:35 +0200317
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700318 add_per_worktree_entries_to_dir(dir, dirname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100319}
320
Michael Haggertya714b192017-04-16 08:41:38 +0200321static struct ref_cache *get_loose_ref_cache(struct files_ref_store *refs)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100322{
323 if (!refs->loose) {
324 /*
325 * Mark the top-level directory complete because we
326 * are about to read the only subdirectory that can
327 * hold references:
328 */
Michael Haggertydf308752017-04-16 08:41:34 +0200329 refs->loose = create_ref_cache(&refs->base, loose_fill_ref_dir);
Michael Haggerty7c22bc82017-04-16 08:41:32 +0200330
331 /* We're going to fill the top level ourselves: */
332 refs->loose->root->flag &= ~REF_INCOMPLETE;
333
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100334 /*
Michael Haggerty7c22bc82017-04-16 08:41:32 +0200335 * Add an incomplete entry for "refs/" (to be filled
336 * lazily):
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100337 */
Michael Haggerty7c22bc82017-04-16 08:41:32 +0200338 add_entry_to_dir(get_ref_dir(refs->loose->root),
Michael Haggertye00d1a42017-04-16 08:41:33 +0200339 create_dir_entry(refs->loose, "refs/", 5, 1));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100340 }
Michael Haggertya714b192017-04-16 08:41:38 +0200341 return refs->loose;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100342}
343
Michael Haggertye1e33b72016-09-04 18:08:25 +0200344static int files_read_raw_ref(struct ref_store *ref_store,
brian m. carlson99afe912017-10-15 22:07:11 +0000345 const char *refname, struct object_id *oid,
Michael Haggertye1e33b72016-09-04 18:08:25 +0200346 struct strbuf *referent, unsigned int *type)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100347{
Michael Haggerty43086512016-09-04 18:08:14 +0200348 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700349 files_downcast(ref_store, REF_STORE_READ, "read_raw_ref");
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400350 struct strbuf sb_contents = STRBUF_INIT;
351 struct strbuf sb_path = STRBUF_INIT;
David Turner70486532016-04-07 15:03:01 -0400352 const char *path;
353 const char *buf;
354 struct stat st;
355 int fd;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400356 int ret = -1;
357 int save_errno;
Jeff Kinge8c42cb2016-10-06 12:48:42 -0400358 int remaining_retries = 3;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100359
Michael Haggertyfa96ea12016-04-22 01:11:17 +0200360 *type = 0;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400361 strbuf_reset(&sb_path);
Michael Haggerty34c7ad82016-09-04 18:08:20 +0200362
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700363 files_ref_path(refs, &sb_path, refname);
Michael Haggerty34c7ad82016-09-04 18:08:20 +0200364
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400365 path = sb_path.buf;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100366
David Turner70486532016-04-07 15:03:01 -0400367stat_ref:
368 /*
369 * We might have to loop back here to avoid a race
370 * condition: first we lstat() the file, then we try
371 * to read it as a link or as a file. But if somebody
372 * changes the type of the file (file <-> directory
373 * <-> symlink) between the lstat() and reading, then
374 * we don't want to report that as an error but rather
375 * try again starting with the lstat().
Jeff Kinge8c42cb2016-10-06 12:48:42 -0400376 *
377 * We'll keep a count of the retries, though, just to avoid
378 * any confusing situation sending us into an infinite loop.
David Turner70486532016-04-07 15:03:01 -0400379 */
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100380
Jeff Kinge8c42cb2016-10-06 12:48:42 -0400381 if (remaining_retries-- <= 0)
382 goto out;
383
David Turner70486532016-04-07 15:03:01 -0400384 if (lstat(path, &st) < 0) {
385 if (errno != ENOENT)
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400386 goto out;
Michael Haggertye0cc8ac2017-06-23 09:01:38 +0200387 if (refs_read_raw_ref(refs->packed_ref_store, refname,
brian m. carlson99afe912017-10-15 22:07:11 +0000388 oid, referent, type)) {
David Turner70486532016-04-07 15:03:01 -0400389 errno = ENOENT;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400390 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100391 }
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400392 ret = 0;
393 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100394 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100395
David Turner70486532016-04-07 15:03:01 -0400396 /* Follow "normalized" - ie "refs/.." symlinks by hand */
397 if (S_ISLNK(st.st_mode)) {
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400398 strbuf_reset(&sb_contents);
Jeff King765b4962018-07-24 06:51:39 -0400399 if (strbuf_readlink(&sb_contents, path, st.st_size) < 0) {
David Turner70486532016-04-07 15:03:01 -0400400 if (errno == ENOENT || errno == EINVAL)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100401 /* inconsistent with lstat; retry */
402 goto stat_ref;
403 else
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400404 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100405 }
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400406 if (starts_with(sb_contents.buf, "refs/") &&
407 !check_refname_format(sb_contents.buf, 0)) {
Michael Haggerty92b38092016-04-22 01:11:17 +0200408 strbuf_swap(&sb_contents, referent);
Michael Haggerty3a0b6b92016-04-26 03:06:23 +0200409 *type |= REF_ISSYMREF;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400410 ret = 0;
411 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100412 }
Jeff King3f7bd762016-10-06 15:41:08 -0400413 /*
414 * It doesn't look like a refname; fall through to just
415 * treating it like a non-symlink, and reading whatever it
416 * points to.
417 */
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100418 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100419
David Turner70486532016-04-07 15:03:01 -0400420 /* Is it a directory? */
421 if (S_ISDIR(st.st_mode)) {
Michael Haggertye167a562016-05-05 14:09:41 +0200422 /*
423 * Even though there is a directory where the loose
424 * ref is supposed to be, there could still be a
425 * packed ref:
426 */
Michael Haggertye0cc8ac2017-06-23 09:01:38 +0200427 if (refs_read_raw_ref(refs->packed_ref_store, refname,
brian m. carlson99afe912017-10-15 22:07:11 +0000428 oid, referent, type)) {
Michael Haggertye167a562016-05-05 14:09:41 +0200429 errno = EISDIR;
430 goto out;
431 }
432 ret = 0;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400433 goto out;
David Turner70486532016-04-07 15:03:01 -0400434 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100435
David Turner70486532016-04-07 15:03:01 -0400436 /*
437 * Anything else, just open it and try to use it as
438 * a ref
439 */
440 fd = open(path, O_RDONLY);
441 if (fd < 0) {
Jeff King3f7bd762016-10-06 15:41:08 -0400442 if (errno == ENOENT && !S_ISLNK(st.st_mode))
David Turner70486532016-04-07 15:03:01 -0400443 /* inconsistent with lstat; retry */
444 goto stat_ref;
445 else
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400446 goto out;
David Turner70486532016-04-07 15:03:01 -0400447 }
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400448 strbuf_reset(&sb_contents);
449 if (strbuf_read(&sb_contents, fd, 256) < 0) {
David Turner70486532016-04-07 15:03:01 -0400450 int save_errno = errno;
451 close(fd);
452 errno = save_errno;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400453 goto out;
David Turner70486532016-04-07 15:03:01 -0400454 }
455 close(fd);
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400456 strbuf_rtrim(&sb_contents);
457 buf = sb_contents.buf;
David Turner70486532016-04-07 15:03:01 -0400458
Han-Wen Nienhuyse39620f2020-08-19 14:27:55 +0000459 ret = parse_loose_ref_contents(buf, oid, referent, type);
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400460
461out:
462 save_errno = errno;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100463 strbuf_release(&sb_path);
464 strbuf_release(&sb_contents);
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400465 errno = save_errno;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100466 return ret;
467}
468
Han-Wen Nienhuyse39620f2020-08-19 14:27:55 +0000469int parse_loose_ref_contents(const char *buf, struct object_id *oid,
470 struct strbuf *referent, unsigned int *type)
471{
472 const char *p;
473 if (skip_prefix(buf, "ref:", &buf)) {
474 while (isspace(*buf))
475 buf++;
476
477 strbuf_reset(referent);
478 strbuf_addstr(referent, buf);
479 *type |= REF_ISSYMREF;
480 return 0;
481 }
482
483 /*
484 * FETCH_HEAD has additional data after the sha.
485 */
486 if (parse_oid_hex(buf, oid, &p) ||
487 (*p != '\0' && !isspace(*p))) {
488 *type |= REF_ISBROKEN;
489 errno = EINVAL;
490 return -1;
491 }
492 return 0;
493}
494
Michael Haggerty8415d242016-04-24 08:11:37 +0200495static void unlock_ref(struct ref_lock *lock)
496{
Jeff Kingee4d8e42017-09-05 08:15:15 -0400497 rollback_lock_file(&lock->lk);
Michael Haggerty8415d242016-04-24 08:11:37 +0200498 free(lock->ref_name);
Michael Haggerty8415d242016-04-24 08:11:37 +0200499 free(lock);
500}
501
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100502/*
Michael Haggerty92b15512016-04-25 15:56:07 +0200503 * Lock refname, without following symrefs, and set *lock_p to point
504 * at a newly-allocated lock object. Fill in lock->old_oid, referent,
505 * and type similarly to read_raw_ref().
506 *
507 * The caller must verify that refname is a "safe" reference name (in
508 * the sense of refname_is_safe()) before calling this function.
509 *
510 * If the reference doesn't already exist, verify that refname doesn't
511 * have a D/F conflict with any existing references. extras and skip
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200512 * are passed to refs_verify_refname_available() for this check.
Michael Haggerty92b15512016-04-25 15:56:07 +0200513 *
514 * If mustexist is not set and the reference is not found or is
Michael Haggerty78fb4572017-11-05 09:42:09 +0100515 * broken, lock the reference anyway but clear old_oid.
Michael Haggerty92b15512016-04-25 15:56:07 +0200516 *
517 * Return 0 on success. On failure, write an error message to err and
518 * return TRANSACTION_NAME_CONFLICT or TRANSACTION_GENERIC_ERROR.
519 *
520 * Implementation note: This function is basically
521 *
522 * lock reference
523 * read_raw_ref()
524 *
525 * but it includes a lot more code to
526 * - Deal with possible races with other processes
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200527 * - Avoid calling refs_verify_refname_available() when it can be
Michael Haggerty92b15512016-04-25 15:56:07 +0200528 * avoided, namely if we were successfully able to read the ref
529 * - Generate informative error messages in the case of failure
530 */
Michael Haggertyf7b0a982016-09-04 18:08:31 +0200531static int lock_raw_ref(struct files_ref_store *refs,
532 const char *refname, int mustexist,
Michael Haggerty92b15512016-04-25 15:56:07 +0200533 const struct string_list *extras,
534 const struct string_list *skip,
535 struct ref_lock **lock_p,
536 struct strbuf *referent,
537 unsigned int *type,
538 struct strbuf *err)
539{
540 struct ref_lock *lock;
541 struct strbuf ref_file = STRBUF_INIT;
542 int attempts_remaining = 3;
543 int ret = TRANSACTION_GENERIC_ERROR;
544
545 assert(err);
Michael Haggerty32c597e2017-02-10 12:16:16 +0100546 files_assert_main_repository(refs, "lock_raw_ref");
Michael Haggertyf7b0a982016-09-04 18:08:31 +0200547
Michael Haggerty92b15512016-04-25 15:56:07 +0200548 *type = 0;
549
550 /* First lock the file so it can't change out from under us. */
551
René Scharfeca56dad2021-03-13 17:17:22 +0100552 *lock_p = CALLOC_ARRAY(lock, 1);
Michael Haggerty92b15512016-04-25 15:56:07 +0200553
554 lock->ref_name = xstrdup(refname);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700555 files_ref_path(refs, &ref_file, refname);
Michael Haggerty92b15512016-04-25 15:56:07 +0200556
557retry:
558 switch (safe_create_leading_directories(ref_file.buf)) {
559 case SCLD_OK:
560 break; /* success */
561 case SCLD_EXISTS:
562 /*
563 * Suppose refname is "refs/foo/bar". We just failed
564 * to create the containing directory, "refs/foo",
565 * because there was a non-directory in the way. This
566 * indicates a D/F conflict, probably because of
567 * another reference such as "refs/foo". There is no
568 * reason to expect this error to be transitory.
569 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700570 if (refs_verify_refname_available(&refs->base, refname,
571 extras, skip, err)) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200572 if (mustexist) {
573 /*
574 * To the user the relevant error is
575 * that the "mustexist" reference is
576 * missing:
577 */
578 strbuf_reset(err);
579 strbuf_addf(err, "unable to resolve reference '%s'",
580 refname);
581 } else {
582 /*
583 * The error message set by
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200584 * refs_verify_refname_available() is
585 * OK.
Michael Haggerty92b15512016-04-25 15:56:07 +0200586 */
587 ret = TRANSACTION_NAME_CONFLICT;
588 }
589 } else {
590 /*
591 * The file that is in the way isn't a loose
592 * reference. Report it as a low-level
593 * failure.
594 */
595 strbuf_addf(err, "unable to create lock file %s.lock; "
596 "non-directory in the way",
597 ref_file.buf);
598 }
599 goto error_return;
600 case SCLD_VANISHED:
601 /* Maybe another process was tidying up. Try again. */
602 if (--attempts_remaining > 0)
603 goto retry;
604 /* fall through */
605 default:
606 strbuf_addf(err, "unable to create directory for %s",
607 ref_file.buf);
608 goto error_return;
609 }
610
Michael Haggerty4ff0f012017-08-21 13:51:34 +0200611 if (hold_lock_file_for_update_timeout(
Jeff Kingee4d8e42017-09-05 08:15:15 -0400612 &lock->lk, ref_file.buf, LOCK_NO_DEREF,
Michael Haggerty4ff0f012017-08-21 13:51:34 +0200613 get_files_ref_lock_timeout_ms()) < 0) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200614 if (errno == ENOENT && --attempts_remaining > 0) {
615 /*
616 * Maybe somebody just deleted one of the
617 * directories leading to ref_file. Try
618 * again:
619 */
620 goto retry;
621 } else {
622 unable_to_lock_message(ref_file.buf, errno, err);
623 goto error_return;
624 }
625 }
626
627 /*
628 * Now we hold the lock and can read the reference without
629 * fear that its value will change.
630 */
631
Michael Haggertyf7b0a982016-09-04 18:08:31 +0200632 if (files_read_raw_ref(&refs->base, refname,
brian m. carlson99afe912017-10-15 22:07:11 +0000633 &lock->old_oid, referent, type)) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200634 if (errno == ENOENT) {
635 if (mustexist) {
636 /* Garden variety missing reference. */
637 strbuf_addf(err, "unable to resolve reference '%s'",
638 refname);
639 goto error_return;
640 } else {
641 /*
642 * Reference is missing, but that's OK. We
643 * know that there is not a conflict with
644 * another loose reference because
645 * (supposing that we are trying to lock
646 * reference "refs/foo/bar"):
647 *
648 * - We were successfully able to create
649 * the lockfile refs/foo/bar.lock, so we
650 * know there cannot be a loose reference
651 * named "refs/foo".
652 *
653 * - We got ENOENT and not EISDIR, so we
654 * know that there cannot be a loose
655 * reference named "refs/foo/bar/baz".
656 */
657 }
658 } else if (errno == EISDIR) {
659 /*
660 * There is a directory in the way. It might have
661 * contained references that have been deleted. If
662 * we don't require that the reference already
663 * exists, try to remove the directory so that it
664 * doesn't cause trouble when we want to rename the
665 * lockfile into place later.
666 */
667 if (mustexist) {
668 /* Garden variety missing reference. */
669 strbuf_addf(err, "unable to resolve reference '%s'",
670 refname);
671 goto error_return;
672 } else if (remove_dir_recursively(&ref_file,
673 REMOVE_DIR_EMPTY_ONLY)) {
Michael Haggertyb05855b2017-04-16 08:41:26 +0200674 if (refs_verify_refname_available(
675 &refs->base, refname,
676 extras, skip, err)) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200677 /*
678 * The error message set by
679 * verify_refname_available() is OK.
680 */
681 ret = TRANSACTION_NAME_CONFLICT;
682 goto error_return;
683 } else {
684 /*
685 * We can't delete the directory,
686 * but we also don't know of any
687 * references that it should
688 * contain.
689 */
690 strbuf_addf(err, "there is a non-empty directory '%s' "
691 "blocking reference '%s'",
692 ref_file.buf, refname);
693 goto error_return;
694 }
695 }
696 } else if (errno == EINVAL && (*type & REF_ISBROKEN)) {
697 strbuf_addf(err, "unable to resolve reference '%s': "
698 "reference broken", refname);
699 goto error_return;
700 } else {
701 strbuf_addf(err, "unable to resolve reference '%s': %s",
702 refname, strerror(errno));
703 goto error_return;
704 }
705
706 /*
707 * If the ref did not exist and we are creating it,
Michael Haggerty8ec617c2017-08-17 17:12:50 +0200708 * make sure there is no existing packed ref that
709 * conflicts with refname:
Michael Haggerty92b15512016-04-25 15:56:07 +0200710 */
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200711 if (refs_verify_refname_available(
Michael Haggerty8ec617c2017-08-17 17:12:50 +0200712 refs->packed_ref_store, refname,
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200713 extras, skip, err))
Michael Haggerty92b15512016-04-25 15:56:07 +0200714 goto error_return;
Michael Haggerty92b15512016-04-25 15:56:07 +0200715 }
716
717 ret = 0;
718 goto out;
719
720error_return:
721 unlock_ref(lock);
722 *lock_p = NULL;
723
724out:
725 strbuf_release(&ref_file);
726 return ret;
727}
728
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200729struct files_ref_iterator {
730 struct ref_iterator base;
731
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200732 struct ref_iterator *iter0;
733 unsigned int flags;
734};
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100735
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200736static int files_ref_iterator_advance(struct ref_iterator *ref_iterator)
737{
738 struct files_ref_iterator *iter =
739 (struct files_ref_iterator *)ref_iterator;
740 int ok;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100741
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200742 while ((ok = ref_iterator_advance(iter->iter0)) == ITER_OK) {
David Turner0c09ec02016-09-04 18:08:44 +0200743 if (iter->flags & DO_FOR_EACH_PER_WORKTREE_ONLY &&
744 ref_type(iter->iter0->refname) != REF_TYPE_PER_WORKTREE)
745 continue;
746
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200747 if (!(iter->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
748 !ref_resolves_to_object(iter->iter0->refname,
749 iter->iter0->oid,
750 iter->iter0->flags))
751 continue;
752
753 iter->base.refname = iter->iter0->refname;
754 iter->base.oid = iter->iter0->oid;
755 iter->base.flags = iter->iter0->flags;
756 return ITER_OK;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100757 }
758
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200759 iter->iter0 = NULL;
760 if (ref_iterator_abort(ref_iterator) != ITER_DONE)
761 ok = ITER_ERROR;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100762
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200763 return ok;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100764}
765
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200766static int files_ref_iterator_peel(struct ref_iterator *ref_iterator,
767 struct object_id *peeled)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100768{
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200769 struct files_ref_iterator *iter =
770 (struct files_ref_iterator *)ref_iterator;
David Turner93770592016-04-07 15:02:49 -0400771
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200772 return ref_iterator_peel(iter->iter0, peeled);
773}
774
775static int files_ref_iterator_abort(struct ref_iterator *ref_iterator)
776{
777 struct files_ref_iterator *iter =
778 (struct files_ref_iterator *)ref_iterator;
779 int ok = ITER_DONE;
780
781 if (iter->iter0)
782 ok = ref_iterator_abort(iter->iter0);
783
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200784 base_ref_iterator_free(ref_iterator);
785 return ok;
786}
787
788static struct ref_iterator_vtable files_ref_iterator_vtable = {
789 files_ref_iterator_advance,
790 files_ref_iterator_peel,
791 files_ref_iterator_abort
792};
793
Michael Haggerty1a769002016-09-04 18:08:37 +0200794static struct ref_iterator *files_ref_iterator_begin(
Michael Haggerty37b6f6d2016-09-04 18:08:36 +0200795 struct ref_store *ref_store,
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200796 const char *prefix, unsigned int flags)
797{
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700798 struct files_ref_store *refs;
Michael Haggerty8738a8a2017-09-13 19:15:55 +0200799 struct ref_iterator *loose_iter, *packed_iter, *overlay_iter;
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200800 struct files_ref_iterator *iter;
801 struct ref_iterator *ref_iterator;
Michael Haggerty0a0865b2017-05-22 16:17:52 +0200802 unsigned int required_flags = REF_STORE_READ;
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200803
Michael Haggerty0a0865b2017-05-22 16:17:52 +0200804 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN))
805 required_flags |= REF_STORE_ODB;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100806
Michael Haggerty0a0865b2017-05-22 16:17:52 +0200807 refs = files_downcast(ref_store, required_flags, "ref_iterator_begin");
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700808
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200809 /*
810 * We must make sure that all loose refs are read before
811 * accessing the packed-refs file; this avoids a race
812 * condition if loose refs are migrated to the packed-refs
813 * file by a simultaneous process, but our in-memory view is
814 * from before the migration. We ensure this as follows:
Michael Haggerty059ae352017-04-16 08:41:39 +0200815 * First, we call start the loose refs iteration with its
816 * `prime_ref` argument set to true. This causes the loose
817 * references in the subtree to be pre-read into the cache.
818 * (If they've already been read, that's OK; we only need to
819 * guarantee that they're read before the packed refs, not
820 * *how much* before.) After that, we call
Michael Haggerty38b86e82017-06-23 09:01:35 +0200821 * packed_ref_iterator_begin(), which internally checks
822 * whether the packed-ref cache is up to date with what is on
823 * disk, and re-reads it if not.
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200824 */
825
Michael Haggerty059ae352017-04-16 08:41:39 +0200826 loose_iter = cache_ref_iterator_begin(get_loose_ref_cache(refs),
827 prefix, 1);
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200828
Michael Haggerty38b86e82017-06-23 09:01:35 +0200829 /*
830 * The packed-refs file might contain broken references, for
831 * example an old version of a reference that points at an
832 * object that has since been garbage-collected. This is OK as
833 * long as there is a corresponding loose reference that
834 * overrides it, and we don't want to emit an error message in
835 * this case. So ask the packed_ref_store for all of its
836 * references, and (if needed) do our own check for broken
837 * ones in files_ref_iterator_advance(), after we have merged
838 * the packed and loose references.
839 */
Michael Haggertye0cc8ac2017-06-23 09:01:38 +0200840 packed_iter = refs_ref_iterator_begin(
841 refs->packed_ref_store, prefix, 0,
Michael Haggerty38b86e82017-06-23 09:01:35 +0200842 DO_FOR_EACH_INCLUDE_BROKEN);
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200843
Michael Haggerty8738a8a2017-09-13 19:15:55 +0200844 overlay_iter = overlay_ref_iterator_begin(loose_iter, packed_iter);
845
René Scharfeca56dad2021-03-13 17:17:22 +0100846 CALLOC_ARRAY(iter, 1);
Michael Haggerty8738a8a2017-09-13 19:15:55 +0200847 ref_iterator = &iter->base;
848 base_ref_iterator_init(ref_iterator, &files_ref_iterator_vtable,
849 overlay_iter->ordered);
850 iter->iter0 = overlay_iter;
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200851 iter->flags = flags;
852
853 return ref_iterator;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100854}
855
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100856/*
brian m. carlson4f01e502017-10-15 22:07:12 +0000857 * Verify that the reference locked by lock has the value old_oid
858 * (unless it is NULL). Fail if the reference doesn't exist and
859 * mustexist is set. Return 0 on success. On error, write an error
860 * message to err, set errno, and return a negative value.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100861 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700862static int verify_lock(struct ref_store *ref_store, struct ref_lock *lock,
brian m. carlson4f01e502017-10-15 22:07:12 +0000863 const struct object_id *old_oid, int mustexist,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100864 struct strbuf *err)
865{
866 assert(err);
867
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700868 if (refs_read_ref_full(ref_store, lock->ref_name,
869 mustexist ? RESOLVE_REF_READING : 0,
brian m. carlson34c290a2017-10-15 22:06:56 +0000870 &lock->old_oid, NULL)) {
brian m. carlson4f01e502017-10-15 22:07:12 +0000871 if (old_oid) {
Jeff King6294dcb2016-01-12 16:44:39 -0500872 int save_errno = errno;
Michael Haggerty0568c8e2016-04-27 15:21:36 +0200873 strbuf_addf(err, "can't verify ref '%s'", lock->ref_name);
Jeff King6294dcb2016-01-12 16:44:39 -0500874 errno = save_errno;
875 return -1;
876 } else {
brian m. carlsonc368dde2016-06-24 23:09:22 +0000877 oidclr(&lock->old_oid);
Jeff King6294dcb2016-01-12 16:44:39 -0500878 return 0;
879 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100880 }
Jeff King9001dc22018-08-28 17:22:48 -0400881 if (old_oid && !oideq(&lock->old_oid, old_oid)) {
Michael Haggerty0568c8e2016-04-27 15:21:36 +0200882 strbuf_addf(err, "ref '%s' is at %s but expected %s",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100883 lock->ref_name,
brian m. carlsonc368dde2016-06-24 23:09:22 +0000884 oid_to_hex(&lock->old_oid),
brian m. carlson4f01e502017-10-15 22:07:12 +0000885 oid_to_hex(old_oid));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100886 errno = EBUSY;
887 return -1;
888 }
889 return 0;
890}
891
892static int remove_empty_directories(struct strbuf *path)
893{
894 /*
895 * we want to create a file but there is a directory there;
896 * if that is an empty directory (or a directory that contains
897 * only empty directories), remove them.
898 */
899 return remove_dir_recursively(path, REMOVE_DIR_EMPTY_ONLY);
900}
901
Michael Haggerty3b5d3c92017-01-06 17:22:28 +0100902static int create_reflock(const char *path, void *cb)
903{
904 struct lock_file *lk = cb;
905
Michael Haggerty4ff0f012017-08-21 13:51:34 +0200906 return hold_lock_file_for_update_timeout(
907 lk, path, LOCK_NO_DEREF,
908 get_files_ref_lock_timeout_ms()) < 0 ? -1 : 0;
Michael Haggerty3b5d3c92017-01-06 17:22:28 +0100909}
910
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100911/*
912 * Locks a ref returning the lock on success and NULL on failure.
913 * On failure errno is set to something meaningful.
914 */
brian m. carlson4f01e502017-10-15 22:07:12 +0000915static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs,
916 const char *refname,
917 const struct object_id *old_oid,
918 const struct string_list *extras,
919 const struct string_list *skip,
920 unsigned int flags, int *type,
921 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100922{
923 struct strbuf ref_file = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100924 struct ref_lock *lock;
925 int last_errno = 0;
brian m. carlson4f01e502017-10-15 22:07:12 +0000926 int mustexist = (old_oid && !is_null_oid(old_oid));
Michael Haggerty7a418f32016-04-22 15:25:25 +0200927 int resolve_flags = RESOLVE_REF_NO_RECURSE;
Michael Haggerty7a418f32016-04-22 15:25:25 +0200928 int resolved;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100929
brian m. carlson4f01e502017-10-15 22:07:12 +0000930 files_assert_main_repository(refs, "lock_ref_oid_basic");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100931 assert(err);
932
René Scharfeca56dad2021-03-13 17:17:22 +0100933 CALLOC_ARRAY(lock, 1);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100934
935 if (mustexist)
936 resolve_flags |= RESOLVE_REF_READING;
Jeff King2859dcd2016-01-12 16:45:09 -0500937 if (flags & REF_DELETING)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100938 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100939
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700940 files_ref_path(refs, &ref_file, refname);
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700941 resolved = !!refs_resolve_ref_unsafe(&refs->base,
942 refname, resolve_flags,
brian m. carlson49e61472017-10-15 22:07:09 +0000943 &lock->old_oid, type);
Michael Haggerty7a418f32016-04-22 15:25:25 +0200944 if (!resolved && errno == EISDIR) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100945 /*
946 * we are trying to lock foo but we used to
947 * have foo/bar which now does not exist;
948 * it is normal for the empty directory 'foo'
949 * to remain.
950 */
Michael Haggerty7a418f32016-04-22 15:25:25 +0200951 if (remove_empty_directories(&ref_file)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100952 last_errno = errno;
Michael Haggertyb05855b2017-04-16 08:41:26 +0200953 if (!refs_verify_refname_available(
954 &refs->base,
955 refname, extras, skip, err))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100956 strbuf_addf(err, "there are still refs under '%s'",
Michael Haggerty7a418f32016-04-22 15:25:25 +0200957 refname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100958 goto error_return;
959 }
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700960 resolved = !!refs_resolve_ref_unsafe(&refs->base,
961 refname, resolve_flags,
brian m. carlson49e61472017-10-15 22:07:09 +0000962 &lock->old_oid, type);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100963 }
Michael Haggerty7a418f32016-04-22 15:25:25 +0200964 if (!resolved) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100965 last_errno = errno;
966 if (last_errno != ENOTDIR ||
Michael Haggertyb05855b2017-04-16 08:41:26 +0200967 !refs_verify_refname_available(&refs->base, refname,
968 extras, skip, err))
Michael Haggerty0568c8e2016-04-27 15:21:36 +0200969 strbuf_addf(err, "unable to resolve reference '%s': %s",
Michael Haggerty7a418f32016-04-22 15:25:25 +0200970 refname, strerror(last_errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100971
972 goto error_return;
973 }
Jeff King2859dcd2016-01-12 16:45:09 -0500974
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100975 /*
976 * If the ref did not exist and we are creating it, make sure
977 * there is no existing packed ref whose name begins with our
978 * refname, nor a packed ref whose name is a proper prefix of
979 * our refname.
980 */
981 if (is_null_oid(&lock->old_oid) &&
Michael Haggerty8ec617c2017-08-17 17:12:50 +0200982 refs_verify_refname_available(refs->packed_ref_store, refname,
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200983 extras, skip, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100984 last_errno = ENOTDIR;
985 goto error_return;
986 }
987
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100988 lock->ref_name = xstrdup(refname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100989
Jeff Kingee4d8e42017-09-05 08:15:15 -0400990 if (raceproof_create_file(ref_file.buf, create_reflock, &lock->lk)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100991 last_errno = errno;
Michael Haggerty3b5d3c92017-01-06 17:22:28 +0100992 unable_to_lock_message(ref_file.buf, errno, err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100993 goto error_return;
994 }
995
brian m. carlson4f01e502017-10-15 22:07:12 +0000996 if (verify_lock(&refs->base, lock, old_oid, mustexist, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100997 last_errno = errno;
998 goto error_return;
999 }
1000 goto out;
1001
1002 error_return:
1003 unlock_ref(lock);
1004 lock = NULL;
1005
1006 out:
1007 strbuf_release(&ref_file);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001008 errno = last_errno;
1009 return lock;
1010}
1011
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001012struct ref_to_prune {
1013 struct ref_to_prune *next;
brian m. carlson49e99582017-10-15 22:06:49 +00001014 struct object_id oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001015 char name[FLEX_ARRAY];
1016};
1017
Michael Haggertya8f0db22017-01-06 17:22:42 +01001018enum {
1019 REMOVE_EMPTY_PARENTS_REF = 0x01,
1020 REMOVE_EMPTY_PARENTS_REFLOG = 0x02
1021};
1022
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001023/*
Michael Haggertya8f0db22017-01-06 17:22:42 +01001024 * Remove empty parent directories associated with the specified
1025 * reference and/or its reflog, but spare [logs/]refs/ and immediate
1026 * subdirs. flags is a combination of REMOVE_EMPTY_PARENTS_REF and/or
1027 * REMOVE_EMPTY_PARENTS_REFLOG.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001028 */
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001029static void try_remove_empty_parents(struct files_ref_store *refs,
1030 const char *refname,
1031 unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001032{
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001033 struct strbuf buf = STRBUF_INIT;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001034 struct strbuf sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001035 char *p, *q;
1036 int i;
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001037
1038 strbuf_addstr(&buf, refname);
1039 p = buf.buf;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001040 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
1041 while (*p && *p != '/')
1042 p++;
1043 /* tolerate duplicate slashes; see check_refname_format() */
1044 while (*p == '/')
1045 p++;
1046 }
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001047 q = buf.buf + buf.len;
Michael Haggertya8f0db22017-01-06 17:22:42 +01001048 while (flags & (REMOVE_EMPTY_PARENTS_REF | REMOVE_EMPTY_PARENTS_REFLOG)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001049 while (q > p && *q != '/')
1050 q--;
1051 while (q > p && *(q-1) == '/')
1052 q--;
1053 if (q == p)
1054 break;
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001055 strbuf_setlen(&buf, q - buf.buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001056
1057 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07001058 files_ref_path(refs, &sb, buf.buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001059 if ((flags & REMOVE_EMPTY_PARENTS_REF) && rmdir(sb.buf))
Michael Haggertya8f0db22017-01-06 17:22:42 +01001060 flags &= ~REMOVE_EMPTY_PARENTS_REF;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001061
1062 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001063 files_reflog_path(refs, &sb, buf.buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001064 if ((flags & REMOVE_EMPTY_PARENTS_REFLOG) && rmdir(sb.buf))
Michael Haggertya8f0db22017-01-06 17:22:42 +01001065 flags &= ~REMOVE_EMPTY_PARENTS_REFLOG;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001066 }
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001067 strbuf_release(&buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001068 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001069}
1070
1071/* make sure nobody touched the ref, and unlink */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001072static void prune_ref(struct files_ref_store *refs, struct ref_to_prune *r)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001073{
1074 struct ref_transaction *transaction;
1075 struct strbuf err = STRBUF_INIT;
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001076 int ret = -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001077
1078 if (check_refname_format(r->name, 0))
1079 return;
1080
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001081 transaction = ref_store_transaction_begin(&refs->base, &err);
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001082 if (!transaction)
1083 goto cleanup;
1084 ref_transaction_add_update(
1085 transaction, r->name,
Michael Haggertyacedcde2017-11-05 09:42:07 +01001086 REF_NO_DEREF | REF_HAVE_NEW | REF_HAVE_OLD | REF_IS_PRUNING,
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001087 &null_oid, &r->oid, NULL);
1088 if (ref_transaction_commit(transaction, &err))
1089 goto cleanup;
1090
1091 ret = 0;
1092
1093cleanup:
1094 if (ret)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001095 error("%s", err.buf);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001096 strbuf_release(&err);
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001097 ref_transaction_free(transaction);
1098 return;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001099}
1100
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001101/*
1102 * Prune the loose versions of the references in the linked list
1103 * `*refs_to_prune`, freeing the entries in the list as we go.
1104 */
1105static void prune_refs(struct files_ref_store *refs, struct ref_to_prune **refs_to_prune)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001106{
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001107 while (*refs_to_prune) {
1108 struct ref_to_prune *r = *refs_to_prune;
1109 *refs_to_prune = r->next;
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001110 prune_ref(refs, r);
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001111 free(r);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001112 }
1113}
1114
Michael Haggerty531cc4a2017-05-22 16:17:48 +02001115/*
1116 * Return true if the specified reference should be packed.
1117 */
1118static int should_pack_ref(const char *refname,
1119 const struct object_id *oid, unsigned int ref_flags,
1120 unsigned int pack_flags)
1121{
1122 /* Do not pack per-worktree refs: */
1123 if (ref_type(refname) != REF_TYPE_NORMAL)
1124 return 0;
1125
1126 /* Do not pack non-tags unless PACK_REFS_ALL is set: */
1127 if (!(pack_flags & PACK_REFS_ALL) && !starts_with(refname, "refs/tags/"))
1128 return 0;
1129
1130 /* Do not pack symbolic refs: */
1131 if (ref_flags & REF_ISSYMREF)
1132 return 0;
1133
1134 /* Do not pack broken refs: */
1135 if (!ref_resolves_to_object(refname, oid, ref_flags))
1136 return 0;
1137
1138 return 1;
1139}
1140
Michael Haggerty82315272016-09-04 18:08:27 +02001141static int files_pack_refs(struct ref_store *ref_store, unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001142{
Michael Haggerty00eebe32016-09-04 18:08:11 +02001143 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001144 files_downcast(ref_store, REF_STORE_WRITE | REF_STORE_ODB,
1145 "pack_refs");
Michael Haggerty50c2d852017-04-16 08:41:41 +02001146 struct ref_iterator *iter;
Michael Haggerty50c2d852017-04-16 08:41:41 +02001147 int ok;
1148 struct ref_to_prune *refs_to_prune = NULL;
Michael Haggerty34789832017-06-23 09:01:39 +02001149 struct strbuf err = STRBUF_INIT;
Michael Haggerty27d03d02017-09-08 15:51:47 +02001150 struct ref_transaction *transaction;
1151
1152 transaction = ref_store_transaction_begin(refs->packed_ref_store, &err);
1153 if (!transaction)
1154 return -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001155
Michael Haggertyc8bed832017-06-23 09:01:42 +02001156 packed_refs_lock(refs->packed_ref_store, LOCK_DIE_ON_ERROR, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001157
Michael Haggerty50c2d852017-04-16 08:41:41 +02001158 iter = cache_ref_iterator_begin(get_loose_ref_cache(refs), NULL, 0);
1159 while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
1160 /*
1161 * If the loose reference can be packed, add an entry
1162 * in the packed ref cache. If the reference should be
1163 * pruned, also add it to refs_to_prune.
1164 */
Michael Haggerty531cc4a2017-05-22 16:17:48 +02001165 if (!should_pack_ref(iter->refname, iter->oid, iter->flags,
1166 flags))
Michael Haggerty50c2d852017-04-16 08:41:41 +02001167 continue;
1168
1169 /*
Michael Haggerty27d03d02017-09-08 15:51:47 +02001170 * Add a reference creation for this reference to the
1171 * packed-refs transaction:
Michael Haggerty50c2d852017-04-16 08:41:41 +02001172 */
Michael Haggerty27d03d02017-09-08 15:51:47 +02001173 if (ref_transaction_update(transaction, iter->refname,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00001174 iter->oid, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001175 REF_NO_DEREF, NULL, &err))
Michael Haggerty27d03d02017-09-08 15:51:47 +02001176 die("failure preparing to create packed reference %s: %s",
1177 iter->refname, err.buf);
Michael Haggerty50c2d852017-04-16 08:41:41 +02001178
1179 /* Schedule the loose reference for pruning if requested. */
1180 if ((flags & PACK_REFS_PRUNE)) {
1181 struct ref_to_prune *n;
1182 FLEX_ALLOC_STR(n, name, iter->refname);
brian m. carlson49e99582017-10-15 22:06:49 +00001183 oidcpy(&n->oid, iter->oid);
Michael Haggerty50c2d852017-04-16 08:41:41 +02001184 n->next = refs_to_prune;
1185 refs_to_prune = n;
1186 }
1187 }
1188 if (ok != ITER_DONE)
1189 die("error while iterating over references");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001190
Michael Haggerty27d03d02017-09-08 15:51:47 +02001191 if (ref_transaction_commit(transaction, &err))
1192 die("unable to write new packed-refs: %s", err.buf);
1193
1194 ref_transaction_free(transaction);
1195
Michael Haggerty42c7f7f2017-06-23 09:01:45 +02001196 packed_refs_unlock(refs->packed_ref_store);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001197
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001198 prune_refs(refs, &refs_to_prune);
Michael Haggerty34789832017-06-23 09:01:39 +02001199 strbuf_release(&err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001200 return 0;
1201}
1202
Michael Haggerty64da4192017-05-22 16:17:38 +02001203static int files_delete_refs(struct ref_store *ref_store, const char *msg,
David Turnera27dcf82016-09-04 18:08:40 +02001204 struct string_list *refnames, unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001205{
Michael Haggerty0a95ac52016-09-04 18:08:30 +02001206 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001207 files_downcast(ref_store, REF_STORE_WRITE, "delete_refs");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001208 struct strbuf err = STRBUF_INIT;
1209 int i, result = 0;
1210
1211 if (!refnames->nr)
1212 return 0;
1213
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001214 if (packed_refs_lock(refs->packed_ref_store, 0, &err))
1215 goto error;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001216
Michael Haggerty2fb330c2017-09-08 15:51:46 +02001217 if (refs_delete_refs(refs->packed_ref_store, msg, refnames, flags)) {
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001218 packed_refs_unlock(refs->packed_ref_store);
1219 goto error;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001220 }
1221
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001222 packed_refs_unlock(refs->packed_ref_store);
1223
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001224 for (i = 0; i < refnames->nr; i++) {
1225 const char *refname = refnames->items[i].string;
1226
Michael Haggerty64da4192017-05-22 16:17:38 +02001227 if (refs_delete_ref(&refs->base, msg, refname, NULL, flags))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001228 result |= error(_("could not remove reference %s"), refname);
1229 }
1230
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001231 strbuf_release(&err);
1232 return result;
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001233
1234error:
1235 /*
1236 * If we failed to rewrite the packed-refs file, then it is
1237 * unsafe to try to remove loose refs, because doing so might
1238 * expose an obsolete packed value for a reference that might
1239 * even point at an object that has been garbage collected.
1240 */
1241 if (refnames->nr == 1)
1242 error(_("could not delete reference %s: %s"),
1243 refnames->items[0].string, err.buf);
1244 else
1245 error(_("could not delete references: %s"), err.buf);
1246
1247 strbuf_release(&err);
1248 return -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001249}
1250
1251/*
1252 * People using contrib's git-new-workdir have .git/logs/refs ->
1253 * /some/other/path/.git/logs/refs, and that may live on another device.
1254 *
1255 * IOW, to avoid cross device rename errors, the temporary renamed log must
1256 * live into logs/refs.
1257 */
Nguyễn Thái Ngọc Duya5c1efd2017-03-26 09:42:21 +07001258#define TMP_RENAMED_LOG "refs/.tmp-renamed-log"
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001259
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001260struct rename_cb {
1261 const char *tmp_renamed_log;
1262 int true_errno;
1263};
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001264
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001265static int rename_tmp_log_callback(const char *path, void *cb_data)
1266{
1267 struct rename_cb *cb = cb_data;
1268
1269 if (rename(cb->tmp_renamed_log, path)) {
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001270 /*
1271 * rename(a, b) when b is an existing directory ought
1272 * to result in ISDIR, but Solaris 5.8 gives ENOTDIR.
1273 * Sheesh. Record the true errno for error reporting,
1274 * but report EISDIR to raceproof_create_file() so
1275 * that it knows to retry.
1276 */
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001277 cb->true_errno = errno;
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001278 if (errno == ENOTDIR)
1279 errno = EISDIR;
1280 return -1;
1281 } else {
1282 return 0;
1283 }
1284}
1285
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001286static int rename_tmp_log(struct files_ref_store *refs, const char *newrefname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001287{
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001288 struct strbuf path = STRBUF_INIT;
1289 struct strbuf tmp = STRBUF_INIT;
1290 struct rename_cb cb;
1291 int ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001292
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001293 files_reflog_path(refs, &path, newrefname);
1294 files_reflog_path(refs, &tmp, TMP_RENAMED_LOG);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001295 cb.tmp_renamed_log = tmp.buf;
1296 ret = raceproof_create_file(path.buf, rename_tmp_log_callback, &cb);
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001297 if (ret) {
1298 if (errno == EISDIR)
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001299 error("directory not empty: %s", path.buf);
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001300 else
Michael Haggerty990c98d2017-01-06 17:22:30 +01001301 error("unable to move logfile %s to %s: %s",
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001302 tmp.buf, path.buf,
1303 strerror(cb.true_errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001304 }
1305
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001306 strbuf_release(&path);
1307 strbuf_release(&tmp);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001308 return ret;
1309}
1310
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001311static int write_ref_to_lockfile(struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001312 const struct object_id *oid, struct strbuf *err);
Michael Haggertyf18a7892016-09-04 18:08:32 +02001313static int commit_ref_update(struct files_ref_store *refs,
1314 struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001315 const struct object_id *oid, const char *logmsg,
Michael Haggerty5d9b2de2016-04-22 14:38:56 +02001316 struct strbuf *err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001317
Sahil Dua52d59cc2017-06-18 23:19:16 +02001318static int files_copy_or_rename_ref(struct ref_store *ref_store,
David Turner9b6b40d2016-09-04 18:08:42 +02001319 const char *oldrefname, const char *newrefname,
Sahil Dua52d59cc2017-06-18 23:19:16 +02001320 const char *logmsg, int copy)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001321{
David Turner9b6b40d2016-09-04 18:08:42 +02001322 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001323 files_downcast(ref_store, REF_STORE_WRITE, "rename_ref");
René Scharfee0ae2442019-12-11 19:46:19 +01001324 struct object_id orig_oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001325 int flag = 0, logmoved = 0;
1326 struct ref_lock *lock;
1327 struct stat loginfo;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001328 struct strbuf sb_oldref = STRBUF_INIT;
1329 struct strbuf sb_newref = STRBUF_INIT;
1330 struct strbuf tmp_renamed_log = STRBUF_INIT;
1331 int log, ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001332 struct strbuf err = STRBUF_INIT;
1333
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001334 files_reflog_path(refs, &sb_oldref, oldrefname);
1335 files_reflog_path(refs, &sb_newref, newrefname);
1336 files_reflog_path(refs, &tmp_renamed_log, TMP_RENAMED_LOG);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001337
1338 log = !lstat(sb_oldref.buf, &loginfo);
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001339 if (log && S_ISLNK(loginfo.st_mode)) {
1340 ret = error("reflog for %s is a symlink", oldrefname);
1341 goto out;
1342 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001343
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001344 if (!refs_resolve_ref_unsafe(&refs->base, oldrefname,
1345 RESOLVE_REF_READING | RESOLVE_REF_NO_RECURSE,
brian m. carlson49e61472017-10-15 22:07:09 +00001346 &orig_oid, &flag)) {
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001347 ret = error("refname %s not found", oldrefname);
1348 goto out;
1349 }
Michael Haggertye711b1a2016-04-21 23:42:19 +02001350
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001351 if (flag & REF_ISSYMREF) {
Sahil Dua52d59cc2017-06-18 23:19:16 +02001352 if (copy)
1353 ret = error("refname %s is a symbolic ref, copying it is not supported",
1354 oldrefname);
1355 else
1356 ret = error("refname %s is a symbolic ref, renaming it is not supported",
1357 oldrefname);
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001358 goto out;
1359 }
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +07001360 if (!refs_rename_ref_available(&refs->base, oldrefname, newrefname)) {
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001361 ret = 1;
1362 goto out;
1363 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001364
Sahil Dua52d59cc2017-06-18 23:19:16 +02001365 if (!copy && log && rename(sb_oldref.buf, tmp_renamed_log.buf)) {
Nguyễn Thái Ngọc Duya5c1efd2017-03-26 09:42:21 +07001366 ret = error("unable to move logfile logs/%s to logs/"TMP_RENAMED_LOG": %s",
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001367 oldrefname, strerror(errno));
1368 goto out;
1369 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001370
Sahil Dua52d59cc2017-06-18 23:19:16 +02001371 if (copy && log && copy_file(tmp_renamed_log.buf, sb_oldref.buf, 0644)) {
1372 ret = error("unable to copy logfile logs/%s to logs/"TMP_RENAMED_LOG": %s",
1373 oldrefname, strerror(errno));
1374 goto out;
1375 }
1376
1377 if (!copy && refs_delete_ref(&refs->base, logmsg, oldrefname,
Michael Haggerty91774af2017-11-05 09:42:06 +01001378 &orig_oid, REF_NO_DEREF)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001379 error("unable to delete old %s", oldrefname);
1380 goto rollback;
1381 }
1382
David Turner12fd3492016-02-24 17:58:51 -05001383 /*
brian m. carlson4417df82017-05-06 22:10:24 +00001384 * Since we are doing a shallow lookup, oid is not the
1385 * correct value to pass to delete_ref as old_oid. But that
1386 * doesn't matter, because an old_oid check wouldn't add to
David Turner12fd3492016-02-24 17:58:51 -05001387 * the safety anyway; we want to delete the reference whatever
1388 * its current value.
1389 */
Sahil Dua52d59cc2017-06-18 23:19:16 +02001390 if (!copy && !refs_read_ref_full(&refs->base, newrefname,
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001391 RESOLVE_REF_READING | RESOLVE_REF_NO_RECURSE,
René Scharfee0ae2442019-12-11 19:46:19 +01001392 NULL, NULL) &&
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001393 refs_delete_ref(&refs->base, NULL, newrefname,
Michael Haggerty91774af2017-11-05 09:42:06 +01001394 NULL, REF_NO_DEREF)) {
Michael Haggerty58364322017-01-06 17:22:21 +01001395 if (errno == EISDIR) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001396 struct strbuf path = STRBUF_INIT;
1397 int result;
1398
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07001399 files_ref_path(refs, &path, newrefname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001400 result = remove_empty_directories(&path);
1401 strbuf_release(&path);
1402
1403 if (result) {
1404 error("Directory not empty: %s", newrefname);
1405 goto rollback;
1406 }
1407 } else {
1408 error("unable to delete existing %s", newrefname);
1409 goto rollback;
1410 }
1411 }
1412
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001413 if (log && rename_tmp_log(refs, newrefname))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001414 goto rollback;
1415
1416 logmoved = log;
1417
brian m. carlson4f01e502017-10-15 22:07:12 +00001418 lock = lock_ref_oid_basic(refs, newrefname, NULL, NULL, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001419 REF_NO_DEREF, NULL, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001420 if (!lock) {
Sahil Dua52d59cc2017-06-18 23:19:16 +02001421 if (copy)
1422 error("unable to copy '%s' to '%s': %s", oldrefname, newrefname, err.buf);
1423 else
1424 error("unable to rename '%s' to '%s': %s", oldrefname, newrefname, err.buf);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001425 strbuf_release(&err);
1426 goto rollback;
1427 }
brian m. carlson4417df82017-05-06 22:10:24 +00001428 oidcpy(&lock->old_oid, &orig_oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001429
brian m. carlson4417df82017-05-06 22:10:24 +00001430 if (write_ref_to_lockfile(lock, &orig_oid, &err) ||
1431 commit_ref_update(refs, lock, &orig_oid, logmsg, &err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001432 error("unable to write current sha1 into %s: %s", newrefname, err.buf);
1433 strbuf_release(&err);
1434 goto rollback;
1435 }
1436
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001437 ret = 0;
1438 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001439
1440 rollback:
brian m. carlson4f01e502017-10-15 22:07:12 +00001441 lock = lock_ref_oid_basic(refs, oldrefname, NULL, NULL, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001442 REF_NO_DEREF, NULL, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001443 if (!lock) {
1444 error("unable to lock %s for rollback: %s", oldrefname, err.buf);
1445 strbuf_release(&err);
1446 goto rollbacklog;
1447 }
1448
1449 flag = log_all_ref_updates;
Cornelius Weig341fb282017-01-27 11:09:47 +01001450 log_all_ref_updates = LOG_REFS_NONE;
brian m. carlson4417df82017-05-06 22:10:24 +00001451 if (write_ref_to_lockfile(lock, &orig_oid, &err) ||
1452 commit_ref_update(refs, lock, &orig_oid, NULL, &err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001453 error("unable to write current sha1 into %s: %s", oldrefname, err.buf);
1454 strbuf_release(&err);
1455 }
1456 log_all_ref_updates = flag;
1457
1458 rollbacklog:
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001459 if (logmoved && rename(sb_newref.buf, sb_oldref.buf))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001460 error("unable to restore logfile %s from %s: %s",
1461 oldrefname, newrefname, strerror(errno));
1462 if (!logmoved && log &&
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001463 rename(tmp_renamed_log.buf, sb_oldref.buf))
Nguyễn Thái Ngọc Duya5c1efd2017-03-26 09:42:21 +07001464 error("unable to restore logfile %s from logs/"TMP_RENAMED_LOG": %s",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001465 oldrefname, strerror(errno));
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001466 ret = 1;
1467 out:
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001468 strbuf_release(&sb_newref);
1469 strbuf_release(&sb_oldref);
1470 strbuf_release(&tmp_renamed_log);
1471
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001472 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001473}
1474
Sahil Dua52d59cc2017-06-18 23:19:16 +02001475static int files_rename_ref(struct ref_store *ref_store,
1476 const char *oldrefname, const char *newrefname,
1477 const char *logmsg)
1478{
1479 return files_copy_or_rename_ref(ref_store, oldrefname,
1480 newrefname, logmsg, 0);
1481}
1482
1483static int files_copy_ref(struct ref_store *ref_store,
1484 const char *oldrefname, const char *newrefname,
1485 const char *logmsg)
1486{
1487 return files_copy_or_rename_ref(ref_store, oldrefname,
1488 newrefname, logmsg, 1);
1489}
1490
Jeff King83a30692017-09-05 08:14:33 -04001491static int close_ref_gently(struct ref_lock *lock)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001492{
Jeff Kingee4d8e42017-09-05 08:15:15 -04001493 if (close_lock_file_gently(&lock->lk))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001494 return -1;
1495 return 0;
1496}
1497
1498static int commit_ref(struct ref_lock *lock)
1499{
Jeff Kingee4d8e42017-09-05 08:15:15 -04001500 char *path = get_locked_file_path(&lock->lk);
Michael Haggerty5387c0d2016-05-05 15:33:03 +02001501 struct stat st;
1502
1503 if (!lstat(path, &st) && S_ISDIR(st.st_mode)) {
1504 /*
1505 * There is a directory at the path we want to rename
1506 * the lockfile to. Hopefully it is empty; try to
1507 * delete it.
1508 */
1509 size_t len = strlen(path);
1510 struct strbuf sb_path = STRBUF_INIT;
1511
1512 strbuf_attach(&sb_path, path, len, len);
1513
1514 /*
1515 * If this fails, commit_lock_file() will also fail
1516 * and will report the problem.
1517 */
1518 remove_empty_directories(&sb_path);
1519 strbuf_release(&sb_path);
1520 } else {
1521 free(path);
1522 }
1523
Jeff Kingee4d8e42017-09-05 08:15:15 -04001524 if (commit_lock_file(&lock->lk))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001525 return -1;
1526 return 0;
1527}
1528
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001529static int open_or_create_logfile(const char *path, void *cb)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001530{
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001531 int *fd = cb;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001532
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001533 *fd = open(path, O_APPEND | O_WRONLY | O_CREAT, 0666);
1534 return (*fd < 0) ? -1 : 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001535}
1536
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001537/*
Michael Haggerty4533e532017-01-06 17:22:36 +01001538 * Create a reflog for a ref. If force_create = 0, only create the
1539 * reflog for certain refs (those for which should_autocreate_reflog
1540 * returns non-zero). Otherwise, create it regardless of the reference
1541 * name. If the logfile already existed or was created, return 0 and
1542 * set *logfd to the file descriptor opened for appending to the file.
1543 * If no logfile exists and we decided not to create one, return 0 and
1544 * set *logfd to -1. On failure, fill in *err, set *logfd to -1, and
1545 * return -1.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001546 */
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001547static int log_ref_setup(struct files_ref_store *refs,
1548 const char *refname, int force_create,
Michael Haggerty4533e532017-01-06 17:22:36 +01001549 int *logfd, struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001550{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001551 struct strbuf logfile_sb = STRBUF_INIT;
1552 char *logfile;
1553
1554 files_reflog_path(refs, &logfile_sb, refname);
1555 logfile = strbuf_detach(&logfile_sb, NULL);
Michael Haggerty854bda62017-01-06 17:22:32 +01001556
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001557 if (force_create || should_autocreate_reflog(refname)) {
Michael Haggerty4533e532017-01-06 17:22:36 +01001558 if (raceproof_create_file(logfile, open_or_create_logfile, logfd)) {
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001559 if (errno == ENOENT)
1560 strbuf_addf(err, "unable to create directory for '%s': "
Michael Haggerty4533e532017-01-06 17:22:36 +01001561 "%s", logfile, strerror(errno));
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001562 else if (errno == EISDIR)
1563 strbuf_addf(err, "there are still logs under '%s'",
Michael Haggerty4533e532017-01-06 17:22:36 +01001564 logfile);
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001565 else
Michael Haggerty854bda62017-01-06 17:22:32 +01001566 strbuf_addf(err, "unable to append to '%s': %s",
Michael Haggerty4533e532017-01-06 17:22:36 +01001567 logfile, strerror(errno));
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001568
Michael Haggerty4533e532017-01-06 17:22:36 +01001569 goto error;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001570 }
Michael Haggerty854bda62017-01-06 17:22:32 +01001571 } else {
Michael Haggerty4533e532017-01-06 17:22:36 +01001572 *logfd = open(logfile, O_APPEND | O_WRONLY, 0666);
Michael Haggertye404f452017-01-06 17:22:34 +01001573 if (*logfd < 0) {
Michael Haggerty854bda62017-01-06 17:22:32 +01001574 if (errno == ENOENT || errno == EISDIR) {
1575 /*
1576 * The logfile doesn't already exist,
1577 * but that is not an error; it only
1578 * means that we won't write log
1579 * entries to it.
1580 */
1581 ;
1582 } else {
1583 strbuf_addf(err, "unable to append to '%s': %s",
Michael Haggerty4533e532017-01-06 17:22:36 +01001584 logfile, strerror(errno));
1585 goto error;
Michael Haggerty854bda62017-01-06 17:22:32 +01001586 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001587 }
1588 }
1589
Michael Haggertye404f452017-01-06 17:22:34 +01001590 if (*logfd >= 0)
Michael Haggerty4533e532017-01-06 17:22:36 +01001591 adjust_shared_perm(logfile);
Michael Haggerty854bda62017-01-06 17:22:32 +01001592
Michael Haggerty4533e532017-01-06 17:22:36 +01001593 free(logfile);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001594 return 0;
Michael Haggerty4533e532017-01-06 17:22:36 +01001595
1596error:
1597 free(logfile);
1598 return -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001599}
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001600
David Turnere3688bd2016-09-04 18:08:38 +02001601static int files_create_reflog(struct ref_store *ref_store,
1602 const char *refname, int force_create,
1603 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001604{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001605 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001606 files_downcast(ref_store, REF_STORE_WRITE, "create_reflog");
Michael Haggertye404f452017-01-06 17:22:34 +01001607 int fd;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001608
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001609 if (log_ref_setup(refs, refname, force_create, &fd, err))
Michael Haggerty4533e532017-01-06 17:22:36 +01001610 return -1;
1611
Michael Haggertye404f452017-01-06 17:22:34 +01001612 if (fd >= 0)
1613 close(fd);
Michael Haggerty4533e532017-01-06 17:22:36 +01001614
1615 return 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001616}
1617
brian m. carlson4417df82017-05-06 22:10:24 +00001618static int log_ref_write_fd(int fd, const struct object_id *old_oid,
1619 const struct object_id *new_oid,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001620 const char *committer, const char *msg)
1621{
Ben Peart80a6c202018-07-10 21:08:22 +00001622 struct strbuf sb = STRBUF_INIT;
1623 int ret = 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001624
Ben Peart80a6c202018-07-10 21:08:22 +00001625 strbuf_addf(&sb, "%s %s %s", oid_to_hex(old_oid), oid_to_hex(new_oid), committer);
Han-Wen Nienhuys25429fe2020-07-31 11:36:10 +00001626 if (msg && *msg) {
1627 strbuf_addch(&sb, '\t');
Junio C Hamano523fa692020-07-10 17:19:53 +00001628 strbuf_addstr(&sb, msg);
Han-Wen Nienhuys25429fe2020-07-31 11:36:10 +00001629 }
Ben Peart80a6c202018-07-10 21:08:22 +00001630 strbuf_addch(&sb, '\n');
1631 if (write_in_full(fd, sb.buf, sb.len) < 0)
1632 ret = -1;
1633 strbuf_release(&sb);
1634 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001635}
1636
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001637static int files_log_ref_write(struct files_ref_store *refs,
brian m. carlson4417df82017-05-06 22:10:24 +00001638 const char *refname, const struct object_id *old_oid,
1639 const struct object_id *new_oid, const char *msg,
Nguyễn Thái Ngọc Duy11f84572017-03-26 09:42:15 +07001640 int flags, struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001641{
Michael Haggertye404f452017-01-06 17:22:34 +01001642 int logfd, result;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001643
Cornelius Weig341fb282017-01-27 11:09:47 +01001644 if (log_all_ref_updates == LOG_REFS_UNSET)
1645 log_all_ref_updates = is_bare_repository() ? LOG_REFS_NONE : LOG_REFS_NORMAL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001646
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001647 result = log_ref_setup(refs, refname,
1648 flags & REF_FORCE_CREATE_REFLOG,
Michael Haggerty4533e532017-01-06 17:22:36 +01001649 &logfd, err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001650
1651 if (result)
1652 return result;
1653
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001654 if (logfd < 0)
1655 return 0;
brian m. carlson4417df82017-05-06 22:10:24 +00001656 result = log_ref_write_fd(logfd, old_oid, new_oid,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001657 git_committer_info(0), msg);
1658 if (result) {
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001659 struct strbuf sb = STRBUF_INIT;
Michael Haggerty87b21e02017-01-06 17:22:35 +01001660 int save_errno = errno;
1661
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001662 files_reflog_path(refs, &sb, refname);
Michael Haggerty87b21e02017-01-06 17:22:35 +01001663 strbuf_addf(err, "unable to append to '%s': %s",
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001664 sb.buf, strerror(save_errno));
1665 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001666 close(logfd);
1667 return -1;
1668 }
1669 if (close(logfd)) {
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001670 struct strbuf sb = STRBUF_INIT;
Michael Haggerty87b21e02017-01-06 17:22:35 +01001671 int save_errno = errno;
1672
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001673 files_reflog_path(refs, &sb, refname);
Michael Haggerty87b21e02017-01-06 17:22:35 +01001674 strbuf_addf(err, "unable to append to '%s': %s",
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001675 sb.buf, strerror(save_errno));
1676 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001677 return -1;
1678 }
1679 return 0;
1680}
1681
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001682/*
Michael Haggerty78fb4572017-11-05 09:42:09 +01001683 * Write oid into the open lockfile, then close the lockfile. On
1684 * errors, rollback the lockfile, fill in *err and return -1.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001685 */
1686static int write_ref_to_lockfile(struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001687 const struct object_id *oid, struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001688{
1689 static char term = '\n';
1690 struct object *o;
1691 int fd;
1692
Stefan Beller109cd762018-06-28 18:21:51 -07001693 o = parse_object(the_repository, oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001694 if (!o) {
1695 strbuf_addf(err,
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001696 "trying to write ref '%s' with nonexistent object %s",
brian m. carlson4417df82017-05-06 22:10:24 +00001697 lock->ref_name, oid_to_hex(oid));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001698 unlock_ref(lock);
1699 return -1;
1700 }
1701 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1702 strbuf_addf(err,
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001703 "trying to write non-commit object %s to branch '%s'",
brian m. carlson4417df82017-05-06 22:10:24 +00001704 oid_to_hex(oid), lock->ref_name);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001705 unlock_ref(lock);
1706 return -1;
1707 }
Jeff Kingee4d8e42017-09-05 08:15:15 -04001708 fd = get_lock_file_fd(&lock->lk);
brian m. carlson2ae2e2a2018-07-16 01:27:59 +00001709 if (write_in_full(fd, oid_to_hex(oid), the_hash_algo->hexsz) < 0 ||
Jeff King06f46f22017-09-13 13:16:03 -04001710 write_in_full(fd, &term, 1) < 0 ||
Jeff King83a30692017-09-05 08:14:33 -04001711 close_ref_gently(lock) < 0) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001712 strbuf_addf(err,
Jeff Kingee4d8e42017-09-05 08:15:15 -04001713 "couldn't write '%s'", get_lock_file_path(&lock->lk));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001714 unlock_ref(lock);
1715 return -1;
1716 }
1717 return 0;
1718}
1719
1720/*
1721 * Commit a change to a loose reference that has already been written
1722 * to the loose reference lockfile. Also update the reflogs if
1723 * necessary, using the specified lockmsg (which can be NULL).
1724 */
Michael Haggertyf18a7892016-09-04 18:08:32 +02001725static int commit_ref_update(struct files_ref_store *refs,
1726 struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001727 const struct object_id *oid, const char *logmsg,
Michael Haggerty5d9b2de2016-04-22 14:38:56 +02001728 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001729{
Michael Haggerty32c597e2017-02-10 12:16:16 +01001730 files_assert_main_repository(refs, "commit_ref_update");
Michael Haggerty00eebe32016-09-04 18:08:11 +02001731
1732 clear_loose_ref_cache(refs);
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001733 if (files_log_ref_write(refs, lock->ref_name,
brian m. carlson4417df82017-05-06 22:10:24 +00001734 &lock->old_oid, oid,
Michael Haggerty81b1b6d2017-01-06 17:22:31 +01001735 logmsg, 0, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001736 char *old_msg = strbuf_detach(err, NULL);
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001737 strbuf_addf(err, "cannot update the ref '%s': %s",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001738 lock->ref_name, old_msg);
1739 free(old_msg);
1740 unlock_ref(lock);
1741 return -1;
1742 }
Michael Haggerty7a418f32016-04-22 15:25:25 +02001743
1744 if (strcmp(lock->ref_name, "HEAD") != 0) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001745 /*
1746 * Special hack: If a branch is updated directly and HEAD
1747 * points to it (may happen on the remote side of a push
1748 * for example) then logically the HEAD reflog should be
1749 * updated too.
1750 * A generic solution implies reverse symref information,
1751 * but finding all symrefs pointing to the given branch
1752 * would be rather costly for this rare event (the direct
1753 * update of a branch) to be worth it. So let's cheat and
1754 * check with HEAD only which should cover 99% of all usage
1755 * scenarios (even 100% of the default ones).
1756 */
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001757 int head_flag;
1758 const char *head_ref;
Michael Haggerty7a418f32016-04-22 15:25:25 +02001759
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001760 head_ref = refs_resolve_ref_unsafe(&refs->base, "HEAD",
1761 RESOLVE_REF_READING,
René Scharfee691b022017-09-23 11:44:57 +02001762 NULL, &head_flag);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001763 if (head_ref && (head_flag & REF_ISSYMREF) &&
1764 !strcmp(head_ref, lock->ref_name)) {
1765 struct strbuf log_err = STRBUF_INIT;
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001766 if (files_log_ref_write(refs, "HEAD",
brian m. carlson4417df82017-05-06 22:10:24 +00001767 &lock->old_oid, oid,
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001768 logmsg, 0, &log_err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001769 error("%s", log_err.buf);
1770 strbuf_release(&log_err);
1771 }
1772 }
1773 }
Michael Haggerty7a418f32016-04-22 15:25:25 +02001774
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001775 if (commit_ref(lock)) {
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001776 strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001777 unlock_ref(lock);
1778 return -1;
1779 }
1780
1781 unlock_ref(lock);
1782 return 0;
1783}
1784
Jeff King370e5ad2015-12-29 00:57:01 -05001785static int create_ref_symlink(struct ref_lock *lock, const char *target)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001786{
Jeff King370e5ad2015-12-29 00:57:01 -05001787 int ret = -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001788#ifndef NO_SYMLINK_HEAD
Jeff Kingee4d8e42017-09-05 08:15:15 -04001789 char *ref_path = get_locked_file_path(&lock->lk);
Jeff King370e5ad2015-12-29 00:57:01 -05001790 unlink(ref_path);
1791 ret = symlink(target, ref_path);
1792 free(ref_path);
1793
1794 if (ret)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001795 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001796#endif
Jeff King370e5ad2015-12-29 00:57:01 -05001797 return ret;
1798}
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001799
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001800static void update_symref_reflog(struct files_ref_store *refs,
1801 struct ref_lock *lock, const char *refname,
Jeff King370e5ad2015-12-29 00:57:01 -05001802 const char *target, const char *logmsg)
1803{
1804 struct strbuf err = STRBUF_INIT;
brian m. carlson4417df82017-05-06 22:10:24 +00001805 struct object_id new_oid;
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001806 if (logmsg &&
1807 !refs_read_ref_full(&refs->base, target,
brian m. carlson34c290a2017-10-15 22:06:56 +00001808 RESOLVE_REF_READING, &new_oid, NULL) &&
brian m. carlson4417df82017-05-06 22:10:24 +00001809 files_log_ref_write(refs, refname, &lock->old_oid,
1810 &new_oid, logmsg, 0, &err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001811 error("%s", err.buf);
1812 strbuf_release(&err);
1813 }
Jeff King370e5ad2015-12-29 00:57:01 -05001814}
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001815
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001816static int create_symref_locked(struct files_ref_store *refs,
1817 struct ref_lock *lock, const char *refname,
Jeff King370e5ad2015-12-29 00:57:01 -05001818 const char *target, const char *logmsg)
1819{
1820 if (prefer_symlink_refs && !create_ref_symlink(lock, target)) {
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001821 update_symref_reflog(refs, lock, refname, target, logmsg);
Jeff King370e5ad2015-12-29 00:57:01 -05001822 return 0;
1823 }
1824
Jeff Kingee4d8e42017-09-05 08:15:15 -04001825 if (!fdopen_lock_file(&lock->lk, "w"))
Jeff King370e5ad2015-12-29 00:57:01 -05001826 return error("unable to fdopen %s: %s",
Martin Ågren7f0dc792021-01-05 20:23:49 +01001827 get_lock_file_path(&lock->lk), strerror(errno));
Jeff King370e5ad2015-12-29 00:57:01 -05001828
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001829 update_symref_reflog(refs, lock, refname, target, logmsg);
Jeff King396da8f2015-12-29 00:57:25 -05001830
Jeff King370e5ad2015-12-29 00:57:01 -05001831 /* no error check; commit_ref will check ferror */
Martin Ågren7f0dc792021-01-05 20:23:49 +01001832 fprintf(get_lock_file_fp(&lock->lk), "ref: %s\n", target);
Jeff King370e5ad2015-12-29 00:57:01 -05001833 if (commit_ref(lock) < 0)
1834 return error("unable to write symref for %s: %s", refname,
1835 strerror(errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001836 return 0;
1837}
1838
Michael Haggerty284689b2016-09-04 18:08:28 +02001839static int files_create_symref(struct ref_store *ref_store,
1840 const char *refname, const char *target,
1841 const char *logmsg)
Jeff King370e5ad2015-12-29 00:57:01 -05001842{
Michael Haggerty7eb27cd2016-09-04 18:08:34 +02001843 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001844 files_downcast(ref_store, REF_STORE_WRITE, "create_symref");
Jeff King370e5ad2015-12-29 00:57:01 -05001845 struct strbuf err = STRBUF_INIT;
1846 struct ref_lock *lock;
1847 int ret;
1848
brian m. carlson4f01e502017-10-15 22:07:12 +00001849 lock = lock_ref_oid_basic(refs, refname, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001850 NULL, NULL, REF_NO_DEREF, NULL,
brian m. carlson4f01e502017-10-15 22:07:12 +00001851 &err);
Jeff King370e5ad2015-12-29 00:57:01 -05001852 if (!lock) {
1853 error("%s", err.buf);
1854 strbuf_release(&err);
1855 return -1;
1856 }
1857
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001858 ret = create_symref_locked(refs, lock, refname, target, logmsg);
Jeff King370e5ad2015-12-29 00:57:01 -05001859 unlock_ref(lock);
1860 return ret;
1861}
1862
David Turnere3688bd2016-09-04 18:08:38 +02001863static int files_reflog_exists(struct ref_store *ref_store,
1864 const char *refname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001865{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001866 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001867 files_downcast(ref_store, REF_STORE_READ, "reflog_exists");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001868 struct strbuf sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001869 struct stat st;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001870 int ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001871
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001872 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001873 ret = !lstat(sb.buf, &st) && S_ISREG(st.st_mode);
1874 strbuf_release(&sb);
1875 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001876}
1877
David Turnere3688bd2016-09-04 18:08:38 +02001878static int files_delete_reflog(struct ref_store *ref_store,
1879 const char *refname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001880{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001881 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001882 files_downcast(ref_store, REF_STORE_WRITE, "delete_reflog");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001883 struct strbuf sb = STRBUF_INIT;
1884 int ret;
1885
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001886 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001887 ret = remove_path(sb.buf);
1888 strbuf_release(&sb);
1889 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001890}
1891
1892static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
1893{
brian m. carlson9461d272017-02-21 23:47:32 +00001894 struct object_id ooid, noid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001895 char *email_end, *message;
Johannes Schindelindddbad72017-04-26 21:29:31 +02001896 timestamp_t timestamp;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001897 int tz;
brian m. carlson43bc3b62017-02-21 23:47:33 +00001898 const char *p = sb->buf;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001899
1900 /* old SP new SP name <email> SP time TAB msg LF */
brian m. carlson43bc3b62017-02-21 23:47:33 +00001901 if (!sb->len || sb->buf[sb->len - 1] != '\n' ||
1902 parse_oid_hex(p, &ooid, &p) || *p++ != ' ' ||
1903 parse_oid_hex(p, &noid, &p) || *p++ != ' ' ||
1904 !(email_end = strchr(p, '>')) ||
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001905 email_end[1] != ' ' ||
Johannes Schindelin1aeb7e72017-04-21 12:45:44 +02001906 !(timestamp = parse_timestamp(email_end + 2, &message, 10)) ||
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001907 !message || message[0] != ' ' ||
1908 (message[1] != '+' && message[1] != '-') ||
1909 !isdigit(message[2]) || !isdigit(message[3]) ||
1910 !isdigit(message[4]) || !isdigit(message[5]))
1911 return 0; /* corrupt? */
1912 email_end[1] = '\0';
1913 tz = strtol(message + 1, NULL, 10);
1914 if (message[6] != '\t')
1915 message += 6;
1916 else
1917 message += 7;
brian m. carlson43bc3b62017-02-21 23:47:33 +00001918 return fn(&ooid, &noid, p, timestamp, tz, message, cb_data);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001919}
1920
1921static char *find_beginning_of_line(char *bob, char *scan)
1922{
1923 while (bob < scan && *(--scan) != '\n')
1924 ; /* keep scanning backwards */
1925 /*
1926 * Return either beginning of the buffer, or LF at the end of
1927 * the previous line.
1928 */
1929 return scan;
1930}
1931
David Turnere3688bd2016-09-04 18:08:38 +02001932static int files_for_each_reflog_ent_reverse(struct ref_store *ref_store,
1933 const char *refname,
1934 each_reflog_ent_fn fn,
1935 void *cb_data)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001936{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001937 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001938 files_downcast(ref_store, REF_STORE_READ,
1939 "for_each_reflog_ent_reverse");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001940 struct strbuf sb = STRBUF_INIT;
1941 FILE *logfp;
1942 long pos;
1943 int ret = 0, at_tail = 1;
1944
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001945 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001946 logfp = fopen(sb.buf, "r");
1947 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001948 if (!logfp)
1949 return -1;
1950
1951 /* Jump to the end */
1952 if (fseek(logfp, 0, SEEK_END) < 0)
René Scharfebe686f02017-04-16 18:55:46 +02001953 ret = error("cannot seek back reflog for %s: %s",
1954 refname, strerror(errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001955 pos = ftell(logfp);
1956 while (!ret && 0 < pos) {
1957 int cnt;
1958 size_t nread;
1959 char buf[BUFSIZ];
1960 char *endp, *scanp;
1961
1962 /* Fill next block from the end */
1963 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
René Scharfebe686f02017-04-16 18:55:46 +02001964 if (fseek(logfp, pos - cnt, SEEK_SET)) {
1965 ret = error("cannot seek back reflog for %s: %s",
1966 refname, strerror(errno));
1967 break;
1968 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001969 nread = fread(buf, cnt, 1, logfp);
René Scharfebe686f02017-04-16 18:55:46 +02001970 if (nread != 1) {
1971 ret = error("cannot read %d bytes from reflog for %s: %s",
1972 cnt, refname, strerror(errno));
1973 break;
1974 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001975 pos -= cnt;
1976
1977 scanp = endp = buf + cnt;
1978 if (at_tail && scanp[-1] == '\n')
1979 /* Looking at the final LF at the end of the file */
1980 scanp--;
1981 at_tail = 0;
1982
1983 while (buf < scanp) {
1984 /*
1985 * terminating LF of the previous line, or the beginning
1986 * of the buffer.
1987 */
1988 char *bp;
1989
1990 bp = find_beginning_of_line(buf, scanp);
1991
1992 if (*bp == '\n') {
1993 /*
1994 * The newline is the end of the previous line,
1995 * so we know we have complete line starting
1996 * at (bp + 1). Prefix it onto any prior data
1997 * we collected for the line and process it.
1998 */
1999 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
2000 scanp = bp;
2001 endp = bp + 1;
2002 ret = show_one_reflog_ent(&sb, fn, cb_data);
2003 strbuf_reset(&sb);
2004 if (ret)
2005 break;
2006 } else if (!pos) {
2007 /*
2008 * We are at the start of the buffer, and the
2009 * start of the file; there is no previous
2010 * line, and we have everything for this one.
2011 * Process it, and we can end the loop.
2012 */
2013 strbuf_splice(&sb, 0, 0, buf, endp - buf);
2014 ret = show_one_reflog_ent(&sb, fn, cb_data);
2015 strbuf_reset(&sb);
2016 break;
2017 }
2018
2019 if (bp == buf) {
2020 /*
2021 * We are at the start of the buffer, and there
2022 * is more file to read backwards. Which means
2023 * we are in the middle of a line. Note that we
2024 * may get here even if *bp was a newline; that
2025 * just means we are at the exact end of the
2026 * previous line, rather than some spot in the
2027 * middle.
2028 *
2029 * Save away what we have to be combined with
2030 * the data from the next read.
2031 */
2032 strbuf_splice(&sb, 0, 0, buf, endp - buf);
2033 break;
2034 }
2035 }
2036
2037 }
2038 if (!ret && sb.len)
Johannes Schindelin033abf92018-05-02 11:38:39 +02002039 BUG("reverse reflog parser had leftover data");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002040
2041 fclose(logfp);
2042 strbuf_release(&sb);
2043 return ret;
2044}
2045
David Turnere3688bd2016-09-04 18:08:38 +02002046static int files_for_each_reflog_ent(struct ref_store *ref_store,
2047 const char *refname,
2048 each_reflog_ent_fn fn, void *cb_data)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002049{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002050 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07002051 files_downcast(ref_store, REF_STORE_READ,
2052 "for_each_reflog_ent");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002053 FILE *logfp;
2054 struct strbuf sb = STRBUF_INIT;
2055 int ret = 0;
2056
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002057 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002058 logfp = fopen(sb.buf, "r");
2059 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002060 if (!logfp)
2061 return -1;
2062
2063 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
2064 ret = show_one_reflog_ent(&sb, fn, cb_data);
2065 fclose(logfp);
2066 strbuf_release(&sb);
2067 return ret;
2068}
Michael Haggerty2880d162016-06-18 06:15:19 +02002069
2070struct files_reflog_iterator {
2071 struct ref_iterator base;
2072
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002073 struct ref_store *ref_store;
Michael Haggerty2880d162016-06-18 06:15:19 +02002074 struct dir_iterator *dir_iterator;
2075 struct object_id oid;
2076};
2077
2078static int files_reflog_iterator_advance(struct ref_iterator *ref_iterator)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002079{
Michael Haggerty2880d162016-06-18 06:15:19 +02002080 struct files_reflog_iterator *iter =
2081 (struct files_reflog_iterator *)ref_iterator;
2082 struct dir_iterator *diter = iter->dir_iterator;
2083 int ok;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002084
Michael Haggerty2880d162016-06-18 06:15:19 +02002085 while ((ok = dir_iterator_advance(diter)) == ITER_OK) {
2086 int flags;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002087
Michael Haggerty2880d162016-06-18 06:15:19 +02002088 if (!S_ISREG(diter->st.st_mode))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002089 continue;
Michael Haggerty2880d162016-06-18 06:15:19 +02002090 if (diter->basename[0] == '.')
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002091 continue;
Michael Haggerty2880d162016-06-18 06:15:19 +02002092 if (ends_with(diter->basename, ".lock"))
2093 continue;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002094
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002095 if (refs_read_ref_full(iter->ref_store,
2096 diter->relative_path, 0,
brian m. carlson34c290a2017-10-15 22:06:56 +00002097 &iter->oid, &flags)) {
Michael Haggerty2880d162016-06-18 06:15:19 +02002098 error("bad ref for %s", diter->path.buf);
2099 continue;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002100 }
Michael Haggerty2880d162016-06-18 06:15:19 +02002101
2102 iter->base.refname = diter->relative_path;
2103 iter->base.oid = &iter->oid;
2104 iter->base.flags = flags;
2105 return ITER_OK;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002106 }
Michael Haggerty2880d162016-06-18 06:15:19 +02002107
2108 iter->dir_iterator = NULL;
2109 if (ref_iterator_abort(ref_iterator) == ITER_ERROR)
2110 ok = ITER_ERROR;
2111 return ok;
2112}
2113
2114static int files_reflog_iterator_peel(struct ref_iterator *ref_iterator,
2115 struct object_id *peeled)
2116{
Johannes Schindelin033abf92018-05-02 11:38:39 +02002117 BUG("ref_iterator_peel() called for reflog_iterator");
Michael Haggerty2880d162016-06-18 06:15:19 +02002118}
2119
2120static int files_reflog_iterator_abort(struct ref_iterator *ref_iterator)
2121{
2122 struct files_reflog_iterator *iter =
2123 (struct files_reflog_iterator *)ref_iterator;
2124 int ok = ITER_DONE;
2125
2126 if (iter->dir_iterator)
2127 ok = dir_iterator_abort(iter->dir_iterator);
2128
2129 base_ref_iterator_free(ref_iterator);
2130 return ok;
2131}
2132
2133static struct ref_iterator_vtable files_reflog_iterator_vtable = {
2134 files_reflog_iterator_advance,
2135 files_reflog_iterator_peel,
2136 files_reflog_iterator_abort
2137};
2138
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002139static struct ref_iterator *reflog_iterator_begin(struct ref_store *ref_store,
2140 const char *gitdir)
Michael Haggerty2880d162016-06-18 06:15:19 +02002141{
Matheus Tavares30123972019-07-10 20:58:59 -03002142 struct dir_iterator *diter;
2143 struct files_reflog_iterator *iter;
2144 struct ref_iterator *ref_iterator;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002145 struct strbuf sb = STRBUF_INIT;
Michael Haggerty2880d162016-06-18 06:15:19 +02002146
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002147 strbuf_addf(&sb, "%s/logs", gitdir);
Matheus Tavares30123972019-07-10 20:58:59 -03002148
Matheus Tavaresfa1da7d2019-07-10 20:59:00 -03002149 diter = dir_iterator_begin(sb.buf, 0);
René Scharfe9b7b0292019-08-07 13:15:14 +02002150 if (!diter) {
2151 strbuf_release(&sb);
Matheus Tavares30123972019-07-10 20:58:59 -03002152 return empty_ref_iterator_begin();
René Scharfe9b7b0292019-08-07 13:15:14 +02002153 }
Matheus Tavares30123972019-07-10 20:58:59 -03002154
René Scharfeca56dad2021-03-13 17:17:22 +01002155 CALLOC_ARRAY(iter, 1);
Matheus Tavares30123972019-07-10 20:58:59 -03002156 ref_iterator = &iter->base;
2157
2158 base_ref_iterator_init(ref_iterator, &files_reflog_iterator_vtable, 0);
2159 iter->dir_iterator = diter;
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002160 iter->ref_store = ref_store;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002161 strbuf_release(&sb);
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002162
Michael Haggerty2880d162016-06-18 06:15:19 +02002163 return ref_iterator;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002164}
2165
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002166static enum iterator_selection reflog_iterator_select(
2167 struct ref_iterator *iter_worktree,
2168 struct ref_iterator *iter_common,
2169 void *cb_data)
2170{
2171 if (iter_worktree) {
2172 /*
2173 * We're a bit loose here. We probably should ignore
2174 * common refs if they are accidentally added as
2175 * per-worktree refs.
2176 */
2177 return ITER_SELECT_0;
2178 } else if (iter_common) {
2179 if (ref_type(iter_common->refname) == REF_TYPE_NORMAL)
2180 return ITER_SELECT_1;
2181
2182 /*
2183 * The main ref store may contain main worktree's
2184 * per-worktree refs, which should be ignored
2185 */
2186 return ITER_SKIP_1;
2187 } else
2188 return ITER_DONE;
2189}
2190
2191static struct ref_iterator *files_reflog_iterator_begin(struct ref_store *ref_store)
2192{
2193 struct files_ref_store *refs =
2194 files_downcast(ref_store, REF_STORE_READ,
2195 "reflog_iterator_begin");
2196
Han-Wen Nienhuys5085aef2020-08-19 14:27:57 +00002197 if (!strcmp(refs->base.gitdir, refs->gitcommondir)) {
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002198 return reflog_iterator_begin(ref_store, refs->gitcommondir);
2199 } else {
2200 return merge_ref_iterator_begin(
Han-Wen Nienhuys5085aef2020-08-19 14:27:57 +00002201 0, reflog_iterator_begin(ref_store, refs->base.gitdir),
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002202 reflog_iterator_begin(ref_store, refs->gitcommondir),
2203 reflog_iterator_select, refs);
2204 }
2205}
2206
Michael Haggerty165056b2016-04-24 08:58:41 +02002207/*
Michael Haggerty92b15512016-04-25 15:56:07 +02002208 * If update is a direct update of head_ref (the reference pointed to
2209 * by HEAD), then add an extra REF_LOG_ONLY update for HEAD.
Michael Haggerty165056b2016-04-24 08:58:41 +02002210 */
Michael Haggerty92b15512016-04-25 15:56:07 +02002211static int split_head_update(struct ref_update *update,
2212 struct ref_transaction *transaction,
2213 const char *head_ref,
2214 struct string_list *affected_refnames,
2215 struct strbuf *err)
2216{
2217 struct string_list_item *item;
2218 struct ref_update *new_update;
2219
2220 if ((update->flags & REF_LOG_ONLY) ||
Michael Haggertyacedcde2017-11-05 09:42:07 +01002221 (update->flags & REF_IS_PRUNING) ||
Michael Haggerty92b15512016-04-25 15:56:07 +02002222 (update->flags & REF_UPDATE_VIA_HEAD))
2223 return 0;
2224
2225 if (strcmp(update->refname, head_ref))
2226 return 0;
2227
2228 /*
2229 * First make sure that HEAD is not already in the
Martin Ågren276d0e32017-09-09 08:57:18 +02002230 * transaction. This check is O(lg N) in the transaction
Michael Haggerty92b15512016-04-25 15:56:07 +02002231 * size, but it happens at most once per transaction.
2232 */
Martin Ågren276d0e32017-09-09 08:57:18 +02002233 if (string_list_has_string(affected_refnames, "HEAD")) {
Michael Haggerty92b15512016-04-25 15:56:07 +02002234 /* An entry already existed */
2235 strbuf_addf(err,
2236 "multiple updates for 'HEAD' (including one "
2237 "via its referent '%s') are not allowed",
2238 update->refname);
2239 return TRANSACTION_NAME_CONFLICT;
2240 }
2241
2242 new_update = ref_transaction_add_update(
2243 transaction, "HEAD",
Michael Haggerty91774af2017-11-05 09:42:06 +01002244 update->flags | REF_LOG_ONLY | REF_NO_DEREF,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00002245 &update->new_oid, &update->old_oid,
Michael Haggerty92b15512016-04-25 15:56:07 +02002246 update->msg);
2247
Martin Ågren276d0e32017-09-09 08:57:18 +02002248 /*
2249 * Add "HEAD". This insertion is O(N) in the transaction
2250 * size, but it happens at most once per transaction.
2251 * Add new_update->refname instead of a literal "HEAD".
2252 */
2253 if (strcmp(new_update->refname, "HEAD"))
2254 BUG("%s unexpectedly not 'HEAD'", new_update->refname);
2255 item = string_list_insert(affected_refnames, new_update->refname);
Michael Haggerty92b15512016-04-25 15:56:07 +02002256 item->util = new_update;
2257
2258 return 0;
2259}
2260
2261/*
2262 * update is for a symref that points at referent and doesn't have
Michael Haggerty91774af2017-11-05 09:42:06 +01002263 * REF_NO_DEREF set. Split it into two updates:
2264 * - The original update, but with REF_LOG_ONLY and REF_NO_DEREF set
Michael Haggerty92b15512016-04-25 15:56:07 +02002265 * - A new, separate update for the referent reference
2266 * Note that the new update will itself be subject to splitting when
2267 * the iteration gets to it.
2268 */
Jeff King10dee402019-02-14 00:50:46 -05002269static int split_symref_update(struct ref_update *update,
Michael Haggerty92b15512016-04-25 15:56:07 +02002270 const char *referent,
Michael Haggerty165056b2016-04-24 08:58:41 +02002271 struct ref_transaction *transaction,
2272 struct string_list *affected_refnames,
2273 struct strbuf *err)
2274{
Michael Haggerty92b15512016-04-25 15:56:07 +02002275 struct string_list_item *item;
2276 struct ref_update *new_update;
2277 unsigned int new_flags;
Michael Haggerty165056b2016-04-24 08:58:41 +02002278
Michael Haggerty92b15512016-04-25 15:56:07 +02002279 /*
2280 * First make sure that referent is not already in the
Martin Ågrenc2994682017-09-09 08:57:15 +02002281 * transaction. This check is O(lg N) in the transaction
Michael Haggerty92b15512016-04-25 15:56:07 +02002282 * size, but it happens at most once per symref in a
2283 * transaction.
2284 */
Martin Ågrenc2994682017-09-09 08:57:15 +02002285 if (string_list_has_string(affected_refnames, referent)) {
2286 /* An entry already exists */
Michael Haggerty92b15512016-04-25 15:56:07 +02002287 strbuf_addf(err,
2288 "multiple updates for '%s' (including one "
2289 "via symref '%s') are not allowed",
2290 referent, update->refname);
2291 return TRANSACTION_NAME_CONFLICT;
2292 }
2293
2294 new_flags = update->flags;
2295 if (!strcmp(update->refname, "HEAD")) {
2296 /*
2297 * Record that the new update came via HEAD, so that
2298 * when we process it, split_head_update() doesn't try
2299 * to add another reflog update for HEAD. Note that
2300 * this bit will be propagated if the new_update
2301 * itself needs to be split.
2302 */
2303 new_flags |= REF_UPDATE_VIA_HEAD;
2304 }
2305
2306 new_update = ref_transaction_add_update(
2307 transaction, referent, new_flags,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00002308 &update->new_oid, &update->old_oid,
Michael Haggerty92b15512016-04-25 15:56:07 +02002309 update->msg);
2310
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002311 new_update->parent_update = update;
2312
2313 /*
2314 * Change the symbolic ref update to log only. Also, it
Michael Haggerty78fb4572017-11-05 09:42:09 +01002315 * doesn't need to check its old OID value, as that will be
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002316 * done when new_update is processed.
2317 */
Michael Haggerty91774af2017-11-05 09:42:06 +01002318 update->flags |= REF_LOG_ONLY | REF_NO_DEREF;
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002319 update->flags &= ~REF_HAVE_OLD;
Michael Haggerty92b15512016-04-25 15:56:07 +02002320
Martin Ågrenc2994682017-09-09 08:57:15 +02002321 /*
2322 * Add the referent. This insertion is O(N) in the transaction
2323 * size, but it happens at most once per symref in a
2324 * transaction. Make sure to add new_update->refname, which will
2325 * be valid as long as affected_refnames is in use, and NOT
2326 * referent, which might soon be freed by our caller.
2327 */
2328 item = string_list_insert(affected_refnames, new_update->refname);
2329 if (item->util)
2330 BUG("%s unexpectedly found in affected_refnames",
2331 new_update->refname);
Michael Haggerty92b15512016-04-25 15:56:07 +02002332 item->util = new_update;
2333
2334 return 0;
2335}
2336
2337/*
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002338 * Return the refname under which update was originally requested.
2339 */
2340static const char *original_update_refname(struct ref_update *update)
2341{
2342 while (update->parent_update)
2343 update = update->parent_update;
2344
2345 return update->refname;
2346}
2347
2348/*
Michael Haggertye3f51032016-06-07 09:29:23 +02002349 * Check whether the REF_HAVE_OLD and old_oid values stored in update
2350 * are consistent with oid, which is the reference's current value. If
2351 * everything is OK, return 0; otherwise, write an error message to
2352 * err and return -1.
2353 */
2354static int check_old_oid(struct ref_update *update, struct object_id *oid,
2355 struct strbuf *err)
2356{
2357 if (!(update->flags & REF_HAVE_OLD) ||
Jeff King4a7e27e2018-08-28 17:22:40 -04002358 oideq(oid, &update->old_oid))
Michael Haggertye3f51032016-06-07 09:29:23 +02002359 return 0;
2360
brian m. carlson98491292017-05-06 22:10:23 +00002361 if (is_null_oid(&update->old_oid))
Michael Haggertye3f51032016-06-07 09:29:23 +02002362 strbuf_addf(err, "cannot lock ref '%s': "
2363 "reference already exists",
2364 original_update_refname(update));
2365 else if (is_null_oid(oid))
2366 strbuf_addf(err, "cannot lock ref '%s': "
2367 "reference is missing but expected %s",
2368 original_update_refname(update),
brian m. carlson98491292017-05-06 22:10:23 +00002369 oid_to_hex(&update->old_oid));
Michael Haggertye3f51032016-06-07 09:29:23 +02002370 else
2371 strbuf_addf(err, "cannot lock ref '%s': "
2372 "is at %s but expected %s",
2373 original_update_refname(update),
2374 oid_to_hex(oid),
brian m. carlson98491292017-05-06 22:10:23 +00002375 oid_to_hex(&update->old_oid));
Michael Haggertye3f51032016-06-07 09:29:23 +02002376
2377 return -1;
2378}
2379
2380/*
Michael Haggerty92b15512016-04-25 15:56:07 +02002381 * Prepare for carrying out update:
2382 * - Lock the reference referred to by update.
2383 * - Read the reference under lock.
Michael Haggerty78fb4572017-11-05 09:42:09 +01002384 * - Check that its old OID value (if specified) is correct, and in
Michael Haggerty92b15512016-04-25 15:56:07 +02002385 * any case record it in update->lock->old_oid for later use when
2386 * writing the reflog.
Michael Haggerty91774af2017-11-05 09:42:06 +01002387 * - If it is a symref update without REF_NO_DEREF, split it up into a
Michael Haggerty92b15512016-04-25 15:56:07 +02002388 * REF_LOG_ONLY update of the symref and add a separate update for
2389 * the referent to transaction.
2390 * - If it is an update of head_ref, add a corresponding REF_LOG_ONLY
2391 * update of HEAD.
2392 */
Michael Haggertyb3bbbc52016-09-04 18:08:33 +02002393static int lock_ref_for_update(struct files_ref_store *refs,
2394 struct ref_update *update,
Michael Haggerty92b15512016-04-25 15:56:07 +02002395 struct ref_transaction *transaction,
2396 const char *head_ref,
2397 struct string_list *affected_refnames,
2398 struct strbuf *err)
2399{
2400 struct strbuf referent = STRBUF_INIT;
2401 int mustexist = (update->flags & REF_HAVE_OLD) &&
brian m. carlson98491292017-05-06 22:10:23 +00002402 !is_null_oid(&update->old_oid);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002403 int ret = 0;
Michael Haggerty92b15512016-04-25 15:56:07 +02002404 struct ref_lock *lock;
2405
Michael Haggerty32c597e2017-02-10 12:16:16 +01002406 files_assert_main_repository(refs, "lock_ref_for_update");
Michael Haggertyb3bbbc52016-09-04 18:08:33 +02002407
brian m. carlson98491292017-05-06 22:10:23 +00002408 if ((update->flags & REF_HAVE_NEW) && is_null_oid(&update->new_oid))
Michael Haggerty165056b2016-04-24 08:58:41 +02002409 update->flags |= REF_DELETING;
Michael Haggerty92b15512016-04-25 15:56:07 +02002410
2411 if (head_ref) {
2412 ret = split_head_update(update, transaction, head_ref,
2413 affected_refnames, err);
2414 if (ret)
Martin Ågren851e1fb2017-09-09 08:57:16 +02002415 goto out;
Michael Haggerty92b15512016-04-25 15:56:07 +02002416 }
2417
Michael Haggertyf7b0a982016-09-04 18:08:31 +02002418 ret = lock_raw_ref(refs, update->refname, mustexist,
Michael Haggerty92b15512016-04-25 15:56:07 +02002419 affected_refnames, NULL,
David Turner7d618262016-09-04 18:08:43 +02002420 &lock, &referent,
Michael Haggerty92b15512016-04-25 15:56:07 +02002421 &update->type, err);
Michael Haggerty92b15512016-04-25 15:56:07 +02002422 if (ret) {
Michael Haggerty165056b2016-04-24 08:58:41 +02002423 char *reason;
2424
Michael Haggerty165056b2016-04-24 08:58:41 +02002425 reason = strbuf_detach(err, NULL);
2426 strbuf_addf(err, "cannot lock ref '%s': %s",
Michael Haggertye3f51032016-06-07 09:29:23 +02002427 original_update_refname(update), reason);
Michael Haggerty165056b2016-04-24 08:58:41 +02002428 free(reason);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002429 goto out;
Michael Haggerty165056b2016-04-24 08:58:41 +02002430 }
Michael Haggerty92b15512016-04-25 15:56:07 +02002431
David Turner7d618262016-09-04 18:08:43 +02002432 update->backend_data = lock;
Michael Haggerty92b15512016-04-25 15:56:07 +02002433
Michael Haggerty92b15512016-04-25 15:56:07 +02002434 if (update->type & REF_ISSYMREF) {
Michael Haggerty91774af2017-11-05 09:42:06 +01002435 if (update->flags & REF_NO_DEREF) {
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002436 /*
2437 * We won't be reading the referent as part of
2438 * the transaction, so we have to read it here
Michael Haggerty78fb4572017-11-05 09:42:09 +01002439 * to record and possibly check old_oid:
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002440 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002441 if (refs_read_ref_full(&refs->base,
2442 referent.buf, 0,
brian m. carlson34c290a2017-10-15 22:06:56 +00002443 &lock->old_oid, NULL)) {
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002444 if (update->flags & REF_HAVE_OLD) {
2445 strbuf_addf(err, "cannot lock ref '%s': "
Michael Haggertye3f51032016-06-07 09:29:23 +02002446 "error reading reference",
2447 original_update_refname(update));
Martin Ågren3f5ef952017-09-09 08:57:17 +02002448 ret = TRANSACTION_GENERIC_ERROR;
Martin Ågren851e1fb2017-09-09 08:57:16 +02002449 goto out;
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002450 }
Michael Haggertye3f51032016-06-07 09:29:23 +02002451 } else if (check_old_oid(update, &lock->old_oid, err)) {
Martin Ågren851e1fb2017-09-09 08:57:16 +02002452 ret = TRANSACTION_GENERIC_ERROR;
2453 goto out;
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002454 }
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002455 } else {
2456 /*
2457 * Create a new update for the reference this
2458 * symref is pointing at. Also, we will record
Michael Haggerty78fb4572017-11-05 09:42:09 +01002459 * and verify old_oid for this update as part
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002460 * of processing the split-off update, so we
2461 * don't have to do it here.
2462 */
Jeff King10dee402019-02-14 00:50:46 -05002463 ret = split_symref_update(update,
Michael Haggertyfcc42ea2016-09-04 18:08:35 +02002464 referent.buf, transaction,
Michael Haggerty92b15512016-04-25 15:56:07 +02002465 affected_refnames, err);
2466 if (ret)
Martin Ågren851e1fb2017-09-09 08:57:16 +02002467 goto out;
Michael Haggerty92b15512016-04-25 15:56:07 +02002468 }
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002469 } else {
2470 struct ref_update *parent_update;
Michael Haggerty8169d0d2016-04-25 17:38:35 +02002471
Martin Ågren851e1fb2017-09-09 08:57:16 +02002472 if (check_old_oid(update, &lock->old_oid, err)) {
2473 ret = TRANSACTION_GENERIC_ERROR;
2474 goto out;
2475 }
Michael Haggertye3f51032016-06-07 09:29:23 +02002476
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002477 /*
2478 * If this update is happening indirectly because of a
Michael Haggerty78fb4572017-11-05 09:42:09 +01002479 * symref update, record the old OID in the parent
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002480 * update:
2481 */
2482 for (parent_update = update->parent_update;
2483 parent_update;
2484 parent_update = parent_update->parent_update) {
David Turner7d618262016-09-04 18:08:43 +02002485 struct ref_lock *parent_lock = parent_update->backend_data;
2486 oidcpy(&parent_lock->old_oid, &lock->old_oid);
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002487 }
Michael Haggerty92b15512016-04-25 15:56:07 +02002488 }
2489
Michael Haggerty165056b2016-04-24 08:58:41 +02002490 if ((update->flags & REF_HAVE_NEW) &&
2491 !(update->flags & REF_DELETING) &&
2492 !(update->flags & REF_LOG_ONLY)) {
Michael Haggerty92b15512016-04-25 15:56:07 +02002493 if (!(update->type & REF_ISSYMREF) &&
Jeff King4a7e27e2018-08-28 17:22:40 -04002494 oideq(&lock->old_oid, &update->new_oid)) {
Michael Haggerty165056b2016-04-24 08:58:41 +02002495 /*
2496 * The reference already has the desired
2497 * value, so we don't need to write it.
2498 */
brian m. carlson4417df82017-05-06 22:10:24 +00002499 } else if (write_ref_to_lockfile(lock, &update->new_oid,
Michael Haggerty165056b2016-04-24 08:58:41 +02002500 err)) {
2501 char *write_err = strbuf_detach(err, NULL);
2502
2503 /*
2504 * The lock was freed upon failure of
2505 * write_ref_to_lockfile():
2506 */
David Turner7d618262016-09-04 18:08:43 +02002507 update->backend_data = NULL;
Michael Haggerty165056b2016-04-24 08:58:41 +02002508 strbuf_addf(err,
Michael Haggertye3f51032016-06-07 09:29:23 +02002509 "cannot update ref '%s': %s",
Michael Haggerty165056b2016-04-24 08:58:41 +02002510 update->refname, write_err);
2511 free(write_err);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002512 ret = TRANSACTION_GENERIC_ERROR;
2513 goto out;
Michael Haggerty165056b2016-04-24 08:58:41 +02002514 } else {
2515 update->flags |= REF_NEEDS_COMMIT;
2516 }
2517 }
2518 if (!(update->flags & REF_NEEDS_COMMIT)) {
2519 /*
2520 * We didn't call write_ref_to_lockfile(), so
2521 * the lockfile is still open. Close it to
2522 * free up the file descriptor:
2523 */
Jeff King83a30692017-09-05 08:14:33 -04002524 if (close_ref_gently(lock)) {
Michael Haggerty165056b2016-04-24 08:58:41 +02002525 strbuf_addf(err, "couldn't close '%s.lock'",
2526 update->refname);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002527 ret = TRANSACTION_GENERIC_ERROR;
2528 goto out;
Michael Haggerty165056b2016-04-24 08:58:41 +02002529 }
2530 }
Martin Ågren851e1fb2017-09-09 08:57:16 +02002531
2532out:
2533 strbuf_release(&referent);
2534 return ret;
Michael Haggerty165056b2016-04-24 08:58:41 +02002535}
2536
Michael Haggertydc39e092017-09-08 15:51:51 +02002537struct files_transaction_backend_data {
2538 struct ref_transaction *packed_transaction;
2539 int packed_refs_locked;
2540};
2541
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002542/*
2543 * Unlock any references in `transaction` that are still locked, and
2544 * mark the transaction closed.
2545 */
Michael Haggertydc39e092017-09-08 15:51:51 +02002546static void files_transaction_cleanup(struct files_ref_store *refs,
2547 struct ref_transaction *transaction)
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002548{
2549 size_t i;
Michael Haggertydc39e092017-09-08 15:51:51 +02002550 struct files_transaction_backend_data *backend_data =
2551 transaction->backend_data;
2552 struct strbuf err = STRBUF_INIT;
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002553
2554 for (i = 0; i < transaction->nr; i++) {
2555 struct ref_update *update = transaction->updates[i];
2556 struct ref_lock *lock = update->backend_data;
2557
2558 if (lock) {
2559 unlock_ref(lock);
2560 update->backend_data = NULL;
2561 }
2562 }
2563
Patrick Steinhardtedc30692020-03-30 15:46:13 +02002564 if (backend_data) {
2565 if (backend_data->packed_transaction &&
2566 ref_transaction_abort(backend_data->packed_transaction, &err)) {
2567 error("error aborting transaction: %s", err.buf);
2568 strbuf_release(&err);
2569 }
2570
2571 if (backend_data->packed_refs_locked)
2572 packed_refs_unlock(refs->packed_ref_store);
2573
2574 free(backend_data);
Michael Haggertydc39e092017-09-08 15:51:51 +02002575 }
2576
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002577 transaction->state = REF_TRANSACTION_CLOSED;
2578}
2579
Michael Haggerty30173b82017-05-22 16:17:44 +02002580static int files_transaction_prepare(struct ref_store *ref_store,
2581 struct ref_transaction *transaction,
2582 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002583{
Michael Haggerty00eebe32016-09-04 18:08:11 +02002584 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07002585 files_downcast(ref_store, REF_STORE_WRITE,
Michael Haggerty30173b82017-05-22 16:17:44 +02002586 "ref_transaction_prepare");
Michael Haggerty43a2dfd2017-05-22 16:17:37 +02002587 size_t i;
2588 int ret = 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002589 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
Michael Haggerty92b15512016-04-25 15:56:07 +02002590 char *head_ref = NULL;
2591 int head_type;
Michael Haggertydc39e092017-09-08 15:51:51 +02002592 struct files_transaction_backend_data *backend_data;
2593 struct ref_transaction *packed_transaction = NULL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002594
2595 assert(err);
2596
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002597 if (!transaction->nr)
2598 goto cleanup;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002599
René Scharfeca56dad2021-03-13 17:17:22 +01002600 CALLOC_ARRAY(backend_data, 1);
Michael Haggertydc39e092017-09-08 15:51:51 +02002601 transaction->backend_data = backend_data;
2602
Michael Haggerty92b15512016-04-25 15:56:07 +02002603 /*
2604 * Fail if a refname appears more than once in the
2605 * transaction. (If we end up splitting up any updates using
2606 * split_symref_update() or split_head_update(), those
2607 * functions will check that the new updates don't have the
Michael Haggerty62c72d12017-11-05 09:42:04 +01002608 * same refname as any existing ones.) Also fail if any of the
Michael Haggertyacedcde2017-11-05 09:42:07 +01002609 * updates use REF_IS_PRUNING without REF_NO_DEREF.
Michael Haggerty92b15512016-04-25 15:56:07 +02002610 */
2611 for (i = 0; i < transaction->nr; i++) {
2612 struct ref_update *update = transaction->updates[i];
2613 struct string_list_item *item =
2614 string_list_append(&affected_refnames, update->refname);
2615
Michael Haggertyacedcde2017-11-05 09:42:07 +01002616 if ((update->flags & REF_IS_PRUNING) &&
Michael Haggerty91774af2017-11-05 09:42:06 +01002617 !(update->flags & REF_NO_DEREF))
Michael Haggertyacedcde2017-11-05 09:42:07 +01002618 BUG("REF_IS_PRUNING set without REF_NO_DEREF");
Michael Haggerty62c72d12017-11-05 09:42:04 +01002619
Michael Haggerty92b15512016-04-25 15:56:07 +02002620 /*
2621 * We store a pointer to update in item->util, but at
2622 * the moment we never use the value of this field
2623 * except to check whether it is non-NULL.
2624 */
2625 item->util = update;
2626 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002627 string_list_sort(&affected_refnames);
2628 if (ref_update_reject_duplicates(&affected_refnames, err)) {
2629 ret = TRANSACTION_GENERIC_ERROR;
2630 goto cleanup;
2631 }
2632
2633 /*
Michael Haggerty92b15512016-04-25 15:56:07 +02002634 * Special hack: If a branch is updated directly and HEAD
2635 * points to it (may happen on the remote side of a push
2636 * for example) then logically the HEAD reflog should be
2637 * updated too.
2638 *
2639 * A generic solution would require reverse symref lookups,
2640 * but finding all symrefs pointing to a given branch would be
2641 * rather costly for this rare event (the direct update of a
2642 * branch) to be worth it. So let's cheat and check with HEAD
2643 * only, which should cover 99% of all usage scenarios (even
2644 * 100% of the default ones).
2645 *
2646 * So if HEAD is a symbolic reference, then record the name of
2647 * the reference that it points to. If we see an update of
2648 * head_ref within the transaction, then split_head_update()
2649 * arranges for the reflog of HEAD to be updated, too.
2650 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002651 head_ref = refs_resolve_refdup(ref_store, "HEAD",
2652 RESOLVE_REF_NO_RECURSE,
René Scharfe872ccb22017-10-01 09:28:50 +02002653 NULL, &head_type);
Michael Haggerty92b15512016-04-25 15:56:07 +02002654
2655 if (head_ref && !(head_type & REF_ISSYMREF)) {
Ævar Arnfjörð Bjarmason6a83d902017-06-15 23:15:46 +00002656 FREE_AND_NULL(head_ref);
Michael Haggerty92b15512016-04-25 15:56:07 +02002657 }
2658
2659 /*
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002660 * Acquire all locks, verify old values if provided, check
2661 * that new values are valid, and write new values to the
2662 * lockfiles, ready to be activated. Only keep one lockfile
2663 * open at a time to avoid running out of file descriptors.
Michael Haggerty30173b82017-05-22 16:17:44 +02002664 * Note that lock_ref_for_update() might append more updates
2665 * to the transaction.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002666 */
Michael Haggertyefe47282016-04-22 00:02:50 +02002667 for (i = 0; i < transaction->nr; i++) {
2668 struct ref_update *update = transaction->updates[i];
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002669
Michael Haggertyb3bbbc52016-09-04 18:08:33 +02002670 ret = lock_ref_for_update(refs, update, transaction,
2671 head_ref, &affected_refnames, err);
Michael Haggerty165056b2016-04-24 08:58:41 +02002672 if (ret)
Michael Haggertyda5267f2017-10-24 17:16:25 +02002673 goto cleanup;
Michael Haggertydc39e092017-09-08 15:51:51 +02002674
2675 if (update->flags & REF_DELETING &&
2676 !(update->flags & REF_LOG_ONLY) &&
Michael Haggertyacedcde2017-11-05 09:42:07 +01002677 !(update->flags & REF_IS_PRUNING)) {
Michael Haggertydc39e092017-09-08 15:51:51 +02002678 /*
2679 * This reference has to be deleted from
2680 * packed-refs if it exists there.
2681 */
2682 if (!packed_transaction) {
2683 packed_transaction = ref_store_transaction_begin(
2684 refs->packed_ref_store, err);
2685 if (!packed_transaction) {
2686 ret = TRANSACTION_GENERIC_ERROR;
2687 goto cleanup;
2688 }
2689
2690 backend_data->packed_transaction =
2691 packed_transaction;
2692 }
2693
2694 ref_transaction_add_update(
2695 packed_transaction, update->refname,
Michael Haggerty91774af2017-11-05 09:42:06 +01002696 REF_HAVE_NEW | REF_NO_DEREF,
Michael Haggertyb0ca4112017-11-05 09:42:01 +01002697 &update->new_oid, NULL,
Michael Haggertydc39e092017-09-08 15:51:51 +02002698 NULL);
2699 }
2700 }
2701
2702 if (packed_transaction) {
2703 if (packed_refs_lock(refs->packed_ref_store, 0, err)) {
2704 ret = TRANSACTION_GENERIC_ERROR;
2705 goto cleanup;
2706 }
2707 backend_data->packed_refs_locked = 1;
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002708
2709 if (is_packed_transaction_needed(refs->packed_ref_store,
2710 packed_transaction)) {
2711 ret = ref_transaction_prepare(packed_transaction, err);
Jeff King249e8dc2019-03-21 05:28:44 -04002712 /*
2713 * A failure during the prepare step will abort
2714 * itself, but not free. Do that now, and disconnect
2715 * from the files_transaction so it does not try to
2716 * abort us when we hit the cleanup code below.
2717 */
2718 if (ret) {
2719 ref_transaction_free(packed_transaction);
2720 backend_data->packed_transaction = NULL;
2721 }
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002722 } else {
2723 /*
2724 * We can skip rewriting the `packed-refs`
2725 * file. But we do need to leave it locked, so
2726 * that somebody else doesn't pack a reference
2727 * that we are trying to delete.
Jeff Kingd3322eb2019-03-21 05:28:54 -04002728 *
2729 * We need to disconnect our transaction from
2730 * backend_data, since the abort (whether successful or
2731 * not) will free it.
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002732 */
Jeff Kingd3322eb2019-03-21 05:28:54 -04002733 backend_data->packed_transaction = NULL;
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002734 if (ref_transaction_abort(packed_transaction, err)) {
2735 ret = TRANSACTION_GENERIC_ERROR;
2736 goto cleanup;
2737 }
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002738 }
Michael Haggerty30173b82017-05-22 16:17:44 +02002739 }
2740
2741cleanup:
2742 free(head_ref);
2743 string_list_clear(&affected_refnames, 0);
2744
2745 if (ret)
Michael Haggertydc39e092017-09-08 15:51:51 +02002746 files_transaction_cleanup(refs, transaction);
Michael Haggerty30173b82017-05-22 16:17:44 +02002747 else
2748 transaction->state = REF_TRANSACTION_PREPARED;
2749
2750 return ret;
2751}
2752
2753static int files_transaction_finish(struct ref_store *ref_store,
2754 struct ref_transaction *transaction,
2755 struct strbuf *err)
2756{
2757 struct files_ref_store *refs =
2758 files_downcast(ref_store, 0, "ref_transaction_finish");
2759 size_t i;
2760 int ret = 0;
Michael Haggerty30173b82017-05-22 16:17:44 +02002761 struct strbuf sb = STRBUF_INIT;
Michael Haggertydc39e092017-09-08 15:51:51 +02002762 struct files_transaction_backend_data *backend_data;
2763 struct ref_transaction *packed_transaction;
2764
Michael Haggerty30173b82017-05-22 16:17:44 +02002765
2766 assert(err);
2767
2768 if (!transaction->nr) {
2769 transaction->state = REF_TRANSACTION_CLOSED;
2770 return 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002771 }
2772
Michael Haggertydc39e092017-09-08 15:51:51 +02002773 backend_data = transaction->backend_data;
2774 packed_transaction = backend_data->packed_transaction;
2775
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002776 /* Perform updates first so live commits remain referenced */
Michael Haggertyefe47282016-04-22 00:02:50 +02002777 for (i = 0; i < transaction->nr; i++) {
2778 struct ref_update *update = transaction->updates[i];
David Turner7d618262016-09-04 18:08:43 +02002779 struct ref_lock *lock = update->backend_data;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002780
David Turnerd99aa882016-02-24 17:58:50 -05002781 if (update->flags & REF_NEEDS_COMMIT ||
2782 update->flags & REF_LOG_ONLY) {
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002783 if (files_log_ref_write(refs,
2784 lock->ref_name,
brian m. carlson4417df82017-05-06 22:10:24 +00002785 &lock->old_oid,
2786 &update->new_oid,
Michael Haggerty81b1b6d2017-01-06 17:22:31 +01002787 update->msg, update->flags,
2788 err)) {
Michael Haggerty92b15512016-04-25 15:56:07 +02002789 char *old_msg = strbuf_detach(err, NULL);
2790
2791 strbuf_addf(err, "cannot update the ref '%s': %s",
2792 lock->ref_name, old_msg);
2793 free(old_msg);
2794 unlock_ref(lock);
David Turner7d618262016-09-04 18:08:43 +02002795 update->backend_data = NULL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002796 ret = TRANSACTION_GENERIC_ERROR;
2797 goto cleanup;
Michael Haggerty92b15512016-04-25 15:56:07 +02002798 }
2799 }
2800 if (update->flags & REF_NEEDS_COMMIT) {
Michael Haggerty00eebe32016-09-04 18:08:11 +02002801 clear_loose_ref_cache(refs);
Michael Haggerty92b15512016-04-25 15:56:07 +02002802 if (commit_ref(lock)) {
2803 strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
2804 unlock_ref(lock);
David Turner7d618262016-09-04 18:08:43 +02002805 update->backend_data = NULL;
Michael Haggerty92b15512016-04-25 15:56:07 +02002806 ret = TRANSACTION_GENERIC_ERROR;
2807 goto cleanup;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002808 }
2809 }
2810 }
Michael Haggertydc39e092017-09-08 15:51:51 +02002811
2812 /*
Michael Haggerty5e00a6c2017-09-08 15:51:53 +02002813 * Now that updates are safely completed, we can perform
2814 * deletes. First delete the reflogs of any references that
2815 * will be deleted, since (in the unexpected event of an
2816 * error) leaving a reference without a reflog is less bad
2817 * than leaving a reflog without a reference (the latter is a
2818 * mildly invalid repository state):
2819 */
2820 for (i = 0; i < transaction->nr; i++) {
2821 struct ref_update *update = transaction->updates[i];
2822 if (update->flags & REF_DELETING &&
2823 !(update->flags & REF_LOG_ONLY) &&
Michael Haggertyacedcde2017-11-05 09:42:07 +01002824 !(update->flags & REF_IS_PRUNING)) {
Michael Haggerty5e00a6c2017-09-08 15:51:53 +02002825 strbuf_reset(&sb);
2826 files_reflog_path(refs, &sb, update->refname);
2827 if (!unlink_or_warn(sb.buf))
2828 try_remove_empty_parents(refs, update->refname,
2829 REMOVE_EMPTY_PARENTS_REFLOG);
2830 }
2831 }
2832
2833 /*
Michael Haggertydc39e092017-09-08 15:51:51 +02002834 * Perform deletes now that updates are safely completed.
2835 *
2836 * First delete any packed versions of the references, while
2837 * retaining the packed-refs lock:
2838 */
2839 if (packed_transaction) {
2840 ret = ref_transaction_commit(packed_transaction, err);
2841 ref_transaction_free(packed_transaction);
2842 packed_transaction = NULL;
2843 backend_data->packed_transaction = NULL;
2844 if (ret)
2845 goto cleanup;
2846 }
2847
2848 /* Now delete the loose versions of the references: */
Michael Haggertyefe47282016-04-22 00:02:50 +02002849 for (i = 0; i < transaction->nr; i++) {
2850 struct ref_update *update = transaction->updates[i];
David Turner7d618262016-09-04 18:08:43 +02002851 struct ref_lock *lock = update->backend_data;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002852
David Turnerd99aa882016-02-24 17:58:50 -05002853 if (update->flags & REF_DELETING &&
2854 !(update->flags & REF_LOG_ONLY)) {
Michael Haggertyce0af242017-01-06 17:22:39 +01002855 if (!(update->type & REF_ISPACKED) ||
2856 update->type & REF_ISSYMREF) {
2857 /* It is a loose reference. */
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002858 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07002859 files_ref_path(refs, &sb, lock->ref_name);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002860 if (unlink_or_msg(sb.buf, err)) {
Michael Haggertyce0af242017-01-06 17:22:39 +01002861 ret = TRANSACTION_GENERIC_ERROR;
2862 goto cleanup;
2863 }
Michael Haggerty44639772017-01-06 17:22:43 +01002864 update->flags |= REF_DELETED_LOOSE;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002865 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002866 }
2867 }
2868
Michael Haggerty00eebe32016-09-04 18:08:11 +02002869 clear_loose_ref_cache(refs);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002870
2871cleanup:
Michael Haggertydc39e092017-09-08 15:51:51 +02002872 files_transaction_cleanup(refs, transaction);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002873
Michael Haggerty44639772017-01-06 17:22:43 +01002874 for (i = 0; i < transaction->nr; i++) {
2875 struct ref_update *update = transaction->updates[i];
Michael Haggerty44639772017-01-06 17:22:43 +01002876
2877 if (update->flags & REF_DELETED_LOOSE) {
2878 /*
2879 * The loose reference was deleted. Delete any
2880 * empty parent directories. (Note that this
2881 * can only work because we have already
2882 * removed the lockfile.)
2883 */
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002884 try_remove_empty_parents(refs, update->refname,
Michael Haggerty44639772017-01-06 17:22:43 +01002885 REMOVE_EMPTY_PARENTS_REF);
2886 }
2887 }
2888
Michael Haggerty30173b82017-05-22 16:17:44 +02002889 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002890 return ret;
2891}
2892
Michael Haggerty30173b82017-05-22 16:17:44 +02002893static int files_transaction_abort(struct ref_store *ref_store,
2894 struct ref_transaction *transaction,
2895 struct strbuf *err)
2896{
Michael Haggertydc39e092017-09-08 15:51:51 +02002897 struct files_ref_store *refs =
2898 files_downcast(ref_store, 0, "ref_transaction_abort");
2899
2900 files_transaction_cleanup(refs, transaction);
Michael Haggerty30173b82017-05-22 16:17:44 +02002901 return 0;
2902}
2903
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002904static int ref_present(const char *refname,
2905 const struct object_id *oid, int flags, void *cb_data)
2906{
2907 struct string_list *affected_refnames = cb_data;
2908
2909 return string_list_has_string(affected_refnames, refname);
2910}
2911
David Turnerfc681462016-09-04 18:08:39 +02002912static int files_initial_transaction_commit(struct ref_store *ref_store,
2913 struct ref_transaction *transaction,
2914 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002915{
Michael Haggertyd99825a2016-09-04 18:08:12 +02002916 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07002917 files_downcast(ref_store, REF_STORE_WRITE,
2918 "initial_ref_transaction_commit");
Michael Haggerty43a2dfd2017-05-22 16:17:37 +02002919 size_t i;
2920 int ret = 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002921 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002922 struct ref_transaction *packed_transaction = NULL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002923
2924 assert(err);
2925
2926 if (transaction->state != REF_TRANSACTION_OPEN)
Johannes Schindelin033abf92018-05-02 11:38:39 +02002927 BUG("commit called for transaction that is not open");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002928
2929 /* Fail if a refname appears more than once in the transaction: */
Michael Haggertyefe47282016-04-22 00:02:50 +02002930 for (i = 0; i < transaction->nr; i++)
2931 string_list_append(&affected_refnames,
2932 transaction->updates[i]->refname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002933 string_list_sort(&affected_refnames);
2934 if (ref_update_reject_duplicates(&affected_refnames, err)) {
2935 ret = TRANSACTION_GENERIC_ERROR;
2936 goto cleanup;
2937 }
2938
2939 /*
2940 * It's really undefined to call this function in an active
2941 * repository or when there are existing references: we are
2942 * only locking and changing packed-refs, so (1) any
2943 * simultaneous processes might try to change a reference at
2944 * the same time we do, and (2) any existing loose versions of
2945 * the references that we are setting would have precedence
2946 * over our values. But some remote helpers create the remote
2947 * "HEAD" and "master" branches before calling this function,
2948 * so here we really only check that none of the references
2949 * that we are creating already exists.
2950 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002951 if (refs_for_each_rawref(&refs->base, ref_present,
2952 &affected_refnames))
Johannes Schindelin033abf92018-05-02 11:38:39 +02002953 BUG("initial ref transaction called with existing refs");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002954
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002955 packed_transaction = ref_store_transaction_begin(refs->packed_ref_store, err);
2956 if (!packed_transaction) {
2957 ret = TRANSACTION_GENERIC_ERROR;
2958 goto cleanup;
2959 }
2960
Michael Haggertyefe47282016-04-22 00:02:50 +02002961 for (i = 0; i < transaction->nr; i++) {
2962 struct ref_update *update = transaction->updates[i];
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002963
2964 if ((update->flags & REF_HAVE_OLD) &&
brian m. carlson98491292017-05-06 22:10:23 +00002965 !is_null_oid(&update->old_oid))
Johannes Schindelin033abf92018-05-02 11:38:39 +02002966 BUG("initial ref transaction with old_sha1 set");
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +07002967 if (refs_verify_refname_available(&refs->base, update->refname,
2968 &affected_refnames, NULL,
2969 err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002970 ret = TRANSACTION_NAME_CONFLICT;
2971 goto cleanup;
2972 }
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002973
2974 /*
2975 * Add a reference creation for this reference to the
2976 * packed-refs transaction:
2977 */
2978 ref_transaction_add_update(packed_transaction, update->refname,
2979 update->flags & ~REF_HAVE_OLD,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00002980 &update->new_oid, &update->old_oid,
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002981 NULL);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002982 }
2983
Michael Haggertyc8bed832017-06-23 09:01:42 +02002984 if (packed_refs_lock(refs->packed_ref_store, 0, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002985 ret = TRANSACTION_GENERIC_ERROR;
2986 goto cleanup;
2987 }
2988
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002989 if (initial_ref_transaction_commit(packed_transaction, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002990 ret = TRANSACTION_GENERIC_ERROR;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002991 }
2992
Mathias Rav81fcb692018-01-18 14:38:41 +01002993 packed_refs_unlock(refs->packed_ref_store);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002994cleanup:
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002995 if (packed_transaction)
2996 ref_transaction_free(packed_transaction);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002997 transaction->state = REF_TRANSACTION_CLOSED;
2998 string_list_clear(&affected_refnames, 0);
2999 return ret;
3000}
3001
3002struct expire_reflog_cb {
3003 unsigned int flags;
3004 reflog_expiry_should_prune_fn *should_prune_fn;
3005 void *policy_cb;
3006 FILE *newlog;
brian m. carlson9461d272017-02-21 23:47:32 +00003007 struct object_id last_kept_oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003008};
3009
brian m. carlson9461d272017-02-21 23:47:32 +00003010static int expire_reflog_ent(struct object_id *ooid, struct object_id *noid,
Johannes Schindelindddbad72017-04-26 21:29:31 +02003011 const char *email, timestamp_t timestamp, int tz,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003012 const char *message, void *cb_data)
3013{
3014 struct expire_reflog_cb *cb = cb_data;
3015 struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;
3016
3017 if (cb->flags & EXPIRE_REFLOGS_REWRITE)
brian m. carlson9461d272017-02-21 23:47:32 +00003018 ooid = &cb->last_kept_oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003019
brian m. carlson43224782017-05-06 22:10:00 +00003020 if ((*cb->should_prune_fn)(ooid, noid, email, timestamp, tz,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003021 message, policy_cb)) {
3022 if (!cb->newlog)
3023 printf("would prune %s", message);
3024 else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
3025 printf("prune %s", message);
3026 } else {
3027 if (cb->newlog) {
Johannes Schindelincb71f8b2017-04-21 12:45:48 +02003028 fprintf(cb->newlog, "%s %s %s %"PRItime" %+05d\t%s",
brian m. carlson9461d272017-02-21 23:47:32 +00003029 oid_to_hex(ooid), oid_to_hex(noid),
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003030 email, timestamp, tz, message);
brian m. carlson9461d272017-02-21 23:47:32 +00003031 oidcpy(&cb->last_kept_oid, noid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003032 }
3033 if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
3034 printf("keep %s", message);
3035 }
3036 return 0;
3037}
3038
David Turnere3688bd2016-09-04 18:08:38 +02003039static int files_reflog_expire(struct ref_store *ref_store,
brian m. carlson0155f712017-10-15 22:07:04 +00003040 const char *refname, const struct object_id *oid,
David Turnere3688bd2016-09-04 18:08:38 +02003041 unsigned int flags,
3042 reflog_expiry_prepare_fn prepare_fn,
3043 reflog_expiry_should_prune_fn should_prune_fn,
3044 reflog_expiry_cleanup_fn cleanup_fn,
3045 void *policy_cb_data)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003046{
Michael Haggerty7eb27cd2016-09-04 18:08:34 +02003047 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07003048 files_downcast(ref_store, REF_STORE_WRITE, "reflog_expire");
Martin Ågrenb2275862018-05-09 22:55:38 +02003049 struct lock_file reflog_lock = LOCK_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003050 struct expire_reflog_cb cb;
3051 struct ref_lock *lock;
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07003052 struct strbuf log_file_sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003053 char *log_file;
3054 int status = 0;
3055 int type;
3056 struct strbuf err = STRBUF_INIT;
3057
3058 memset(&cb, 0, sizeof(cb));
3059 cb.flags = flags;
3060 cb.policy_cb = policy_cb_data;
3061 cb.should_prune_fn = should_prune_fn;
3062
3063 /*
3064 * The reflog file is locked by holding the lock on the
3065 * reference itself, plus we might need to update the
3066 * reference if --updateref was specified:
3067 */
brian m. carlson4f01e502017-10-15 22:07:12 +00003068 lock = lock_ref_oid_basic(refs, refname, oid,
Michael Haggerty91774af2017-11-05 09:42:06 +01003069 NULL, NULL, REF_NO_DEREF,
brian m. carlson4f01e502017-10-15 22:07:12 +00003070 &type, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003071 if (!lock) {
3072 error("cannot lock ref '%s': %s", refname, err.buf);
3073 strbuf_release(&err);
3074 return -1;
3075 }
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07003076 if (!refs_reflog_exists(ref_store, refname)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003077 unlock_ref(lock);
3078 return 0;
3079 }
3080
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07003081 files_reflog_path(refs, &log_file_sb, refname);
3082 log_file = strbuf_detach(&log_file_sb, NULL);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003083 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
3084 /*
3085 * Even though holding $GIT_DIR/logs/$reflog.lock has
3086 * no locking implications, we use the lock_file
3087 * machinery here anyway because it does a lot of the
3088 * work we need, including cleaning up if the program
3089 * exits unexpectedly.
3090 */
3091 if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
3092 struct strbuf err = STRBUF_INIT;
3093 unable_to_lock_message(log_file, errno, &err);
3094 error("%s", err.buf);
3095 strbuf_release(&err);
3096 goto failure;
3097 }
3098 cb.newlog = fdopen_lock_file(&reflog_lock, "w");
3099 if (!cb.newlog) {
3100 error("cannot fdopen %s (%s)",
3101 get_lock_file_path(&reflog_lock), strerror(errno));
3102 goto failure;
3103 }
3104 }
3105
brian m. carlson0155f712017-10-15 22:07:04 +00003106 (*prepare_fn)(refname, oid, cb.policy_cb);
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07003107 refs_for_each_reflog_ent(ref_store, refname, expire_reflog_ent, &cb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003108 (*cleanup_fn)(cb.policy_cb);
3109
3110 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
3111 /*
3112 * It doesn't make sense to adjust a reference pointed
3113 * to by a symbolic ref based on expiring entries in
3114 * the symbolic reference's reflog. Nor can we update
3115 * a reference if there are no remaining reflog
3116 * entries.
3117 */
3118 int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&
3119 !(type & REF_ISSYMREF) &&
brian m. carlson9461d272017-02-21 23:47:32 +00003120 !is_null_oid(&cb.last_kept_oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003121
Jeff King83a30692017-09-05 08:14:33 -04003122 if (close_lock_file_gently(&reflog_lock)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003123 status |= error("couldn't write %s: %s", log_file,
3124 strerror(errno));
Jeff King83a30692017-09-05 08:14:33 -04003125 rollback_lock_file(&reflog_lock);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003126 } else if (update &&
Jeff Kingee4d8e42017-09-05 08:15:15 -04003127 (write_in_full(get_lock_file_fd(&lock->lk),
brian m. carlson2ae2e2a2018-07-16 01:27:59 +00003128 oid_to_hex(&cb.last_kept_oid), the_hash_algo->hexsz) < 0 ||
Jeff King88780c32017-09-25 16:27:17 -04003129 write_str_in_full(get_lock_file_fd(&lock->lk), "\n") < 0 ||
Jeff King83a30692017-09-05 08:14:33 -04003130 close_ref_gently(lock) < 0)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003131 status |= error("couldn't write %s",
Jeff Kingee4d8e42017-09-05 08:15:15 -04003132 get_lock_file_path(&lock->lk));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003133 rollback_lock_file(&reflog_lock);
3134 } else if (commit_lock_file(&reflog_lock)) {
Junio C Hamanoe0048d32015-12-11 10:40:54 -08003135 status |= error("unable to write reflog '%s' (%s)",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003136 log_file, strerror(errno));
3137 } else if (update && commit_ref(lock)) {
3138 status |= error("couldn't set %s", lock->ref_name);
3139 }
3140 }
3141 free(log_file);
3142 unlock_ref(lock);
3143 return status;
3144
3145 failure:
3146 rollback_lock_file(&reflog_lock);
3147 free(log_file);
3148 unlock_ref(lock);
3149 return -1;
3150}
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +02003151
David Turner6fb5acf2016-09-04 18:08:41 +02003152static int files_init_db(struct ref_store *ref_store, struct strbuf *err)
3153{
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07003154 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07003155 files_downcast(ref_store, REF_STORE_WRITE, "init_db");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07003156 struct strbuf sb = STRBUF_INIT;
3157
David Turner6fb5acf2016-09-04 18:08:41 +02003158 /*
3159 * Create .git/refs/{heads,tags}
3160 */
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07003161 files_ref_path(refs, &sb, "refs/heads");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07003162 safe_create_dir(sb.buf, 1);
3163
3164 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07003165 files_ref_path(refs, &sb, "refs/tags");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07003166 safe_create_dir(sb.buf, 1);
3167
3168 strbuf_release(&sb);
David Turner6fb5acf2016-09-04 18:08:41 +02003169 return 0;
3170}
3171
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +02003172struct ref_storage_be refs_be_files = {
3173 NULL,
Michael Haggerty00eebe32016-09-04 18:08:11 +02003174 "files",
Ronnie Sahlberg127b42a2016-09-04 18:08:16 +02003175 files_ref_store_create,
David Turner6fb5acf2016-09-04 18:08:41 +02003176 files_init_db,
Michael Haggerty30173b82017-05-22 16:17:44 +02003177 files_transaction_prepare,
3178 files_transaction_finish,
3179 files_transaction_abort,
David Turnerfc681462016-09-04 18:08:39 +02003180 files_initial_transaction_commit,
Michael Haggertye1e33b72016-09-04 18:08:25 +02003181
Michael Haggerty82315272016-09-04 18:08:27 +02003182 files_pack_refs,
Michael Haggerty284689b2016-09-04 18:08:28 +02003183 files_create_symref,
David Turnera27dcf82016-09-04 18:08:40 +02003184 files_delete_refs,
David Turner9b6b40d2016-09-04 18:08:42 +02003185 files_rename_ref,
Sahil Dua52d59cc2017-06-18 23:19:16 +02003186 files_copy_ref,
Michael Haggerty82315272016-09-04 18:08:27 +02003187
Michael Haggerty1a769002016-09-04 18:08:37 +02003188 files_ref_iterator_begin,
Michael Haggerty62665822016-09-04 18:08:26 +02003189 files_read_raw_ref,
David Turnere3688bd2016-09-04 18:08:38 +02003190
3191 files_reflog_iterator_begin,
3192 files_for_each_reflog_ent,
3193 files_for_each_reflog_ent_reverse,
3194 files_reflog_exists,
3195 files_create_reflog,
3196 files_delete_reflog,
3197 files_reflog_expire
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +02003198};