worktree.c

   1 #include "cache.h"
   2 #include "repository.h"
   3 #include "refs.h"
   4 #include "strbuf.h"
   5 #include "worktree.h"
   6 #include "dir.h"
   7 #include "wt-status.h"
   8
   9 void free_worktrees(struct worktree **worktrees)
  10 {
  11         int i = 0;
  12
  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]);
  19         }
  20         free (worktrees);
  21 }
  22
  23 /**
  24  * Update head_sha1, head_ref and is_detached of the given worktree
  25  */
  26 static void add_head_info(struct worktree *wt)
  27 {
  28         int flags;
  29         const char *target;
  30
  31         target = refs_resolve_ref_unsafe(get_worktree_ref_store(wt),
  32                                          "HEAD",
  33                                          0,
  34                                          &wt->head_oid, &flags);
  35         if (!target)
  36                 return;
  37
  38         if (flags & REF_ISSYMREF)
  39                 wt->head_ref = xstrdup(target);
  40         else
  41                 wt->is_detached = 1;
  42 }
  43
  44 /**
  45  * get the main worktree
  46  */
  47 static struct worktree *get_main_worktree(void)
  48 {
  49         struct worktree *worktree = NULL;
  50         struct strbuf path = STRBUF_INIT;
  51         struct strbuf worktree_path = STRBUF_INIT;
  52         int is_bare = 0;
  53
  54         strbuf_add_absolute_path(&worktree_path, get_git_common_dir());
  55         is_bare = !strbuf_strip_suffix(&worktree_path, "/.git");
  56         if (is_bare)
  57                 strbuf_strip_suffix(&worktree_path, "/.");
  58
  59         strbuf_addf(&path, "%s/HEAD", get_git_common_dir());
  60
  61         worktree = xcalloc(1, sizeof(*worktree));
  62         worktree->path = strbuf_detach(&worktree_path, NULL);
  63         worktree->is_bare = is_bare;
  64         add_head_info(worktree);
  65
  66         strbuf_release(&path);
  67         strbuf_release(&worktree_path);
  68         return worktree;
  69 }
  70
  71 static struct worktree *get_linked_worktree(const char *id)
  72 {
  73         struct worktree *worktree = NULL;
  74         struct strbuf path = STRBUF_INIT;
  75         struct strbuf worktree_path = STRBUF_INIT;
  76
  77         if (!id)
  78                 die("Missing linked worktree name");
  79
  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 */
  83                 goto done;
  84
  85         strbuf_rtrim(&worktree_path);
  86         if (!strbuf_strip_suffix(&worktree_path, "/.git")) {
  87                 strbuf_reset(&worktree_path);
  88                 strbuf_add_absolute_path(&worktree_path, ".");
  89                 strbuf_strip_suffix(&worktree_path, "/.");
  90         }
  91
  92         strbuf_reset(&path);
  93         strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
  94
  95         worktree = xcalloc(1, sizeof(*worktree));
  96         worktree->path = strbuf_detach(&worktree_path, NULL);
  97         worktree->id = xstrdup(id);
  98         add_head_info(worktree);
  99
 100 done:
 101         strbuf_release(&path);
 102         strbuf_release(&worktree_path);
 103         return worktree;
 104 }
 105
 106 static void mark_current_worktree(struct worktree **worktrees)
 107 {
 108         char *git_dir = absolute_pathdup(get_git_dir());
 109         int i;
 110
 111         for (i = 0; worktrees[i]; i++) {
 112                 struct worktree *wt = worktrees[i];
 113                 const char *wt_git_dir = get_worktree_git_dir(wt);
 114
 115                 if (!fspathcmp(git_dir, absolute_path(wt_git_dir))) {
 116                         wt->is_current = 1;
 117                         break;
 118                 }
 119         }
 120         free(git_dir);
 121 }
 122
 123 static int compare_worktree(const void *a_, const void *b_)
 124 {
 125         const struct worktree *const *a = a_;
 126         const struct worktree *const *b = b_;
 127         return fspathcmp((*a)->path, (*b)->path);
 128 }
 129
 130 struct worktree **get_worktrees(unsigned flags)
 131 {
 132         struct worktree **list = NULL;
 133         struct strbuf path = STRBUF_INIT;
 134         DIR *dir;
 135         struct dirent *d;
 136         int counter = 0, alloc = 2;
 137
 138         ALLOC_ARRAY(list, alloc);
 139
 140         list[counter++] = get_main_worktree();
 141
 142         strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
 143         dir = opendir(path.buf);
 144         strbuf_release(&path);
 145         if (dir) {
 146                 while ((d = readdir(dir)) != NULL) {
 147                         struct worktree *linked = NULL;
 148                         if (is_dot_or_dotdot(d->d_name))
 149                                 continue;
 150
 151                         if ((linked = get_linked_worktree(d->d_name))) {
 152                                 ALLOC_GROW(list, counter + 1, alloc);
 153                                 list[counter++] = linked;
 154                         }
 155                 }
 156                 closedir(dir);
 157         }
 158         ALLOC_GROW(list, counter + 1, alloc);
 159         list[counter] = NULL;
 160
 161         if (flags & GWT_SORT_LINKED)
 162                 /*
 163                  * don't sort the first item (main worktree), which will
 164                  * always be the first
 165                  */
 166                 QSORT(list + 1, counter - 1, compare_worktree);
 167
 168         mark_current_worktree(list);
 169         return list;
 170 }
 171
 172 const char *get_worktree_git_dir(const struct worktree *wt)
 173 {
 174         if (!wt)
 175                 return get_git_dir();
 176         else if (!wt->id)
 177                 return get_git_common_dir();
 178         else
 179                 return git_common_path("worktrees/%s", wt->id);
 180 }
 181
 182 static struct worktree *find_worktree_by_suffix(struct worktree **list,
 183                                                 const char *suffix)
 184 {
 185         struct worktree *found = NULL;
 186         int nr_found = 0, suffixlen;
 187
 188         suffixlen = strlen(suffix);
 189         if (!suffixlen)
 190                 return NULL;
 191
 192         for (; *list && nr_found < 2; list++) {
 193                 const char      *path    = (*list)->path;
 194                 int              pathlen = strlen(path);
 195                 int              start   = pathlen - suffixlen;
 196
 197                 /* suffix must start at directory boundary */
 198                 if ((!start || (start > 0 && is_dir_sep(path[start - 1]))) &&
 199                     !fspathcmp(suffix, path + start)) {
 200                         found = *list;
 201                         nr_found++;
 202                 }
 203         }
 204         return nr_found == 1 ? found : NULL;
 205 }
 206
 207 struct worktree *find_worktree(struct worktree **list,
 208                                const char *prefix,
 209                                const char *arg)
 210 {
 211         struct worktree *wt;
 212         char *path;
 213         char *to_free = NULL;
 214
 215         if ((wt = find_worktree_by_suffix(list, arg)))
 216                 return wt;
 217
 218         if (prefix)
 219                 arg = to_free = prefix_filename(prefix, arg);
 220         path = real_pathdup(arg, 1);
 221         for (; *list; list++)
 222                 if (!fspathcmp(path, real_path((*list)->path)))
 223                         break;
 224         free(path);
 225         free(to_free);
 226         return *list;
 227 }
 228
 229 int is_main_worktree(const struct worktree *wt)
 230 {
 231         return !wt->id;
 232 }
 233
 234 const char *is_worktree_locked(struct worktree *wt)
 235 {
 236         assert(!is_main_worktree(wt));
 237
 238         if (!wt->lock_reason_valid) {
 239                 struct strbuf path = STRBUF_INIT;
 240
 241                 strbuf_addstr(&path, worktree_git_path(wt, "locked"));
 242                 if (file_exists(path.buf)) {
 243                         struct strbuf lock_reason = STRBUF_INIT;
 244                         if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
 245                                 die_errno(_("failed to read '%s'"), path.buf);
 246                         strbuf_trim(&lock_reason);
 247                         wt->lock_reason = strbuf_detach(&lock_reason, NULL);
 248                 } else
 249                         wt->lock_reason = NULL;
 250                 wt->lock_reason_valid = 1;
 251                 strbuf_release(&path);
 252         }
 253
 254         return wt->lock_reason;
 255 }
 256
 257 /* convenient wrapper to deal with NULL strbuf */
 258 static void strbuf_addf_gently(struct strbuf *buf, const char *fmt, ...)
 259 {
 260         va_list params;
 261
 262         if (!buf)
 263                 return;
 264
 265         va_start(params, fmt);
 266         strbuf_vaddf(buf, fmt, params);
 267         va_end(params);
 268 }
 269
 270 int validate_worktree(const struct worktree *wt, struct strbuf *errmsg,
 271                       unsigned flags)
 272 {
 273         struct strbuf wt_path = STRBUF_INIT;
 274         char *path = NULL;
 275         int err, ret = -1;
 276
 277         strbuf_addf(&wt_path, "%s/.git", wt->path);
 278
 279         if (is_main_worktree(wt)) {
 280                 if (is_directory(wt_path.buf)) {
 281                         ret = 0;
 282                         goto done;
 283                 }
 284                 /*
 285                  * Main worktree using .git file to point to the
 286                  * repository would make it impossible to know where
 287                  * the actual worktree is if this function is executed
 288                  * from another worktree. No .git file support for now.
 289                  */
 290                 strbuf_addf_gently(errmsg,
 291                                    _("'%s' at main working tree is not the repository directory"),
 292                                    wt_path.buf);
 293                 goto done;
 294         }
 295
 296         /*
 297          * Make sure "gitdir" file points to a real .git file and that
 298          * file points back here.
 299          */
 300         if (!is_absolute_path(wt->path)) {
 301                 strbuf_addf_gently(errmsg,
 302                                    _("'%s' file does not contain absolute path to the working tree location"),
 303                                    git_common_path("worktrees/%s/gitdir", wt->id));
 304                 goto done;
 305         }
 306
 307         if (flags & WT_VALIDATE_WORKTREE_MISSING_OK &&
 308             !file_exists(wt->path)) {
 309                 ret = 0;
 310                 goto done;
 311         }
 312
 313         if (!file_exists(wt_path.buf)) {
 314                 strbuf_addf_gently(errmsg, _("'%s' does not exist"), wt_path.buf);
 315                 goto done;
 316         }
 317
 318         path = xstrdup_or_null(read_gitfile_gently(wt_path.buf, &err));
 319         if (!path) {
 320                 strbuf_addf_gently(errmsg, _("'%s' is not a .git file, error code %d"),
 321                                    wt_path.buf, err);
 322                 goto done;
 323         }
 324
 325         ret = fspathcmp(path, real_path(git_common_path("worktrees/%s", wt->id)));
 326
 327         if (ret)
 328                 strbuf_addf_gently(errmsg, _("'%s' does not point back to '%s'"),
 329                                    wt->path, git_common_path("worktrees/%s", wt->id));
 330 done:
 331         free(path);
 332         strbuf_release(&wt_path);
 333         return ret;
 334 }
 335
 336 void update_worktree_location(struct worktree *wt, const char *path_)
 337 {
 338         struct strbuf path = STRBUF_INIT;
 339
 340         if (is_main_worktree(wt))
 341                 die("BUG: can't relocate main worktree");
 342
 343         strbuf_realpath(&path, path_, 1);
 344         if (fspathcmp(wt->path, path.buf)) {
 345                 write_file(git_common_path("worktrees/%s/gitdir", wt->id),
 346                            "%s/.git", path.buf);
 347                 free(wt->path);
 348                 wt->path = strbuf_detach(&path, NULL);
 349         }
 350         strbuf_release(&path);
 351 }
 352
 353 int is_worktree_being_rebased(const struct worktree *wt,
 354                               const char *target)
 355 {
 356         struct wt_status_state state;
 357         int found_rebase;
 358
 359         memset(&state, 0, sizeof(state));
 360         found_rebase = wt_status_check_rebase(wt, &state) &&
 361                 ((state.rebase_in_progress ||
 362                   state.rebase_interactive_in_progress) &&
 363                  state.branch &&
 364                  starts_with(target, "refs/heads/") &&
 365                  !strcmp(state.branch, target + strlen("refs/heads/")));
 366         free(state.branch);
 367         free(state.onto);
 368         return found_rebase;
 369 }
 370
 371 int is_worktree_being_bisected(const struct worktree *wt,
 372                                const char *target)
 373 {
 374         struct wt_status_state state;
 375         int found_rebase;
 376
 377         memset(&state, 0, sizeof(state));
 378         found_rebase = wt_status_check_bisect(wt, &state) &&
 379                 state.branch &&
 380                 starts_with(target, "refs/heads/") &&
 381                 !strcmp(state.branch, target + strlen("refs/heads/"));
 382         free(state.branch);
 383         return found_rebase;
 384 }
 385
 386 /*
 387  * note: this function should be able to detect shared symref even if
 388  * HEAD is temporarily detached (e.g. in the middle of rebase or
 389  * bisect). New commands that do similar things should update this
 390  * function as well.
 391  */
 392 const struct worktree *find_shared_symref(const char *symref,
 393                                           const char *target)
 394 {
 395         const struct worktree *existing = NULL;
 396         static struct worktree **worktrees;
 397         int i = 0;
 398
 399         if (worktrees)
 400                 free_worktrees(worktrees);
 401         worktrees = get_worktrees(0);
 402
 403         for (i = 0; worktrees[i]; i++) {
 404                 struct worktree *wt = worktrees[i];
 405                 const char *symref_target;
 406                 struct ref_store *refs;
 407                 int flags;
 408
 409                 if (wt->is_bare)
 410                         continue;
 411
 412                 if (wt->is_detached && !strcmp(symref, "HEAD")) {
 413                         if (is_worktree_being_rebased(wt, target)) {
 414                                 existing = wt;
 415                                 break;
 416                         }
 417                         if (is_worktree_being_bisected(wt, target)) {
 418                                 existing = wt;
 419                                 break;
 420                         }
 421                 }
 422
 423                 refs = get_worktree_ref_store(wt);
 424                 symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
 425                                                         NULL, &flags);
 426                 if ((flags & REF_ISSYMREF) &&
 427                     symref_target && !strcmp(symref_target, target)) {
 428                         existing = wt;
 429                         break;
 430                 }
 431         }
 432
 433         return existing;
 434 }
 435
 436 int submodule_uses_worktrees(const char *path)
 437 {
 438         char *submodule_gitdir;
 439         struct strbuf sb = STRBUF_INIT;
 440         DIR *dir;
 441         struct dirent *d;
 442         int ret = 0;
 443         struct repository_format format;
 444
 445         submodule_gitdir = git_pathdup_submodule(path, "%s", "");
 446         if (!submodule_gitdir)
 447                 return 0;
 448
 449         /* The env would be set for the superproject. */
 450         get_common_dir_noenv(&sb, submodule_gitdir);
 451         free(submodule_gitdir);
 452
 453         /*
 454          * The check below is only known to be good for repository format
 455          * version 0 at the time of writing this code.
 456          */
 457         strbuf_addstr(&sb, "/config");
 458         read_repository_format(&format, sb.buf);
 459         if (format.version != 0) {
 460                 strbuf_release(&sb);
 461                 return 1;
 462         }
 463
 464         /* Replace config by worktrees. */
 465         strbuf_setlen(&sb, sb.len - strlen("config"));
 466         strbuf_addstr(&sb, "worktrees");
 467
 468         /* See if there is any file inside the worktrees directory. */
 469         dir = opendir(sb.buf);
 470         strbuf_release(&sb);
 471
 472         if (!dir)
 473                 return 0;
 474
 475         while ((d = readdir(dir)) != NULL) {
 476                 if (is_dot_or_dotdot(d->d_name))
 477                         continue;
 478
 479                 ret = 1;
 480                 break;
 481         }
 482         closedir(dir);
 483         return ret;
 484 }
 485
 486 int other_head_refs(each_ref_fn fn, void *cb_data)
 487 {
 488         struct worktree **worktrees, **p;
 489         int ret = 0;
 490
 491         worktrees = get_worktrees(0);
 492         for (p = worktrees; *p; p++) {
 493                 struct worktree *wt = *p;
 494                 struct ref_store *refs;
 495
 496                 if (wt->is_current)
 497                         continue;
 498
 499                 refs = get_worktree_ref_store(wt);
 500                 ret = refs_head_ref(refs, fn, cb_data);
 501                 if (ret)
 502                         break;
 503         }
 504         free_worktrees(worktrees);
 505         return ret;
 506 }