1 /*
2  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3  *
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.
7  *
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.
15  */
16 
17 struct got_worktree {
18 	char *root_path;
19 	char *repo_path;
20 	char *path_prefix;
21 	struct got_object_id *base_commit_id;
22 	char *head_ref_name;
23 	uuid_t uuid;
24 
25 	/*
26 	 * File descriptor for the lock file, open while a work tree is open.
27 	 * When a work tree is opened, a shared lock on the lock file is
28 	 * acquired with flock(2). This shared lock is held until the work
29 	 * tree is closed, i.e. throughout the lifetime of any operation
30 	 * which uses a work tree.
31 	 * Before any modifications are made to the on-disk state of work
32 	 * tree meta data, tracked files, or directory tree structure, this
33 	 * shared lock must be upgraded to an exclusive lock.
34 	 */
35 	int lockfd;
36 };
37 
38 struct got_commitable {
39 	char *path;
40 	char *in_repo_path;
41 	char *ondisk_path;
42 	unsigned char status;
43 	struct got_object_id *blob_id;
44 	struct got_object_id *base_blob_id;
45 	struct got_object_id *base_commit_id;
46 	mode_t mode;
47 	int flags;
48 #define GOT_COMMITABLE_ADDED 0x01
49 };
50 
51 #define GOT_WORKTREE_GOT_DIR		".got"
52 #define GOT_WORKTREE_FILE_INDEX		"file-index"
53 #define GOT_WORKTREE_REPOSITORY		"repository"
54 #define GOT_WORKTREE_PATH_PREFIX	"path-prefix"
55 #define GOT_WORKTREE_HEAD_REF		"head-ref"
56 #define GOT_WORKTREE_BASE_COMMIT	"base-commit"
57 #define GOT_WORKTREE_LOCK		"lock"
58 #define GOT_WORKTREE_FORMAT		"format"
59 #define GOT_WORKTREE_UUID		"uuid"
60 #define GOT_WORKTREE_HISTEDIT_SCRIPT	"histedit-script"
61 
62 #define GOT_WORKTREE_FORMAT_VERSION	1
63 #define GOT_WORKTREE_INVALID_COMMIT_ID	GOT_SHA1_STRING_ZERO
64 
65 #define GOT_WORKTREE_BASE_REF_PREFIX "refs/got/worktree/base"
66 
67 const struct got_error *got_worktree_get_base_ref_name(char **,
68     struct got_worktree *worktree);
69 
70 /* Temporary branch which accumulates commits during a rebase operation. */
71 #define GOT_WORKTREE_REBASE_TMP_REF_PREFIX "refs/got/worktree/rebase/tmp"
72 
73 /* Symbolic reference pointing at the name of the new base branch. */
74 #define GOT_WORKTREE_NEWBASE_REF_PREFIX "refs/got/worktree/rebase/newbase"
75 
76 /* Symbolic reference pointing at the name of the branch being rebased. */
77 #define GOT_WORKTREE_REBASE_BRANCH_REF_PREFIX "refs/got/worktree/rebase/branch"
78 
79 /* Reference pointing at the ID of the current commit being rebased. */
80 #define GOT_WORKTREE_REBASE_COMMIT_REF_PREFIX "refs/got/worktree/rebase/commit"
81 
82 /* Temporary branch which accumulates commits during a histedit operation. */
83 #define GOT_WORKTREE_HISTEDIT_TMP_REF_PREFIX "refs/got/worktree/histedit/tmp"
84 
85 /* Symbolic reference pointing at the name of the branch being edited. */
86 #define GOT_WORKTREE_HISTEDIT_BRANCH_REF_PREFIX \
87 	"refs/got/worktree/histedit/branch"
88 
89 /* Reference pointing at the ID of the work tree's pre-edit base commit. */
90 #define GOT_WORKTREE_HISTEDIT_BASE_COMMIT_REF_PREFIX \
91 	"refs/got/worktree/histedit/base-commit"
92 
93 /* Reference pointing at the ID of the current commit being edited. */
94 #define GOT_WORKTREE_HISTEDIT_COMMIT_REF_PREFIX \
95 	"refs/got/worktree/histedit/commit"