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 worktree_path = STRBUF_INIT;
  51
  52         strbuf_add_absolute_path(&worktree_path, get_git_common_dir());
  53         strbuf_strip_suffix(&worktree_path, "/.");
  54         if (!strbuf_strip_suffix(&worktree_path, "/.git"))
  55                 strbuf_strip_suffix(&worktree_path, "/.");
  56
  57         worktree = xcalloc(1, sizeof(*worktree));
  58         worktree->path = strbuf_detach(&worktree_path, NULL);
  59         /*
  60          * NEEDSWORK: If this function is called from a secondary worktree and
  61          * config.worktree is present, is_bare_repository_cfg will reflect the
  62          * contents of config.worktree, not the contents of the main worktree.
  63          * This means that worktree->is_bare may be set to 0 even if the main
  64          * worktree is configured to be bare.
  65          */
  66         worktree->is_bare = (is_bare_repository_cfg == 1) ||
  67                 is_bare_repository();
  68         add_head_info(worktree);
  69
  70         strbuf_release(&worktree_path);
  71         return worktree;
  72 }
  73
  74 static struct worktree *get_linked_worktree(const char *id)
  75 {
  76         struct worktree *worktree = NULL;
  77         struct strbuf path = STRBUF_INIT;
  78         struct strbuf worktree_path = STRBUF_INIT;
  79
  80         if (!id)
  81                 die("Missing linked worktree name");
  82
  83         strbuf_git_common_path(&path, the_repository, "worktrees/%s/gitdir", id);
  84         if (strbuf_read_file(&worktree_path, path.buf, 0) <= 0)
  85                 /* invalid gitdir file */
  86                 goto done;
  87
  88         strbuf_rtrim(&worktree_path);
  89         if (!strbuf_strip_suffix(&worktree_path, "/.git")) {
  90                 strbuf_reset(&worktree_path);
  91                 strbuf_add_absolute_path(&worktree_path, ".");
  92                 strbuf_strip_suffix(&worktree_path, "/.");
  93         }
  94
  95         strbuf_reset(&path);
  96         strbuf_addf(&path, "%s/worktrees/%s/HEAD", get_git_common_dir(), id);
  97
  98         worktree = xcalloc(1, sizeof(*worktree));
  99         worktree->path = strbuf_detach(&worktree_path, NULL);
 100         worktree->id = xstrdup(id);
 101         add_head_info(worktree);
 102
 103 done:
 104         strbuf_release(&path);
 105         strbuf_release(&worktree_path);
 106         return worktree;
 107 }
 108
 109 static void mark_current_worktree(struct worktree **worktrees)
 110 {
 111         char *git_dir = absolute_pathdup(get_git_dir());
 112         int i;
 113
 114         for (i = 0; worktrees[i]; i++) {
 115                 struct worktree *wt = worktrees[i];
 116                 const char *wt_git_dir = get_worktree_git_dir(wt);
 117
 118                 if (!fspathcmp(git_dir, absolute_path(wt_git_dir))) {
 119                         wt->is_current = 1;
 120                         break;
 121                 }
 122         }
 123         free(git_dir);
 124 }
 125
 126 static int compare_worktree(const void *a_, const void *b_)
 127 {
 128         const struct worktree *const *a = a_;
 129         const struct worktree *const *b = b_;
 130         return fspathcmp((*a)->path, (*b)->path);
 131 }
 132
 133 struct worktree **get_worktrees(unsigned flags)
 134 {
 135         struct worktree **list = NULL;
 136         struct strbuf path = STRBUF_INIT;
 137         DIR *dir;
 138         struct dirent *d;
 139         int counter = 0, alloc = 2;
 140
 141         ALLOC_ARRAY(list, alloc);
 142
 143         list[counter++] = get_main_worktree();
 144
 145         strbuf_addf(&path, "%s/worktrees", get_git_common_dir());
 146         dir = opendir(path.buf);
 147         strbuf_release(&path);
 148         if (dir) {
 149                 while ((d = readdir(dir)) != NULL) {
 150                         struct worktree *linked = NULL;
 151                         if (is_dot_or_dotdot(d->d_name))
 152                                 continue;
 153
 154                         if ((linked = get_linked_worktree(d->d_name))) {
 155                                 ALLOC_GROW(list, counter + 1, alloc);
 156                                 list[counter++] = linked;
 157                         }
 158                 }
 159                 closedir(dir);
 160         }
 161         ALLOC_GROW(list, counter + 1, alloc);
 162         list[counter] = NULL;
 163
 164         if (flags & GWT_SORT_LINKED)
 165                 /*
 166                  * don't sort the first item (main worktree), which will
 167                  * always be the first
 168                  */
 169                 QSORT(list + 1, counter - 1, compare_worktree);
 170
 171         mark_current_worktree(list);
 172         return list;
 173 }
 174
 175 const char *get_worktree_git_dir(const struct worktree *wt)
 176 {
 177         if (!wt)
 178                 return get_git_dir();
 179         else if (!wt->id)
 180                 return get_git_common_dir();
 181         else
 182                 return git_common_path("worktrees/%s", wt->id);
 183 }
 184
 185 static struct worktree *find_worktree_by_suffix(struct worktree **list,
 186                                                 const char *suffix)
 187 {
 188         struct worktree *found = NULL;
 189         int nr_found = 0, suffixlen;
 190
 191         suffixlen = strlen(suffix);
 192         if (!suffixlen)
 193                 return NULL;
 194
 195         for (; *list && nr_found < 2; list++) {
 196                 const char      *path    = (*list)->path;
 197                 int              pathlen = strlen(path);
 198                 int              start   = pathlen - suffixlen;
 199
 200                 /* suffix must start at directory boundary */
 201                 if ((!start || (start > 0 && is_dir_sep(path[start - 1]))) &&
 202                     !fspathcmp(suffix, path + start)) {
 203                         found = *list;
 204                         nr_found++;
 205                 }
 206         }
 207         return nr_found == 1 ? found : NULL;
 208 }
 209
 210 struct worktree *find_worktree(struct worktree **list,
 211                                const char *prefix,
 212                                const char *arg)
 213 {
 214         struct worktree *wt;
 215         char *to_free = NULL;
 216
 217         if ((wt = find_worktree_by_suffix(list, arg)))
 218                 return wt;
 219
 220         if (prefix)
 221                 arg = to_free = prefix_filename(prefix, arg);
 222         wt = find_worktree_by_path(list, arg);
 223         free(to_free);
 224         return wt;
 225 }
 226
 227 struct worktree *find_worktree_by_path(struct worktree **list, const char *p)
 228 {
 229         char *path = real_pathdup(p, 0);
 230
 231         if (!path)
 232                 return NULL;
 233         for (; *list; list++) {
 234                 const char *wt_path = real_path_if_valid((*list)->path);
 235
 236                 if (wt_path && !fspathcmp(path, wt_path))
 237                         break;
 238         }
 239         free(path);
 240         return *list;
 241 }
 242
 243 int is_main_worktree(const struct worktree *wt)
 244 {
 245         return !wt->id;
 246 }
 247
 248 const char *worktree_lock_reason(struct worktree *wt)
 249 {
 250         assert(!is_main_worktree(wt));
 251
 252         if (!wt->lock_reason_valid) {
 253                 struct strbuf path = STRBUF_INIT;
 254
 255                 strbuf_addstr(&path, worktree_git_path(wt, "locked"));
 256                 if (file_exists(path.buf)) {
 257                         struct strbuf lock_reason = STRBUF_INIT;
 258                         if (strbuf_read_file(&lock_reason, path.buf, 0) < 0)
 259                                 die_errno(_("failed to read '%s'"), path.buf);
 260                         strbuf_trim(&lock_reason);
 261                         wt->lock_reason = strbuf_detach(&lock_reason, NULL);
 262                 } else
 263                         wt->lock_reason = NULL;
 264                 wt->lock_reason_valid = 1;
 265                 strbuf_release(&path);
 266         }
 267
 268         return wt->lock_reason;
 269 }
 270
 271 /* convenient wrapper to deal with NULL strbuf */
 272 static void strbuf_addf_gently(struct strbuf *buf, const char *fmt, ...)
 273 {
 274         va_list params;
 275
 276         if (!buf)
 277                 return;
 278
 279         va_start(params, fmt);
 280         strbuf_vaddf(buf, fmt, params);
 281         va_end(params);
 282 }
 283
 284 int validate_worktree(const struct worktree *wt, struct strbuf *errmsg,
 285                       unsigned flags)
 286 {
 287         struct strbuf wt_path = STRBUF_INIT;
 288         char *path = NULL;
 289         int err, ret = -1;
 290
 291         strbuf_addf(&wt_path, "%s/.git", wt->path);
 292
 293         if (is_main_worktree(wt)) {
 294                 if (is_directory(wt_path.buf)) {
 295                         ret = 0;
 296                         goto done;
 297                 }
 298                 /*
 299                  * Main worktree using .git file to point to the
 300                  * repository would make it impossible to know where
 301                  * the actual worktree is if this function is executed
 302                  * from another worktree. No .git file support for now.
 303                  */
 304                 strbuf_addf_gently(errmsg,
 305                                    _("'%s' at main working tree is not the repository directory"),
 306                                    wt_path.buf);
 307                 goto done;
 308         }
 309
 310         /*
 311          * Make sure "gitdir" file points to a real .git file and that
 312          * file points back here.
 313          */
 314         if (!is_absolute_path(wt->path)) {
 315                 strbuf_addf_gently(errmsg,
 316                                    _("'%s' file does not contain absolute path to the working tree location"),
 317                                    git_common_path("worktrees/%s/gitdir", wt->id));
 318                 goto done;
 319         }
 320
 321         if (flags & WT_VALIDATE_WORKTREE_MISSING_OK &&
 322             !file_exists(wt->path)) {
 323                 ret = 0;
 324                 goto done;
 325         }
 326
 327         if (!file_exists(wt_path.buf)) {
 328                 strbuf_addf_gently(errmsg, _("'%s' does not exist"), wt_path.buf);
 329                 goto done;
 330         }
 331
 332         path = xstrdup_or_null(read_gitfile_gently(wt_path.buf, &err));
 333         if (!path) {
 334                 strbuf_addf_gently(errmsg, _("'%s' is not a .git file, error code %d"),
 335                                    wt_path.buf, err);
 336                 goto done;
 337         }
 338
 339         ret = fspathcmp(path, real_path(git_common_path("worktrees/%s", wt->id)));
 340
 341         if (ret)
 342                 strbuf_addf_gently(errmsg, _("'%s' does not point back to '%s'"),
 343                                    wt->path, git_common_path("worktrees/%s", wt->id));
 344 done:
 345         free(path);
 346         strbuf_release(&wt_path);
 347         return ret;
 348 }
 349
 350 void update_worktree_location(struct worktree *wt, const char *path_)
 351 {
 352         struct strbuf path = STRBUF_INIT;
 353
 354         if (is_main_worktree(wt))
 355                 BUG("can't relocate main worktree");
 356
 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);
 361                 free(wt->path);
 362                 wt->path = strbuf_detach(&path, NULL);
 363         }
 364         strbuf_release(&path);
 365 }
 366
 367 int is_worktree_being_rebased(const struct worktree *wt,
 368                               const char *target)
 369 {
 370         struct wt_status_state state;
 371         int found_rebase;
 372
 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) &&
 377                  state.branch &&
 378                  starts_with(target, "refs/heads/") &&
 379                  !strcmp(state.branch, target + strlen("refs/heads/")));
 380         free(state.branch);
 381         free(state.onto);
 382         return found_rebase;
 383 }
 384
 385 int is_worktree_being_bisected(const struct worktree *wt,
 386                                const char *target)
 387 {
 388         struct wt_status_state state;
 389         int found_rebase;
 390
 391         memset(&state, 0, sizeof(state));
 392         found_rebase = wt_status_check_bisect(wt, &state) &&
 393                 state.branch &&
 394                 starts_with(target, "refs/heads/") &&
 395                 !strcmp(state.branch, target + strlen("refs/heads/"));
 396         free(state.branch);
 397         return found_rebase;
 398 }
 399
 400 /*
 401  * note: this function should be able to detect shared symref even if
 402  * HEAD is temporarily detached (e.g. in the middle of rebase or
 403  * bisect). New commands that do similar things should update this
 404  * function as well.
 405  */
 406 const struct worktree *find_shared_symref(const char *symref,
 407                                           const char *target)
 408 {
 409         const struct worktree *existing = NULL;
 410         static struct worktree **worktrees;
 411         int i = 0;
 412
 413         if (worktrees)
 414                 free_worktrees(worktrees);
 415         worktrees = get_worktrees(0);
 416
 417         for (i = 0; worktrees[i]; i++) {
 418                 struct worktree *wt = worktrees[i];
 419                 const char *symref_target;
 420                 struct ref_store *refs;
 421                 int flags;
 422
 423                 if (wt->is_bare)
 424                         continue;
 425
 426                 if (wt->is_detached && !strcmp(symref, "HEAD")) {
 427                         if (is_worktree_being_rebased(wt, target)) {
 428                                 existing = wt;
 429                                 break;
 430                         }
 431                         if (is_worktree_being_bisected(wt, target)) {
 432                                 existing = wt;
 433                                 break;
 434                         }
 435                 }
 436
 437                 refs = get_worktree_ref_store(wt);
 438                 symref_target = refs_resolve_ref_unsafe(refs, symref, 0,
 439                                                         NULL, &flags);
 440                 if ((flags & REF_ISSYMREF) &&
 441                     symref_target && !strcmp(symref_target, target)) {
 442                         existing = wt;
 443                         break;
 444                 }
 445         }
 446
 447         return existing;
 448 }
 449
 450 int submodule_uses_worktrees(const char *path)
 451 {
 452         char *submodule_gitdir;
 453         struct strbuf sb = STRBUF_INIT;
 454         DIR *dir;
 455         struct dirent *d;
 456         int ret = 0;
 457         struct repository_format format = REPOSITORY_FORMAT_INIT;
 458
 459         submodule_gitdir = git_pathdup_submodule(path, "%s", "");
 460         if (!submodule_gitdir)
 461                 return 0;
 462
 463         /* The env would be set for the superproject. */
 464         get_common_dir_noenv(&sb, submodule_gitdir);
 465         free(submodule_gitdir);
 466
 467         /*
 468          * The check below is only known to be good for repository format
 469          * version 0 at the time of writing this code.
 470          */
 471         strbuf_addstr(&sb, "/config");
 472         read_repository_format(&format, sb.buf);
 473         if (format.version != 0) {
 474                 strbuf_release(&sb);
 475                 clear_repository_format(&format);
 476                 return 1;
 477         }
 478         clear_repository_format(&format);
 479
 480         /* Replace config by worktrees. */
 481         strbuf_setlen(&sb, sb.len - strlen("config"));
 482         strbuf_addstr(&sb, "worktrees");
 483
 484         /* See if there is any file inside the worktrees directory. */
 485         dir = opendir(sb.buf);
 486         strbuf_release(&sb);
 487
 488         if (!dir)
 489                 return 0;
 490
 491         while ((d = readdir(dir)) != NULL) {
 492                 if (is_dot_or_dotdot(d->d_name))
 493                         continue;
 494
 495                 ret = 1;
 496                 break;
 497         }
 498         closedir(dir);
 499         return ret;
 500 }
 501
 502 int parse_worktree_ref(const char *worktree_ref, const char **name,
 503                        int *name_length, const char **ref)
 504 {
 505         if (skip_prefix(worktree_ref, "main-worktree/", &worktree_ref)) {
 506                 if (!*worktree_ref)
 507                         return -1;
 508                 if (name)
 509                         *name = NULL;
 510                 if (name_length)
 511                         *name_length = 0;
 512                 if (ref)
 513                         *ref = worktree_ref;
 514                 return 0;
 515         }
 516         if (skip_prefix(worktree_ref, "worktrees/", &worktree_ref)) {
 517                 const char *slash = strchr(worktree_ref, '/');
 518
 519                 if (!slash || slash == worktree_ref || !slash[1])
 520                         return -1;
 521                 if (name)
 522                         *name = worktree_ref;
 523                 if (name_length)
 524                         *name_length = slash - worktree_ref;
 525                 if (ref)
 526                         *ref = slash + 1;
 527                 return 0;
 528         }
 529         return -1;
 530 }
 531
 532 void strbuf_worktree_ref(const struct worktree *wt,
 533                          struct strbuf *sb,
 534                          const char *refname)
 535 {
 536         switch (ref_type(refname)) {
 537         case REF_TYPE_PSEUDOREF:
 538         case REF_TYPE_PER_WORKTREE:
 539                 if (wt && !wt->is_current) {
 540                         if (is_main_worktree(wt))
 541                                 strbuf_addstr(sb, "main-worktree/");
 542                         else
 543                                 strbuf_addf(sb, "worktrees/%s/", wt->id);
 544                 }
 545                 break;
 546
 547         case REF_TYPE_MAIN_PSEUDOREF:
 548         case REF_TYPE_OTHER_PSEUDOREF:
 549                 break;
 550
 551         case REF_TYPE_NORMAL:
 552                 /*
 553                  * For shared refs, don't prefix worktrees/ or
 554                  * main-worktree/. It's not necessary and
 555                  * files-backend.c can't handle it anyway.
 556                  */
 557                 break;
 558         }
 559         strbuf_addstr(sb, refname);
 560 }
 561
 562 const char *worktree_ref(const struct worktree *wt, const char *refname)
 563 {
 564         static struct strbuf sb = STRBUF_INIT;
 565
 566         strbuf_reset(&sb);
 567         strbuf_worktree_ref(wt, &sb, refname);
 568         return sb.buf;
 569 }
 570
 571 int other_head_refs(each_ref_fn fn, void *cb_data)
 572 {
 573         struct worktree **worktrees, **p;
 574         int ret = 0;
 575
 576         worktrees = get_worktrees(0);
 577         for (p = worktrees; *p; p++) {
 578                 struct worktree *wt = *p;
 579                 struct object_id oid;
 580                 int flag;
 581
 582                 if (wt->is_current)
 583                         continue;
 584
 585                 if (!refs_read_ref_full(get_main_ref_store(the_repository),
 586                                         worktree_ref(wt, "HEAD"),
 587                                         RESOLVE_REF_READING,
 588                                         &oid, &flag))
 589                         ret = fn(worktree_ref(wt, "HEAD"), &oid, flag, cb_data);
 590                 if (ret)
 591                         break;
 592         }
 593         free_worktrees(worktrees);
 594         return ret;
 595 }