2 #include "repository.h"
9 void free_worktrees(struct worktree
**worktrees
)
13 for (i
= 0; worktrees
[i
]; i
++) {
14 free(worktrees
[i
]->path
);
15 free(worktrees
[i
]->id
);
16 free(worktrees
[i
]->head_ref
);
17 free(worktrees
[i
]->lock_reason
);
18 free(worktrees
[i
]->prune_reason
);
25 * Update head_oid, head_ref and is_detached of the given worktree
27 static void add_head_info(struct worktree
*wt
)
32 target
= refs_resolve_ref_unsafe(get_worktree_ref_store(wt
),
35 &wt
->head_oid
, &flags
);
39 if (flags
& REF_ISSYMREF
)
40 wt
->head_ref
= xstrdup(target
);
46 * get the main worktree
48 static struct worktree
*get_main_worktree(void)
50 struct worktree
*worktree
= NULL
;
51 struct strbuf worktree_path
= STRBUF_INIT
;
53 strbuf_add_real_path(&worktree_path
, get_git_common_dir());
54 strbuf_strip_suffix(&worktree_path
, "/.git");
56 CALLOC_ARRAY(worktree
, 1);
57 worktree
->path
= strbuf_detach(&worktree_path
, NULL
);
59 * NEEDSWORK: If this function is called from a secondary worktree and
60 * config.worktree is present, is_bare_repository_cfg will reflect the
61 * contents of config.worktree, not the contents of the main worktree.
62 * This means that worktree->is_bare may be set to 0 even if the main
63 * worktree is configured to be bare.
65 worktree
->is_bare
= (is_bare_repository_cfg
== 1) ||
67 add_head_info(worktree
);
71 static struct worktree
*get_linked_worktree(const char *id
)
73 struct worktree
*worktree
= NULL
;
74 struct strbuf path
= STRBUF_INIT
;
75 struct strbuf worktree_path
= STRBUF_INIT
;
78 die("Missing linked worktree name");
80 strbuf_git_common_path(&path
, the_repository
, "worktrees/%s/gitdir", id
);
81 if (strbuf_read_file(&worktree_path
, path
.buf
, 0) <= 0)
82 /* invalid gitdir file */
84 strbuf_rtrim(&worktree_path
);
85 strbuf_strip_suffix(&worktree_path
, "/.git");
87 CALLOC_ARRAY(worktree
, 1);
88 worktree
->path
= strbuf_detach(&worktree_path
, NULL
);
89 worktree
->id
= xstrdup(id
);
90 add_head_info(worktree
);
93 strbuf_release(&path
);
94 strbuf_release(&worktree_path
);
98 static void mark_current_worktree(struct worktree
**worktrees
)
100 char *git_dir
= absolute_pathdup(get_git_dir());
103 for (i
= 0; worktrees
[i
]; i
++) {
104 struct worktree
*wt
= worktrees
[i
];
105 const char *wt_git_dir
= get_worktree_git_dir(wt
);
107 if (!fspathcmp(git_dir
, absolute_path(wt_git_dir
))) {
115 struct worktree
**get_worktrees(void)
117 struct worktree
**list
= NULL
;
118 struct strbuf path
= STRBUF_INIT
;
121 int counter
= 0, alloc
= 2;
123 ALLOC_ARRAY(list
, alloc
);
125 list
[counter
++] = get_main_worktree();
127 strbuf_addf(&path
, "%s/worktrees", get_git_common_dir());
128 dir
= opendir(path
.buf
);
129 strbuf_release(&path
);
131 while ((d
= readdir_skip_dot_and_dotdot(dir
)) != NULL
) {
132 struct worktree
*linked
= NULL
;
134 if ((linked
= get_linked_worktree(d
->d_name
))) {
135 ALLOC_GROW(list
, counter
+ 1, alloc
);
136 list
[counter
++] = linked
;
141 ALLOC_GROW(list
, counter
+ 1, alloc
);
142 list
[counter
] = NULL
;
144 mark_current_worktree(list
);
148 const char *get_worktree_git_dir(const struct worktree
*wt
)
151 return get_git_dir();
153 return get_git_common_dir();
155 return git_common_path("worktrees/%s", wt
->id
);
158 static struct worktree
*find_worktree_by_suffix(struct worktree
**list
,
161 struct worktree
*found
= NULL
;
162 int nr_found
= 0, suffixlen
;
164 suffixlen
= strlen(suffix
);
168 for (; *list
&& nr_found
< 2; list
++) {
169 const char *path
= (*list
)->path
;
170 int pathlen
= strlen(path
);
171 int start
= pathlen
- suffixlen
;
173 /* suffix must start at directory boundary */
174 if ((!start
|| (start
> 0 && is_dir_sep(path
[start
- 1]))) &&
175 !fspathcmp(suffix
, path
+ start
)) {
180 return nr_found
== 1 ? found
: NULL
;
183 struct worktree
*find_worktree(struct worktree
**list
,
188 char *to_free
= NULL
;
190 if ((wt
= find_worktree_by_suffix(list
, arg
)))
194 arg
= to_free
= prefix_filename(prefix
, arg
);
195 wt
= find_worktree_by_path(list
, arg
);
200 struct worktree
*find_worktree_by_path(struct worktree
**list
, const char *p
)
202 struct strbuf wt_path
= STRBUF_INIT
;
203 char *path
= real_pathdup(p
, 0);
207 for (; *list
; list
++) {
208 if (!strbuf_realpath(&wt_path
, (*list
)->path
, 0))
211 if (!fspathcmp(path
, wt_path
.buf
))
215 strbuf_release(&wt_path
);
219 int is_main_worktree(const struct worktree
*wt
)
224 const char *worktree_lock_reason(struct worktree
*wt
)
226 if (is_main_worktree(wt
))
229 if (!wt
->lock_reason_valid
) {
230 struct strbuf path
= STRBUF_INIT
;
232 strbuf_addstr(&path
, worktree_git_path(wt
, "locked"));
233 if (file_exists(path
.buf
)) {
234 struct strbuf lock_reason
= STRBUF_INIT
;
235 if (strbuf_read_file(&lock_reason
, path
.buf
, 0) < 0)
236 die_errno(_("failed to read '%s'"), path
.buf
);
237 strbuf_trim(&lock_reason
);
238 wt
->lock_reason
= strbuf_detach(&lock_reason
, NULL
);
240 wt
->lock_reason
= NULL
;
241 wt
->lock_reason_valid
= 1;
242 strbuf_release(&path
);
245 return wt
->lock_reason
;
248 const char *worktree_prune_reason(struct worktree
*wt
, timestamp_t expire
)
250 struct strbuf reason
= STRBUF_INIT
;
253 if (is_main_worktree(wt
))
255 if (wt
->prune_reason_valid
)
256 return wt
->prune_reason
;
258 if (should_prune_worktree(wt
->id
, &reason
, &path
, expire
))
259 wt
->prune_reason
= strbuf_detach(&reason
, NULL
);
260 wt
->prune_reason_valid
= 1;
262 strbuf_release(&reason
);
264 return wt
->prune_reason
;
267 /* convenient wrapper to deal with NULL strbuf */
268 __attribute__((format (printf
, 2, 3)))
269 static void strbuf_addf_gently(struct strbuf
*buf
, const char *fmt
, ...)
276 va_start(params
, fmt
);
277 strbuf_vaddf(buf
, fmt
, params
);
281 int validate_worktree(const struct worktree
*wt
, struct strbuf
*errmsg
,
284 struct strbuf wt_path
= STRBUF_INIT
;
285 struct strbuf realpath
= STRBUF_INIT
;
289 strbuf_addf(&wt_path
, "%s/.git", wt
->path
);
291 if (is_main_worktree(wt
)) {
292 if (is_directory(wt_path
.buf
)) {
297 * Main worktree using .git file to point to the
298 * repository would make it impossible to know where
299 * the actual worktree is if this function is executed
300 * from another worktree. No .git file support for now.
302 strbuf_addf_gently(errmsg
,
303 _("'%s' at main working tree is not the repository directory"),
309 * Make sure "gitdir" file points to a real .git file and that
310 * file points back here.
312 if (!is_absolute_path(wt
->path
)) {
313 strbuf_addf_gently(errmsg
,
314 _("'%s' file does not contain absolute path to the working tree location"),
315 git_common_path("worktrees/%s/gitdir", wt
->id
));
319 if (flags
& WT_VALIDATE_WORKTREE_MISSING_OK
&&
320 !file_exists(wt
->path
)) {
325 if (!file_exists(wt_path
.buf
)) {
326 strbuf_addf_gently(errmsg
, _("'%s' does not exist"), wt_path
.buf
);
330 path
= xstrdup_or_null(read_gitfile_gently(wt_path
.buf
, &err
));
332 strbuf_addf_gently(errmsg
, _("'%s' is not a .git file, error code %d"),
337 strbuf_realpath(&realpath
, git_common_path("worktrees/%s", wt
->id
), 1);
338 ret
= fspathcmp(path
, realpath
.buf
);
341 strbuf_addf_gently(errmsg
, _("'%s' does not point back to '%s'"),
342 wt
->path
, git_common_path("worktrees/%s", wt
->id
));
345 strbuf_release(&wt_path
);
346 strbuf_release(&realpath
);
350 void update_worktree_location(struct worktree
*wt
, const char *path_
)
352 struct strbuf path
= STRBUF_INIT
;
354 if (is_main_worktree(wt
))
355 BUG("can't relocate main worktree");
357 strbuf_realpath(&path
, path_
, 1);
358 if (fspathcmp(wt
->path
, path
.buf
)) {
359 write_file(git_common_path("worktrees/%s/gitdir", wt
->id
),
360 "%s/.git", path
.buf
);
362 wt
->path
= strbuf_detach(&path
, NULL
);
364 strbuf_release(&path
);
367 int is_worktree_being_rebased(const struct worktree
*wt
,
370 struct wt_status_state state
;
373 memset(&state
, 0, sizeof(state
));
374 found_rebase
= wt_status_check_rebase(wt
, &state
) &&
375 (state
.rebase_in_progress
||
376 state
.rebase_interactive_in_progress
) &&
378 skip_prefix(target
, "refs/heads/", &target
) &&
379 !strcmp(state
.branch
, target
);
380 wt_status_state_free_buffers(&state
);
384 int is_worktree_being_bisected(const struct worktree
*wt
,
387 struct wt_status_state state
;
390 memset(&state
, 0, sizeof(state
));
391 found_bisect
= wt_status_check_bisect(wt
, &state
) &&
393 skip_prefix(target
, "refs/heads/", &target
) &&
394 !strcmp(state
.branch
, target
);
395 wt_status_state_free_buffers(&state
);
400 * note: this function should be able to detect shared symref even if
401 * HEAD is temporarily detached (e.g. in the middle of rebase or
402 * bisect). New commands that do similar things should update this
405 const struct worktree
*find_shared_symref(struct worktree
**worktrees
,
409 const struct worktree
*existing
= NULL
;
412 for (i
= 0; worktrees
[i
]; i
++) {
413 struct worktree
*wt
= worktrees
[i
];
414 const char *symref_target
;
415 struct ref_store
*refs
;
421 if (wt
->is_detached
&& !strcmp(symref
, "HEAD")) {
422 if (is_worktree_being_rebased(wt
, target
)) {
426 if (is_worktree_being_bisected(wt
, target
)) {
432 refs
= get_worktree_ref_store(wt
);
433 symref_target
= refs_resolve_ref_unsafe(refs
, symref
, 0,
435 if ((flags
& REF_ISSYMREF
) &&
436 symref_target
&& !strcmp(symref_target
, target
)) {
445 int submodule_uses_worktrees(const char *path
)
447 char *submodule_gitdir
;
448 struct strbuf sb
= STRBUF_INIT
, err
= STRBUF_INIT
;
452 struct repository_format format
= REPOSITORY_FORMAT_INIT
;
454 submodule_gitdir
= git_pathdup_submodule(path
, "%s", "");
455 if (!submodule_gitdir
)
458 /* The env would be set for the superproject. */
459 get_common_dir_noenv(&sb
, submodule_gitdir
);
460 free(submodule_gitdir
);
462 strbuf_addstr(&sb
, "/config");
463 read_repository_format(&format
, sb
.buf
);
464 if (verify_repository_format(&format
, &err
)) {
465 strbuf_release(&err
);
467 clear_repository_format(&format
);
470 clear_repository_format(&format
);
471 strbuf_release(&err
);
473 /* Replace config by worktrees. */
474 strbuf_setlen(&sb
, sb
.len
- strlen("config"));
475 strbuf_addstr(&sb
, "worktrees");
477 /* See if there is any file inside the worktrees directory. */
478 dir
= opendir(sb
.buf
);
484 d
= readdir_skip_dot_and_dotdot(dir
);
491 int parse_worktree_ref(const char *worktree_ref
, const char **name
,
492 int *name_length
, const char **ref
)
494 if (skip_prefix(worktree_ref
, "main-worktree/", &worktree_ref
)) {
505 if (skip_prefix(worktree_ref
, "worktrees/", &worktree_ref
)) {
506 const char *slash
= strchr(worktree_ref
, '/');
508 if (!slash
|| slash
== worktree_ref
|| !slash
[1])
511 *name
= worktree_ref
;
513 *name_length
= slash
- worktree_ref
;
521 void strbuf_worktree_ref(const struct worktree
*wt
,
525 switch (ref_type(refname
)) {
526 case REF_TYPE_PSEUDOREF
:
527 case REF_TYPE_PER_WORKTREE
:
528 if (wt
&& !wt
->is_current
) {
529 if (is_main_worktree(wt
))
530 strbuf_addstr(sb
, "main-worktree/");
532 strbuf_addf(sb
, "worktrees/%s/", wt
->id
);
536 case REF_TYPE_MAIN_PSEUDOREF
:
537 case REF_TYPE_OTHER_PSEUDOREF
:
540 case REF_TYPE_NORMAL
:
542 * For shared refs, don't prefix worktrees/ or
543 * main-worktree/. It's not necessary and
544 * files-backend.c can't handle it anyway.
548 strbuf_addstr(sb
, refname
);
551 int other_head_refs(each_ref_fn fn
, void *cb_data
)
553 struct worktree
**worktrees
, **p
;
554 struct strbuf refname
= STRBUF_INIT
;
557 worktrees
= get_worktrees();
558 for (p
= worktrees
; *p
; p
++) {
559 struct worktree
*wt
= *p
;
560 struct object_id oid
;
566 strbuf_reset(&refname
);
567 strbuf_worktree_ref(wt
, &refname
, "HEAD");
568 if (refs_resolve_ref_unsafe(get_main_ref_store(the_repository
),
572 ret
= fn(refname
.buf
, &oid
, flag
, cb_data
);
576 free_worktrees(worktrees
);
577 strbuf_release(&refname
);
582 * Repair worktree's /path/to/worktree/.git file if missing, corrupt, or not
583 * pointing at <repo>/worktrees/<id>.
585 static void repair_gitfile(struct worktree
*wt
,
586 worktree_repair_fn fn
, void *cb_data
)
588 struct strbuf dotgit
= STRBUF_INIT
;
589 struct strbuf repo
= STRBUF_INIT
;
591 const char *repair
= NULL
;
594 /* missing worktree can't be repaired */
595 if (!file_exists(wt
->path
))
598 if (!is_directory(wt
->path
)) {
599 fn(1, wt
->path
, _("not a directory"), cb_data
);
603 strbuf_realpath(&repo
, git_common_path("worktrees/%s", wt
->id
), 1);
604 strbuf_addf(&dotgit
, "%s/.git", wt
->path
);
605 backlink
= xstrdup_or_null(read_gitfile_gently(dotgit
.buf
, &err
));
607 if (err
== READ_GITFILE_ERR_NOT_A_FILE
)
608 fn(1, wt
->path
, _(".git is not a file"), cb_data
);
610 repair
= _(".git file broken");
611 else if (fspathcmp(backlink
, repo
.buf
))
612 repair
= _(".git file incorrect");
615 fn(0, wt
->path
, repair
, cb_data
);
616 write_file(dotgit
.buf
, "gitdir: %s", repo
.buf
);
620 strbuf_release(&repo
);
621 strbuf_release(&dotgit
);
624 static void repair_noop(int iserr
, const char *path
, const char *msg
,
630 void repair_worktrees(worktree_repair_fn fn
, void *cb_data
)
632 struct worktree
**worktrees
= get_worktrees();
633 struct worktree
**wt
= worktrees
+ 1; /* +1 skips main worktree */
638 repair_gitfile(*wt
, fn
, cb_data
);
639 free_worktrees(worktrees
);
642 static int is_main_worktree_path(const char *path
)
644 struct strbuf target
= STRBUF_INIT
;
645 struct strbuf maindir
= STRBUF_INIT
;
648 strbuf_add_real_path(&target
, path
);
649 strbuf_strip_suffix(&target
, "/.git");
650 strbuf_add_real_path(&maindir
, get_git_common_dir());
651 strbuf_strip_suffix(&maindir
, "/.git");
652 cmp
= fspathcmp(maindir
.buf
, target
.buf
);
654 strbuf_release(&maindir
);
655 strbuf_release(&target
);
660 * If both the main worktree and linked worktree have been moved, then the
661 * gitfile /path/to/worktree/.git won't point into the repository, thus we
662 * won't know which <repo>/worktrees/<id>/gitdir to repair. However, we may
663 * be able to infer the gitdir by manually reading /path/to/worktree/.git,
664 * extracting the <id>, and checking if <repo>/worktrees/<id> exists.
666 static char *infer_backlink(const char *gitfile
)
668 struct strbuf actual
= STRBUF_INIT
;
669 struct strbuf inferred
= STRBUF_INIT
;
672 if (strbuf_read_file(&actual
, gitfile
, 0) < 0)
674 if (!starts_with(actual
.buf
, "gitdir:"))
676 if (!(id
= find_last_dir_sep(actual
.buf
)))
678 strbuf_trim(&actual
);
679 id
++; /* advance past '/' to point at <id> */
682 strbuf_git_common_path(&inferred
, the_repository
, "worktrees/%s", id
);
683 if (!is_directory(inferred
.buf
))
686 strbuf_release(&actual
);
687 return strbuf_detach(&inferred
, NULL
);
690 strbuf_release(&actual
);
691 strbuf_release(&inferred
);
696 * Repair <repo>/worktrees/<id>/gitdir if missing, corrupt, or not pointing at
697 * the worktree's path.
699 void repair_worktree_at_path(const char *path
,
700 worktree_repair_fn fn
, void *cb_data
)
702 struct strbuf dotgit
= STRBUF_INIT
;
703 struct strbuf realdotgit
= STRBUF_INIT
;
704 struct strbuf gitdir
= STRBUF_INIT
;
705 struct strbuf olddotgit
= STRBUF_INIT
;
706 char *backlink
= NULL
;
707 const char *repair
= NULL
;
713 if (is_main_worktree_path(path
))
716 strbuf_addf(&dotgit
, "%s/.git", path
);
717 if (!strbuf_realpath(&realdotgit
, dotgit
.buf
, 0)) {
718 fn(1, path
, _("not a valid path"), cb_data
);
722 backlink
= xstrdup_or_null(read_gitfile_gently(realdotgit
.buf
, &err
));
723 if (err
== READ_GITFILE_ERR_NOT_A_FILE
) {
724 fn(1, realdotgit
.buf
, _("unable to locate repository; .git is not a file"), cb_data
);
726 } else if (err
== READ_GITFILE_ERR_NOT_A_REPO
) {
727 if (!(backlink
= infer_backlink(realdotgit
.buf
))) {
728 fn(1, realdotgit
.buf
, _("unable to locate repository; .git file does not reference a repository"), cb_data
);
732 fn(1, realdotgit
.buf
, _("unable to locate repository; .git file broken"), cb_data
);
736 strbuf_addf(&gitdir
, "%s/gitdir", backlink
);
737 if (strbuf_read_file(&olddotgit
, gitdir
.buf
, 0) < 0)
738 repair
= _("gitdir unreadable");
740 strbuf_rtrim(&olddotgit
);
741 if (fspathcmp(olddotgit
.buf
, realdotgit
.buf
))
742 repair
= _("gitdir incorrect");
746 fn(0, gitdir
.buf
, repair
, cb_data
);
747 write_file(gitdir
.buf
, "%s", realdotgit
.buf
);
751 strbuf_release(&olddotgit
);
752 strbuf_release(&gitdir
);
753 strbuf_release(&realdotgit
);
754 strbuf_release(&dotgit
);
757 int should_prune_worktree(const char *id
, struct strbuf
*reason
, char **wtpath
, timestamp_t expire
)
766 if (!is_directory(git_path("worktrees/%s", id
))) {
767 strbuf_addstr(reason
, _("not a valid directory"));
770 if (file_exists(git_path("worktrees/%s/locked", id
)))
772 if (stat(git_path("worktrees/%s/gitdir", id
), &st
)) {
773 strbuf_addstr(reason
, _("gitdir file does not exist"));
776 fd
= open(git_path("worktrees/%s/gitdir", id
), O_RDONLY
);
778 strbuf_addf(reason
, _("unable to read gitdir file (%s)"),
782 len
= xsize_t(st
.st_size
);
783 path
= xmallocz(len
);
785 read_result
= read_in_full(fd
, path
, len
);
786 if (read_result
< 0) {
787 strbuf_addf(reason
, _("unable to read gitdir file (%s)"),
795 if (read_result
!= len
) {
797 _("short read (expected %"PRIuMAX
" bytes, read %"PRIuMAX
")"),
798 (uintmax_t)len
, (uintmax_t)read_result
);
802 while (len
&& (path
[len
- 1] == '\n' || path
[len
- 1] == '\r'))
805 strbuf_addstr(reason
, _("invalid gitdir file"));
810 if (!file_exists(path
)) {
811 if (stat(git_path("worktrees/%s/index", id
), &st
) ||
812 st
.st_mtime
<= expire
) {
813 strbuf_addstr(reason
, _("gitdir file points to non-existent location"));