git.oblomov.eu Git - git/blob - 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 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         char *path = real_pathdup(p, 0);
 216
 217         if (!path)
 218                 return NULL;
 219         for (; *list; list++) {
 220                 const char *wt_path = real_path_if_valid((*list)->path);
 221
 222                 if (wt_path && !fspathcmp(path, wt_path))
 223                         break;
 224         }
 225         free(path);
 226         return *list;
 227 }
 228
 229 int is_main_worktree(const struct worktree *wt)
 230 {
 231         return !wt->id;
 232 }
 233
 234 const char *worktree_lock_reason(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                 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();
 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 = REPOSITORY_FORMAT_INIT;
 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                 clear_repository_format(&format);
 462                 return 1;
 463         }
 464         clear_repository_format(&format);
 465
 466         /* Replace config by worktrees. */
 467         strbuf_setlen(&sb, sb.len - strlen("config"));
 468         strbuf_addstr(&sb, "worktrees");
 469
 470         /* See if there is any file inside the worktrees directory. */
 471         dir = opendir(sb.buf);
 472         strbuf_release(&sb);
 473
 474         if (!dir)
 475                 return 0;
 476
 477         while ((d = readdir(dir)) != NULL) {
 478                 if (is_dot_or_dotdot(d->d_name))
 479                         continue;
 480
 481                 ret = 1;
 482                 break;
 483         }
 484         closedir(dir);
 485         return ret;
 486 }
 487
 488 int parse_worktree_ref(const char *worktree_ref, const char **name,
 489                        int *name_length, const char **ref)
 490 {
 491         if (skip_prefix(worktree_ref, "main-worktree/", &worktree_ref)) {
 492                 if (!*worktree_ref)
 493                         return -1;
 494                 if (name)
 495                         *name = NULL;
 496                 if (name_length)
 497                         *name_length = 0;
 498                 if (ref)
 499                         *ref = worktree_ref;
 500                 return 0;
 501         }
 502         if (skip_prefix(worktree_ref, "worktrees/", &worktree_ref)) {
 503                 const char *slash = strchr(worktree_ref, '/');
 504
 505                 if (!slash || slash == worktree_ref || !slash[1])
 506                         return -1;
 507                 if (name)
 508                         *name = worktree_ref;
 509                 if (name_length)
 510                         *name_length = slash - worktree_ref;
 511                 if (ref)
 512                         *ref = slash + 1;
 513                 return 0;
 514         }
 515         return -1;
 516 }
 517
 518 void strbuf_worktree_ref(const struct worktree *wt,
 519                          struct strbuf *sb,
 520                          const char *refname)
 521 {
 522         switch (ref_type(refname)) {
 523         case REF_TYPE_PSEUDOREF:
 524         case REF_TYPE_PER_WORKTREE:
 525                 if (wt && !wt->is_current) {
 526                         if (is_main_worktree(wt))
 527                                 strbuf_addstr(sb, "main-worktree/");
 528                         else
 529                                 strbuf_addf(sb, "worktrees/%s/", wt->id);
 530                 }
 531                 break;
 532
 533         case REF_TYPE_MAIN_PSEUDOREF:
 534         case REF_TYPE_OTHER_PSEUDOREF:
 535                 break;
 536
 537         case REF_TYPE_NORMAL:
 538                 /*
 539                  * For shared refs, don't prefix worktrees/ or
 540                  * main-worktree/. It's not necessary and
 541                  * files-backend.c can't handle it anyway.
 542                  */
 543                 break;
 544         }
 545         strbuf_addstr(sb, refname);
 546 }
 547
 548 const char *worktree_ref(const struct worktree *wt, const char *refname)
 549 {
 550         static struct strbuf sb = STRBUF_INIT;
 551
 552         strbuf_reset(&sb);
 553         strbuf_worktree_ref(wt, &sb, refname);
 554         return sb.buf;
 555 }
 556
 557 int other_head_refs(each_ref_fn fn, void *cb_data)
 558 {
 559         struct worktree **worktrees, **p;
 560         int ret = 0;
 561
 562         worktrees = get_worktrees();
 563         for (p = worktrees; *p; p++) {
 564                 struct worktree *wt = *p;
 565                 struct object_id oid;
 566                 int flag;
 567
 568                 if (wt->is_current)
 569                         continue;
 570
 571                 if (!refs_read_ref_full(get_main_ref_store(the_repository),
 572                                         worktree_ref(wt, "HEAD"),
 573                                         RESOLVE_REF_READING,
 574                                         &oid, &flag))
 575                         ret = fn(worktree_ref(wt, "HEAD"), &oid, flag, cb_data);
 576                 if (ret)
 577                         break;
 578         }
 579         free_worktrees(worktrees);
 580         return ret;
 581 }