lib/got_lib_fileindex.h

   1 /*
   2  * Copyright (c) 2018, 2019 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 /*
  18  * State information for a tracked file in a work tree.
  19  * When written to disk, multi-byte fields are written in big-endian.
  20  * Some fields are based on results from stat(2). These are only used in
  21  * order to detect modifications made to on-disk files, they are never
  22  * applied back to the filesystem.
  23  */
  24 struct got_fileindex_entry {
  25         RB_ENTRY(got_fileindex_entry) entry;
  26         uint64_t ctime_sec;
  27         uint64_t ctime_nsec;
  28         uint64_t mtime_sec;
  29         uint64_t mtime_nsec;
  30         uint32_t uid;
  31         uint32_t gid;
  32         /*
  33          * On-disk size is truncated to the lower 32 bits.
  34          * The value is only used to check for modifications anyway.
  35          */
  36         uint32_t size;
  37
  38         uint16_t mode;
  39 #define GOT_FILEIDX_MODE_FILE_TYPE      0x000f
  40 #define GOT_FILEIDX_MODE_FILE_TYPE_ONDISK       0x0003
  41 #define GOT_FILEIDX_MODE_FILE_TYPE_STAGED       0x000c
  42 #define GOT_FILEIDX_MODE_FILE_TYPE_STAGED_SHIFT 2
  43 #define GOT_FILEIDX_MODE_REGULAR_FILE   1
  44 #define GOT_FILEIDX_MODE_SYMLINK        2
  45 #define GOT_FILEIDX_MODE_BAD_SYMLINK    3
  46 #define GOT_FILEIDX_MODE_PERMS          0xfff0
  47 #define GOT_FILEIDX_MODE_PERMS_SHIFT    4
  48
  49         /* SHA1 of corresponding blob in repository. */
  50         uint8_t blob_sha1[SHA1_DIGEST_LENGTH];
  51
  52         /* SHA1 of corresponding base commit in repository. */
  53         uint8_t commit_sha1[SHA1_DIGEST_LENGTH];
  54
  55         uint32_t flags;
  56
  57         /*
  58          * UNIX-style path, relative to work tree root.
  59          * Variable length, and NUL-padded to a multiple of 8 on disk.
  60          */
  61         char *path;
  62
  63         /*
  64          * (since GOT_FILE_INDEX_VERSION 2)
  65          * SHA1 of staged blob in repository if stage equals either
  66          * GOT_FILEIDX_STAGE_MODIFY or GOT_FILEIDX_STAGE_ADD.
  67          * Otherwise, this field is not written to disk.
  68          */
  69         uint8_t staged_blob_sha1[SHA1_DIGEST_LENGTH];
  70 };
  71
  72 /* Modifications explicitly staged for commit. */
  73 #define GOT_FILEIDX_STAGE_NONE          0
  74 #define GOT_FILEIDX_STAGE_MODIFY        1
  75 #define GOT_FILEIDX_STAGE_ADD           2
  76 #define GOT_FILEIDX_STAGE_DELETE        3
  77
  78 struct got_fileindex;
  79
  80 RB_HEAD(got_fileindex_tree, got_fileindex_entry);
  81
  82 size_t got_fileindex_entry_path_len(const struct got_fileindex_entry *);
  83
  84 static inline int
  85 got_fileindex_cmp(const struct got_fileindex_entry *e1,
  86     const struct got_fileindex_entry *e2)
  87 {
  88         return got_path_cmp(e1->path, e2->path,
  89             got_fileindex_entry_path_len(e1),
  90             got_fileindex_entry_path_len(e2));
  91 }
  92
  93 RB_PROTOTYPE(got_fileindex_tree, got_fileindex_entry, entry, got_fileindex_cmp);
  94
  95 /* On-disk file index header structure. */
  96 struct got_fileindex_hdr {
  97         uint32_t signature;     /* big-endian */
  98 #define GOT_FILE_INDEX_SIGNATURE        0x676f7449 /* 'g', 'o', 't', 'I' */
  99         uint32_t version;       /* big-endian */
 100 #define GOT_FILE_INDEX_VERSION  2
 101         uint32_t nentries;      /* big-endian */
 102         /* list of concatenated fileindex entries */
 103         uint8_t sha1[SHA1_DIGEST_LENGTH]; /* checksum of above on-disk data */
 104 };
 105
 106 mode_t got_fileindex_entry_perms_get(struct got_fileindex_entry *);
 107 uint16_t got_fileindex_perms_from_st(struct stat *);
 108 mode_t got_fileindex_perms_to_st(struct got_fileindex_entry *);
 109
 110 const struct got_error *got_fileindex_entry_update(struct got_fileindex_entry *,
 111     int, const char *, uint8_t *, uint8_t *, int);
 112 void got_fileindex_entry_mark_skipped(struct got_fileindex_entry *);
 113 const struct got_error *got_fileindex_entry_alloc(struct got_fileindex_entry **,
 114     const char *);
 115 void got_fileindex_entry_free(struct got_fileindex_entry *);
 116
 117 struct got_fileindex *got_fileindex_alloc(void);
 118 void got_fileindex_free(struct got_fileindex *);
 119 const struct got_error *got_fileindex_write(struct got_fileindex *, FILE *);
 120 const struct got_error *got_fileindex_entry_add(struct got_fileindex *,
 121     struct got_fileindex_entry *);
 122 void got_fileindex_entry_remove(struct got_fileindex *,
 123     struct got_fileindex_entry *);
 124 struct got_fileindex_entry *got_fileindex_entry_get(struct got_fileindex *,
 125     const char *, size_t);
 126 const struct got_error *got_fileindex_read(struct got_fileindex *, FILE *);
 127 typedef const struct got_error *(*got_fileindex_cb)(void *,
 128     struct got_fileindex_entry *);
 129 const struct got_error *got_fileindex_for_each_entry_safe(
 130     struct got_fileindex *, got_fileindex_cb cb, void *);
 131
 132 typedef const struct got_error *(*got_fileindex_diff_tree_old_new_cb)(void *,
 133     struct got_fileindex_entry *, struct got_tree_entry *, const char *);
 134 typedef const struct got_error *(*got_fileindex_diff_tree_old_cb)(void *,
 135     struct got_fileindex_entry *, const char *);
 136 typedef const struct got_error *(*got_fileindex_diff_tree_new_cb)(void *,
 137     struct got_tree_entry *, const char *);
 138 struct got_fileindex_diff_tree_cb {
 139         got_fileindex_diff_tree_old_new_cb diff_old_new;
 140         got_fileindex_diff_tree_old_cb diff_old;
 141         got_fileindex_diff_tree_new_cb diff_new;
 142 };
 143 const struct got_error *got_fileindex_diff_tree(struct got_fileindex *,
 144     struct got_tree_object *, const char *, const char *,
 145     struct got_repository *, struct got_fileindex_diff_tree_cb *, void *);
 146
 147 typedef const struct got_error *(*got_fileindex_diff_dir_old_new_cb)(void *,
 148     struct got_fileindex_entry *, struct dirent *, const char *, int);
 149 typedef const struct got_error *(*got_fileindex_diff_dir_old_cb)(void *,
 150     struct got_fileindex_entry *, const char *);
 151 typedef const struct got_error *(*got_fileindex_diff_dir_new_cb)(int *, void *,
 152     struct dirent *, const char *, int);
 153 typedef const struct got_error *(*got_fileindex_diff_dir_traverse)(void *,
 154     const char *, int);
 155 struct got_fileindex_diff_dir_cb {
 156         got_fileindex_diff_dir_old_new_cb diff_old_new;
 157         got_fileindex_diff_dir_old_cb diff_old;
 158         got_fileindex_diff_dir_new_cb diff_new;
 159         got_fileindex_diff_dir_traverse diff_traverse;
 160 };
 161 const struct got_error *got_fileindex_diff_dir(struct got_fileindex *, int,
 162     const char *, const char *, struct got_repository *,
 163     struct got_fileindex_diff_dir_cb *, void *);
 164
 165 int got_fileindex_entry_has_blob(struct got_fileindex_entry *);
 166 int got_fileindex_entry_has_commit(struct got_fileindex_entry *);
 167 int got_fileindex_entry_has_file_on_disk(struct got_fileindex_entry *);
 168 int got_fileindex_entry_was_skipped(struct got_fileindex_entry *);
 169 uint32_t got_fileindex_entry_stage_get(const struct got_fileindex_entry *);
 170 void got_fileindex_entry_stage_set(struct got_fileindex_entry *ie, uint32_t);
 171 int got_fileindex_entry_filetype_get(struct got_fileindex_entry *);
 172 void got_fileindex_entry_filetype_set(struct got_fileindex_entry *, int);
 173 void got_fileindex_entry_staged_filetype_set(struct got_fileindex_entry *, int);
 174 int got_fileindex_entry_staged_filetype_get(struct got_fileindex_entry *);
 175
 176 void got_fileindex_entry_mark_deleted_from_disk(struct got_fileindex_entry *);
 177
 178 /*
 179  * Retrieve staged, blob or commit id from a fileindex entry, and return
 180  * the given object id.
 181  */
 182 struct got_object_id *got_fileindex_entry_get_staged_blob_id(
 183     struct got_object_id *, struct got_fileindex_entry *);
 184 struct got_object_id *got_fileindex_entry_get_blob_id(struct got_object_id *,
 185     struct got_fileindex_entry *);
 186 struct got_object_id *got_fileindex_entry_get_commit_id(struct got_object_id *,
 187     struct got_fileindex_entry *);