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