src/index.h

   1 /*
   2  * Copyright (C) the libgit2 contributors. All rights reserved.
   3  *
   4  * This file is part of libgit2, distributed under the GNU GPL v2 with
   5  * a Linking Exception. For full terms see the included COPYING file.
   6  */
   7 #ifndef INCLUDE_index_h__
   8 #define INCLUDE_index_h__
   9
  10 #include "fileops.h"
  11 #include "filebuf.h"
  12 #include "vector.h"
  13 #include "idxmap.h"
  14 #include "tree-cache.h"
  15 #include "git2/odb.h"
  16 #include "git2/index.h"
  17
  18 #define GIT_INDEX_FILE "index"
  19 #define GIT_INDEX_FILE_MODE 0666
  20
  21 struct git_index {
  22         git_refcount rc;
  23
  24         char *index_file_path;
  25         git_futils_filestamp stamp;
  26         git_oid checksum;   /* checksum at the end of the file */
  27
  28         git_vector entries;
  29         git_idxmap *entries_map;
  30
  31         git_vector deleted; /* deleted entries if readers > 0 */
  32         git_atomic readers; /* number of active iterators */
  33
  34         unsigned int on_disk:1;
  35         unsigned int ignore_case:1;
  36         unsigned int distrust_filemode:1;
  37         unsigned int no_symlinks:1;
  38
  39         git_tree_cache *tree;
  40         git_pool tree_pool;
  41
  42         git_vector names;
  43         git_vector reuc;
  44
  45         git_vector_cmp entries_cmp_path;
  46         git_vector_cmp entries_search;
  47         git_vector_cmp entries_search_path;
  48         git_vector_cmp reuc_search;
  49 };
  50
  51 struct git_index_conflict_iterator {
  52         git_index *index;
  53         size_t cur;
  54 };
  55
  56 extern void git_index_entry__init_from_stat(
  57         git_index_entry *entry, struct stat *st, bool trust_mode);
  58
  59 /* Index entry comparison functions for array sorting */
  60 extern int git_index_entry_cmp(const void *a, const void *b);
  61 extern int git_index_entry_icmp(const void *a, const void *b);
  62
  63 /* Index entry search functions for search using a search spec */
  64 extern int git_index_entry_srch(const void *a, const void *b);
  65 extern int git_index_entry_isrch(const void *a, const void *b);
  66
  67 /* Index time handling functions */
  68 GIT_INLINE(bool) git_index_time_eq(const git_index_time *one, const git_index_time *two)
  69 {
  70         if (one->seconds != two->seconds)
  71                 return false;
  72
  73 #ifdef GIT_USE_NSEC
  74         if (one->nanoseconds != two->nanoseconds)
  75                 return false;
  76 #endif
  77
  78         return true;
  79 }
  80
  81 /*
  82  * Test if the given index time is newer than the given existing index entry.
  83  * If the timestamps are exactly equivalent, then the given index time is
  84  * considered "racily newer" than the existing index entry.
  85  */
  86 GIT_INLINE(bool) git_index_entry_newer_than_index(
  87         const git_index_entry *entry, git_index *index)
  88 {
  89         /* If we never read the index, we can't have this race either */
  90         if (!index || index->stamp.mtime.tv_sec == 0)
  91                 return false;
  92
  93         /* If the timestamp is the same or newer than the index, it's racy */
  94 #if defined(GIT_USE_NSEC)
  95         if ((int32_t)index->stamp.mtime.tv_sec < entry->mtime.seconds)
  96                 return true;
  97         else if ((int32_t)index->stamp.mtime.tv_sec > entry->mtime.seconds)
  98                 return false;
  99         else
 100                 return (uint32_t)index->stamp.mtime.tv_nsec <= entry->mtime.nanoseconds;
 101 #else
 102         return ((int32_t)index->stamp.mtime.tv_sec) <= entry->mtime.seconds;
 103 #endif
 104 }
 105
 106 /* Search index for `path`, returning GIT_ENOTFOUND if it does not exist
 107  * (but not setting an error message).
 108  *
 109  * `at_pos` is set to the position where it is or would be inserted.
 110  * Pass `path_len` as strlen of path or 0 to call strlen internally.
 111  */
 112 extern int git_index__find_pos(
 113         size_t *at_pos, git_index *index, const char *path, size_t path_len, int stage);
 114
 115 extern int git_index__fill(git_index *index, const git_vector *source_entries);
 116
 117 extern void git_index__set_ignore_case(git_index *index, bool ignore_case);
 118
 119 extern unsigned int git_index__create_mode(unsigned int mode);
 120
 121 GIT_INLINE(const git_futils_filestamp *) git_index__filestamp(git_index *index)
 122 {
 123    return &index->stamp;
 124 }
 125
 126 extern int git_index__changed_relative_to(git_index *index, const git_oid *checksum);
 127
 128 /* Copy the current entries vector *and* increment the index refcount.
 129  * Call `git_index__release_snapshot` when done.
 130  */
 131 extern int git_index_snapshot_new(git_vector *snap, git_index *index);
 132 extern void git_index_snapshot_release(git_vector *snap, git_index *index);
 133
 134 /* Allow searching in a snapshot; entries must already be sorted! */
 135 extern int git_index_snapshot_find(
 136         size_t *at_pos, git_vector *snap, git_vector_cmp entry_srch,
 137         const char *path, size_t path_len, int stage);
 138
 139 /* Replace an index with a new index */
 140 int git_index_read_index(git_index *index, const git_index *new_index);
 141
 142 typedef struct {
 143         git_index *index;
 144         git_filebuf file;
 145         unsigned int should_write:1;
 146 } git_indexwriter;
 147
 148 #define GIT_INDEXWRITER_INIT { NULL, GIT_FILEBUF_INIT }
 149
 150 /* Lock the index for eventual writing. */
 151 extern int git_indexwriter_init(git_indexwriter *writer, git_index *index);
 152
 153 /* Lock the index for eventual writing by a repository operation: a merge,
 154  * revert, cherry-pick or a rebase.  Note that the given checkout strategy
 155  * will be updated for the operation's use so that checkout will not write
 156  * the index.
 157  */
 158 extern int git_indexwriter_init_for_operation(
 159         git_indexwriter *writer,
 160         git_repository *repo,
 161         unsigned int *checkout_strategy);
 162
 163 /* Write the index and unlock it. */
 164 extern int git_indexwriter_commit(git_indexwriter *writer);
 165
 166 /* Cleanup an index writing session, unlocking the file (if it is still
 167  * locked and freeing any data structures.
 168  */
 169 extern void git_indexwriter_cleanup(git_indexwriter *writer);
 170
 171 #endif