2 * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 #include <sys/limits.h>
19 #include <sys/queue.h>
34 #include "got_error.h"
35 #include "got_repository.h"
36 #include "got_reference.h"
37 #include "got_object.h"
38 #include "got_worktree.h"
39 #include "got_opentemp.h"
41 #include "got_lib_worktree.h"
42 #include "got_lib_path.h"
43 #include "got_lib_sha1.h"
44 #include "got_lib_fileindex.h"
45 #include "got_lib_inflate.h"
46 #include "got_lib_delta.h"
47 #include "got_lib_object.h"
50 #define MIN(_a,_b) ((_a) < (_b) ? (_a) : (_b))
53 static const struct got_error *
54 create_meta_file(const char *path_got, const char *name, const char *content)
56 const struct got_error *err = NULL;
60 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
61 err = got_error_from_errno();
66 fd = open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
67 GOT_DEFAULT_FILE_MODE);
69 err = got_error_from_errno();
74 int len = dprintf(fd, "%s\n", content);
75 if (len != strlen(content) + 1) {
76 err = got_error_from_errno();
82 if (fd != -1 && close(fd) == -1 && err == NULL)
83 err = got_error_from_errno();
88 static const struct got_error *
89 update_meta_file(const char *path_got, const char *name, const char *content)
91 const struct got_error *err = NULL;
96 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
97 err = got_error_from_errno();
102 err = got_opentemp_named(&tmppath, &tmpfile, path);
107 int len = fprintf(tmpfile, "%s\n", content);
108 if (len != strlen(content) + 1) {
109 err = got_error_from_errno();
114 if (rename(tmppath, path) != 0) {
115 err = got_error_from_errno();
125 static const struct got_error *
126 read_meta_file(char **content, const char *path_got, const char *name)
128 const struct got_error *err = NULL;
136 if (asprintf(&path, "%s/%s", path_got, name) == -1) {
137 err = got_error_from_errno();
142 fd = open(path, O_RDONLY | O_NOFOLLOW);
144 err = got_error_from_errno();
147 if (flock(fd, LOCK_SH | LOCK_NB) == -1) {
148 err = (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
149 : got_error_from_errno());
154 *content = calloc(1, sb.st_size);
155 if (*content == NULL) {
156 err = got_error_from_errno();
160 n = read(fd, *content, sb.st_size);
161 if (n != sb.st_size) {
162 err = (n == -1 ? got_error_from_errno() :
163 got_error(GOT_ERR_WORKTREE_META));
166 if ((*content)[sb.st_size - 1] != '\n') {
167 err = got_error(GOT_ERR_WORKTREE_META);
170 (*content)[sb.st_size - 1] = '\0';
173 if (fd != -1 && close(fd) == -1 && err == NULL)
174 err = got_error_from_errno();
183 const struct got_error *
184 got_worktree_init(const char *path, struct got_reference *head_ref,
185 const char *prefix, struct got_repository *repo)
187 const struct got_error *err = NULL;
188 struct got_object_id *commit_id = NULL;
190 char *path_got = NULL;
192 char *formatstr = NULL;
193 char *absprefix = NULL;
194 char *basestr = NULL;
196 err = got_ref_resolve(&commit_id, repo, head_ref);
199 err = got_object_get_type(&obj_type, repo, commit_id);
202 if (obj_type != GOT_OBJ_TYPE_COMMIT)
203 return got_error(GOT_ERR_OBJ_TYPE);
205 if (!got_path_is_absolute(prefix)) {
206 if (asprintf(&absprefix, "/%s", prefix) == -1)
207 return got_error_from_errno();
210 /* Create top-level directory (may already exist). */
211 if (mkdir(path, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST) {
212 err = got_error_from_errno();
216 /* Create .got directory (may already exist). */
217 if (asprintf(&path_got, "%s/%s", path, GOT_WORKTREE_GOT_DIR) == -1) {
218 err = got_error_from_errno();
221 if (mkdir(path_got, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST) {
222 err = got_error_from_errno();
226 /* Create an empty lock file. */
227 err = create_meta_file(path_got, GOT_WORKTREE_LOCK, NULL);
231 /* Create an empty file index. */
232 err = create_meta_file(path_got, GOT_WORKTREE_FILE_INDEX, NULL);
236 /* Write the HEAD reference. */
237 refstr = got_ref_to_str(head_ref);
238 if (refstr == NULL) {
239 err = got_error_from_errno();
242 err = create_meta_file(path_got, GOT_WORKTREE_HEAD_REF, refstr);
246 /* Record our base commit. */
247 err = got_object_id_str(&basestr, commit_id);
250 err = create_meta_file(path_got, GOT_WORKTREE_BASE_COMMIT, basestr);
254 /* Store path to repository. */
255 err = create_meta_file(path_got, GOT_WORKTREE_REPOSITORY,
256 got_repo_get_path(repo));
260 /* Store in-repository path prefix. */
261 err = create_meta_file(path_got, GOT_WORKTREE_PATH_PREFIX,
262 absprefix ? absprefix : prefix);
266 /* Stamp work tree with format file. */
267 if (asprintf(&formatstr, "%d", GOT_WORKTREE_FORMAT_VERSION) == -1) {
268 err = got_error_from_errno();
271 err = create_meta_file(path_got, GOT_WORKTREE_FORMAT, formatstr);
285 const struct got_error *
286 got_worktree_open(struct got_worktree **worktree, const char *path)
288 const struct got_error *err = NULL;
290 char *formatstr = NULL;
291 char *path_lock = NULL;
292 char *base_commit_id_str = NULL;
293 char *head_ref_str = NULL;
294 int version, fd = -1;
296 struct got_repository *repo = NULL;
300 if (asprintf(&path_got, "%s/%s", path, GOT_WORKTREE_GOT_DIR) == -1) {
301 err = got_error_from_errno();
306 if (asprintf(&path_lock, "%s/%s", path_got, GOT_WORKTREE_LOCK) == -1) {
307 err = got_error_from_errno();
312 fd = open(path_lock, O_RDWR | O_EXLOCK | O_NONBLOCK);
314 err = (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
315 : got_error_from_errno());
319 err = read_meta_file(&formatstr, path_got, GOT_WORKTREE_FORMAT);
323 version = strtonum(formatstr, 1, INT_MAX, &errstr);
325 err = got_error(GOT_ERR_WORKTREE_META);
328 if (version != GOT_WORKTREE_FORMAT_VERSION) {
329 err = got_error(GOT_ERR_WORKTREE_VERS);
333 *worktree = calloc(1, sizeof(**worktree));
334 if (*worktree == NULL) {
335 err = got_error_from_errno();
338 (*worktree)->lockfd = -1;
340 (*worktree)->root_path = strdup(path);
341 if ((*worktree)->root_path == NULL) {
342 err = got_error_from_errno();
345 err = read_meta_file(&(*worktree)->repo_path, path_got,
346 GOT_WORKTREE_REPOSITORY);
350 err = read_meta_file(&(*worktree)->path_prefix, path_got,
351 GOT_WORKTREE_PATH_PREFIX);
355 err = read_meta_file(&base_commit_id_str, path_got,
356 GOT_WORKTREE_BASE_COMMIT);
360 err = got_repo_open(&repo, (*worktree)->repo_path);
364 err = got_object_resolve_id_str(&(*worktree)->base_commit_id, repo,
369 err = read_meta_file(&head_ref_str, path_got, GOT_WORKTREE_HEAD_REF);
373 err = got_ref_open(&(*worktree)->head_ref, repo, head_ref_str);
376 got_repo_close(repo);
380 free(base_commit_id_str);
384 if (*worktree != NULL)
385 got_worktree_close(*worktree);
388 (*worktree)->lockfd = fd;
394 got_worktree_close(struct got_worktree *worktree)
396 free(worktree->root_path);
397 free(worktree->repo_path);
398 free(worktree->path_prefix);
399 free(worktree->base_commit_id);
400 if (worktree->head_ref)
401 got_ref_close(worktree->head_ref);
402 if (worktree->lockfd != -1)
403 close(worktree->lockfd);
408 got_worktree_get_repo_path(struct got_worktree *worktree)
410 return worktree->repo_path;
414 got_worktree_get_path_prefix(struct got_worktree *worktree)
416 return worktree->path_prefix;
419 const struct got_error *
420 got_worktree_match_path_prefix(int *match, struct got_worktree *worktree,
421 const char *path_prefix)
423 char *absprefix = NULL;
425 if (!got_path_is_absolute(path_prefix)) {
426 if (asprintf(&absprefix, "/%s", path_prefix) == -1)
427 return got_error_from_errno();
429 *match = (strcmp(absprefix ? absprefix : path_prefix,
430 worktree->path_prefix) == 0);
436 got_worktree_get_head_ref_name(struct got_worktree *worktree)
438 return got_ref_to_str(worktree->head_ref);
441 struct got_reference *
442 got_worktree_get_head_ref(struct got_worktree *worktree)
444 return got_ref_dup(worktree->head_ref);
447 const struct got_object_id *
448 got_worktree_get_base_commit_id(struct got_worktree *worktree)
450 return worktree->base_commit_id;
453 const struct got_error *
454 got_worktree_set_base_commit_id(struct got_worktree *worktree,
455 struct got_repository *repo, struct got_object_id *commit_id)
457 const struct got_error *err;
458 struct got_object *obj = NULL;
460 char *path_got = NULL;
462 if (asprintf(&path_got, "%s/%s", worktree->root_path,
463 GOT_WORKTREE_GOT_DIR) == -1) {
464 err = got_error_from_errno();
469 err = got_object_open(&obj, repo, commit_id);
473 if (obj->type != GOT_OBJ_TYPE_COMMIT) {
474 err = got_error(GOT_ERR_OBJ_TYPE);
478 /* Record our base commit. */
479 err = got_object_id_str(&id_str, commit_id);
482 err = update_meta_file(path_got, GOT_WORKTREE_BASE_COMMIT, id_str);
486 free(worktree->base_commit_id);
487 worktree->base_commit_id = got_object_id_dup(commit_id);
488 if (worktree->base_commit_id == NULL) {
489 err = got_error_from_errno();
494 got_object_close(obj);
500 static const struct got_error *
501 lock_worktree(struct got_worktree *worktree, int operation)
503 if (flock(worktree->lockfd, operation | LOCK_NB) == -1)
504 return (errno == EWOULDBLOCK ? got_error(GOT_ERR_WORKTREE_BUSY)
505 : got_error_from_errno());
509 static const struct got_error *
510 make_parent_dirs(const char *abspath)
512 const struct got_error *err = NULL;
514 char *parent = dirname(abspath);
518 if (mkdir(parent, GOT_DEFAULT_DIR_MODE) == -1) {
519 if (errno == ENOENT) {
520 err = make_parent_dirs(parent);
523 if (mkdir(parent, GOT_DEFAULT_DIR_MODE) == -1)
524 return got_error_from_errno();
526 err = got_error_from_errno();
532 static const struct got_error *
533 add_dir_on_disk(struct got_worktree *worktree, const char *path)
535 const struct got_error *err = NULL;
538 if (asprintf(&abspath, "%s/%s", worktree->root_path, path) == -1)
539 return got_error_from_errno();
541 /* XXX queue work rather than editing disk directly? */
542 if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1) {
545 if (errno == EEXIST) {
546 if (lstat(abspath, &sb) == -1) {
547 err = got_error_from_errno();
551 if (!S_ISDIR(sb.st_mode)) {
552 /* TODO directory is obstructed; do something */
553 err = got_error(GOT_ERR_FILE_OBSTRUCTED);
558 } else if (errno == ENOENT) {
559 err = make_parent_dirs(abspath);
562 if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1)
563 err = got_error_from_errno();
565 err = got_error_from_errno();
573 static const struct got_error *
574 install_blob(struct got_worktree *worktree, struct got_fileindex *fileindex,
575 struct got_fileindex_entry *entry, const char *path,
576 struct got_blob_object *blob,
577 struct got_repository *repo, got_worktree_checkout_cb progress_cb,
580 const struct got_error *err = NULL;
585 char *tmppath = NULL;
587 if (asprintf(&ondisk_path, "%s/%s", worktree->root_path, path) == -1)
588 return got_error_from_errno();
590 fd = open(ondisk_path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
591 GOT_DEFAULT_FILE_MODE);
593 if (errno == ENOENT) {
594 char *parent = dirname(path);
596 return got_error_from_errno();
597 err = add_dir_on_disk(worktree, parent);
600 fd = open(ondisk_path,
601 O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
602 GOT_DEFAULT_FILE_MODE);
604 return got_error_from_errno();
605 } else if (errno == EEXIST) {
607 if (lstat(ondisk_path, &sb) == -1) {
608 err = got_error_from_errno();
610 } else if (!S_ISREG(sb.st_mode)) {
611 /* TODO file is obstructed; do something */
612 err = got_error(GOT_ERR_FILE_OBSTRUCTED);
615 err = got_opentemp_named_fd(&tmppath, &fd,
622 return got_error_from_errno();
625 (*progress_cb)(progress_arg,
626 update ? GOT_STATUS_UPDATE : GOT_STATUS_ADD, path);
628 hdrlen = got_object_blob_get_hdrlen(blob);
630 const uint8_t *buf = got_object_blob_get_read_buf(blob);
631 err = got_object_blob_read_block(&len, blob);
635 /* Skip blob object header first time around. */
636 ssize_t outlen = write(fd, buf + hdrlen, len - hdrlen);
638 err = got_error_from_errno();
640 } else if (outlen != len - hdrlen) {
641 err = got_error(GOT_ERR_IO);
651 if (rename(tmppath, ondisk_path) != 0) {
652 err = got_error_from_errno();
658 entry = got_fileindex_entry_get(fileindex, path);
660 err = got_fileindex_entry_update(entry, ondisk_path,
661 blob->id.sha1, worktree->base_commit_id->sha1);
663 err = got_fileindex_entry_alloc(&entry, ondisk_path,
664 path, blob->id.sha1, worktree->base_commit_id->sha1);
667 err = got_fileindex_entry_add(fileindex, entry);
677 static const struct got_error *
678 update_blob(struct got_worktree *worktree,
679 struct got_fileindex *fileindex, struct got_fileindex_entry *ie,
680 struct got_tree_entry *te, const char *path,
681 struct got_repository *repo, got_worktree_checkout_cb progress_cb,
682 void *progress_arg, got_worktree_cancel_cb cancel_cb, void *cancel_arg)
684 const struct got_error *err = NULL;
685 struct got_blob_object *blob = NULL;
688 if (memcmp(ie->commit_sha1, worktree->base_commit_id->sha1,
689 SHA1_DIGEST_LENGTH) == 0) {
690 (*progress_cb)(progress_arg, GOT_STATUS_EXISTS,
694 if (memcmp(ie->blob_sha1,
695 te->id->sha1, SHA1_DIGEST_LENGTH) == 0)
699 err = got_object_open_as_blob(&blob, repo, te->id, 8192);
703 err = install_blob(worktree, fileindex, ie, path, blob, repo,
704 progress_cb, progress_arg);
705 got_object_blob_close(blob);
709 static const struct got_error *
710 remove_ondisk_file(const char *root_path, const char *path)
712 const struct got_error *err = NULL;
713 char *ondisk_path = NULL;
715 if (asprintf(&ondisk_path, "%s/%s", root_path, path) == -1)
716 return got_error_from_errno();
718 if (unlink(ondisk_path) == -1) {
720 err = got_error_from_errno();
722 char *parent = dirname(ondisk_path);
723 while (parent && strcmp(parent, root_path) != 0) {
724 if (rmdir(parent) == -1) {
725 if (errno != ENOTEMPTY)
726 err = got_error_from_errno();
729 parent = dirname(parent);
737 struct got_fileindex *fileindex;
738 struct got_worktree *worktree;
739 struct got_repository *repo;
740 got_worktree_checkout_cb progress_cb;
742 got_worktree_cancel_cb cancel_cb;
746 static const struct got_error *
747 diff_old_new(void *arg, struct got_fileindex_entry *ie,
748 struct got_tree_entry *te, const char *parent_path)
750 struct diff_cb_arg *a = arg;
752 return update_blob(a->worktree, a->fileindex, ie, te,
753 ie->path, a->repo, a->progress_cb, a->progress_arg,
754 a->cancel_cb, a->cancel_arg);
757 static const struct got_error *
758 diff_old(void *arg, struct got_fileindex_entry *ie, const char *parent_path)
760 const struct got_error *err;
761 struct diff_cb_arg *a = arg;
763 (*a->progress_cb)(a->progress_arg, GOT_STATUS_DELETE, ie->path);
765 err = remove_ondisk_file(a->worktree->root_path, ie->path);
768 got_fileindex_entry_remove(a->fileindex, ie);
772 static const struct got_error *
773 diff_new(void *arg, struct got_tree_entry *te, const char *parent_path)
775 struct diff_cb_arg *a = arg;
776 const struct got_error *err;
779 if (asprintf(&path, "%s%s%s", parent_path,
780 parent_path[0] ? "/" : "", te->name)
782 return got_error_from_errno();
784 if (S_ISDIR(te->mode))
785 err = add_dir_on_disk(a->worktree, path);
787 err = update_blob(a->worktree, a->fileindex, NULL, te, path,
788 a->repo, a->progress_cb, a->progress_arg,
789 a->cancel_cb, a->cancel_arg);
795 const struct got_error *
796 got_worktree_checkout_files(struct got_worktree *worktree,
797 struct got_repository *repo, got_worktree_checkout_cb progress_cb,
798 void *progress_arg, got_worktree_cancel_cb cancel_cb, void *cancel_arg)
800 const struct got_error *err = NULL, *unlockerr, *checkout_err = NULL;
801 struct got_commit_object *commit = NULL;
802 struct got_object_id *tree_id = NULL;
803 struct got_tree_object *tree = NULL;
804 char *fileindex_path = NULL, *new_fileindex_path = NULL;
805 struct got_fileindex *fileindex = NULL;
806 FILE *index = NULL, *new_index = NULL;
807 struct got_fileindex_diff_tree_cb diff_cb;
808 struct diff_cb_arg arg;
810 err = lock_worktree(worktree, LOCK_EX);
814 fileindex = got_fileindex_alloc();
815 if (fileindex == NULL) {
816 err = got_error_from_errno();
820 if (asprintf(&fileindex_path, "%s/%s/%s", worktree->root_path,
821 GOT_WORKTREE_GOT_DIR, GOT_WORKTREE_FILE_INDEX) == -1) {
822 err = got_error_from_errno();
823 fileindex_path = NULL;
828 * Read the file index.
829 * Checking out files is supposed to be an idempotent operation.
830 * If the on-disk file index is incomplete we will try to complete it.
832 index = fopen(fileindex_path, "rb");
834 if (errno != ENOENT) {
835 err = got_error_from_errno();
839 err = got_fileindex_read(fileindex, index);
845 err = got_opentemp_named(&new_fileindex_path, &new_index,
850 err = got_object_open_as_commit(&commit, repo,
851 worktree->base_commit_id);
855 err = got_object_id_by_path(&tree_id, repo,
856 worktree->base_commit_id, worktree->path_prefix);
860 err = got_object_open_as_tree(&tree, repo, tree_id);
864 diff_cb.diff_old_new = diff_old_new;
865 diff_cb.diff_old = diff_old;
866 diff_cb.diff_new = diff_new;
867 arg.fileindex = fileindex;
868 arg.worktree = worktree;
870 arg.progress_cb = progress_cb;
871 arg.progress_arg = progress_arg;
872 arg.cancel_cb = cancel_cb;
873 arg.cancel_arg = cancel_arg;
874 checkout_err = got_fileindex_diff_tree(fileindex, tree, repo,
877 /* Try to sync the fileindex back to disk in any case. */
878 err = got_fileindex_write(fileindex, new_index);
882 if (rename(new_fileindex_path, fileindex_path) != 0) {
883 err = got_error_from_errno();
887 free(new_fileindex_path);
888 new_fileindex_path = NULL;
892 got_object_tree_close(tree);
894 got_object_commit_close(commit);
895 if (new_fileindex_path)
896 unlink(new_fileindex_path);
899 free(new_fileindex_path);
900 free(fileindex_path);
901 got_fileindex_free(fileindex);
904 unlockerr = lock_worktree(worktree, LOCK_SH);
905 if (unlockerr && err == NULL)