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