2 * Copyright (c) 2018 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>
33 #include "got_error.h"
34 #include "got_repository.h"
35 #include "got_reference.h"
36 #include "got_object.h"
37 #include "got_worktree.h"
38 #include "got_opentemp.h"
40 #include "got_lib_worktree.h"
41 #include "got_lib_path.h"
42 #include "got_lib_pathset.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());
510 apply_path_prefix(struct got_worktree *worktree, const char *path)
512 const char *p = path;
513 p += strlen(worktree->path_prefix);
519 static const struct got_error *
520 blob_checkout(struct got_worktree *worktree, struct got_fileindex *fileindex,
521 struct got_fileindex_entry *entry, const char *path,
522 struct got_blob_object *blob, struct got_repository *repo,
523 got_worktree_checkout_cb progress_cb, void *progress_arg,
524 const char *progress_path)
526 const struct got_error *err = NULL;
531 char *tmppath = NULL;
533 if (asprintf(&ondisk_path, "%s/%s", worktree->root_path,
534 apply_path_prefix(worktree, path)) == -1)
535 return got_error_from_errno();
537 fd = open(ondisk_path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW,
538 GOT_DEFAULT_FILE_MODE);
540 err = got_error_from_errno();
541 if (errno == EEXIST) {
543 if (lstat(ondisk_path, &sb) == -1) {
544 err = got_error_from_errno();
546 } else if (!S_ISREG(sb.st_mode)) {
547 /* TODO file is obstructed; do something */
548 err = got_error(GOT_ERR_FILE_OBSTRUCTED);
551 err = got_opentemp_named_fd(&tmppath, &fd,
561 (*progress_cb)(progress_arg,
562 update ? GOT_STATUS_UPDATE : GOT_STATUS_ADD, progress_path);
564 hdrlen = got_object_blob_get_hdrlen(blob);
566 const uint8_t *buf = got_object_blob_get_read_buf(blob);
567 err = got_object_blob_read_block(&len, blob);
571 /* Skip blob object header first time around. */
572 ssize_t outlen = write(fd, buf + hdrlen, len - hdrlen);
574 err = got_error_from_errno();
576 } else if (outlen != len - hdrlen) {
577 err = got_error(GOT_ERR_IO);
587 if (rename(tmppath, ondisk_path) != 0) {
588 err = got_error_from_errno();
594 err = got_fileindex_entry_update(entry, ondisk_path,
595 blob->id.sha1, worktree->base_commit_id->sha1);
597 err = got_fileindex_entry_alloc(&entry, ondisk_path,
598 apply_path_prefix(worktree, path), blob->id.sha1,
599 worktree->base_commit_id->sha1);
602 err = got_fileindex_entry_add(fileindex, entry);
614 static const struct got_error *
615 add_dir_on_disk(struct got_worktree *worktree, const char *path)
617 const struct got_error *err = NULL;
620 if (asprintf(&abspath, "%s/%s", worktree->root_path,
621 apply_path_prefix(worktree, path)) == -1)
622 return got_error_from_errno();
624 /* XXX queue work rather than editing disk directly? */
625 if (mkdir(abspath, GOT_DEFAULT_DIR_MODE) == -1) {
628 if (errno != EEXIST) {
629 err = got_error_from_errno();
633 if (lstat(abspath, &sb) == -1) {
634 err = got_error_from_errno();
638 if (!S_ISDIR(sb.st_mode)) {
639 /* TODO directory is obstructed; do something */
640 return got_error(GOT_ERR_FILE_OBSTRUCTED);
649 static const struct got_error *
650 tree_checkout(struct got_worktree *, struct got_fileindex *,
651 struct got_tree_object *, const char *, struct got_repository *,
652 got_worktree_checkout_cb progress_cb, void *progress_arg,
653 got_worktree_cancel_cb cancel_cb, void *cancel_arg);
655 static const struct got_error *
656 tree_checkout_entry(struct got_worktree *worktree,
657 struct got_fileindex *fileindex, struct got_tree_entry *te,
658 const char *parent, struct got_repository *repo,
659 got_worktree_checkout_cb progress_cb, void *progress_arg,
660 got_worktree_cancel_cb cancel_cb, void *cancel_arg)
662 const struct got_error *err = NULL;
663 struct got_object *obj = NULL;
664 struct got_blob_object *blob = NULL;
665 struct got_fileindex_entry *entry = NULL;
666 struct got_tree_object *tree = NULL;
668 char *progress_path = NULL;
671 if (parent[0] == '/' && parent[1] == '\0')
673 if (asprintf(&path, "%s/%s", parent, te->name) == -1)
674 return got_error_from_errno();
676 /* Skip this entry if it is outside of our path prefix. */
677 len = MIN(strlen(worktree->path_prefix), strlen(path));
678 if (strncmp(path, worktree->path_prefix, len) != 0) {
683 err = got_object_open(&obj, repo, te->id);
687 progress_path = path;
688 if (strncmp(progress_path, worktree->path_prefix, len) == 0)
689 progress_path += len;
692 case GOT_OBJ_TYPE_BLOB:
693 if (strlen(worktree->path_prefix) >= strlen(path))
695 entry = got_fileindex_entry_get(fileindex,
696 apply_path_prefix(worktree, path));
698 memcmp(entry->commit_sha1, worktree->base_commit_id->sha1,
699 SHA1_DIGEST_LENGTH) == 0) {
700 (*progress_cb)(progress_arg, GOT_STATUS_EXISTS,
704 if (entry && memcmp(entry->blob_sha1, obj->id.sha1,
705 SHA1_DIGEST_LENGTH) == 0)
707 err = got_object_blob_open(&blob, repo, obj, 8192);
710 err = blob_checkout(worktree, fileindex, entry, path, blob,
711 repo, progress_cb, progress_arg, progress_path);
713 case GOT_OBJ_TYPE_TREE:
714 if (strlen(worktree->path_prefix) < strlen(path)) {
715 err = add_dir_on_disk(worktree, path);
719 err = got_object_tree_open(&tree, repo, obj);
722 /* XXX infinite recursion possible */
723 err = tree_checkout(worktree, fileindex, tree, path, repo,
724 progress_cb, progress_arg, cancel_cb, cancel_arg);
732 got_object_blob_close(blob);
734 got_object_tree_close(tree);
736 got_object_close(obj);
741 struct collect_missing_entry_args {
742 struct got_fileindex *fileindex;
743 const struct got_tree_entries *entries;
744 struct got_pathset *missing_entries;
745 const char *current_subdir;
748 static const struct got_error *
749 collect_missing_file(void *args, struct got_fileindex_entry *entry)
751 const struct got_error *err = NULL;
752 struct collect_missing_entry_args *a = args;
755 struct got_tree_entry *te;
758 if (a->current_subdir[0] != '\0' &&
759 strncmp(a->current_subdir, entry->path,
760 strlen(a->current_subdir)) != 0)
763 start = entry->path + strlen(a->current_subdir);
764 while (start[0] == '/')
766 end = strchr(start, '/');
768 end = strchr(start, '\0');
770 return got_error(GOT_ERR_BAD_PATH);
774 SIMPLEQ_FOREACH(te, &a->entries->head, entry) {
775 if (strncmp(start, te->name, len) == 0 &&
776 te->name[len] == '\0') {
785 got_fileindex_entry_remove(a->fileindex, entry);
786 err = got_pathset_add(a->missing_entries, entry->path, NULL);
787 got_fileindex_entry_free(entry);
791 struct remove_missing_file_args {
792 const char *root_path;
793 got_worktree_checkout_cb progress_cb;
795 got_worktree_cancel_cb cancel_cb;
799 static const struct got_error *
800 remove_missing_file(const char *path, void *data, void *arg)
802 const struct got_error *err = NULL;
803 char *ondisk_path = NULL;
804 struct remove_missing_file_args *a = arg;
807 err = (*a->cancel_cb)(a->cancel_arg);
812 (*a->progress_cb)(a->progress_arg, GOT_STATUS_DELETE, path);
814 if (asprintf(&ondisk_path, "%s/%s", a->root_path, path) == -1)
815 return got_error_from_errno();
817 if (unlink(ondisk_path) == -1)
818 err = got_error_from_errno();
820 char *parent = dirname(ondisk_path);
821 while (parent && strcmp(parent, a->root_path) != 0) {
822 if (rmdir(parent) == -1 && errno != ENOTEMPTY) {
823 err = got_error_from_errno();
826 parent = dirname(parent);
833 /* Remove files which exist in the file index but not in the tree. */
834 static const struct got_error *
835 remove_missing_files(struct got_worktree *worktree, const char *path,
836 struct got_fileindex *fileindex, const struct got_tree_entries *entries,
837 got_worktree_checkout_cb progress_cb, void *progress_arg,
838 got_worktree_cancel_cb cancel_cb, void *cancel_arg)
840 const struct got_error *err = NULL;
841 struct collect_missing_entry_args a;
842 struct remove_missing_file_args a2;
844 a.fileindex = fileindex;
846 a.missing_entries = got_pathset_alloc();
847 if (a.missing_entries == NULL)
848 return got_error_from_errno();
849 a.current_subdir = apply_path_prefix(worktree, path);
850 err = got_fileindex_for_each_entry_safe(fileindex,
851 collect_missing_file, &a);
855 a2.root_path = worktree->root_path;
856 a2.cancel_cb = cancel_cb;
857 a2.cancel_arg = cancel_arg;
858 a2.progress_cb = progress_cb;
859 a2.progress_arg = progress_arg;
861 err = got_pathset_for_each(a.missing_entries, remove_missing_file, &a2);
862 got_pathset_free(a.missing_entries);
866 static const struct got_error *
867 tree_checkout(struct got_worktree *worktree,
868 struct got_fileindex *fileindex, struct got_tree_object *tree,
869 const char *path, struct got_repository *repo,
870 got_worktree_checkout_cb progress_cb, void *progress_arg,
871 got_worktree_cancel_cb cancel_cb, void *cancel_arg)
873 const struct got_error *err = NULL;
874 const struct got_tree_entries *entries;
875 struct got_tree_entry *te;
878 /* Skip this tree if it shares no path components with the prefix. */
879 len = MIN(strlen(worktree->path_prefix), strlen(path));
880 if (strncmp(path, worktree->path_prefix, len) != 0)
883 entries = got_object_tree_get_entries(tree);
884 SIMPLEQ_FOREACH(te, &entries->head, entry) {
886 err = (*cancel_cb)(cancel_arg);
890 err = tree_checkout_entry(worktree, fileindex, te, path, repo,
891 progress_cb, progress_arg, cancel_cb, cancel_arg);
896 len = strlen(worktree->path_prefix);
897 if (strncmp(worktree->path_prefix, path, len) == 0) {
898 err = remove_missing_files(worktree, path, fileindex, entries,
899 progress_cb, progress_arg, cancel_cb, cancel_arg);
907 const struct got_error *
908 got_worktree_checkout_files(struct got_worktree *worktree,
909 struct got_repository *repo, got_worktree_checkout_cb progress_cb,
910 void *progress_arg, got_worktree_cancel_cb cancel_cb, void *cancel_arg)
912 const struct got_error *err = NULL, *unlockerr, *checkout_err = NULL;
913 struct got_commit_object *commit = NULL;
914 struct got_tree_object *tree = NULL;
915 char *fileindex_path = NULL, *new_fileindex_path = NULL;
916 struct got_fileindex *fileindex = NULL;
917 FILE *index = NULL, *new_index = NULL;
919 err = lock_worktree(worktree, LOCK_EX);
923 fileindex = got_fileindex_alloc();
924 if (fileindex == NULL) {
925 err = got_error_from_errno();
929 if (asprintf(&fileindex_path, "%s/%s/%s", worktree->root_path,
930 GOT_WORKTREE_GOT_DIR, GOT_WORKTREE_FILE_INDEX) == -1) {
931 err = got_error_from_errno();
932 fileindex_path = NULL;
937 * Read the file index.
938 * Checking out files is supposed to be an idempotent operation.
939 * If the on-disk file index is incomplete we will try to complete it.
941 index = fopen(fileindex_path, "rb");
943 err = got_error_from_errno();
946 err = got_fileindex_read(fileindex, index);
951 err = got_opentemp_named(&new_fileindex_path, &new_index,
956 err = got_object_open_as_commit(&commit, repo,
957 worktree->base_commit_id);
961 err = got_object_open_as_tree(&tree, repo, commit->tree_id);
965 checkout_err = tree_checkout(worktree, fileindex, tree, "/", repo,
966 progress_cb, progress_arg, cancel_cb, cancel_arg);
968 /* Try to sync the fileindex back to disk in any case. */
969 err = got_fileindex_write(fileindex, new_index);
973 if (rename(new_fileindex_path, fileindex_path) != 0) {
974 err = got_error_from_errno();
978 free(new_fileindex_path);
979 new_fileindex_path = NULL;
983 got_object_tree_close(tree);
985 got_object_commit_close(commit);
986 if (new_fileindex_path)
987 unlink(new_fileindex_path);
990 free(new_fileindex_path);
991 free(fileindex_path);
992 got_fileindex_free(fileindex);
995 unlockerr = lock_worktree(worktree, LOCK_SH);
996 if (unlockerr && err == NULL)