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