blob: 985631f33edf92afc706061b0d208bd35fab4bdc [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/*
42 * Used as a flag in ref_update::flags when we want to log a ref
43 * update but not actually perform it. This is used when a symbolic
44 * ref update is split up.
45 */
46#define REF_LOG_ONLY (1 << 7)
47
48/*
49 * Used as a flag in ref_update::flags when the ref_update was via an
50 * update to HEAD.
51 */
52#define REF_UPDATE_VIA_HEAD (1 << 8)
53
54/*
55 * Used as a flag in ref_update::flags when the loose reference has
56 * been deleted.
57 */
58#define REF_DELETED_LOOSE (1 << 9)
59
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010060struct ref_lock {
61 char *ref_name;
Jeff Kingee4d8e42017-09-05 08:15:15 -040062 struct lock_file lk;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010063 struct object_id old_oid;
64};
65
Michael Haggerty00eebe32016-09-04 18:08:11 +020066struct files_ref_store {
67 struct ref_store base;
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +070068 unsigned int store_flags;
Michael Haggerty32c597e2017-02-10 12:16:16 +010069
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +070070 char *gitdir;
71 char *gitcommondir;
Nguyễn Thái Ngọc Duy33dfb9f2017-03-26 09:42:18 +070072
Michael Haggerty7c22bc82017-04-16 08:41:32 +020073 struct ref_cache *loose;
Michael Haggerty55c6bc32017-05-22 16:17:40 +020074
Michael Haggertye0cc8ac2017-06-23 09:01:38 +020075 struct ref_store *packed_ref_store;
Michael Haggerty00eebe32016-09-04 18:08:11 +020076};
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010077
Michael Haggerty65a0a8e2016-09-04 18:08:09 +020078static void clear_loose_ref_cache(struct files_ref_store *refs)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010079{
80 if (refs->loose) {
Michael Haggerty7c22bc82017-04-16 08:41:32 +020081 free_ref_cache(refs->loose);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010082 refs->loose = NULL;
83 }
84}
85
Jeff Kinga2d51562016-01-22 17:29:30 -050086/*
87 * Create a new submodule ref cache and add it to the internal
88 * set of caches.
89 */
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +070090static struct ref_store *files_ref_store_create(const char *gitdir,
91 unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010092{
Michael Haggerty00eebe32016-09-04 18:08:11 +020093 struct files_ref_store *refs = xcalloc(1, sizeof(*refs));
94 struct ref_store *ref_store = (struct ref_store *)refs;
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +070095 struct strbuf sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +010096
Michael Haggertyfbfd0a22017-02-10 12:16:17 +010097 base_ref_store_init(ref_store, &refs_be_files);
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +070098 refs->store_flags = flags;
Jeff Kinga2d51562016-01-22 17:29:30 -050099
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700100 refs->gitdir = xstrdup(gitdir);
101 get_common_dir_noenv(&sb, gitdir);
102 refs->gitcommondir = strbuf_detach(&sb, NULL);
103 strbuf_addf(&sb, "%s/packed-refs", refs->gitcommondir);
Michael Haggertye0d48392017-06-23 09:01:22 +0200104 refs->packed_ref_store = packed_ref_store_create(sb.buf, flags);
105 strbuf_release(&sb);
Jeff Kinga2d51562016-01-22 17:29:30 -0500106
Jeff Kingfb9c2d22018-03-30 14:35:12 -0400107 chdir_notify_reparent("files-backend $GIT_DIR",
108 &refs->gitdir);
109 chdir_notify_reparent("files-backend $GIT_COMMONDIR",
110 &refs->gitcommondir);
111
Michael Haggerty00eebe32016-09-04 18:08:11 +0200112 return ref_store;
Jeff Kinga2d51562016-01-22 17:29:30 -0500113}
114
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100115/*
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700116 * Die if refs is not the main ref store. caller is used in any
117 * necessary error messages.
Michael Haggerty32c597e2017-02-10 12:16:16 +0100118 */
119static void files_assert_main_repository(struct files_ref_store *refs,
120 const char *caller)
121{
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700122 if (refs->store_flags & REF_STORE_MAIN)
123 return;
124
Johannes Schindelin033abf92018-05-02 11:38:39 +0200125 BUG("operation %s only allowed for main ref store", caller);
Michael Haggerty32c597e2017-02-10 12:16:16 +0100126}
127
128/*
Michael Haggerty00eebe32016-09-04 18:08:11 +0200129 * 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 +0700130 * files_ref_store. required_flags is compared with ref_store's
131 * store_flags to ensure the ref_store has all required capabilities.
132 * "caller" is used in any necessary error messages.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100133 */
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700134static struct files_ref_store *files_downcast(struct ref_store *ref_store,
135 unsigned int required_flags,
136 const char *caller)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100137{
Michael Haggerty32c597e2017-02-10 12:16:16 +0100138 struct files_ref_store *refs;
139
Michael Haggerty00eebe32016-09-04 18:08:11 +0200140 if (ref_store->be != &refs_be_files)
Johannes Schindelin033abf92018-05-02 11:38:39 +0200141 BUG("ref_store is type \"%s\" not \"files\" in %s",
Michael Haggerty00eebe32016-09-04 18:08:11 +0200142 ref_store->be->name, caller);
Michael Haggerty2eed2782016-06-18 06:15:12 +0200143
Michael Haggerty32c597e2017-02-10 12:16:16 +0100144 refs = (struct files_ref_store *)ref_store;
Michael Haggerty2eed2782016-06-18 06:15:12 +0200145
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700146 if ((refs->store_flags & required_flags) != required_flags)
Johannes Schindelin033abf92018-05-02 11:38:39 +0200147 BUG("operation %s requires abilities 0x%x, but only have 0x%x",
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700148 caller, required_flags, refs->store_flags);
Michael Haggerty32c597e2017-02-10 12:16:16 +0100149
150 return refs;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100151}
152
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200153static void files_reflog_path_other_worktrees(struct files_ref_store *refs,
154 struct strbuf *sb,
155 const char *refname)
156{
157 const char *real_ref;
158 const char *worktree_name;
159 int length;
160
161 if (parse_worktree_ref(refname, &worktree_name, &length, &real_ref))
162 BUG("refname %s is not a other-worktree ref", refname);
163
164 if (worktree_name)
165 strbuf_addf(sb, "%s/worktrees/%.*s/logs/%s", refs->gitcommondir,
166 length, worktree_name, real_ref);
167 else
168 strbuf_addf(sb, "%s/logs/%s", refs->gitcommondir,
169 real_ref);
170}
171
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +0700172static void files_reflog_path(struct files_ref_store *refs,
173 struct strbuf *sb,
174 const char *refname)
175{
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700176 switch (ref_type(refname)) {
177 case REF_TYPE_PER_WORKTREE:
178 case REF_TYPE_PSEUDOREF:
179 strbuf_addf(sb, "%s/logs/%s", refs->gitdir, refname);
180 break;
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200181 case REF_TYPE_OTHER_PSEUDOREF:
182 case REF_TYPE_MAIN_PSEUDOREF:
Nguyễn Thái Ngọc Duy46c0eb52018-11-25 05:58:16 +0100183 files_reflog_path_other_worktrees(refs, sb, refname);
184 break;
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700185 case REF_TYPE_NORMAL:
186 strbuf_addf(sb, "%s/logs/%s", refs->gitcommondir, refname);
187 break;
188 default:
Johannes Schindelin033abf92018-05-02 11:38:39 +0200189 BUG("unknown ref type %d of ref %s",
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700190 ref_type(refname), refname);
191 }
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +0700192}
193
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700194static void files_ref_path(struct files_ref_store *refs,
195 struct strbuf *sb,
196 const char *refname)
197{
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700198 switch (ref_type(refname)) {
199 case REF_TYPE_PER_WORKTREE:
200 case REF_TYPE_PSEUDOREF:
201 strbuf_addf(sb, "%s/%s", refs->gitdir, refname);
202 break;
Nguyễn Thái Ngọc Duy3a3b9d82018-10-21 10:08:54 +0200203 case REF_TYPE_MAIN_PSEUDOREF:
204 if (!skip_prefix(refname, "main-worktree/", &refname))
205 BUG("ref %s is not a main pseudoref", refname);
206 /* fallthrough */
207 case REF_TYPE_OTHER_PSEUDOREF:
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700208 case REF_TYPE_NORMAL:
209 strbuf_addf(sb, "%s/%s", refs->gitcommondir, refname);
210 break;
211 default:
Johannes Schindelin033abf92018-05-02 11:38:39 +0200212 BUG("unknown ref type %d of ref %s",
Nguyễn Thái Ngọc Duyf57f37e2017-03-26 09:42:24 +0700213 ref_type(refname), refname);
214 }
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700215}
216
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100217/*
Nguyễn Thái Ngọc Duyb9317d52019-03-07 19:29:17 +0700218 * Manually add refs/bisect, refs/rewritten and refs/worktree, which, being
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700219 * per-worktree, might not appear in the directory listing for
220 * refs/ in the main repo.
221 */
222static void add_per_worktree_entries_to_dir(struct ref_dir *dir, const char *dirname)
223{
Nguyễn Thái Ngọc Duyb9317d52019-03-07 19:29:17 +0700224 const char *prefixes[] = { "refs/bisect/", "refs/worktree/", "refs/rewritten/" };
Nguyễn Thái Ngọc Duy90d31ff2019-03-07 19:29:16 +0700225 int ip;
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700226
227 if (strcmp(dirname, "refs/"))
228 return;
229
Nguyễn Thái Ngọc Duy90d31ff2019-03-07 19:29:16 +0700230 for (ip = 0; ip < ARRAY_SIZE(prefixes); ip++) {
231 const char *prefix = prefixes[ip];
232 int prefix_len = strlen(prefix);
233 struct ref_entry *child_entry;
234 int pos;
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700235
Nguyễn Thái Ngọc Duy90d31ff2019-03-07 19:29:16 +0700236 pos = search_ref_dir(dir, prefix, prefix_len);
237 if (pos >= 0)
238 continue;
239 child_entry = create_dir_entry(dir->cache, prefix, prefix_len, 1);
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700240 add_entry_to_dir(dir, child_entry);
241 }
242}
243
244/*
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100245 * Read the loose references from the namespace dirname into dir
246 * (without recursing). dirname must end with '/'. dir must be the
247 * directory entry corresponding to dirname.
248 */
Michael Haggertydf308752017-04-16 08:41:34 +0200249static void loose_fill_ref_dir(struct ref_store *ref_store,
250 struct ref_dir *dir, const char *dirname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100251{
Michael Haggertydf308752017-04-16 08:41:34 +0200252 struct files_ref_store *refs =
253 files_downcast(ref_store, REF_STORE_READ, "fill_ref_dir");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100254 DIR *d;
255 struct dirent *de;
256 int dirnamelen = strlen(dirname);
257 struct strbuf refname;
258 struct strbuf path = STRBUF_INIT;
259 size_t path_baselen;
260
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700261 files_ref_path(refs, &path, dirname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100262 path_baselen = path.len;
263
264 d = opendir(path.buf);
265 if (!d) {
266 strbuf_release(&path);
267 return;
268 }
269
270 strbuf_init(&refname, dirnamelen + 257);
271 strbuf_add(&refname, dirname, dirnamelen);
272
273 while ((de = readdir(d)) != NULL) {
brian m. carlson4417df82017-05-06 22:10:24 +0000274 struct object_id oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100275 struct stat st;
276 int flag;
277
278 if (de->d_name[0] == '.')
279 continue;
280 if (ends_with(de->d_name, ".lock"))
281 continue;
282 strbuf_addstr(&refname, de->d_name);
283 strbuf_addstr(&path, de->d_name);
284 if (stat(path.buf, &st) < 0) {
285 ; /* silently ignore */
286 } else if (S_ISDIR(st.st_mode)) {
287 strbuf_addch(&refname, '/');
288 add_entry_to_dir(dir,
Michael Haggertye00d1a42017-04-16 08:41:33 +0200289 create_dir_entry(dir->cache, refname.buf,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100290 refname.len, 1));
291 } else {
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700292 if (!refs_resolve_ref_unsafe(&refs->base,
Michael Haggerty3c0cb0c2017-02-09 21:53:52 +0100293 refname.buf,
294 RESOLVE_REF_READING,
brian m. carlson49e61472017-10-15 22:07:09 +0000295 &oid, &flag)) {
brian m. carlson4417df82017-05-06 22:10:24 +0000296 oidclr(&oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100297 flag |= REF_ISBROKEN;
brian m. carlson4417df82017-05-06 22:10:24 +0000298 } else if (is_null_oid(&oid)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100299 /*
300 * It is so astronomically unlikely
Michael Haggerty78fb4572017-11-05 09:42:09 +0100301 * that null_oid is the OID of an
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100302 * actual object that we consider its
303 * appearance in a loose reference
304 * file to be repo corruption
305 * (probably due to a software bug).
306 */
307 flag |= REF_ISBROKEN;
308 }
309
310 if (check_refname_format(refname.buf,
311 REFNAME_ALLOW_ONELEVEL)) {
312 if (!refname_is_safe(refname.buf))
313 die("loose refname is dangerous: %s", refname.buf);
brian m. carlson4417df82017-05-06 22:10:24 +0000314 oidclr(&oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100315 flag |= REF_BAD_NAME | REF_ISBROKEN;
316 }
317 add_entry_to_dir(dir,
Michael Haggertyc1da06c2017-05-22 16:17:53 +0200318 create_ref_entry(refname.buf, &oid, flag));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100319 }
320 strbuf_setlen(&refname, dirnamelen);
321 strbuf_setlen(&path, path_baselen);
322 }
323 strbuf_release(&refname);
324 strbuf_release(&path);
325 closedir(d);
Michael Haggertye3bf2982017-04-16 08:41:35 +0200326
Nguyễn Thái Ngọc Duy09e65642019-03-07 19:29:15 +0700327 add_per_worktree_entries_to_dir(dir, dirname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100328}
329
Michael Haggertya714b192017-04-16 08:41:38 +0200330static struct ref_cache *get_loose_ref_cache(struct files_ref_store *refs)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100331{
332 if (!refs->loose) {
333 /*
334 * Mark the top-level directory complete because we
335 * are about to read the only subdirectory that can
336 * hold references:
337 */
Michael Haggertydf308752017-04-16 08:41:34 +0200338 refs->loose = create_ref_cache(&refs->base, loose_fill_ref_dir);
Michael Haggerty7c22bc82017-04-16 08:41:32 +0200339
340 /* We're going to fill the top level ourselves: */
341 refs->loose->root->flag &= ~REF_INCOMPLETE;
342
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100343 /*
Michael Haggerty7c22bc82017-04-16 08:41:32 +0200344 * Add an incomplete entry for "refs/" (to be filled
345 * lazily):
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100346 */
Michael Haggerty7c22bc82017-04-16 08:41:32 +0200347 add_entry_to_dir(get_ref_dir(refs->loose->root),
Michael Haggertye00d1a42017-04-16 08:41:33 +0200348 create_dir_entry(refs->loose, "refs/", 5, 1));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100349 }
Michael Haggertya714b192017-04-16 08:41:38 +0200350 return refs->loose;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100351}
352
Michael Haggertye1e33b72016-09-04 18:08:25 +0200353static int files_read_raw_ref(struct ref_store *ref_store,
brian m. carlson99afe912017-10-15 22:07:11 +0000354 const char *refname, struct object_id *oid,
Michael Haggertye1e33b72016-09-04 18:08:25 +0200355 struct strbuf *referent, unsigned int *type)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100356{
Michael Haggerty43086512016-09-04 18:08:14 +0200357 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700358 files_downcast(ref_store, REF_STORE_READ, "read_raw_ref");
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400359 struct strbuf sb_contents = STRBUF_INIT;
360 struct strbuf sb_path = STRBUF_INIT;
David Turner70486532016-04-07 15:03:01 -0400361 const char *path;
362 const char *buf;
brian m. carlson99afe912017-10-15 22:07:11 +0000363 const char *p;
David Turner70486532016-04-07 15:03:01 -0400364 struct stat st;
365 int fd;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400366 int ret = -1;
367 int save_errno;
Jeff Kinge8c42cb2016-10-06 12:48:42 -0400368 int remaining_retries = 3;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100369
Michael Haggertyfa96ea12016-04-22 01:11:17 +0200370 *type = 0;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400371 strbuf_reset(&sb_path);
Michael Haggerty34c7ad82016-09-04 18:08:20 +0200372
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700373 files_ref_path(refs, &sb_path, refname);
Michael Haggerty34c7ad82016-09-04 18:08:20 +0200374
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400375 path = sb_path.buf;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100376
David Turner70486532016-04-07 15:03:01 -0400377stat_ref:
378 /*
379 * We might have to loop back here to avoid a race
380 * condition: first we lstat() the file, then we try
381 * to read it as a link or as a file. But if somebody
382 * changes the type of the file (file <-> directory
383 * <-> symlink) between the lstat() and reading, then
384 * we don't want to report that as an error but rather
385 * try again starting with the lstat().
Jeff Kinge8c42cb2016-10-06 12:48:42 -0400386 *
387 * We'll keep a count of the retries, though, just to avoid
388 * any confusing situation sending us into an infinite loop.
David Turner70486532016-04-07 15:03:01 -0400389 */
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100390
Jeff Kinge8c42cb2016-10-06 12:48:42 -0400391 if (remaining_retries-- <= 0)
392 goto out;
393
David Turner70486532016-04-07 15:03:01 -0400394 if (lstat(path, &st) < 0) {
395 if (errno != ENOENT)
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400396 goto out;
Michael Haggertye0cc8ac2017-06-23 09:01:38 +0200397 if (refs_read_raw_ref(refs->packed_ref_store, refname,
brian m. carlson99afe912017-10-15 22:07:11 +0000398 oid, referent, type)) {
David Turner70486532016-04-07 15:03:01 -0400399 errno = ENOENT;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400400 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100401 }
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400402 ret = 0;
403 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100404 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100405
David Turner70486532016-04-07 15:03:01 -0400406 /* Follow "normalized" - ie "refs/.." symlinks by hand */
407 if (S_ISLNK(st.st_mode)) {
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400408 strbuf_reset(&sb_contents);
Jeff King765b4962018-07-24 06:51:39 -0400409 if (strbuf_readlink(&sb_contents, path, st.st_size) < 0) {
David Turner70486532016-04-07 15:03:01 -0400410 if (errno == ENOENT || errno == EINVAL)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100411 /* inconsistent with lstat; retry */
412 goto stat_ref;
413 else
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400414 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100415 }
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400416 if (starts_with(sb_contents.buf, "refs/") &&
417 !check_refname_format(sb_contents.buf, 0)) {
Michael Haggerty92b38092016-04-22 01:11:17 +0200418 strbuf_swap(&sb_contents, referent);
Michael Haggerty3a0b6b92016-04-26 03:06:23 +0200419 *type |= REF_ISSYMREF;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400420 ret = 0;
421 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100422 }
Jeff King3f7bd762016-10-06 15:41:08 -0400423 /*
424 * It doesn't look like a refname; fall through to just
425 * treating it like a non-symlink, and reading whatever it
426 * points to.
427 */
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100428 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100429
David Turner70486532016-04-07 15:03:01 -0400430 /* Is it a directory? */
431 if (S_ISDIR(st.st_mode)) {
Michael Haggertye167a562016-05-05 14:09:41 +0200432 /*
433 * Even though there is a directory where the loose
434 * ref is supposed to be, there could still be a
435 * packed ref:
436 */
Michael Haggertye0cc8ac2017-06-23 09:01:38 +0200437 if (refs_read_raw_ref(refs->packed_ref_store, refname,
brian m. carlson99afe912017-10-15 22:07:11 +0000438 oid, referent, type)) {
Michael Haggertye167a562016-05-05 14:09:41 +0200439 errno = EISDIR;
440 goto out;
441 }
442 ret = 0;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400443 goto out;
David Turner70486532016-04-07 15:03:01 -0400444 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100445
David Turner70486532016-04-07 15:03:01 -0400446 /*
447 * Anything else, just open it and try to use it as
448 * a ref
449 */
450 fd = open(path, O_RDONLY);
451 if (fd < 0) {
Jeff King3f7bd762016-10-06 15:41:08 -0400452 if (errno == ENOENT && !S_ISLNK(st.st_mode))
David Turner70486532016-04-07 15:03:01 -0400453 /* inconsistent with lstat; retry */
454 goto stat_ref;
455 else
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400456 goto out;
David Turner70486532016-04-07 15:03:01 -0400457 }
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400458 strbuf_reset(&sb_contents);
459 if (strbuf_read(&sb_contents, fd, 256) < 0) {
David Turner70486532016-04-07 15:03:01 -0400460 int save_errno = errno;
461 close(fd);
462 errno = save_errno;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400463 goto out;
David Turner70486532016-04-07 15:03:01 -0400464 }
465 close(fd);
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400466 strbuf_rtrim(&sb_contents);
467 buf = sb_contents.buf;
Junio C Hamano145136a2020-01-30 11:35:46 -0800468 if (skip_prefix(buf, "ref:", &buf)) {
David Turner70486532016-04-07 15:03:01 -0400469 while (isspace(*buf))
470 buf++;
471
Michael Haggerty92b38092016-04-22 01:11:17 +0200472 strbuf_reset(referent);
473 strbuf_addstr(referent, buf);
Michael Haggerty3a0b6b92016-04-26 03:06:23 +0200474 *type |= REF_ISSYMREF;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400475 ret = 0;
476 goto out;
David Turner70486532016-04-07 15:03:01 -0400477 }
478
479 /*
480 * Please note that FETCH_HEAD has additional
481 * data after the sha.
482 */
brian m. carlson99afe912017-10-15 22:07:11 +0000483 if (parse_oid_hex(buf, oid, &p) ||
484 (*p != '\0' && !isspace(*p))) {
Michael Haggerty3a0b6b92016-04-26 03:06:23 +0200485 *type |= REF_ISBROKEN;
David Turner70486532016-04-07 15:03:01 -0400486 errno = EINVAL;
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400487 goto out;
David Turner70486532016-04-07 15:03:01 -0400488 }
489
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400490 ret = 0;
491
492out:
493 save_errno = errno;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100494 strbuf_release(&sb_path);
495 strbuf_release(&sb_contents);
Michael Haggerty42a38cf2016-04-07 15:03:02 -0400496 errno = save_errno;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100497 return ret;
498}
499
Michael Haggerty8415d242016-04-24 08:11:37 +0200500static void unlock_ref(struct ref_lock *lock)
501{
Jeff Kingee4d8e42017-09-05 08:15:15 -0400502 rollback_lock_file(&lock->lk);
Michael Haggerty8415d242016-04-24 08:11:37 +0200503 free(lock->ref_name);
Michael Haggerty8415d242016-04-24 08:11:37 +0200504 free(lock);
505}
506
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100507/*
Michael Haggerty92b15512016-04-25 15:56:07 +0200508 * Lock refname, without following symrefs, and set *lock_p to point
509 * at a newly-allocated lock object. Fill in lock->old_oid, referent,
510 * and type similarly to read_raw_ref().
511 *
512 * The caller must verify that refname is a "safe" reference name (in
513 * the sense of refname_is_safe()) before calling this function.
514 *
515 * If the reference doesn't already exist, verify that refname doesn't
516 * have a D/F conflict with any existing references. extras and skip
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200517 * are passed to refs_verify_refname_available() for this check.
Michael Haggerty92b15512016-04-25 15:56:07 +0200518 *
519 * If mustexist is not set and the reference is not found or is
Michael Haggerty78fb4572017-11-05 09:42:09 +0100520 * broken, lock the reference anyway but clear old_oid.
Michael Haggerty92b15512016-04-25 15:56:07 +0200521 *
522 * Return 0 on success. On failure, write an error message to err and
523 * return TRANSACTION_NAME_CONFLICT or TRANSACTION_GENERIC_ERROR.
524 *
525 * Implementation note: This function is basically
526 *
527 * lock reference
528 * read_raw_ref()
529 *
530 * but it includes a lot more code to
531 * - Deal with possible races with other processes
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200532 * - Avoid calling refs_verify_refname_available() when it can be
Michael Haggerty92b15512016-04-25 15:56:07 +0200533 * avoided, namely if we were successfully able to read the ref
534 * - Generate informative error messages in the case of failure
535 */
Michael Haggertyf7b0a982016-09-04 18:08:31 +0200536static int lock_raw_ref(struct files_ref_store *refs,
537 const char *refname, int mustexist,
Michael Haggerty92b15512016-04-25 15:56:07 +0200538 const struct string_list *extras,
539 const struct string_list *skip,
540 struct ref_lock **lock_p,
541 struct strbuf *referent,
542 unsigned int *type,
543 struct strbuf *err)
544{
545 struct ref_lock *lock;
546 struct strbuf ref_file = STRBUF_INIT;
547 int attempts_remaining = 3;
548 int ret = TRANSACTION_GENERIC_ERROR;
549
550 assert(err);
Michael Haggerty32c597e2017-02-10 12:16:16 +0100551 files_assert_main_repository(refs, "lock_raw_ref");
Michael Haggertyf7b0a982016-09-04 18:08:31 +0200552
Michael Haggerty92b15512016-04-25 15:56:07 +0200553 *type = 0;
554
555 /* First lock the file so it can't change out from under us. */
556
557 *lock_p = lock = xcalloc(1, sizeof(*lock));
558
559 lock->ref_name = xstrdup(refname);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700560 files_ref_path(refs, &ref_file, refname);
Michael Haggerty92b15512016-04-25 15:56:07 +0200561
562retry:
563 switch (safe_create_leading_directories(ref_file.buf)) {
564 case SCLD_OK:
565 break; /* success */
566 case SCLD_EXISTS:
567 /*
568 * Suppose refname is "refs/foo/bar". We just failed
569 * to create the containing directory, "refs/foo",
570 * because there was a non-directory in the way. This
571 * indicates a D/F conflict, probably because of
572 * another reference such as "refs/foo". There is no
573 * reason to expect this error to be transitory.
574 */
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +0700575 if (refs_verify_refname_available(&refs->base, refname,
576 extras, skip, err)) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200577 if (mustexist) {
578 /*
579 * To the user the relevant error is
580 * that the "mustexist" reference is
581 * missing:
582 */
583 strbuf_reset(err);
584 strbuf_addf(err, "unable to resolve reference '%s'",
585 refname);
586 } else {
587 /*
588 * The error message set by
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200589 * refs_verify_refname_available() is
590 * OK.
Michael Haggerty92b15512016-04-25 15:56:07 +0200591 */
592 ret = TRANSACTION_NAME_CONFLICT;
593 }
594 } else {
595 /*
596 * The file that is in the way isn't a loose
597 * reference. Report it as a low-level
598 * failure.
599 */
600 strbuf_addf(err, "unable to create lock file %s.lock; "
601 "non-directory in the way",
602 ref_file.buf);
603 }
604 goto error_return;
605 case SCLD_VANISHED:
606 /* Maybe another process was tidying up. Try again. */
607 if (--attempts_remaining > 0)
608 goto retry;
609 /* fall through */
610 default:
611 strbuf_addf(err, "unable to create directory for %s",
612 ref_file.buf);
613 goto error_return;
614 }
615
Michael Haggerty4ff0f012017-08-21 13:51:34 +0200616 if (hold_lock_file_for_update_timeout(
Jeff Kingee4d8e42017-09-05 08:15:15 -0400617 &lock->lk, ref_file.buf, LOCK_NO_DEREF,
Michael Haggerty4ff0f012017-08-21 13:51:34 +0200618 get_files_ref_lock_timeout_ms()) < 0) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200619 if (errno == ENOENT && --attempts_remaining > 0) {
620 /*
621 * Maybe somebody just deleted one of the
622 * directories leading to ref_file. Try
623 * again:
624 */
625 goto retry;
626 } else {
627 unable_to_lock_message(ref_file.buf, errno, err);
628 goto error_return;
629 }
630 }
631
632 /*
633 * Now we hold the lock and can read the reference without
634 * fear that its value will change.
635 */
636
Michael Haggertyf7b0a982016-09-04 18:08:31 +0200637 if (files_read_raw_ref(&refs->base, refname,
brian m. carlson99afe912017-10-15 22:07:11 +0000638 &lock->old_oid, referent, type)) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200639 if (errno == ENOENT) {
640 if (mustexist) {
641 /* Garden variety missing reference. */
642 strbuf_addf(err, "unable to resolve reference '%s'",
643 refname);
644 goto error_return;
645 } else {
646 /*
647 * Reference is missing, but that's OK. We
648 * know that there is not a conflict with
649 * another loose reference because
650 * (supposing that we are trying to lock
651 * reference "refs/foo/bar"):
652 *
653 * - We were successfully able to create
654 * the lockfile refs/foo/bar.lock, so we
655 * know there cannot be a loose reference
656 * named "refs/foo".
657 *
658 * - We got ENOENT and not EISDIR, so we
659 * know that there cannot be a loose
660 * reference named "refs/foo/bar/baz".
661 */
662 }
663 } else if (errno == EISDIR) {
664 /*
665 * There is a directory in the way. It might have
666 * contained references that have been deleted. If
667 * we don't require that the reference already
668 * exists, try to remove the directory so that it
669 * doesn't cause trouble when we want to rename the
670 * lockfile into place later.
671 */
672 if (mustexist) {
673 /* Garden variety missing reference. */
674 strbuf_addf(err, "unable to resolve reference '%s'",
675 refname);
676 goto error_return;
677 } else if (remove_dir_recursively(&ref_file,
678 REMOVE_DIR_EMPTY_ONLY)) {
Michael Haggertyb05855b2017-04-16 08:41:26 +0200679 if (refs_verify_refname_available(
680 &refs->base, refname,
681 extras, skip, err)) {
Michael Haggerty92b15512016-04-25 15:56:07 +0200682 /*
683 * The error message set by
684 * verify_refname_available() is OK.
685 */
686 ret = TRANSACTION_NAME_CONFLICT;
687 goto error_return;
688 } else {
689 /*
690 * We can't delete the directory,
691 * but we also don't know of any
692 * references that it should
693 * contain.
694 */
695 strbuf_addf(err, "there is a non-empty directory '%s' "
696 "blocking reference '%s'",
697 ref_file.buf, refname);
698 goto error_return;
699 }
700 }
701 } else if (errno == EINVAL && (*type & REF_ISBROKEN)) {
702 strbuf_addf(err, "unable to resolve reference '%s': "
703 "reference broken", refname);
704 goto error_return;
705 } else {
706 strbuf_addf(err, "unable to resolve reference '%s': %s",
707 refname, strerror(errno));
708 goto error_return;
709 }
710
711 /*
712 * If the ref did not exist and we are creating it,
Michael Haggerty8ec617c2017-08-17 17:12:50 +0200713 * make sure there is no existing packed ref that
714 * conflicts with refname:
Michael Haggerty92b15512016-04-25 15:56:07 +0200715 */
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200716 if (refs_verify_refname_available(
Michael Haggerty8ec617c2017-08-17 17:12:50 +0200717 refs->packed_ref_store, refname,
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200718 extras, skip, err))
Michael Haggerty92b15512016-04-25 15:56:07 +0200719 goto error_return;
Michael Haggerty92b15512016-04-25 15:56:07 +0200720 }
721
722 ret = 0;
723 goto out;
724
725error_return:
726 unlock_ref(lock);
727 *lock_p = NULL;
728
729out:
730 strbuf_release(&ref_file);
731 return ret;
732}
733
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200734struct files_ref_iterator {
735 struct ref_iterator base;
736
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200737 struct ref_iterator *iter0;
738 unsigned int flags;
739};
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100740
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200741static int files_ref_iterator_advance(struct ref_iterator *ref_iterator)
742{
743 struct files_ref_iterator *iter =
744 (struct files_ref_iterator *)ref_iterator;
745 int ok;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100746
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200747 while ((ok = ref_iterator_advance(iter->iter0)) == ITER_OK) {
David Turner0c09ec02016-09-04 18:08:44 +0200748 if (iter->flags & DO_FOR_EACH_PER_WORKTREE_ONLY &&
749 ref_type(iter->iter0->refname) != REF_TYPE_PER_WORKTREE)
750 continue;
751
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200752 if (!(iter->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
753 !ref_resolves_to_object(iter->iter0->refname,
754 iter->iter0->oid,
755 iter->iter0->flags))
756 continue;
757
758 iter->base.refname = iter->iter0->refname;
759 iter->base.oid = iter->iter0->oid;
760 iter->base.flags = iter->iter0->flags;
761 return ITER_OK;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100762 }
763
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200764 iter->iter0 = NULL;
765 if (ref_iterator_abort(ref_iterator) != ITER_DONE)
766 ok = ITER_ERROR;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100767
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200768 return ok;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100769}
770
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200771static int files_ref_iterator_peel(struct ref_iterator *ref_iterator,
772 struct object_id *peeled)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100773{
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200774 struct files_ref_iterator *iter =
775 (struct files_ref_iterator *)ref_iterator;
David Turner93770592016-04-07 15:02:49 -0400776
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200777 return ref_iterator_peel(iter->iter0, peeled);
778}
779
780static int files_ref_iterator_abort(struct ref_iterator *ref_iterator)
781{
782 struct files_ref_iterator *iter =
783 (struct files_ref_iterator *)ref_iterator;
784 int ok = ITER_DONE;
785
786 if (iter->iter0)
787 ok = ref_iterator_abort(iter->iter0);
788
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200789 base_ref_iterator_free(ref_iterator);
790 return ok;
791}
792
793static struct ref_iterator_vtable files_ref_iterator_vtable = {
794 files_ref_iterator_advance,
795 files_ref_iterator_peel,
796 files_ref_iterator_abort
797};
798
Michael Haggerty1a769002016-09-04 18:08:37 +0200799static struct ref_iterator *files_ref_iterator_begin(
Michael Haggerty37b6f6d2016-09-04 18:08:36 +0200800 struct ref_store *ref_store,
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200801 const char *prefix, unsigned int flags)
802{
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700803 struct files_ref_store *refs;
Michael Haggerty8738a8a2017-09-13 19:15:55 +0200804 struct ref_iterator *loose_iter, *packed_iter, *overlay_iter;
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200805 struct files_ref_iterator *iter;
806 struct ref_iterator *ref_iterator;
Michael Haggerty0a0865b2017-05-22 16:17:52 +0200807 unsigned int required_flags = REF_STORE_READ;
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200808
Michael Haggerty0a0865b2017-05-22 16:17:52 +0200809 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN))
810 required_flags |= REF_STORE_ODB;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100811
Michael Haggerty0a0865b2017-05-22 16:17:52 +0200812 refs = files_downcast(ref_store, required_flags, "ref_iterator_begin");
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +0700813
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200814 /*
815 * We must make sure that all loose refs are read before
816 * accessing the packed-refs file; this avoids a race
817 * condition if loose refs are migrated to the packed-refs
818 * file by a simultaneous process, but our in-memory view is
819 * from before the migration. We ensure this as follows:
Michael Haggerty059ae352017-04-16 08:41:39 +0200820 * First, we call start the loose refs iteration with its
821 * `prime_ref` argument set to true. This causes the loose
822 * references in the subtree to be pre-read into the cache.
823 * (If they've already been read, that's OK; we only need to
824 * guarantee that they're read before the packed refs, not
825 * *how much* before.) After that, we call
Michael Haggerty38b86e82017-06-23 09:01:35 +0200826 * packed_ref_iterator_begin(), which internally checks
827 * whether the packed-ref cache is up to date with what is on
828 * disk, and re-reads it if not.
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200829 */
830
Michael Haggerty059ae352017-04-16 08:41:39 +0200831 loose_iter = cache_ref_iterator_begin(get_loose_ref_cache(refs),
832 prefix, 1);
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200833
Michael Haggerty38b86e82017-06-23 09:01:35 +0200834 /*
835 * The packed-refs file might contain broken references, for
836 * example an old version of a reference that points at an
837 * object that has since been garbage-collected. This is OK as
838 * long as there is a corresponding loose reference that
839 * overrides it, and we don't want to emit an error message in
840 * this case. So ask the packed_ref_store for all of its
841 * references, and (if needed) do our own check for broken
842 * ones in files_ref_iterator_advance(), after we have merged
843 * the packed and loose references.
844 */
Michael Haggertye0cc8ac2017-06-23 09:01:38 +0200845 packed_iter = refs_ref_iterator_begin(
846 refs->packed_ref_store, prefix, 0,
Michael Haggerty38b86e82017-06-23 09:01:35 +0200847 DO_FOR_EACH_INCLUDE_BROKEN);
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200848
Michael Haggerty8738a8a2017-09-13 19:15:55 +0200849 overlay_iter = overlay_ref_iterator_begin(loose_iter, packed_iter);
850
851 iter = xcalloc(1, sizeof(*iter));
852 ref_iterator = &iter->base;
853 base_ref_iterator_init(ref_iterator, &files_ref_iterator_vtable,
854 overlay_iter->ordered);
855 iter->iter0 = overlay_iter;
Michael Haggerty3bc581b2016-06-18 06:15:15 +0200856 iter->flags = flags;
857
858 return ref_iterator;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100859}
860
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100861/*
brian m. carlson4f01e502017-10-15 22:07:12 +0000862 * Verify that the reference locked by lock has the value old_oid
863 * (unless it is NULL). Fail if the reference doesn't exist and
864 * mustexist is set. Return 0 on success. On error, write an error
865 * message to err, set errno, and return a negative value.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100866 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700867static int verify_lock(struct ref_store *ref_store, struct ref_lock *lock,
brian m. carlson4f01e502017-10-15 22:07:12 +0000868 const struct object_id *old_oid, int mustexist,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100869 struct strbuf *err)
870{
871 assert(err);
872
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700873 if (refs_read_ref_full(ref_store, lock->ref_name,
874 mustexist ? RESOLVE_REF_READING : 0,
brian m. carlson34c290a2017-10-15 22:06:56 +0000875 &lock->old_oid, NULL)) {
brian m. carlson4f01e502017-10-15 22:07:12 +0000876 if (old_oid) {
Jeff King6294dcb2016-01-12 16:44:39 -0500877 int save_errno = errno;
Michael Haggerty0568c8e2016-04-27 15:21:36 +0200878 strbuf_addf(err, "can't verify ref '%s'", lock->ref_name);
Jeff King6294dcb2016-01-12 16:44:39 -0500879 errno = save_errno;
880 return -1;
881 } else {
brian m. carlsonc368dde2016-06-24 23:09:22 +0000882 oidclr(&lock->old_oid);
Jeff King6294dcb2016-01-12 16:44:39 -0500883 return 0;
884 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100885 }
Jeff King9001dc22018-08-28 17:22:48 -0400886 if (old_oid && !oideq(&lock->old_oid, old_oid)) {
Michael Haggerty0568c8e2016-04-27 15:21:36 +0200887 strbuf_addf(err, "ref '%s' is at %s but expected %s",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100888 lock->ref_name,
brian m. carlsonc368dde2016-06-24 23:09:22 +0000889 oid_to_hex(&lock->old_oid),
brian m. carlson4f01e502017-10-15 22:07:12 +0000890 oid_to_hex(old_oid));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100891 errno = EBUSY;
892 return -1;
893 }
894 return 0;
895}
896
897static int remove_empty_directories(struct strbuf *path)
898{
899 /*
900 * we want to create a file but there is a directory there;
901 * if that is an empty directory (or a directory that contains
902 * only empty directories), remove them.
903 */
904 return remove_dir_recursively(path, REMOVE_DIR_EMPTY_ONLY);
905}
906
Michael Haggerty3b5d3c92017-01-06 17:22:28 +0100907static int create_reflock(const char *path, void *cb)
908{
909 struct lock_file *lk = cb;
910
Michael Haggerty4ff0f012017-08-21 13:51:34 +0200911 return hold_lock_file_for_update_timeout(
912 lk, path, LOCK_NO_DEREF,
913 get_files_ref_lock_timeout_ms()) < 0 ? -1 : 0;
Michael Haggerty3b5d3c92017-01-06 17:22:28 +0100914}
915
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100916/*
917 * Locks a ref returning the lock on success and NULL on failure.
918 * On failure errno is set to something meaningful.
919 */
brian m. carlson4f01e502017-10-15 22:07:12 +0000920static struct ref_lock *lock_ref_oid_basic(struct files_ref_store *refs,
921 const char *refname,
922 const struct object_id *old_oid,
923 const struct string_list *extras,
924 const struct string_list *skip,
925 unsigned int flags, int *type,
926 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100927{
928 struct strbuf ref_file = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100929 struct ref_lock *lock;
930 int last_errno = 0;
brian m. carlson4f01e502017-10-15 22:07:12 +0000931 int mustexist = (old_oid && !is_null_oid(old_oid));
Michael Haggerty7a418f32016-04-22 15:25:25 +0200932 int resolve_flags = RESOLVE_REF_NO_RECURSE;
Michael Haggerty7a418f32016-04-22 15:25:25 +0200933 int resolved;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100934
brian m. carlson4f01e502017-10-15 22:07:12 +0000935 files_assert_main_repository(refs, "lock_ref_oid_basic");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100936 assert(err);
937
938 lock = xcalloc(1, sizeof(struct ref_lock));
939
940 if (mustexist)
941 resolve_flags |= RESOLVE_REF_READING;
Jeff King2859dcd2016-01-12 16:45:09 -0500942 if (flags & REF_DELETING)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100943 resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100944
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +0700945 files_ref_path(refs, &ref_file, refname);
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700946 resolved = !!refs_resolve_ref_unsafe(&refs->base,
947 refname, resolve_flags,
brian m. carlson49e61472017-10-15 22:07:09 +0000948 &lock->old_oid, type);
Michael Haggerty7a418f32016-04-22 15:25:25 +0200949 if (!resolved && errno == EISDIR) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100950 /*
951 * we are trying to lock foo but we used to
952 * have foo/bar which now does not exist;
953 * it is normal for the empty directory 'foo'
954 * to remain.
955 */
Michael Haggerty7a418f32016-04-22 15:25:25 +0200956 if (remove_empty_directories(&ref_file)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100957 last_errno = errno;
Michael Haggertyb05855b2017-04-16 08:41:26 +0200958 if (!refs_verify_refname_available(
959 &refs->base,
960 refname, extras, skip, err))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100961 strbuf_addf(err, "there are still refs under '%s'",
Michael Haggerty7a418f32016-04-22 15:25:25 +0200962 refname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100963 goto error_return;
964 }
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +0700965 resolved = !!refs_resolve_ref_unsafe(&refs->base,
966 refname, resolve_flags,
brian m. carlson49e61472017-10-15 22:07:09 +0000967 &lock->old_oid, type);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100968 }
Michael Haggerty7a418f32016-04-22 15:25:25 +0200969 if (!resolved) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100970 last_errno = errno;
971 if (last_errno != ENOTDIR ||
Michael Haggertyb05855b2017-04-16 08:41:26 +0200972 !refs_verify_refname_available(&refs->base, refname,
973 extras, skip, err))
Michael Haggerty0568c8e2016-04-27 15:21:36 +0200974 strbuf_addf(err, "unable to resolve reference '%s': %s",
Michael Haggerty7a418f32016-04-22 15:25:25 +0200975 refname, strerror(last_errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100976
977 goto error_return;
978 }
Jeff King2859dcd2016-01-12 16:45:09 -0500979
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100980 /*
981 * If the ref did not exist and we are creating it, make sure
982 * there is no existing packed ref whose name begins with our
983 * refname, nor a packed ref whose name is a proper prefix of
984 * our refname.
985 */
986 if (is_null_oid(&lock->old_oid) &&
Michael Haggerty8ec617c2017-08-17 17:12:50 +0200987 refs_verify_refname_available(refs->packed_ref_store, refname,
Michael Haggerty524a9fd2017-04-16 08:41:27 +0200988 extras, skip, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100989 last_errno = ENOTDIR;
990 goto error_return;
991 }
992
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100993 lock->ref_name = xstrdup(refname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100994
Jeff Kingee4d8e42017-09-05 08:15:15 -0400995 if (raceproof_create_file(ref_file.buf, create_reflock, &lock->lk)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100996 last_errno = errno;
Michael Haggerty3b5d3c92017-01-06 17:22:28 +0100997 unable_to_lock_message(ref_file.buf, errno, err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +0100998 goto error_return;
999 }
1000
brian m. carlson4f01e502017-10-15 22:07:12 +00001001 if (verify_lock(&refs->base, lock, old_oid, mustexist, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001002 last_errno = errno;
1003 goto error_return;
1004 }
1005 goto out;
1006
1007 error_return:
1008 unlock_ref(lock);
1009 lock = NULL;
1010
1011 out:
1012 strbuf_release(&ref_file);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001013 errno = last_errno;
1014 return lock;
1015}
1016
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001017struct ref_to_prune {
1018 struct ref_to_prune *next;
brian m. carlson49e99582017-10-15 22:06:49 +00001019 struct object_id oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001020 char name[FLEX_ARRAY];
1021};
1022
Michael Haggertya8f0db22017-01-06 17:22:42 +01001023enum {
1024 REMOVE_EMPTY_PARENTS_REF = 0x01,
1025 REMOVE_EMPTY_PARENTS_REFLOG = 0x02
1026};
1027
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001028/*
Michael Haggertya8f0db22017-01-06 17:22:42 +01001029 * Remove empty parent directories associated with the specified
1030 * reference and/or its reflog, but spare [logs/]refs/ and immediate
1031 * subdirs. flags is a combination of REMOVE_EMPTY_PARENTS_REF and/or
1032 * REMOVE_EMPTY_PARENTS_REFLOG.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001033 */
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001034static void try_remove_empty_parents(struct files_ref_store *refs,
1035 const char *refname,
1036 unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001037{
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001038 struct strbuf buf = STRBUF_INIT;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001039 struct strbuf sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001040 char *p, *q;
1041 int i;
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001042
1043 strbuf_addstr(&buf, refname);
1044 p = buf.buf;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001045 for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
1046 while (*p && *p != '/')
1047 p++;
1048 /* tolerate duplicate slashes; see check_refname_format() */
1049 while (*p == '/')
1050 p++;
1051 }
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001052 q = buf.buf + buf.len;
Michael Haggertya8f0db22017-01-06 17:22:42 +01001053 while (flags & (REMOVE_EMPTY_PARENTS_REF | REMOVE_EMPTY_PARENTS_REFLOG)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001054 while (q > p && *q != '/')
1055 q--;
1056 while (q > p && *(q-1) == '/')
1057 q--;
1058 if (q == p)
1059 break;
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001060 strbuf_setlen(&buf, q - buf.buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001061
1062 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07001063 files_ref_path(refs, &sb, buf.buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001064 if ((flags & REMOVE_EMPTY_PARENTS_REF) && rmdir(sb.buf))
Michael Haggertya8f0db22017-01-06 17:22:42 +01001065 flags &= ~REMOVE_EMPTY_PARENTS_REF;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001066
1067 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001068 files_reflog_path(refs, &sb, buf.buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001069 if ((flags & REMOVE_EMPTY_PARENTS_REFLOG) && rmdir(sb.buf))
Michael Haggertya8f0db22017-01-06 17:22:42 +01001070 flags &= ~REMOVE_EMPTY_PARENTS_REFLOG;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001071 }
Michael Haggerty8bdaecb2017-01-06 17:22:41 +01001072 strbuf_release(&buf);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001073 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001074}
1075
1076/* make sure nobody touched the ref, and unlink */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001077static void prune_ref(struct files_ref_store *refs, struct ref_to_prune *r)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001078{
1079 struct ref_transaction *transaction;
1080 struct strbuf err = STRBUF_INIT;
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001081 int ret = -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001082
1083 if (check_refname_format(r->name, 0))
1084 return;
1085
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001086 transaction = ref_store_transaction_begin(&refs->base, &err);
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001087 if (!transaction)
1088 goto cleanup;
1089 ref_transaction_add_update(
1090 transaction, r->name,
Michael Haggertyacedcde2017-11-05 09:42:07 +01001091 REF_NO_DEREF | REF_HAVE_NEW | REF_HAVE_OLD | REF_IS_PRUNING,
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001092 &null_oid, &r->oid, NULL);
1093 if (ref_transaction_commit(transaction, &err))
1094 goto cleanup;
1095
1096 ret = 0;
1097
1098cleanup:
1099 if (ret)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001100 error("%s", err.buf);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001101 strbuf_release(&err);
Michael Haggertyb00f3cf2017-11-05 09:42:02 +01001102 ref_transaction_free(transaction);
1103 return;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001104}
1105
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001106/*
1107 * Prune the loose versions of the references in the linked list
1108 * `*refs_to_prune`, freeing the entries in the list as we go.
1109 */
1110static void prune_refs(struct files_ref_store *refs, struct ref_to_prune **refs_to_prune)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001111{
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001112 while (*refs_to_prune) {
1113 struct ref_to_prune *r = *refs_to_prune;
1114 *refs_to_prune = r->next;
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001115 prune_ref(refs, r);
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001116 free(r);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001117 }
1118}
1119
Michael Haggerty531cc4a2017-05-22 16:17:48 +02001120/*
1121 * Return true if the specified reference should be packed.
1122 */
1123static int should_pack_ref(const char *refname,
1124 const struct object_id *oid, unsigned int ref_flags,
1125 unsigned int pack_flags)
1126{
1127 /* Do not pack per-worktree refs: */
1128 if (ref_type(refname) != REF_TYPE_NORMAL)
1129 return 0;
1130
1131 /* Do not pack non-tags unless PACK_REFS_ALL is set: */
1132 if (!(pack_flags & PACK_REFS_ALL) && !starts_with(refname, "refs/tags/"))
1133 return 0;
1134
1135 /* Do not pack symbolic refs: */
1136 if (ref_flags & REF_ISSYMREF)
1137 return 0;
1138
1139 /* Do not pack broken refs: */
1140 if (!ref_resolves_to_object(refname, oid, ref_flags))
1141 return 0;
1142
1143 return 1;
1144}
1145
Michael Haggerty82315272016-09-04 18:08:27 +02001146static int files_pack_refs(struct ref_store *ref_store, unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001147{
Michael Haggerty00eebe32016-09-04 18:08:11 +02001148 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001149 files_downcast(ref_store, REF_STORE_WRITE | REF_STORE_ODB,
1150 "pack_refs");
Michael Haggerty50c2d852017-04-16 08:41:41 +02001151 struct ref_iterator *iter;
Michael Haggerty50c2d852017-04-16 08:41:41 +02001152 int ok;
1153 struct ref_to_prune *refs_to_prune = NULL;
Michael Haggerty34789832017-06-23 09:01:39 +02001154 struct strbuf err = STRBUF_INIT;
Michael Haggerty27d03d02017-09-08 15:51:47 +02001155 struct ref_transaction *transaction;
1156
1157 transaction = ref_store_transaction_begin(refs->packed_ref_store, &err);
1158 if (!transaction)
1159 return -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001160
Michael Haggertyc8bed832017-06-23 09:01:42 +02001161 packed_refs_lock(refs->packed_ref_store, LOCK_DIE_ON_ERROR, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001162
Michael Haggerty50c2d852017-04-16 08:41:41 +02001163 iter = cache_ref_iterator_begin(get_loose_ref_cache(refs), NULL, 0);
1164 while ((ok = ref_iterator_advance(iter)) == ITER_OK) {
1165 /*
1166 * If the loose reference can be packed, add an entry
1167 * in the packed ref cache. If the reference should be
1168 * pruned, also add it to refs_to_prune.
1169 */
Michael Haggerty531cc4a2017-05-22 16:17:48 +02001170 if (!should_pack_ref(iter->refname, iter->oid, iter->flags,
1171 flags))
Michael Haggerty50c2d852017-04-16 08:41:41 +02001172 continue;
1173
1174 /*
Michael Haggerty27d03d02017-09-08 15:51:47 +02001175 * Add a reference creation for this reference to the
1176 * packed-refs transaction:
Michael Haggerty50c2d852017-04-16 08:41:41 +02001177 */
Michael Haggerty27d03d02017-09-08 15:51:47 +02001178 if (ref_transaction_update(transaction, iter->refname,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00001179 iter->oid, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001180 REF_NO_DEREF, NULL, &err))
Michael Haggerty27d03d02017-09-08 15:51:47 +02001181 die("failure preparing to create packed reference %s: %s",
1182 iter->refname, err.buf);
Michael Haggerty50c2d852017-04-16 08:41:41 +02001183
1184 /* Schedule the loose reference for pruning if requested. */
1185 if ((flags & PACK_REFS_PRUNE)) {
1186 struct ref_to_prune *n;
1187 FLEX_ALLOC_STR(n, name, iter->refname);
brian m. carlson49e99582017-10-15 22:06:49 +00001188 oidcpy(&n->oid, iter->oid);
Michael Haggerty50c2d852017-04-16 08:41:41 +02001189 n->next = refs_to_prune;
1190 refs_to_prune = n;
1191 }
1192 }
1193 if (ok != ITER_DONE)
1194 die("error while iterating over references");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001195
Michael Haggerty27d03d02017-09-08 15:51:47 +02001196 if (ref_transaction_commit(transaction, &err))
1197 die("unable to write new packed-refs: %s", err.buf);
1198
1199 ref_transaction_free(transaction);
1200
Michael Haggerty42c7f7f2017-06-23 09:01:45 +02001201 packed_refs_unlock(refs->packed_ref_store);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001202
Michael Haggerty22b09cd2017-09-08 15:51:48 +02001203 prune_refs(refs, &refs_to_prune);
Michael Haggerty34789832017-06-23 09:01:39 +02001204 strbuf_release(&err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001205 return 0;
1206}
1207
Michael Haggerty64da4192017-05-22 16:17:38 +02001208static int files_delete_refs(struct ref_store *ref_store, const char *msg,
David Turnera27dcf82016-09-04 18:08:40 +02001209 struct string_list *refnames, unsigned int flags)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001210{
Michael Haggerty0a95ac52016-09-04 18:08:30 +02001211 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001212 files_downcast(ref_store, REF_STORE_WRITE, "delete_refs");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001213 struct strbuf err = STRBUF_INIT;
1214 int i, result = 0;
1215
1216 if (!refnames->nr)
1217 return 0;
1218
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001219 if (packed_refs_lock(refs->packed_ref_store, 0, &err))
1220 goto error;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001221
Michael Haggerty2fb330c2017-09-08 15:51:46 +02001222 if (refs_delete_refs(refs->packed_ref_store, msg, refnames, flags)) {
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001223 packed_refs_unlock(refs->packed_ref_store);
1224 goto error;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001225 }
1226
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001227 packed_refs_unlock(refs->packed_ref_store);
1228
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001229 for (i = 0; i < refnames->nr; i++) {
1230 const char *refname = refnames->items[i].string;
1231
Michael Haggerty64da4192017-05-22 16:17:38 +02001232 if (refs_delete_ref(&refs->base, msg, refname, NULL, flags))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001233 result |= error(_("could not remove reference %s"), refname);
1234 }
1235
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001236 strbuf_release(&err);
1237 return result;
Michael Haggertye5cc7d72017-07-01 20:31:06 +02001238
1239error:
1240 /*
1241 * If we failed to rewrite the packed-refs file, then it is
1242 * unsafe to try to remove loose refs, because doing so might
1243 * expose an obsolete packed value for a reference that might
1244 * even point at an object that has been garbage collected.
1245 */
1246 if (refnames->nr == 1)
1247 error(_("could not delete reference %s: %s"),
1248 refnames->items[0].string, err.buf);
1249 else
1250 error(_("could not delete references: %s"), err.buf);
1251
1252 strbuf_release(&err);
1253 return -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001254}
1255
1256/*
1257 * People using contrib's git-new-workdir have .git/logs/refs ->
1258 * /some/other/path/.git/logs/refs, and that may live on another device.
1259 *
1260 * IOW, to avoid cross device rename errors, the temporary renamed log must
1261 * live into logs/refs.
1262 */
Nguyễn Thái Ngọc Duya5c1efd2017-03-26 09:42:21 +07001263#define TMP_RENAMED_LOG "refs/.tmp-renamed-log"
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001264
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001265struct rename_cb {
1266 const char *tmp_renamed_log;
1267 int true_errno;
1268};
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001269
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001270static int rename_tmp_log_callback(const char *path, void *cb_data)
1271{
1272 struct rename_cb *cb = cb_data;
1273
1274 if (rename(cb->tmp_renamed_log, path)) {
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001275 /*
1276 * rename(a, b) when b is an existing directory ought
1277 * to result in ISDIR, but Solaris 5.8 gives ENOTDIR.
1278 * Sheesh. Record the true errno for error reporting,
1279 * but report EISDIR to raceproof_create_file() so
1280 * that it knows to retry.
1281 */
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001282 cb->true_errno = errno;
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001283 if (errno == ENOTDIR)
1284 errno = EISDIR;
1285 return -1;
1286 } else {
1287 return 0;
1288 }
1289}
1290
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001291static int rename_tmp_log(struct files_ref_store *refs, const char *newrefname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001292{
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001293 struct strbuf path = STRBUF_INIT;
1294 struct strbuf tmp = STRBUF_INIT;
1295 struct rename_cb cb;
1296 int ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001297
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001298 files_reflog_path(refs, &path, newrefname);
1299 files_reflog_path(refs, &tmp, TMP_RENAMED_LOG);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001300 cb.tmp_renamed_log = tmp.buf;
1301 ret = raceproof_create_file(path.buf, rename_tmp_log_callback, &cb);
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001302 if (ret) {
1303 if (errno == EISDIR)
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001304 error("directory not empty: %s", path.buf);
Michael Haggerty6a7f3632017-01-06 17:22:29 +01001305 else
Michael Haggerty990c98d2017-01-06 17:22:30 +01001306 error("unable to move logfile %s to %s: %s",
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001307 tmp.buf, path.buf,
1308 strerror(cb.true_errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001309 }
1310
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001311 strbuf_release(&path);
1312 strbuf_release(&tmp);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001313 return ret;
1314}
1315
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001316static int write_ref_to_lockfile(struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001317 const struct object_id *oid, struct strbuf *err);
Michael Haggertyf18a7892016-09-04 18:08:32 +02001318static int commit_ref_update(struct files_ref_store *refs,
1319 struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001320 const struct object_id *oid, const char *logmsg,
Michael Haggerty5d9b2de2016-04-22 14:38:56 +02001321 struct strbuf *err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001322
Sahil Dua52d59cc2017-06-18 23:19:16 +02001323static int files_copy_or_rename_ref(struct ref_store *ref_store,
David Turner9b6b40d2016-09-04 18:08:42 +02001324 const char *oldrefname, const char *newrefname,
Sahil Dua52d59cc2017-06-18 23:19:16 +02001325 const char *logmsg, int copy)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001326{
David Turner9b6b40d2016-09-04 18:08:42 +02001327 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001328 files_downcast(ref_store, REF_STORE_WRITE, "rename_ref");
René Scharfee0ae2442019-12-11 19:46:19 +01001329 struct object_id orig_oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001330 int flag = 0, logmoved = 0;
1331 struct ref_lock *lock;
1332 struct stat loginfo;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001333 struct strbuf sb_oldref = STRBUF_INIT;
1334 struct strbuf sb_newref = STRBUF_INIT;
1335 struct strbuf tmp_renamed_log = STRBUF_INIT;
1336 int log, ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001337 struct strbuf err = STRBUF_INIT;
1338
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001339 files_reflog_path(refs, &sb_oldref, oldrefname);
1340 files_reflog_path(refs, &sb_newref, newrefname);
1341 files_reflog_path(refs, &tmp_renamed_log, TMP_RENAMED_LOG);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001342
1343 log = !lstat(sb_oldref.buf, &loginfo);
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001344 if (log && S_ISLNK(loginfo.st_mode)) {
1345 ret = error("reflog for %s is a symlink", oldrefname);
1346 goto out;
1347 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001348
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001349 if (!refs_resolve_ref_unsafe(&refs->base, oldrefname,
1350 RESOLVE_REF_READING | RESOLVE_REF_NO_RECURSE,
brian m. carlson49e61472017-10-15 22:07:09 +00001351 &orig_oid, &flag)) {
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001352 ret = error("refname %s not found", oldrefname);
1353 goto out;
1354 }
Michael Haggertye711b1a2016-04-21 23:42:19 +02001355
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001356 if (flag & REF_ISSYMREF) {
Sahil Dua52d59cc2017-06-18 23:19:16 +02001357 if (copy)
1358 ret = error("refname %s is a symbolic ref, copying it is not supported",
1359 oldrefname);
1360 else
1361 ret = error("refname %s is a symbolic ref, renaming it is not supported",
1362 oldrefname);
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001363 goto out;
1364 }
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +07001365 if (!refs_rename_ref_available(&refs->base, oldrefname, newrefname)) {
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001366 ret = 1;
1367 goto out;
1368 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001369
Sahil Dua52d59cc2017-06-18 23:19:16 +02001370 if (!copy && log && rename(sb_oldref.buf, tmp_renamed_log.buf)) {
Nguyễn Thái Ngọc Duya5c1efd2017-03-26 09:42:21 +07001371 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 +07001372 oldrefname, strerror(errno));
1373 goto out;
1374 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001375
Sahil Dua52d59cc2017-06-18 23:19:16 +02001376 if (copy && log && copy_file(tmp_renamed_log.buf, sb_oldref.buf, 0644)) {
1377 ret = error("unable to copy logfile logs/%s to logs/"TMP_RENAMED_LOG": %s",
1378 oldrefname, strerror(errno));
1379 goto out;
1380 }
1381
1382 if (!copy && refs_delete_ref(&refs->base, logmsg, oldrefname,
Michael Haggerty91774af2017-11-05 09:42:06 +01001383 &orig_oid, REF_NO_DEREF)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001384 error("unable to delete old %s", oldrefname);
1385 goto rollback;
1386 }
1387
David Turner12fd3492016-02-24 17:58:51 -05001388 /*
brian m. carlson4417df82017-05-06 22:10:24 +00001389 * Since we are doing a shallow lookup, oid is not the
1390 * correct value to pass to delete_ref as old_oid. But that
1391 * doesn't matter, because an old_oid check wouldn't add to
David Turner12fd3492016-02-24 17:58:51 -05001392 * the safety anyway; we want to delete the reference whatever
1393 * its current value.
1394 */
Sahil Dua52d59cc2017-06-18 23:19:16 +02001395 if (!copy && !refs_read_ref_full(&refs->base, newrefname,
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001396 RESOLVE_REF_READING | RESOLVE_REF_NO_RECURSE,
René Scharfee0ae2442019-12-11 19:46:19 +01001397 NULL, NULL) &&
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001398 refs_delete_ref(&refs->base, NULL, newrefname,
Michael Haggerty91774af2017-11-05 09:42:06 +01001399 NULL, REF_NO_DEREF)) {
Michael Haggerty58364322017-01-06 17:22:21 +01001400 if (errno == EISDIR) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001401 struct strbuf path = STRBUF_INIT;
1402 int result;
1403
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07001404 files_ref_path(refs, &path, newrefname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001405 result = remove_empty_directories(&path);
1406 strbuf_release(&path);
1407
1408 if (result) {
1409 error("Directory not empty: %s", newrefname);
1410 goto rollback;
1411 }
1412 } else {
1413 error("unable to delete existing %s", newrefname);
1414 goto rollback;
1415 }
1416 }
1417
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001418 if (log && rename_tmp_log(refs, newrefname))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001419 goto rollback;
1420
1421 logmoved = log;
1422
brian m. carlson4f01e502017-10-15 22:07:12 +00001423 lock = lock_ref_oid_basic(refs, newrefname, NULL, NULL, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001424 REF_NO_DEREF, NULL, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001425 if (!lock) {
Sahil Dua52d59cc2017-06-18 23:19:16 +02001426 if (copy)
1427 error("unable to copy '%s' to '%s': %s", oldrefname, newrefname, err.buf);
1428 else
1429 error("unable to rename '%s' to '%s': %s", oldrefname, newrefname, err.buf);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001430 strbuf_release(&err);
1431 goto rollback;
1432 }
brian m. carlson4417df82017-05-06 22:10:24 +00001433 oidcpy(&lock->old_oid, &orig_oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001434
brian m. carlson4417df82017-05-06 22:10:24 +00001435 if (write_ref_to_lockfile(lock, &orig_oid, &err) ||
1436 commit_ref_update(refs, lock, &orig_oid, logmsg, &err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001437 error("unable to write current sha1 into %s: %s", newrefname, err.buf);
1438 strbuf_release(&err);
1439 goto rollback;
1440 }
1441
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001442 ret = 0;
1443 goto out;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001444
1445 rollback:
brian m. carlson4f01e502017-10-15 22:07:12 +00001446 lock = lock_ref_oid_basic(refs, oldrefname, NULL, NULL, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001447 REF_NO_DEREF, NULL, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001448 if (!lock) {
1449 error("unable to lock %s for rollback: %s", oldrefname, err.buf);
1450 strbuf_release(&err);
1451 goto rollbacklog;
1452 }
1453
1454 flag = log_all_ref_updates;
Cornelius Weig341fb282017-01-27 11:09:47 +01001455 log_all_ref_updates = LOG_REFS_NONE;
brian m. carlson4417df82017-05-06 22:10:24 +00001456 if (write_ref_to_lockfile(lock, &orig_oid, &err) ||
1457 commit_ref_update(refs, lock, &orig_oid, NULL, &err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001458 error("unable to write current sha1 into %s: %s", oldrefname, err.buf);
1459 strbuf_release(&err);
1460 }
1461 log_all_ref_updates = flag;
1462
1463 rollbacklog:
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001464 if (logmoved && rename(sb_newref.buf, sb_oldref.buf))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001465 error("unable to restore logfile %s from %s: %s",
1466 oldrefname, newrefname, strerror(errno));
1467 if (!logmoved && log &&
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001468 rename(tmp_renamed_log.buf, sb_oldref.buf))
Nguyễn Thái Ngọc Duya5c1efd2017-03-26 09:42:21 +07001469 error("unable to restore logfile %s from logs/"TMP_RENAMED_LOG": %s",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001470 oldrefname, strerror(errno));
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001471 ret = 1;
1472 out:
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001473 strbuf_release(&sb_newref);
1474 strbuf_release(&sb_oldref);
1475 strbuf_release(&tmp_renamed_log);
1476
Nguyễn Thái Ngọc Duy0a3f07d2017-03-26 09:42:19 +07001477 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001478}
1479
Sahil Dua52d59cc2017-06-18 23:19:16 +02001480static int files_rename_ref(struct ref_store *ref_store,
1481 const char *oldrefname, const char *newrefname,
1482 const char *logmsg)
1483{
1484 return files_copy_or_rename_ref(ref_store, oldrefname,
1485 newrefname, logmsg, 0);
1486}
1487
1488static int files_copy_ref(struct ref_store *ref_store,
1489 const char *oldrefname, const char *newrefname,
1490 const char *logmsg)
1491{
1492 return files_copy_or_rename_ref(ref_store, oldrefname,
1493 newrefname, logmsg, 1);
1494}
1495
Jeff King83a30692017-09-05 08:14:33 -04001496static int close_ref_gently(struct ref_lock *lock)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001497{
Jeff Kingee4d8e42017-09-05 08:15:15 -04001498 if (close_lock_file_gently(&lock->lk))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001499 return -1;
1500 return 0;
1501}
1502
1503static int commit_ref(struct ref_lock *lock)
1504{
Jeff Kingee4d8e42017-09-05 08:15:15 -04001505 char *path = get_locked_file_path(&lock->lk);
Michael Haggerty5387c0d2016-05-05 15:33:03 +02001506 struct stat st;
1507
1508 if (!lstat(path, &st) && S_ISDIR(st.st_mode)) {
1509 /*
1510 * There is a directory at the path we want to rename
1511 * the lockfile to. Hopefully it is empty; try to
1512 * delete it.
1513 */
1514 size_t len = strlen(path);
1515 struct strbuf sb_path = STRBUF_INIT;
1516
1517 strbuf_attach(&sb_path, path, len, len);
1518
1519 /*
1520 * If this fails, commit_lock_file() will also fail
1521 * and will report the problem.
1522 */
1523 remove_empty_directories(&sb_path);
1524 strbuf_release(&sb_path);
1525 } else {
1526 free(path);
1527 }
1528
Jeff Kingee4d8e42017-09-05 08:15:15 -04001529 if (commit_lock_file(&lock->lk))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001530 return -1;
1531 return 0;
1532}
1533
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001534static int open_or_create_logfile(const char *path, void *cb)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001535{
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001536 int *fd = cb;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001537
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001538 *fd = open(path, O_APPEND | O_WRONLY | O_CREAT, 0666);
1539 return (*fd < 0) ? -1 : 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001540}
1541
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001542/*
Michael Haggerty4533e532017-01-06 17:22:36 +01001543 * Create a reflog for a ref. If force_create = 0, only create the
1544 * reflog for certain refs (those for which should_autocreate_reflog
1545 * returns non-zero). Otherwise, create it regardless of the reference
1546 * name. If the logfile already existed or was created, return 0 and
1547 * set *logfd to the file descriptor opened for appending to the file.
1548 * If no logfile exists and we decided not to create one, return 0 and
1549 * set *logfd to -1. On failure, fill in *err, set *logfd to -1, and
1550 * return -1.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001551 */
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001552static int log_ref_setup(struct files_ref_store *refs,
1553 const char *refname, int force_create,
Michael Haggerty4533e532017-01-06 17:22:36 +01001554 int *logfd, struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001555{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001556 struct strbuf logfile_sb = STRBUF_INIT;
1557 char *logfile;
1558
1559 files_reflog_path(refs, &logfile_sb, refname);
1560 logfile = strbuf_detach(&logfile_sb, NULL);
Michael Haggerty854bda62017-01-06 17:22:32 +01001561
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001562 if (force_create || should_autocreate_reflog(refname)) {
Michael Haggerty4533e532017-01-06 17:22:36 +01001563 if (raceproof_create_file(logfile, open_or_create_logfile, logfd)) {
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001564 if (errno == ENOENT)
1565 strbuf_addf(err, "unable to create directory for '%s': "
Michael Haggerty4533e532017-01-06 17:22:36 +01001566 "%s", logfile, strerror(errno));
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001567 else if (errno == EISDIR)
1568 strbuf_addf(err, "there are still logs under '%s'",
Michael Haggerty4533e532017-01-06 17:22:36 +01001569 logfile);
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001570 else
Michael Haggerty854bda62017-01-06 17:22:32 +01001571 strbuf_addf(err, "unable to append to '%s': %s",
Michael Haggerty4533e532017-01-06 17:22:36 +01001572 logfile, strerror(errno));
Michael Haggerty1fb0c802017-01-06 17:22:33 +01001573
Michael Haggerty4533e532017-01-06 17:22:36 +01001574 goto error;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001575 }
Michael Haggerty854bda62017-01-06 17:22:32 +01001576 } else {
Michael Haggerty4533e532017-01-06 17:22:36 +01001577 *logfd = open(logfile, O_APPEND | O_WRONLY, 0666);
Michael Haggertye404f452017-01-06 17:22:34 +01001578 if (*logfd < 0) {
Michael Haggerty854bda62017-01-06 17:22:32 +01001579 if (errno == ENOENT || errno == EISDIR) {
1580 /*
1581 * The logfile doesn't already exist,
1582 * but that is not an error; it only
1583 * means that we won't write log
1584 * entries to it.
1585 */
1586 ;
1587 } else {
1588 strbuf_addf(err, "unable to append to '%s': %s",
Michael Haggerty4533e532017-01-06 17:22:36 +01001589 logfile, strerror(errno));
1590 goto error;
Michael Haggerty854bda62017-01-06 17:22:32 +01001591 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001592 }
1593 }
1594
Michael Haggertye404f452017-01-06 17:22:34 +01001595 if (*logfd >= 0)
Michael Haggerty4533e532017-01-06 17:22:36 +01001596 adjust_shared_perm(logfile);
Michael Haggerty854bda62017-01-06 17:22:32 +01001597
Michael Haggerty4533e532017-01-06 17:22:36 +01001598 free(logfile);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001599 return 0;
Michael Haggerty4533e532017-01-06 17:22:36 +01001600
1601error:
1602 free(logfile);
1603 return -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001604}
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001605
David Turnere3688bd2016-09-04 18:08:38 +02001606static int files_create_reflog(struct ref_store *ref_store,
1607 const char *refname, int force_create,
1608 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001609{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001610 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001611 files_downcast(ref_store, REF_STORE_WRITE, "create_reflog");
Michael Haggertye404f452017-01-06 17:22:34 +01001612 int fd;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001613
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001614 if (log_ref_setup(refs, refname, force_create, &fd, err))
Michael Haggerty4533e532017-01-06 17:22:36 +01001615 return -1;
1616
Michael Haggertye404f452017-01-06 17:22:34 +01001617 if (fd >= 0)
1618 close(fd);
Michael Haggerty4533e532017-01-06 17:22:36 +01001619
1620 return 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001621}
1622
brian m. carlson4417df82017-05-06 22:10:24 +00001623static int log_ref_write_fd(int fd, const struct object_id *old_oid,
1624 const struct object_id *new_oid,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001625 const char *committer, const char *msg)
1626{
Ben Peart80a6c202018-07-10 21:08:22 +00001627 struct strbuf sb = STRBUF_INIT;
1628 int ret = 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001629
Ben Peart80a6c202018-07-10 21:08:22 +00001630 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 +00001631 if (msg && *msg) {
1632 strbuf_addch(&sb, '\t');
Junio C Hamano523fa692020-07-10 17:19:53 +00001633 strbuf_addstr(&sb, msg);
Han-Wen Nienhuys25429fe2020-07-31 11:36:10 +00001634 }
Ben Peart80a6c202018-07-10 21:08:22 +00001635 strbuf_addch(&sb, '\n');
1636 if (write_in_full(fd, sb.buf, sb.len) < 0)
1637 ret = -1;
1638 strbuf_release(&sb);
1639 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001640}
1641
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001642static int files_log_ref_write(struct files_ref_store *refs,
brian m. carlson4417df82017-05-06 22:10:24 +00001643 const char *refname, const struct object_id *old_oid,
1644 const struct object_id *new_oid, const char *msg,
Nguyễn Thái Ngọc Duy11f84572017-03-26 09:42:15 +07001645 int flags, struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001646{
Michael Haggertye404f452017-01-06 17:22:34 +01001647 int logfd, result;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001648
Cornelius Weig341fb282017-01-27 11:09:47 +01001649 if (log_all_ref_updates == LOG_REFS_UNSET)
1650 log_all_ref_updates = is_bare_repository() ? LOG_REFS_NONE : LOG_REFS_NORMAL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001651
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001652 result = log_ref_setup(refs, refname,
1653 flags & REF_FORCE_CREATE_REFLOG,
Michael Haggerty4533e532017-01-06 17:22:36 +01001654 &logfd, err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001655
1656 if (result)
1657 return result;
1658
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001659 if (logfd < 0)
1660 return 0;
brian m. carlson4417df82017-05-06 22:10:24 +00001661 result = log_ref_write_fd(logfd, old_oid, new_oid,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001662 git_committer_info(0), msg);
1663 if (result) {
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001664 struct strbuf sb = STRBUF_INIT;
Michael Haggerty87b21e02017-01-06 17:22:35 +01001665 int save_errno = errno;
1666
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001667 files_reflog_path(refs, &sb, refname);
Michael Haggerty87b21e02017-01-06 17:22:35 +01001668 strbuf_addf(err, "unable to append to '%s': %s",
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001669 sb.buf, strerror(save_errno));
1670 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001671 close(logfd);
1672 return -1;
1673 }
1674 if (close(logfd)) {
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001675 struct strbuf sb = STRBUF_INIT;
Michael Haggerty87b21e02017-01-06 17:22:35 +01001676 int save_errno = errno;
1677
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001678 files_reflog_path(refs, &sb, refname);
Michael Haggerty87b21e02017-01-06 17:22:35 +01001679 strbuf_addf(err, "unable to append to '%s': %s",
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001680 sb.buf, strerror(save_errno));
1681 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001682 return -1;
1683 }
1684 return 0;
1685}
1686
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001687/*
Michael Haggerty78fb4572017-11-05 09:42:09 +01001688 * Write oid into the open lockfile, then close the lockfile. On
1689 * errors, rollback the lockfile, fill in *err and return -1.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001690 */
1691static int write_ref_to_lockfile(struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001692 const struct object_id *oid, struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001693{
1694 static char term = '\n';
1695 struct object *o;
1696 int fd;
1697
Stefan Beller109cd762018-06-28 18:21:51 -07001698 o = parse_object(the_repository, oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001699 if (!o) {
1700 strbuf_addf(err,
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001701 "trying to write ref '%s' with nonexistent object %s",
brian m. carlson4417df82017-05-06 22:10:24 +00001702 lock->ref_name, oid_to_hex(oid));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001703 unlock_ref(lock);
1704 return -1;
1705 }
1706 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1707 strbuf_addf(err,
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001708 "trying to write non-commit object %s to branch '%s'",
brian m. carlson4417df82017-05-06 22:10:24 +00001709 oid_to_hex(oid), lock->ref_name);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001710 unlock_ref(lock);
1711 return -1;
1712 }
Jeff Kingee4d8e42017-09-05 08:15:15 -04001713 fd = get_lock_file_fd(&lock->lk);
brian m. carlson2ae2e2a2018-07-16 01:27:59 +00001714 if (write_in_full(fd, oid_to_hex(oid), the_hash_algo->hexsz) < 0 ||
Jeff King06f46f22017-09-13 13:16:03 -04001715 write_in_full(fd, &term, 1) < 0 ||
Jeff King83a30692017-09-05 08:14:33 -04001716 close_ref_gently(lock) < 0) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001717 strbuf_addf(err,
Jeff Kingee4d8e42017-09-05 08:15:15 -04001718 "couldn't write '%s'", get_lock_file_path(&lock->lk));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001719 unlock_ref(lock);
1720 return -1;
1721 }
1722 return 0;
1723}
1724
1725/*
1726 * Commit a change to a loose reference that has already been written
1727 * to the loose reference lockfile. Also update the reflogs if
1728 * necessary, using the specified lockmsg (which can be NULL).
1729 */
Michael Haggertyf18a7892016-09-04 18:08:32 +02001730static int commit_ref_update(struct files_ref_store *refs,
1731 struct ref_lock *lock,
brian m. carlson4417df82017-05-06 22:10:24 +00001732 const struct object_id *oid, const char *logmsg,
Michael Haggerty5d9b2de2016-04-22 14:38:56 +02001733 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001734{
Michael Haggerty32c597e2017-02-10 12:16:16 +01001735 files_assert_main_repository(refs, "commit_ref_update");
Michael Haggerty00eebe32016-09-04 18:08:11 +02001736
1737 clear_loose_ref_cache(refs);
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001738 if (files_log_ref_write(refs, lock->ref_name,
brian m. carlson4417df82017-05-06 22:10:24 +00001739 &lock->old_oid, oid,
Michael Haggerty81b1b6d2017-01-06 17:22:31 +01001740 logmsg, 0, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001741 char *old_msg = strbuf_detach(err, NULL);
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001742 strbuf_addf(err, "cannot update the ref '%s': %s",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001743 lock->ref_name, old_msg);
1744 free(old_msg);
1745 unlock_ref(lock);
1746 return -1;
1747 }
Michael Haggerty7a418f32016-04-22 15:25:25 +02001748
1749 if (strcmp(lock->ref_name, "HEAD") != 0) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001750 /*
1751 * Special hack: If a branch is updated directly and HEAD
1752 * points to it (may happen on the remote side of a push
1753 * for example) then logically the HEAD reflog should be
1754 * updated too.
1755 * A generic solution implies reverse symref information,
1756 * but finding all symrefs pointing to the given branch
1757 * would be rather costly for this rare event (the direct
1758 * update of a branch) to be worth it. So let's cheat and
1759 * check with HEAD only which should cover 99% of all usage
1760 * scenarios (even 100% of the default ones).
1761 */
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001762 int head_flag;
1763 const char *head_ref;
Michael Haggerty7a418f32016-04-22 15:25:25 +02001764
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001765 head_ref = refs_resolve_ref_unsafe(&refs->base, "HEAD",
1766 RESOLVE_REF_READING,
René Scharfee691b022017-09-23 11:44:57 +02001767 NULL, &head_flag);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001768 if (head_ref && (head_flag & REF_ISSYMREF) &&
1769 !strcmp(head_ref, lock->ref_name)) {
1770 struct strbuf log_err = STRBUF_INIT;
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001771 if (files_log_ref_write(refs, "HEAD",
brian m. carlson4417df82017-05-06 22:10:24 +00001772 &lock->old_oid, oid,
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001773 logmsg, 0, &log_err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001774 error("%s", log_err.buf);
1775 strbuf_release(&log_err);
1776 }
1777 }
1778 }
Michael Haggerty7a418f32016-04-22 15:25:25 +02001779
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001780 if (commit_ref(lock)) {
Michael Haggerty0568c8e2016-04-27 15:21:36 +02001781 strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001782 unlock_ref(lock);
1783 return -1;
1784 }
1785
1786 unlock_ref(lock);
1787 return 0;
1788}
1789
Jeff King370e5ad2015-12-29 00:57:01 -05001790static int create_ref_symlink(struct ref_lock *lock, const char *target)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001791{
Jeff King370e5ad2015-12-29 00:57:01 -05001792 int ret = -1;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001793#ifndef NO_SYMLINK_HEAD
Jeff Kingee4d8e42017-09-05 08:15:15 -04001794 char *ref_path = get_locked_file_path(&lock->lk);
Jeff King370e5ad2015-12-29 00:57:01 -05001795 unlink(ref_path);
1796 ret = symlink(target, ref_path);
1797 free(ref_path);
1798
1799 if (ret)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001800 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001801#endif
Jeff King370e5ad2015-12-29 00:57:01 -05001802 return ret;
1803}
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001804
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001805static void update_symref_reflog(struct files_ref_store *refs,
1806 struct ref_lock *lock, const char *refname,
Jeff King370e5ad2015-12-29 00:57:01 -05001807 const char *target, const char *logmsg)
1808{
1809 struct strbuf err = STRBUF_INIT;
brian m. carlson4417df82017-05-06 22:10:24 +00001810 struct object_id new_oid;
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07001811 if (logmsg &&
1812 !refs_read_ref_full(&refs->base, target,
brian m. carlson34c290a2017-10-15 22:06:56 +00001813 RESOLVE_REF_READING, &new_oid, NULL) &&
brian m. carlson4417df82017-05-06 22:10:24 +00001814 files_log_ref_write(refs, refname, &lock->old_oid,
1815 &new_oid, logmsg, 0, &err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001816 error("%s", err.buf);
1817 strbuf_release(&err);
1818 }
Jeff King370e5ad2015-12-29 00:57:01 -05001819}
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001820
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001821static int create_symref_locked(struct files_ref_store *refs,
1822 struct ref_lock *lock, const char *refname,
Jeff King370e5ad2015-12-29 00:57:01 -05001823 const char *target, const char *logmsg)
1824{
1825 if (prefer_symlink_refs && !create_ref_symlink(lock, target)) {
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001826 update_symref_reflog(refs, lock, refname, target, logmsg);
Jeff King370e5ad2015-12-29 00:57:01 -05001827 return 0;
1828 }
1829
Jeff Kingee4d8e42017-09-05 08:15:15 -04001830 if (!fdopen_lock_file(&lock->lk, "w"))
Jeff King370e5ad2015-12-29 00:57:01 -05001831 return error("unable to fdopen %s: %s",
Jeff Kingee4d8e42017-09-05 08:15:15 -04001832 lock->lk.tempfile->filename.buf, strerror(errno));
Jeff King370e5ad2015-12-29 00:57:01 -05001833
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001834 update_symref_reflog(refs, lock, refname, target, logmsg);
Jeff King396da8f2015-12-29 00:57:25 -05001835
Jeff King370e5ad2015-12-29 00:57:01 -05001836 /* no error check; commit_ref will check ferror */
Jeff Kingee4d8e42017-09-05 08:15:15 -04001837 fprintf(lock->lk.tempfile->fp, "ref: %s\n", target);
Jeff King370e5ad2015-12-29 00:57:01 -05001838 if (commit_ref(lock) < 0)
1839 return error("unable to write symref for %s: %s", refname,
1840 strerror(errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001841 return 0;
1842}
1843
Michael Haggerty284689b2016-09-04 18:08:28 +02001844static int files_create_symref(struct ref_store *ref_store,
1845 const char *refname, const char *target,
1846 const char *logmsg)
Jeff King370e5ad2015-12-29 00:57:01 -05001847{
Michael Haggerty7eb27cd2016-09-04 18:08:34 +02001848 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001849 files_downcast(ref_store, REF_STORE_WRITE, "create_symref");
Jeff King370e5ad2015-12-29 00:57:01 -05001850 struct strbuf err = STRBUF_INIT;
1851 struct ref_lock *lock;
1852 int ret;
1853
brian m. carlson4f01e502017-10-15 22:07:12 +00001854 lock = lock_ref_oid_basic(refs, refname, NULL,
Michael Haggerty91774af2017-11-05 09:42:06 +01001855 NULL, NULL, REF_NO_DEREF, NULL,
brian m. carlson4f01e502017-10-15 22:07:12 +00001856 &err);
Jeff King370e5ad2015-12-29 00:57:01 -05001857 if (!lock) {
1858 error("%s", err.buf);
1859 strbuf_release(&err);
1860 return -1;
1861 }
1862
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001863 ret = create_symref_locked(refs, lock, refname, target, logmsg);
Jeff King370e5ad2015-12-29 00:57:01 -05001864 unlock_ref(lock);
1865 return ret;
1866}
1867
David Turnere3688bd2016-09-04 18:08:38 +02001868static int files_reflog_exists(struct ref_store *ref_store,
1869 const char *refname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001870{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001871 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001872 files_downcast(ref_store, REF_STORE_READ, "reflog_exists");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001873 struct strbuf sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001874 struct stat st;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001875 int ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001876
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001877 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001878 ret = !lstat(sb.buf, &st) && S_ISREG(st.st_mode);
1879 strbuf_release(&sb);
1880 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001881}
1882
David Turnere3688bd2016-09-04 18:08:38 +02001883static int files_delete_reflog(struct ref_store *ref_store,
1884 const char *refname)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001885{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001886 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001887 files_downcast(ref_store, REF_STORE_WRITE, "delete_reflog");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001888 struct strbuf sb = STRBUF_INIT;
1889 int ret;
1890
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001891 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001892 ret = remove_path(sb.buf);
1893 strbuf_release(&sb);
1894 return ret;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001895}
1896
1897static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
1898{
brian m. carlson9461d272017-02-21 23:47:32 +00001899 struct object_id ooid, noid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001900 char *email_end, *message;
Johannes Schindelindddbad72017-04-26 21:29:31 +02001901 timestamp_t timestamp;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001902 int tz;
brian m. carlson43bc3b62017-02-21 23:47:33 +00001903 const char *p = sb->buf;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001904
1905 /* old SP new SP name <email> SP time TAB msg LF */
brian m. carlson43bc3b62017-02-21 23:47:33 +00001906 if (!sb->len || sb->buf[sb->len - 1] != '\n' ||
1907 parse_oid_hex(p, &ooid, &p) || *p++ != ' ' ||
1908 parse_oid_hex(p, &noid, &p) || *p++ != ' ' ||
1909 !(email_end = strchr(p, '>')) ||
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001910 email_end[1] != ' ' ||
Johannes Schindelin1aeb7e72017-04-21 12:45:44 +02001911 !(timestamp = parse_timestamp(email_end + 2, &message, 10)) ||
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001912 !message || message[0] != ' ' ||
1913 (message[1] != '+' && message[1] != '-') ||
1914 !isdigit(message[2]) || !isdigit(message[3]) ||
1915 !isdigit(message[4]) || !isdigit(message[5]))
1916 return 0; /* corrupt? */
1917 email_end[1] = '\0';
1918 tz = strtol(message + 1, NULL, 10);
1919 if (message[6] != '\t')
1920 message += 6;
1921 else
1922 message += 7;
brian m. carlson43bc3b62017-02-21 23:47:33 +00001923 return fn(&ooid, &noid, p, timestamp, tz, message, cb_data);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001924}
1925
1926static char *find_beginning_of_line(char *bob, char *scan)
1927{
1928 while (bob < scan && *(--scan) != '\n')
1929 ; /* keep scanning backwards */
1930 /*
1931 * Return either beginning of the buffer, or LF at the end of
1932 * the previous line.
1933 */
1934 return scan;
1935}
1936
David Turnere3688bd2016-09-04 18:08:38 +02001937static int files_for_each_reflog_ent_reverse(struct ref_store *ref_store,
1938 const char *refname,
1939 each_reflog_ent_fn fn,
1940 void *cb_data)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001941{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001942 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07001943 files_downcast(ref_store, REF_STORE_READ,
1944 "for_each_reflog_ent_reverse");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001945 struct strbuf sb = STRBUF_INIT;
1946 FILE *logfp;
1947 long pos;
1948 int ret = 0, at_tail = 1;
1949
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07001950 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07001951 logfp = fopen(sb.buf, "r");
1952 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001953 if (!logfp)
1954 return -1;
1955
1956 /* Jump to the end */
1957 if (fseek(logfp, 0, SEEK_END) < 0)
René Scharfebe686f02017-04-16 18:55:46 +02001958 ret = error("cannot seek back reflog for %s: %s",
1959 refname, strerror(errno));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001960 pos = ftell(logfp);
1961 while (!ret && 0 < pos) {
1962 int cnt;
1963 size_t nread;
1964 char buf[BUFSIZ];
1965 char *endp, *scanp;
1966
1967 /* Fill next block from the end */
1968 cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
René Scharfebe686f02017-04-16 18:55:46 +02001969 if (fseek(logfp, pos - cnt, SEEK_SET)) {
1970 ret = error("cannot seek back reflog for %s: %s",
1971 refname, strerror(errno));
1972 break;
1973 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001974 nread = fread(buf, cnt, 1, logfp);
René Scharfebe686f02017-04-16 18:55:46 +02001975 if (nread != 1) {
1976 ret = error("cannot read %d bytes from reflog for %s: %s",
1977 cnt, refname, strerror(errno));
1978 break;
1979 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01001980 pos -= cnt;
1981
1982 scanp = endp = buf + cnt;
1983 if (at_tail && scanp[-1] == '\n')
1984 /* Looking at the final LF at the end of the file */
1985 scanp--;
1986 at_tail = 0;
1987
1988 while (buf < scanp) {
1989 /*
1990 * terminating LF of the previous line, or the beginning
1991 * of the buffer.
1992 */
1993 char *bp;
1994
1995 bp = find_beginning_of_line(buf, scanp);
1996
1997 if (*bp == '\n') {
1998 /*
1999 * The newline is the end of the previous line,
2000 * so we know we have complete line starting
2001 * at (bp + 1). Prefix it onto any prior data
2002 * we collected for the line and process it.
2003 */
2004 strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
2005 scanp = bp;
2006 endp = bp + 1;
2007 ret = show_one_reflog_ent(&sb, fn, cb_data);
2008 strbuf_reset(&sb);
2009 if (ret)
2010 break;
2011 } else if (!pos) {
2012 /*
2013 * We are at the start of the buffer, and the
2014 * start of the file; there is no previous
2015 * line, and we have everything for this one.
2016 * Process it, and we can end the loop.
2017 */
2018 strbuf_splice(&sb, 0, 0, buf, endp - buf);
2019 ret = show_one_reflog_ent(&sb, fn, cb_data);
2020 strbuf_reset(&sb);
2021 break;
2022 }
2023
2024 if (bp == buf) {
2025 /*
2026 * We are at the start of the buffer, and there
2027 * is more file to read backwards. Which means
2028 * we are in the middle of a line. Note that we
2029 * may get here even if *bp was a newline; that
2030 * just means we are at the exact end of the
2031 * previous line, rather than some spot in the
2032 * middle.
2033 *
2034 * Save away what we have to be combined with
2035 * the data from the next read.
2036 */
2037 strbuf_splice(&sb, 0, 0, buf, endp - buf);
2038 break;
2039 }
2040 }
2041
2042 }
2043 if (!ret && sb.len)
Johannes Schindelin033abf92018-05-02 11:38:39 +02002044 BUG("reverse reflog parser had leftover data");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002045
2046 fclose(logfp);
2047 strbuf_release(&sb);
2048 return ret;
2049}
2050
David Turnere3688bd2016-09-04 18:08:38 +02002051static int files_for_each_reflog_ent(struct ref_store *ref_store,
2052 const char *refname,
2053 each_reflog_ent_fn fn, void *cb_data)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002054{
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002055 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07002056 files_downcast(ref_store, REF_STORE_READ,
2057 "for_each_reflog_ent");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002058 FILE *logfp;
2059 struct strbuf sb = STRBUF_INIT;
2060 int ret = 0;
2061
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002062 files_reflog_path(refs, &sb, refname);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002063 logfp = fopen(sb.buf, "r");
2064 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002065 if (!logfp)
2066 return -1;
2067
2068 while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
2069 ret = show_one_reflog_ent(&sb, fn, cb_data);
2070 fclose(logfp);
2071 strbuf_release(&sb);
2072 return ret;
2073}
Michael Haggerty2880d162016-06-18 06:15:19 +02002074
2075struct files_reflog_iterator {
2076 struct ref_iterator base;
2077
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002078 struct ref_store *ref_store;
Michael Haggerty2880d162016-06-18 06:15:19 +02002079 struct dir_iterator *dir_iterator;
2080 struct object_id oid;
2081};
2082
2083static int files_reflog_iterator_advance(struct ref_iterator *ref_iterator)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002084{
Michael Haggerty2880d162016-06-18 06:15:19 +02002085 struct files_reflog_iterator *iter =
2086 (struct files_reflog_iterator *)ref_iterator;
2087 struct dir_iterator *diter = iter->dir_iterator;
2088 int ok;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002089
Michael Haggerty2880d162016-06-18 06:15:19 +02002090 while ((ok = dir_iterator_advance(diter)) == ITER_OK) {
2091 int flags;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002092
Michael Haggerty2880d162016-06-18 06:15:19 +02002093 if (!S_ISREG(diter->st.st_mode))
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002094 continue;
Michael Haggerty2880d162016-06-18 06:15:19 +02002095 if (diter->basename[0] == '.')
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002096 continue;
Michael Haggerty2880d162016-06-18 06:15:19 +02002097 if (ends_with(diter->basename, ".lock"))
2098 continue;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002099
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002100 if (refs_read_ref_full(iter->ref_store,
2101 diter->relative_path, 0,
brian m. carlson34c290a2017-10-15 22:06:56 +00002102 &iter->oid, &flags)) {
Michael Haggerty2880d162016-06-18 06:15:19 +02002103 error("bad ref for %s", diter->path.buf);
2104 continue;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002105 }
Michael Haggerty2880d162016-06-18 06:15:19 +02002106
2107 iter->base.refname = diter->relative_path;
2108 iter->base.oid = &iter->oid;
2109 iter->base.flags = flags;
2110 return ITER_OK;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002111 }
Michael Haggerty2880d162016-06-18 06:15:19 +02002112
2113 iter->dir_iterator = NULL;
2114 if (ref_iterator_abort(ref_iterator) == ITER_ERROR)
2115 ok = ITER_ERROR;
2116 return ok;
2117}
2118
2119static int files_reflog_iterator_peel(struct ref_iterator *ref_iterator,
2120 struct object_id *peeled)
2121{
Johannes Schindelin033abf92018-05-02 11:38:39 +02002122 BUG("ref_iterator_peel() called for reflog_iterator");
Michael Haggerty2880d162016-06-18 06:15:19 +02002123}
2124
2125static int files_reflog_iterator_abort(struct ref_iterator *ref_iterator)
2126{
2127 struct files_reflog_iterator *iter =
2128 (struct files_reflog_iterator *)ref_iterator;
2129 int ok = ITER_DONE;
2130
2131 if (iter->dir_iterator)
2132 ok = dir_iterator_abort(iter->dir_iterator);
2133
2134 base_ref_iterator_free(ref_iterator);
2135 return ok;
2136}
2137
2138static struct ref_iterator_vtable files_reflog_iterator_vtable = {
2139 files_reflog_iterator_advance,
2140 files_reflog_iterator_peel,
2141 files_reflog_iterator_abort
2142};
2143
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002144static struct ref_iterator *reflog_iterator_begin(struct ref_store *ref_store,
2145 const char *gitdir)
Michael Haggerty2880d162016-06-18 06:15:19 +02002146{
Matheus Tavares30123972019-07-10 20:58:59 -03002147 struct dir_iterator *diter;
2148 struct files_reflog_iterator *iter;
2149 struct ref_iterator *ref_iterator;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002150 struct strbuf sb = STRBUF_INIT;
Michael Haggerty2880d162016-06-18 06:15:19 +02002151
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002152 strbuf_addf(&sb, "%s/logs", gitdir);
Matheus Tavares30123972019-07-10 20:58:59 -03002153
Matheus Tavaresfa1da7d2019-07-10 20:59:00 -03002154 diter = dir_iterator_begin(sb.buf, 0);
René Scharfe9b7b0292019-08-07 13:15:14 +02002155 if (!diter) {
2156 strbuf_release(&sb);
Matheus Tavares30123972019-07-10 20:58:59 -03002157 return empty_ref_iterator_begin();
René Scharfe9b7b0292019-08-07 13:15:14 +02002158 }
Matheus Tavares30123972019-07-10 20:58:59 -03002159
2160 iter = xcalloc(1, sizeof(*iter));
2161 ref_iterator = &iter->base;
2162
2163 base_ref_iterator_init(ref_iterator, &files_reflog_iterator_vtable, 0);
2164 iter->dir_iterator = diter;
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002165 iter->ref_store = ref_store;
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002166 strbuf_release(&sb);
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002167
Michael Haggerty2880d162016-06-18 06:15:19 +02002168 return ref_iterator;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002169}
2170
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002171static enum iterator_selection reflog_iterator_select(
2172 struct ref_iterator *iter_worktree,
2173 struct ref_iterator *iter_common,
2174 void *cb_data)
2175{
2176 if (iter_worktree) {
2177 /*
2178 * We're a bit loose here. We probably should ignore
2179 * common refs if they are accidentally added as
2180 * per-worktree refs.
2181 */
2182 return ITER_SELECT_0;
2183 } else if (iter_common) {
2184 if (ref_type(iter_common->refname) == REF_TYPE_NORMAL)
2185 return ITER_SELECT_1;
2186
2187 /*
2188 * The main ref store may contain main worktree's
2189 * per-worktree refs, which should be ignored
2190 */
2191 return ITER_SKIP_1;
2192 } else
2193 return ITER_DONE;
2194}
2195
2196static struct ref_iterator *files_reflog_iterator_begin(struct ref_store *ref_store)
2197{
2198 struct files_ref_store *refs =
2199 files_downcast(ref_store, REF_STORE_READ,
2200 "reflog_iterator_begin");
2201
2202 if (!strcmp(refs->gitdir, refs->gitcommondir)) {
2203 return reflog_iterator_begin(ref_store, refs->gitcommondir);
2204 } else {
2205 return merge_ref_iterator_begin(
Junio C Hamano1a2e1a72017-10-03 15:42:50 +09002206 0,
Nguyễn Thái Ngọc Duy944b4e32017-08-23 19:37:00 +07002207 reflog_iterator_begin(ref_store, refs->gitdir),
2208 reflog_iterator_begin(ref_store, refs->gitcommondir),
2209 reflog_iterator_select, refs);
2210 }
2211}
2212
Michael Haggerty165056b2016-04-24 08:58:41 +02002213/*
Michael Haggerty92b15512016-04-25 15:56:07 +02002214 * If update is a direct update of head_ref (the reference pointed to
2215 * by HEAD), then add an extra REF_LOG_ONLY update for HEAD.
Michael Haggerty165056b2016-04-24 08:58:41 +02002216 */
Michael Haggerty92b15512016-04-25 15:56:07 +02002217static int split_head_update(struct ref_update *update,
2218 struct ref_transaction *transaction,
2219 const char *head_ref,
2220 struct string_list *affected_refnames,
2221 struct strbuf *err)
2222{
2223 struct string_list_item *item;
2224 struct ref_update *new_update;
2225
2226 if ((update->flags & REF_LOG_ONLY) ||
Michael Haggertyacedcde2017-11-05 09:42:07 +01002227 (update->flags & REF_IS_PRUNING) ||
Michael Haggerty92b15512016-04-25 15:56:07 +02002228 (update->flags & REF_UPDATE_VIA_HEAD))
2229 return 0;
2230
2231 if (strcmp(update->refname, head_ref))
2232 return 0;
2233
2234 /*
2235 * First make sure that HEAD is not already in the
Martin Ågren276d0e32017-09-09 08:57:18 +02002236 * transaction. This check is O(lg N) in the transaction
Michael Haggerty92b15512016-04-25 15:56:07 +02002237 * size, but it happens at most once per transaction.
2238 */
Martin Ågren276d0e32017-09-09 08:57:18 +02002239 if (string_list_has_string(affected_refnames, "HEAD")) {
Michael Haggerty92b15512016-04-25 15:56:07 +02002240 /* An entry already existed */
2241 strbuf_addf(err,
2242 "multiple updates for 'HEAD' (including one "
2243 "via its referent '%s') are not allowed",
2244 update->refname);
2245 return TRANSACTION_NAME_CONFLICT;
2246 }
2247
2248 new_update = ref_transaction_add_update(
2249 transaction, "HEAD",
Michael Haggerty91774af2017-11-05 09:42:06 +01002250 update->flags | REF_LOG_ONLY | REF_NO_DEREF,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00002251 &update->new_oid, &update->old_oid,
Michael Haggerty92b15512016-04-25 15:56:07 +02002252 update->msg);
2253
Martin Ågren276d0e32017-09-09 08:57:18 +02002254 /*
2255 * Add "HEAD". This insertion is O(N) in the transaction
2256 * size, but it happens at most once per transaction.
2257 * Add new_update->refname instead of a literal "HEAD".
2258 */
2259 if (strcmp(new_update->refname, "HEAD"))
2260 BUG("%s unexpectedly not 'HEAD'", new_update->refname);
2261 item = string_list_insert(affected_refnames, new_update->refname);
Michael Haggerty92b15512016-04-25 15:56:07 +02002262 item->util = new_update;
2263
2264 return 0;
2265}
2266
2267/*
2268 * update is for a symref that points at referent and doesn't have
Michael Haggerty91774af2017-11-05 09:42:06 +01002269 * REF_NO_DEREF set. Split it into two updates:
2270 * - The original update, but with REF_LOG_ONLY and REF_NO_DEREF set
Michael Haggerty92b15512016-04-25 15:56:07 +02002271 * - A new, separate update for the referent reference
2272 * Note that the new update will itself be subject to splitting when
2273 * the iteration gets to it.
2274 */
Jeff King10dee402019-02-14 00:50:46 -05002275static int split_symref_update(struct ref_update *update,
Michael Haggerty92b15512016-04-25 15:56:07 +02002276 const char *referent,
Michael Haggerty165056b2016-04-24 08:58:41 +02002277 struct ref_transaction *transaction,
2278 struct string_list *affected_refnames,
2279 struct strbuf *err)
2280{
Michael Haggerty92b15512016-04-25 15:56:07 +02002281 struct string_list_item *item;
2282 struct ref_update *new_update;
2283 unsigned int new_flags;
Michael Haggerty165056b2016-04-24 08:58:41 +02002284
Michael Haggerty92b15512016-04-25 15:56:07 +02002285 /*
2286 * First make sure that referent is not already in the
Martin Ågrenc2994682017-09-09 08:57:15 +02002287 * transaction. This check is O(lg N) in the transaction
Michael Haggerty92b15512016-04-25 15:56:07 +02002288 * size, but it happens at most once per symref in a
2289 * transaction.
2290 */
Martin Ågrenc2994682017-09-09 08:57:15 +02002291 if (string_list_has_string(affected_refnames, referent)) {
2292 /* An entry already exists */
Michael Haggerty92b15512016-04-25 15:56:07 +02002293 strbuf_addf(err,
2294 "multiple updates for '%s' (including one "
2295 "via symref '%s') are not allowed",
2296 referent, update->refname);
2297 return TRANSACTION_NAME_CONFLICT;
2298 }
2299
2300 new_flags = update->flags;
2301 if (!strcmp(update->refname, "HEAD")) {
2302 /*
2303 * Record that the new update came via HEAD, so that
2304 * when we process it, split_head_update() doesn't try
2305 * to add another reflog update for HEAD. Note that
2306 * this bit will be propagated if the new_update
2307 * itself needs to be split.
2308 */
2309 new_flags |= REF_UPDATE_VIA_HEAD;
2310 }
2311
2312 new_update = ref_transaction_add_update(
2313 transaction, referent, new_flags,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00002314 &update->new_oid, &update->old_oid,
Michael Haggerty92b15512016-04-25 15:56:07 +02002315 update->msg);
2316
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002317 new_update->parent_update = update;
2318
2319 /*
2320 * Change the symbolic ref update to log only. Also, it
Michael Haggerty78fb4572017-11-05 09:42:09 +01002321 * doesn't need to check its old OID value, as that will be
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002322 * done when new_update is processed.
2323 */
Michael Haggerty91774af2017-11-05 09:42:06 +01002324 update->flags |= REF_LOG_ONLY | REF_NO_DEREF;
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002325 update->flags &= ~REF_HAVE_OLD;
Michael Haggerty92b15512016-04-25 15:56:07 +02002326
Martin Ågrenc2994682017-09-09 08:57:15 +02002327 /*
2328 * Add the referent. This insertion is O(N) in the transaction
2329 * size, but it happens at most once per symref in a
2330 * transaction. Make sure to add new_update->refname, which will
2331 * be valid as long as affected_refnames is in use, and NOT
2332 * referent, which might soon be freed by our caller.
2333 */
2334 item = string_list_insert(affected_refnames, new_update->refname);
2335 if (item->util)
2336 BUG("%s unexpectedly found in affected_refnames",
2337 new_update->refname);
Michael Haggerty92b15512016-04-25 15:56:07 +02002338 item->util = new_update;
2339
2340 return 0;
2341}
2342
2343/*
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002344 * Return the refname under which update was originally requested.
2345 */
2346static const char *original_update_refname(struct ref_update *update)
2347{
2348 while (update->parent_update)
2349 update = update->parent_update;
2350
2351 return update->refname;
2352}
2353
2354/*
Michael Haggertye3f51032016-06-07 09:29:23 +02002355 * Check whether the REF_HAVE_OLD and old_oid values stored in update
2356 * are consistent with oid, which is the reference's current value. If
2357 * everything is OK, return 0; otherwise, write an error message to
2358 * err and return -1.
2359 */
2360static int check_old_oid(struct ref_update *update, struct object_id *oid,
2361 struct strbuf *err)
2362{
2363 if (!(update->flags & REF_HAVE_OLD) ||
Jeff King4a7e27e2018-08-28 17:22:40 -04002364 oideq(oid, &update->old_oid))
Michael Haggertye3f51032016-06-07 09:29:23 +02002365 return 0;
2366
brian m. carlson98491292017-05-06 22:10:23 +00002367 if (is_null_oid(&update->old_oid))
Michael Haggertye3f51032016-06-07 09:29:23 +02002368 strbuf_addf(err, "cannot lock ref '%s': "
2369 "reference already exists",
2370 original_update_refname(update));
2371 else if (is_null_oid(oid))
2372 strbuf_addf(err, "cannot lock ref '%s': "
2373 "reference is missing but expected %s",
2374 original_update_refname(update),
brian m. carlson98491292017-05-06 22:10:23 +00002375 oid_to_hex(&update->old_oid));
Michael Haggertye3f51032016-06-07 09:29:23 +02002376 else
2377 strbuf_addf(err, "cannot lock ref '%s': "
2378 "is at %s but expected %s",
2379 original_update_refname(update),
2380 oid_to_hex(oid),
brian m. carlson98491292017-05-06 22:10:23 +00002381 oid_to_hex(&update->old_oid));
Michael Haggertye3f51032016-06-07 09:29:23 +02002382
2383 return -1;
2384}
2385
2386/*
Michael Haggerty92b15512016-04-25 15:56:07 +02002387 * Prepare for carrying out update:
2388 * - Lock the reference referred to by update.
2389 * - Read the reference under lock.
Michael Haggerty78fb4572017-11-05 09:42:09 +01002390 * - Check that its old OID value (if specified) is correct, and in
Michael Haggerty92b15512016-04-25 15:56:07 +02002391 * any case record it in update->lock->old_oid for later use when
2392 * writing the reflog.
Michael Haggerty91774af2017-11-05 09:42:06 +01002393 * - If it is a symref update without REF_NO_DEREF, split it up into a
Michael Haggerty92b15512016-04-25 15:56:07 +02002394 * REF_LOG_ONLY update of the symref and add a separate update for
2395 * the referent to transaction.
2396 * - If it is an update of head_ref, add a corresponding REF_LOG_ONLY
2397 * update of HEAD.
2398 */
Michael Haggertyb3bbbc52016-09-04 18:08:33 +02002399static int lock_ref_for_update(struct files_ref_store *refs,
2400 struct ref_update *update,
Michael Haggerty92b15512016-04-25 15:56:07 +02002401 struct ref_transaction *transaction,
2402 const char *head_ref,
2403 struct string_list *affected_refnames,
2404 struct strbuf *err)
2405{
2406 struct strbuf referent = STRBUF_INIT;
2407 int mustexist = (update->flags & REF_HAVE_OLD) &&
brian m. carlson98491292017-05-06 22:10:23 +00002408 !is_null_oid(&update->old_oid);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002409 int ret = 0;
Michael Haggerty92b15512016-04-25 15:56:07 +02002410 struct ref_lock *lock;
2411
Michael Haggerty32c597e2017-02-10 12:16:16 +01002412 files_assert_main_repository(refs, "lock_ref_for_update");
Michael Haggertyb3bbbc52016-09-04 18:08:33 +02002413
brian m. carlson98491292017-05-06 22:10:23 +00002414 if ((update->flags & REF_HAVE_NEW) && is_null_oid(&update->new_oid))
Michael Haggerty165056b2016-04-24 08:58:41 +02002415 update->flags |= REF_DELETING;
Michael Haggerty92b15512016-04-25 15:56:07 +02002416
2417 if (head_ref) {
2418 ret = split_head_update(update, transaction, head_ref,
2419 affected_refnames, err);
2420 if (ret)
Martin Ågren851e1fb2017-09-09 08:57:16 +02002421 goto out;
Michael Haggerty92b15512016-04-25 15:56:07 +02002422 }
2423
Michael Haggertyf7b0a982016-09-04 18:08:31 +02002424 ret = lock_raw_ref(refs, update->refname, mustexist,
Michael Haggerty92b15512016-04-25 15:56:07 +02002425 affected_refnames, NULL,
David Turner7d618262016-09-04 18:08:43 +02002426 &lock, &referent,
Michael Haggerty92b15512016-04-25 15:56:07 +02002427 &update->type, err);
Michael Haggerty92b15512016-04-25 15:56:07 +02002428 if (ret) {
Michael Haggerty165056b2016-04-24 08:58:41 +02002429 char *reason;
2430
Michael Haggerty165056b2016-04-24 08:58:41 +02002431 reason = strbuf_detach(err, NULL);
2432 strbuf_addf(err, "cannot lock ref '%s': %s",
Michael Haggertye3f51032016-06-07 09:29:23 +02002433 original_update_refname(update), reason);
Michael Haggerty165056b2016-04-24 08:58:41 +02002434 free(reason);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002435 goto out;
Michael Haggerty165056b2016-04-24 08:58:41 +02002436 }
Michael Haggerty92b15512016-04-25 15:56:07 +02002437
David Turner7d618262016-09-04 18:08:43 +02002438 update->backend_data = lock;
Michael Haggerty92b15512016-04-25 15:56:07 +02002439
Michael Haggerty92b15512016-04-25 15:56:07 +02002440 if (update->type & REF_ISSYMREF) {
Michael Haggerty91774af2017-11-05 09:42:06 +01002441 if (update->flags & REF_NO_DEREF) {
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002442 /*
2443 * We won't be reading the referent as part of
2444 * the transaction, so we have to read it here
Michael Haggerty78fb4572017-11-05 09:42:09 +01002445 * to record and possibly check old_oid:
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002446 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002447 if (refs_read_ref_full(&refs->base,
2448 referent.buf, 0,
brian m. carlson34c290a2017-10-15 22:06:56 +00002449 &lock->old_oid, NULL)) {
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002450 if (update->flags & REF_HAVE_OLD) {
2451 strbuf_addf(err, "cannot lock ref '%s': "
Michael Haggertye3f51032016-06-07 09:29:23 +02002452 "error reading reference",
2453 original_update_refname(update));
Martin Ågren3f5ef952017-09-09 08:57:17 +02002454 ret = TRANSACTION_GENERIC_ERROR;
Martin Ågren851e1fb2017-09-09 08:57:16 +02002455 goto out;
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002456 }
Michael Haggertye3f51032016-06-07 09:29:23 +02002457 } else if (check_old_oid(update, &lock->old_oid, err)) {
Martin Ågren851e1fb2017-09-09 08:57:16 +02002458 ret = TRANSACTION_GENERIC_ERROR;
2459 goto out;
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002460 }
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002461 } else {
2462 /*
2463 * Create a new update for the reference this
2464 * symref is pointing at. Also, we will record
Michael Haggerty78fb4572017-11-05 09:42:09 +01002465 * and verify old_oid for this update as part
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002466 * of processing the split-off update, so we
2467 * don't have to do it here.
2468 */
Jeff King10dee402019-02-14 00:50:46 -05002469 ret = split_symref_update(update,
Michael Haggertyfcc42ea2016-09-04 18:08:35 +02002470 referent.buf, transaction,
Michael Haggerty92b15512016-04-25 15:56:07 +02002471 affected_refnames, err);
2472 if (ret)
Martin Ågren851e1fb2017-09-09 08:57:16 +02002473 goto out;
Michael Haggerty92b15512016-04-25 15:56:07 +02002474 }
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002475 } else {
2476 struct ref_update *parent_update;
Michael Haggerty8169d0d2016-04-25 17:38:35 +02002477
Martin Ågren851e1fb2017-09-09 08:57:16 +02002478 if (check_old_oid(update, &lock->old_oid, err)) {
2479 ret = TRANSACTION_GENERIC_ERROR;
2480 goto out;
2481 }
Michael Haggertye3f51032016-06-07 09:29:23 +02002482
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002483 /*
2484 * If this update is happening indirectly because of a
Michael Haggerty78fb4572017-11-05 09:42:09 +01002485 * symref update, record the old OID in the parent
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002486 * update:
2487 */
2488 for (parent_update = update->parent_update;
2489 parent_update;
2490 parent_update = parent_update->parent_update) {
David Turner7d618262016-09-04 18:08:43 +02002491 struct ref_lock *parent_lock = parent_update->backend_data;
2492 oidcpy(&parent_lock->old_oid, &lock->old_oid);
Michael Haggerty6e30b2f2016-04-25 17:48:32 +02002493 }
Michael Haggerty92b15512016-04-25 15:56:07 +02002494 }
2495
Michael Haggerty165056b2016-04-24 08:58:41 +02002496 if ((update->flags & REF_HAVE_NEW) &&
2497 !(update->flags & REF_DELETING) &&
2498 !(update->flags & REF_LOG_ONLY)) {
Michael Haggerty92b15512016-04-25 15:56:07 +02002499 if (!(update->type & REF_ISSYMREF) &&
Jeff King4a7e27e2018-08-28 17:22:40 -04002500 oideq(&lock->old_oid, &update->new_oid)) {
Michael Haggerty165056b2016-04-24 08:58:41 +02002501 /*
2502 * The reference already has the desired
2503 * value, so we don't need to write it.
2504 */
brian m. carlson4417df82017-05-06 22:10:24 +00002505 } else if (write_ref_to_lockfile(lock, &update->new_oid,
Michael Haggerty165056b2016-04-24 08:58:41 +02002506 err)) {
2507 char *write_err = strbuf_detach(err, NULL);
2508
2509 /*
2510 * The lock was freed upon failure of
2511 * write_ref_to_lockfile():
2512 */
David Turner7d618262016-09-04 18:08:43 +02002513 update->backend_data = NULL;
Michael Haggerty165056b2016-04-24 08:58:41 +02002514 strbuf_addf(err,
Michael Haggertye3f51032016-06-07 09:29:23 +02002515 "cannot update ref '%s': %s",
Michael Haggerty165056b2016-04-24 08:58:41 +02002516 update->refname, write_err);
2517 free(write_err);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002518 ret = TRANSACTION_GENERIC_ERROR;
2519 goto out;
Michael Haggerty165056b2016-04-24 08:58:41 +02002520 } else {
2521 update->flags |= REF_NEEDS_COMMIT;
2522 }
2523 }
2524 if (!(update->flags & REF_NEEDS_COMMIT)) {
2525 /*
2526 * We didn't call write_ref_to_lockfile(), so
2527 * the lockfile is still open. Close it to
2528 * free up the file descriptor:
2529 */
Jeff King83a30692017-09-05 08:14:33 -04002530 if (close_ref_gently(lock)) {
Michael Haggerty165056b2016-04-24 08:58:41 +02002531 strbuf_addf(err, "couldn't close '%s.lock'",
2532 update->refname);
Martin Ågren851e1fb2017-09-09 08:57:16 +02002533 ret = TRANSACTION_GENERIC_ERROR;
2534 goto out;
Michael Haggerty165056b2016-04-24 08:58:41 +02002535 }
2536 }
Martin Ågren851e1fb2017-09-09 08:57:16 +02002537
2538out:
2539 strbuf_release(&referent);
2540 return ret;
Michael Haggerty165056b2016-04-24 08:58:41 +02002541}
2542
Michael Haggertydc39e092017-09-08 15:51:51 +02002543struct files_transaction_backend_data {
2544 struct ref_transaction *packed_transaction;
2545 int packed_refs_locked;
2546};
2547
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002548/*
2549 * Unlock any references in `transaction` that are still locked, and
2550 * mark the transaction closed.
2551 */
Michael Haggertydc39e092017-09-08 15:51:51 +02002552static void files_transaction_cleanup(struct files_ref_store *refs,
2553 struct ref_transaction *transaction)
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002554{
2555 size_t i;
Michael Haggertydc39e092017-09-08 15:51:51 +02002556 struct files_transaction_backend_data *backend_data =
2557 transaction->backend_data;
2558 struct strbuf err = STRBUF_INIT;
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002559
2560 for (i = 0; i < transaction->nr; i++) {
2561 struct ref_update *update = transaction->updates[i];
2562 struct ref_lock *lock = update->backend_data;
2563
2564 if (lock) {
2565 unlock_ref(lock);
2566 update->backend_data = NULL;
2567 }
2568 }
2569
Patrick Steinhardtedc30692020-03-30 15:46:13 +02002570 if (backend_data) {
2571 if (backend_data->packed_transaction &&
2572 ref_transaction_abort(backend_data->packed_transaction, &err)) {
2573 error("error aborting transaction: %s", err.buf);
2574 strbuf_release(&err);
2575 }
2576
2577 if (backend_data->packed_refs_locked)
2578 packed_refs_unlock(refs->packed_ref_store);
2579
2580 free(backend_data);
Michael Haggertydc39e092017-09-08 15:51:51 +02002581 }
2582
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002583 transaction->state = REF_TRANSACTION_CLOSED;
2584}
2585
Michael Haggerty30173b82017-05-22 16:17:44 +02002586static int files_transaction_prepare(struct ref_store *ref_store,
2587 struct ref_transaction *transaction,
2588 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002589{
Michael Haggerty00eebe32016-09-04 18:08:11 +02002590 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07002591 files_downcast(ref_store, REF_STORE_WRITE,
Michael Haggerty30173b82017-05-22 16:17:44 +02002592 "ref_transaction_prepare");
Michael Haggerty43a2dfd2017-05-22 16:17:37 +02002593 size_t i;
2594 int ret = 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002595 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
Michael Haggerty92b15512016-04-25 15:56:07 +02002596 char *head_ref = NULL;
2597 int head_type;
Michael Haggertydc39e092017-09-08 15:51:51 +02002598 struct files_transaction_backend_data *backend_data;
2599 struct ref_transaction *packed_transaction = NULL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002600
2601 assert(err);
2602
Michael Haggertyc0ca9352017-05-22 16:17:42 +02002603 if (!transaction->nr)
2604 goto cleanup;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002605
Michael Haggertydc39e092017-09-08 15:51:51 +02002606 backend_data = xcalloc(1, sizeof(*backend_data));
2607 transaction->backend_data = backend_data;
2608
Michael Haggerty92b15512016-04-25 15:56:07 +02002609 /*
2610 * Fail if a refname appears more than once in the
2611 * transaction. (If we end up splitting up any updates using
2612 * split_symref_update() or split_head_update(), those
2613 * functions will check that the new updates don't have the
Michael Haggerty62c72d12017-11-05 09:42:04 +01002614 * same refname as any existing ones.) Also fail if any of the
Michael Haggertyacedcde2017-11-05 09:42:07 +01002615 * updates use REF_IS_PRUNING without REF_NO_DEREF.
Michael Haggerty92b15512016-04-25 15:56:07 +02002616 */
2617 for (i = 0; i < transaction->nr; i++) {
2618 struct ref_update *update = transaction->updates[i];
2619 struct string_list_item *item =
2620 string_list_append(&affected_refnames, update->refname);
2621
Michael Haggertyacedcde2017-11-05 09:42:07 +01002622 if ((update->flags & REF_IS_PRUNING) &&
Michael Haggerty91774af2017-11-05 09:42:06 +01002623 !(update->flags & REF_NO_DEREF))
Michael Haggertyacedcde2017-11-05 09:42:07 +01002624 BUG("REF_IS_PRUNING set without REF_NO_DEREF");
Michael Haggerty62c72d12017-11-05 09:42:04 +01002625
Michael Haggerty92b15512016-04-25 15:56:07 +02002626 /*
2627 * We store a pointer to update in item->util, but at
2628 * the moment we never use the value of this field
2629 * except to check whether it is non-NULL.
2630 */
2631 item->util = update;
2632 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002633 string_list_sort(&affected_refnames);
2634 if (ref_update_reject_duplicates(&affected_refnames, err)) {
2635 ret = TRANSACTION_GENERIC_ERROR;
2636 goto cleanup;
2637 }
2638
2639 /*
Michael Haggerty92b15512016-04-25 15:56:07 +02002640 * Special hack: If a branch is updated directly and HEAD
2641 * points to it (may happen on the remote side of a push
2642 * for example) then logically the HEAD reflog should be
2643 * updated too.
2644 *
2645 * A generic solution would require reverse symref lookups,
2646 * but finding all symrefs pointing to a given branch would be
2647 * rather costly for this rare event (the direct update of a
2648 * branch) to be worth it. So let's cheat and check with HEAD
2649 * only, which should cover 99% of all usage scenarios (even
2650 * 100% of the default ones).
2651 *
2652 * So if HEAD is a symbolic reference, then record the name of
2653 * the reference that it points to. If we see an update of
2654 * head_ref within the transaction, then split_head_update()
2655 * arranges for the reflog of HEAD to be updated, too.
2656 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002657 head_ref = refs_resolve_refdup(ref_store, "HEAD",
2658 RESOLVE_REF_NO_RECURSE,
René Scharfe872ccb22017-10-01 09:28:50 +02002659 NULL, &head_type);
Michael Haggerty92b15512016-04-25 15:56:07 +02002660
2661 if (head_ref && !(head_type & REF_ISSYMREF)) {
Ævar Arnfjörð Bjarmason6a83d902017-06-15 23:15:46 +00002662 FREE_AND_NULL(head_ref);
Michael Haggerty92b15512016-04-25 15:56:07 +02002663 }
2664
2665 /*
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002666 * Acquire all locks, verify old values if provided, check
2667 * that new values are valid, and write new values to the
2668 * lockfiles, ready to be activated. Only keep one lockfile
2669 * open at a time to avoid running out of file descriptors.
Michael Haggerty30173b82017-05-22 16:17:44 +02002670 * Note that lock_ref_for_update() might append more updates
2671 * to the transaction.
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002672 */
Michael Haggertyefe47282016-04-22 00:02:50 +02002673 for (i = 0; i < transaction->nr; i++) {
2674 struct ref_update *update = transaction->updates[i];
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002675
Michael Haggertyb3bbbc52016-09-04 18:08:33 +02002676 ret = lock_ref_for_update(refs, update, transaction,
2677 head_ref, &affected_refnames, err);
Michael Haggerty165056b2016-04-24 08:58:41 +02002678 if (ret)
Michael Haggertyda5267f2017-10-24 17:16:25 +02002679 goto cleanup;
Michael Haggertydc39e092017-09-08 15:51:51 +02002680
2681 if (update->flags & REF_DELETING &&
2682 !(update->flags & REF_LOG_ONLY) &&
Michael Haggertyacedcde2017-11-05 09:42:07 +01002683 !(update->flags & REF_IS_PRUNING)) {
Michael Haggertydc39e092017-09-08 15:51:51 +02002684 /*
2685 * This reference has to be deleted from
2686 * packed-refs if it exists there.
2687 */
2688 if (!packed_transaction) {
2689 packed_transaction = ref_store_transaction_begin(
2690 refs->packed_ref_store, err);
2691 if (!packed_transaction) {
2692 ret = TRANSACTION_GENERIC_ERROR;
2693 goto cleanup;
2694 }
2695
2696 backend_data->packed_transaction =
2697 packed_transaction;
2698 }
2699
2700 ref_transaction_add_update(
2701 packed_transaction, update->refname,
Michael Haggerty91774af2017-11-05 09:42:06 +01002702 REF_HAVE_NEW | REF_NO_DEREF,
Michael Haggertyb0ca4112017-11-05 09:42:01 +01002703 &update->new_oid, NULL,
Michael Haggertydc39e092017-09-08 15:51:51 +02002704 NULL);
2705 }
2706 }
2707
2708 if (packed_transaction) {
2709 if (packed_refs_lock(refs->packed_ref_store, 0, err)) {
2710 ret = TRANSACTION_GENERIC_ERROR;
2711 goto cleanup;
2712 }
2713 backend_data->packed_refs_locked = 1;
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002714
2715 if (is_packed_transaction_needed(refs->packed_ref_store,
2716 packed_transaction)) {
2717 ret = ref_transaction_prepare(packed_transaction, err);
Jeff King249e8dc2019-03-21 05:28:44 -04002718 /*
2719 * A failure during the prepare step will abort
2720 * itself, but not free. Do that now, and disconnect
2721 * from the files_transaction so it does not try to
2722 * abort us when we hit the cleanup code below.
2723 */
2724 if (ret) {
2725 ref_transaction_free(packed_transaction);
2726 backend_data->packed_transaction = NULL;
2727 }
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002728 } else {
2729 /*
2730 * We can skip rewriting the `packed-refs`
2731 * file. But we do need to leave it locked, so
2732 * that somebody else doesn't pack a reference
2733 * that we are trying to delete.
Jeff Kingd3322eb2019-03-21 05:28:54 -04002734 *
2735 * We need to disconnect our transaction from
2736 * backend_data, since the abort (whether successful or
2737 * not) will free it.
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002738 */
Jeff Kingd3322eb2019-03-21 05:28:54 -04002739 backend_data->packed_transaction = NULL;
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002740 if (ref_transaction_abort(packed_transaction, err)) {
2741 ret = TRANSACTION_GENERIC_ERROR;
2742 goto cleanup;
2743 }
Michael Haggerty7c6bd252017-10-28 11:16:02 +02002744 }
Michael Haggerty30173b82017-05-22 16:17:44 +02002745 }
2746
2747cleanup:
2748 free(head_ref);
2749 string_list_clear(&affected_refnames, 0);
2750
2751 if (ret)
Michael Haggertydc39e092017-09-08 15:51:51 +02002752 files_transaction_cleanup(refs, transaction);
Michael Haggerty30173b82017-05-22 16:17:44 +02002753 else
2754 transaction->state = REF_TRANSACTION_PREPARED;
2755
2756 return ret;
2757}
2758
2759static int files_transaction_finish(struct ref_store *ref_store,
2760 struct ref_transaction *transaction,
2761 struct strbuf *err)
2762{
2763 struct files_ref_store *refs =
2764 files_downcast(ref_store, 0, "ref_transaction_finish");
2765 size_t i;
2766 int ret = 0;
Michael Haggerty30173b82017-05-22 16:17:44 +02002767 struct strbuf sb = STRBUF_INIT;
Michael Haggertydc39e092017-09-08 15:51:51 +02002768 struct files_transaction_backend_data *backend_data;
2769 struct ref_transaction *packed_transaction;
2770
Michael Haggerty30173b82017-05-22 16:17:44 +02002771
2772 assert(err);
2773
2774 if (!transaction->nr) {
2775 transaction->state = REF_TRANSACTION_CLOSED;
2776 return 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002777 }
2778
Michael Haggertydc39e092017-09-08 15:51:51 +02002779 backend_data = transaction->backend_data;
2780 packed_transaction = backend_data->packed_transaction;
2781
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002782 /* Perform updates first so live commits remain referenced */
Michael Haggertyefe47282016-04-22 00:02:50 +02002783 for (i = 0; i < transaction->nr; i++) {
2784 struct ref_update *update = transaction->updates[i];
David Turner7d618262016-09-04 18:08:43 +02002785 struct ref_lock *lock = update->backend_data;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002786
David Turnerd99aa882016-02-24 17:58:50 -05002787 if (update->flags & REF_NEEDS_COMMIT ||
2788 update->flags & REF_LOG_ONLY) {
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002789 if (files_log_ref_write(refs,
2790 lock->ref_name,
brian m. carlson4417df82017-05-06 22:10:24 +00002791 &lock->old_oid,
2792 &update->new_oid,
Michael Haggerty81b1b6d2017-01-06 17:22:31 +01002793 update->msg, update->flags,
2794 err)) {
Michael Haggerty92b15512016-04-25 15:56:07 +02002795 char *old_msg = strbuf_detach(err, NULL);
2796
2797 strbuf_addf(err, "cannot update the ref '%s': %s",
2798 lock->ref_name, old_msg);
2799 free(old_msg);
2800 unlock_ref(lock);
David Turner7d618262016-09-04 18:08:43 +02002801 update->backend_data = NULL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002802 ret = TRANSACTION_GENERIC_ERROR;
2803 goto cleanup;
Michael Haggerty92b15512016-04-25 15:56:07 +02002804 }
2805 }
2806 if (update->flags & REF_NEEDS_COMMIT) {
Michael Haggerty00eebe32016-09-04 18:08:11 +02002807 clear_loose_ref_cache(refs);
Michael Haggerty92b15512016-04-25 15:56:07 +02002808 if (commit_ref(lock)) {
2809 strbuf_addf(err, "couldn't set '%s'", lock->ref_name);
2810 unlock_ref(lock);
David Turner7d618262016-09-04 18:08:43 +02002811 update->backend_data = NULL;
Michael Haggerty92b15512016-04-25 15:56:07 +02002812 ret = TRANSACTION_GENERIC_ERROR;
2813 goto cleanup;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002814 }
2815 }
2816 }
Michael Haggertydc39e092017-09-08 15:51:51 +02002817
2818 /*
Michael Haggerty5e00a6c2017-09-08 15:51:53 +02002819 * Now that updates are safely completed, we can perform
2820 * deletes. First delete the reflogs of any references that
2821 * will be deleted, since (in the unexpected event of an
2822 * error) leaving a reference without a reflog is less bad
2823 * than leaving a reflog without a reference (the latter is a
2824 * mildly invalid repository state):
2825 */
2826 for (i = 0; i < transaction->nr; i++) {
2827 struct ref_update *update = transaction->updates[i];
2828 if (update->flags & REF_DELETING &&
2829 !(update->flags & REF_LOG_ONLY) &&
Michael Haggertyacedcde2017-11-05 09:42:07 +01002830 !(update->flags & REF_IS_PRUNING)) {
Michael Haggerty5e00a6c2017-09-08 15:51:53 +02002831 strbuf_reset(&sb);
2832 files_reflog_path(refs, &sb, update->refname);
2833 if (!unlink_or_warn(sb.buf))
2834 try_remove_empty_parents(refs, update->refname,
2835 REMOVE_EMPTY_PARENTS_REFLOG);
2836 }
2837 }
2838
2839 /*
Michael Haggertydc39e092017-09-08 15:51:51 +02002840 * Perform deletes now that updates are safely completed.
2841 *
2842 * First delete any packed versions of the references, while
2843 * retaining the packed-refs lock:
2844 */
2845 if (packed_transaction) {
2846 ret = ref_transaction_commit(packed_transaction, err);
2847 ref_transaction_free(packed_transaction);
2848 packed_transaction = NULL;
2849 backend_data->packed_transaction = NULL;
2850 if (ret)
2851 goto cleanup;
2852 }
2853
2854 /* Now delete the loose versions of the references: */
Michael Haggertyefe47282016-04-22 00:02:50 +02002855 for (i = 0; i < transaction->nr; i++) {
2856 struct ref_update *update = transaction->updates[i];
David Turner7d618262016-09-04 18:08:43 +02002857 struct ref_lock *lock = update->backend_data;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002858
David Turnerd99aa882016-02-24 17:58:50 -05002859 if (update->flags & REF_DELETING &&
2860 !(update->flags & REF_LOG_ONLY)) {
Michael Haggertyce0af242017-01-06 17:22:39 +01002861 if (!(update->type & REF_ISPACKED) ||
2862 update->type & REF_ISSYMREF) {
2863 /* It is a loose reference. */
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002864 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07002865 files_ref_path(refs, &sb, lock->ref_name);
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07002866 if (unlink_or_msg(sb.buf, err)) {
Michael Haggertyce0af242017-01-06 17:22:39 +01002867 ret = TRANSACTION_GENERIC_ERROR;
2868 goto cleanup;
2869 }
Michael Haggerty44639772017-01-06 17:22:43 +01002870 update->flags |= REF_DELETED_LOOSE;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002871 }
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002872 }
2873 }
2874
Michael Haggerty00eebe32016-09-04 18:08:11 +02002875 clear_loose_ref_cache(refs);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002876
2877cleanup:
Michael Haggertydc39e092017-09-08 15:51:51 +02002878 files_transaction_cleanup(refs, transaction);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002879
Michael Haggerty44639772017-01-06 17:22:43 +01002880 for (i = 0; i < transaction->nr; i++) {
2881 struct ref_update *update = transaction->updates[i];
Michael Haggerty44639772017-01-06 17:22:43 +01002882
2883 if (update->flags & REF_DELETED_LOOSE) {
2884 /*
2885 * The loose reference was deleted. Delete any
2886 * empty parent directories. (Note that this
2887 * can only work because we have already
2888 * removed the lockfile.)
2889 */
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07002890 try_remove_empty_parents(refs, update->refname,
Michael Haggerty44639772017-01-06 17:22:43 +01002891 REMOVE_EMPTY_PARENTS_REF);
2892 }
2893 }
2894
Michael Haggerty30173b82017-05-22 16:17:44 +02002895 strbuf_release(&sb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002896 return ret;
2897}
2898
Michael Haggerty30173b82017-05-22 16:17:44 +02002899static int files_transaction_abort(struct ref_store *ref_store,
2900 struct ref_transaction *transaction,
2901 struct strbuf *err)
2902{
Michael Haggertydc39e092017-09-08 15:51:51 +02002903 struct files_ref_store *refs =
2904 files_downcast(ref_store, 0, "ref_transaction_abort");
2905
2906 files_transaction_cleanup(refs, transaction);
Michael Haggerty30173b82017-05-22 16:17:44 +02002907 return 0;
2908}
2909
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002910static int ref_present(const char *refname,
2911 const struct object_id *oid, int flags, void *cb_data)
2912{
2913 struct string_list *affected_refnames = cb_data;
2914
2915 return string_list_has_string(affected_refnames, refname);
2916}
2917
David Turnerfc681462016-09-04 18:08:39 +02002918static int files_initial_transaction_commit(struct ref_store *ref_store,
2919 struct ref_transaction *transaction,
2920 struct strbuf *err)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002921{
Michael Haggertyd99825a2016-09-04 18:08:12 +02002922 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07002923 files_downcast(ref_store, REF_STORE_WRITE,
2924 "initial_ref_transaction_commit");
Michael Haggerty43a2dfd2017-05-22 16:17:37 +02002925 size_t i;
2926 int ret = 0;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002927 struct string_list affected_refnames = STRING_LIST_INIT_NODUP;
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002928 struct ref_transaction *packed_transaction = NULL;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002929
2930 assert(err);
2931
2932 if (transaction->state != REF_TRANSACTION_OPEN)
Johannes Schindelin033abf92018-05-02 11:38:39 +02002933 BUG("commit called for transaction that is not open");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002934
2935 /* Fail if a refname appears more than once in the transaction: */
Michael Haggertyefe47282016-04-22 00:02:50 +02002936 for (i = 0; i < transaction->nr; i++)
2937 string_list_append(&affected_refnames,
2938 transaction->updates[i]->refname);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002939 string_list_sort(&affected_refnames);
2940 if (ref_update_reject_duplicates(&affected_refnames, err)) {
2941 ret = TRANSACTION_GENERIC_ERROR;
2942 goto cleanup;
2943 }
2944
2945 /*
2946 * It's really undefined to call this function in an active
2947 * repository or when there are existing references: we are
2948 * only locking and changing packed-refs, so (1) any
2949 * simultaneous processes might try to change a reference at
2950 * the same time we do, and (2) any existing loose versions of
2951 * the references that we are setting would have precedence
2952 * over our values. But some remote helpers create the remote
2953 * "HEAD" and "master" branches before calling this function,
2954 * so here we really only check that none of the references
2955 * that we are creating already exists.
2956 */
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07002957 if (refs_for_each_rawref(&refs->base, ref_present,
2958 &affected_refnames))
Johannes Schindelin033abf92018-05-02 11:38:39 +02002959 BUG("initial ref transaction called with existing refs");
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002960
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002961 packed_transaction = ref_store_transaction_begin(refs->packed_ref_store, err);
2962 if (!packed_transaction) {
2963 ret = TRANSACTION_GENERIC_ERROR;
2964 goto cleanup;
2965 }
2966
Michael Haggertyefe47282016-04-22 00:02:50 +02002967 for (i = 0; i < transaction->nr; i++) {
2968 struct ref_update *update = transaction->updates[i];
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002969
2970 if ((update->flags & REF_HAVE_OLD) &&
brian m. carlson98491292017-05-06 22:10:23 +00002971 !is_null_oid(&update->old_oid))
Johannes Schindelin033abf92018-05-02 11:38:39 +02002972 BUG("initial ref transaction with old_sha1 set");
Nguyễn Thái Ngọc Duy7d2df052017-03-26 09:42:34 +07002973 if (refs_verify_refname_available(&refs->base, update->refname,
2974 &affected_refnames, NULL,
2975 err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002976 ret = TRANSACTION_NAME_CONFLICT;
2977 goto cleanup;
2978 }
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002979
2980 /*
2981 * Add a reference creation for this reference to the
2982 * packed-refs transaction:
2983 */
2984 ref_transaction_add_update(packed_transaction, update->refname,
2985 update->flags & ~REF_HAVE_OLD,
brian m. carlson89f3bbd2017-10-15 22:06:53 +00002986 &update->new_oid, &update->old_oid,
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002987 NULL);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002988 }
2989
Michael Haggertyc8bed832017-06-23 09:01:42 +02002990 if (packed_refs_lock(refs->packed_ref_store, 0, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002991 ret = TRANSACTION_GENERIC_ERROR;
2992 goto cleanup;
2993 }
2994
Michael Haggerty1444bfe2017-09-08 15:51:49 +02002995 if (initial_ref_transaction_commit(packed_transaction, err)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002996 ret = TRANSACTION_GENERIC_ERROR;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01002997 }
2998
Mathias Rav81fcb692018-01-18 14:38:41 +01002999 packed_refs_unlock(refs->packed_ref_store);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003000cleanup:
Michael Haggerty1444bfe2017-09-08 15:51:49 +02003001 if (packed_transaction)
3002 ref_transaction_free(packed_transaction);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003003 transaction->state = REF_TRANSACTION_CLOSED;
3004 string_list_clear(&affected_refnames, 0);
3005 return ret;
3006}
3007
3008struct expire_reflog_cb {
3009 unsigned int flags;
3010 reflog_expiry_should_prune_fn *should_prune_fn;
3011 void *policy_cb;
3012 FILE *newlog;
brian m. carlson9461d272017-02-21 23:47:32 +00003013 struct object_id last_kept_oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003014};
3015
brian m. carlson9461d272017-02-21 23:47:32 +00003016static int expire_reflog_ent(struct object_id *ooid, struct object_id *noid,
Johannes Schindelindddbad72017-04-26 21:29:31 +02003017 const char *email, timestamp_t timestamp, int tz,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003018 const char *message, void *cb_data)
3019{
3020 struct expire_reflog_cb *cb = cb_data;
3021 struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;
3022
3023 if (cb->flags & EXPIRE_REFLOGS_REWRITE)
brian m. carlson9461d272017-02-21 23:47:32 +00003024 ooid = &cb->last_kept_oid;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003025
brian m. carlson43224782017-05-06 22:10:00 +00003026 if ((*cb->should_prune_fn)(ooid, noid, email, timestamp, tz,
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003027 message, policy_cb)) {
3028 if (!cb->newlog)
3029 printf("would prune %s", message);
3030 else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
3031 printf("prune %s", message);
3032 } else {
3033 if (cb->newlog) {
Johannes Schindelincb71f8b2017-04-21 12:45:48 +02003034 fprintf(cb->newlog, "%s %s %s %"PRItime" %+05d\t%s",
brian m. carlson9461d272017-02-21 23:47:32 +00003035 oid_to_hex(ooid), oid_to_hex(noid),
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003036 email, timestamp, tz, message);
brian m. carlson9461d272017-02-21 23:47:32 +00003037 oidcpy(&cb->last_kept_oid, noid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003038 }
3039 if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
3040 printf("keep %s", message);
3041 }
3042 return 0;
3043}
3044
David Turnere3688bd2016-09-04 18:08:38 +02003045static int files_reflog_expire(struct ref_store *ref_store,
brian m. carlson0155f712017-10-15 22:07:04 +00003046 const char *refname, const struct object_id *oid,
David Turnere3688bd2016-09-04 18:08:38 +02003047 unsigned int flags,
3048 reflog_expiry_prepare_fn prepare_fn,
3049 reflog_expiry_should_prune_fn should_prune_fn,
3050 reflog_expiry_cleanup_fn cleanup_fn,
3051 void *policy_cb_data)
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003052{
Michael Haggerty7eb27cd2016-09-04 18:08:34 +02003053 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07003054 files_downcast(ref_store, REF_STORE_WRITE, "reflog_expire");
Martin Ågrenb2275862018-05-09 22:55:38 +02003055 struct lock_file reflog_lock = LOCK_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003056 struct expire_reflog_cb cb;
3057 struct ref_lock *lock;
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07003058 struct strbuf log_file_sb = STRBUF_INIT;
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003059 char *log_file;
3060 int status = 0;
3061 int type;
3062 struct strbuf err = STRBUF_INIT;
3063
3064 memset(&cb, 0, sizeof(cb));
3065 cb.flags = flags;
3066 cb.policy_cb = policy_cb_data;
3067 cb.should_prune_fn = should_prune_fn;
3068
3069 /*
3070 * The reflog file is locked by holding the lock on the
3071 * reference itself, plus we might need to update the
3072 * reference if --updateref was specified:
3073 */
brian m. carlson4f01e502017-10-15 22:07:12 +00003074 lock = lock_ref_oid_basic(refs, refname, oid,
Michael Haggerty91774af2017-11-05 09:42:06 +01003075 NULL, NULL, REF_NO_DEREF,
brian m. carlson4f01e502017-10-15 22:07:12 +00003076 &type, &err);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003077 if (!lock) {
3078 error("cannot lock ref '%s': %s", refname, err.buf);
3079 strbuf_release(&err);
3080 return -1;
3081 }
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07003082 if (!refs_reflog_exists(ref_store, refname)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003083 unlock_ref(lock);
3084 return 0;
3085 }
3086
Nguyễn Thái Ngọc Duy802de3d2017-03-26 09:42:22 +07003087 files_reflog_path(refs, &log_file_sb, refname);
3088 log_file = strbuf_detach(&log_file_sb, NULL);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003089 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
3090 /*
3091 * Even though holding $GIT_DIR/logs/$reflog.lock has
3092 * no locking implications, we use the lock_file
3093 * machinery here anyway because it does a lot of the
3094 * work we need, including cleaning up if the program
3095 * exits unexpectedly.
3096 */
3097 if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
3098 struct strbuf err = STRBUF_INIT;
3099 unable_to_lock_message(log_file, errno, &err);
3100 error("%s", err.buf);
3101 strbuf_release(&err);
3102 goto failure;
3103 }
3104 cb.newlog = fdopen_lock_file(&reflog_lock, "w");
3105 if (!cb.newlog) {
3106 error("cannot fdopen %s (%s)",
3107 get_lock_file_path(&reflog_lock), strerror(errno));
3108 goto failure;
3109 }
3110 }
3111
brian m. carlson0155f712017-10-15 22:07:04 +00003112 (*prepare_fn)(refname, oid, cb.policy_cb);
Nguyễn Thái Ngọc Duy2f40e952017-03-26 09:42:36 +07003113 refs_for_each_reflog_ent(ref_store, refname, expire_reflog_ent, &cb);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003114 (*cleanup_fn)(cb.policy_cb);
3115
3116 if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
3117 /*
3118 * It doesn't make sense to adjust a reference pointed
3119 * to by a symbolic ref based on expiring entries in
3120 * the symbolic reference's reflog. Nor can we update
3121 * a reference if there are no remaining reflog
3122 * entries.
3123 */
3124 int update = (flags & EXPIRE_REFLOGS_UPDATE_REF) &&
3125 !(type & REF_ISSYMREF) &&
brian m. carlson9461d272017-02-21 23:47:32 +00003126 !is_null_oid(&cb.last_kept_oid);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003127
Jeff King83a30692017-09-05 08:14:33 -04003128 if (close_lock_file_gently(&reflog_lock)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003129 status |= error("couldn't write %s: %s", log_file,
3130 strerror(errno));
Jeff King83a30692017-09-05 08:14:33 -04003131 rollback_lock_file(&reflog_lock);
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003132 } else if (update &&
Jeff Kingee4d8e42017-09-05 08:15:15 -04003133 (write_in_full(get_lock_file_fd(&lock->lk),
brian m. carlson2ae2e2a2018-07-16 01:27:59 +00003134 oid_to_hex(&cb.last_kept_oid), the_hash_algo->hexsz) < 0 ||
Jeff King88780c32017-09-25 16:27:17 -04003135 write_str_in_full(get_lock_file_fd(&lock->lk), "\n") < 0 ||
Jeff King83a30692017-09-05 08:14:33 -04003136 close_ref_gently(lock) < 0)) {
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003137 status |= error("couldn't write %s",
Jeff Kingee4d8e42017-09-05 08:15:15 -04003138 get_lock_file_path(&lock->lk));
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003139 rollback_lock_file(&reflog_lock);
3140 } else if (commit_lock_file(&reflog_lock)) {
Junio C Hamanoe0048d32015-12-11 10:40:54 -08003141 status |= error("unable to write reflog '%s' (%s)",
Michael Haggerty7bd9bcf2015-11-09 14:34:01 +01003142 log_file, strerror(errno));
3143 } else if (update && commit_ref(lock)) {
3144 status |= error("couldn't set %s", lock->ref_name);
3145 }
3146 }
3147 free(log_file);
3148 unlock_ref(lock);
3149 return status;
3150
3151 failure:
3152 rollback_lock_file(&reflog_lock);
3153 free(log_file);
3154 unlock_ref(lock);
3155 return -1;
3156}
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +02003157
David Turner6fb5acf2016-09-04 18:08:41 +02003158static int files_init_db(struct ref_store *ref_store, struct strbuf *err)
3159{
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07003160 struct files_ref_store *refs =
Nguyễn Thái Ngọc Duy9e7ec632017-03-26 09:42:32 +07003161 files_downcast(ref_store, REF_STORE_WRITE, "init_db");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07003162 struct strbuf sb = STRBUF_INIT;
3163
David Turner6fb5acf2016-09-04 18:08:41 +02003164 /*
3165 * Create .git/refs/{heads,tags}
3166 */
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07003167 files_ref_path(refs, &sb, "refs/heads");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07003168 safe_create_dir(sb.buf, 1);
3169
3170 strbuf_reset(&sb);
Nguyễn Thái Ngọc Duy19e02f42017-03-26 09:42:23 +07003171 files_ref_path(refs, &sb, "refs/tags");
Nguyễn Thái Ngọc Duye9dcc302017-03-26 09:42:20 +07003172 safe_create_dir(sb.buf, 1);
3173
3174 strbuf_release(&sb);
David Turner6fb5acf2016-09-04 18:08:41 +02003175 return 0;
3176}
3177
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +02003178struct ref_storage_be refs_be_files = {
3179 NULL,
Michael Haggerty00eebe32016-09-04 18:08:11 +02003180 "files",
Ronnie Sahlberg127b42a2016-09-04 18:08:16 +02003181 files_ref_store_create,
David Turner6fb5acf2016-09-04 18:08:41 +02003182 files_init_db,
Michael Haggerty30173b82017-05-22 16:17:44 +02003183 files_transaction_prepare,
3184 files_transaction_finish,
3185 files_transaction_abort,
David Turnerfc681462016-09-04 18:08:39 +02003186 files_initial_transaction_commit,
Michael Haggertye1e33b72016-09-04 18:08:25 +02003187
Michael Haggerty82315272016-09-04 18:08:27 +02003188 files_pack_refs,
Michael Haggerty284689b2016-09-04 18:08:28 +02003189 files_create_symref,
David Turnera27dcf82016-09-04 18:08:40 +02003190 files_delete_refs,
David Turner9b6b40d2016-09-04 18:08:42 +02003191 files_rename_ref,
Sahil Dua52d59cc2017-06-18 23:19:16 +02003192 files_copy_ref,
Michael Haggerty82315272016-09-04 18:08:27 +02003193
Michael Haggerty1a769002016-09-04 18:08:37 +02003194 files_ref_iterator_begin,
Michael Haggerty62665822016-09-04 18:08:26 +02003195 files_read_raw_ref,
David Turnere3688bd2016-09-04 18:08:38 +02003196
3197 files_reflog_iterator_begin,
3198 files_for_each_reflog_ent,
3199 files_for_each_reflog_ent_reverse,
3200 files_reflog_exists,
3201 files_create_reflog,
3202 files_delete_reflog,
3203 files_reflog_expire
Ronnie Sahlberg3dce4442016-09-04 18:08:10 +02003204};