src/fileops.h

   1 /*
   2  * fileops.h - OS agnostic disk io operations
   3  *
   4  * This header describes the strictly internal part of the api
   5  */
   6 #ifndef INCLUDE_fileops_h__
   7 #define INCLUDE_fileops_h__
   8
   9 #include "common.h"
  10 #include "map.h"
  11 #include "dir.h"
  12 #include <fcntl.h>
  13 #include <time.h>
  14
  15 #ifdef GIT_WIN32
  16 #define GIT_PLATFORM_PATH_SEP '\\'
  17 #else
  18 #define GIT_PLATFORM_PATH_SEP '/'
  19 #endif
  20
  21 #define S_IFGITLINK 0160000
  22 #define S_ISGITLINK(m) (((m) & S_IFMT) == S_IFGITLINK)
  23
  24 #ifdef GIT_WIN32
  25 GIT_INLINE(int) link(const char *GIT_UNUSED(old), const char *GIT_UNUSED(new))
  26 {
  27         GIT_UNUSED_ARG(old)
  28         GIT_UNUSED_ARG(new)
  29         errno = ENOSYS;
  30         return -1;
  31 }
  32
  33 GIT_INLINE(int) git__mkdir(const char *path, int GIT_UNUSED(mode))
  34 {
  35         GIT_UNUSED_ARG(mode)
  36         return mkdir(path);
  37 }
  38
  39 extern int git__unlink(const char *path);
  40 extern int git__mkstemp(char *template);
  41 extern int git__fsync(int fd);
  42
  43 # ifndef GIT__WIN32_NO_HIDE_FILEOPS
  44 #  define unlink(p) git__unlink(p)
  45 #  define mkstemp(t) git__mkstemp(t)
  46 #  define mkdir(p,m) git__mkdir(p, m)
  47 #  define fsync(fd) git__fsync(fd)
  48 # endif
  49 #endif  /* GIT_WIN32 */
  50
  51
  52 #if !defined(O_BINARY)
  53 #define O_BINARY 0
  54 #endif
  55
  56 #define GITFO_BUF_INIT {NULL, 0}
  57
  58 typedef int git_file;
  59
  60 typedef struct {  /* file io buffer  */
  61         void *data;  /* data bytes   */
  62         size_t len;  /* data length  */
  63 } gitfo_buf;
  64
  65 extern int gitfo_exists(const char *path);
  66 extern int gitfo_open(const char *path, int flags);
  67 extern int gitfo_creat(const char *path, int mode);
  68 extern int gitfo_creat_force(const char *path, int mode);
  69 extern int gitfo_creat_locked(const char *path, int mode);
  70 extern int gitfo_creat_locked_force(const char *path, int mode);
  71 extern int gitfo_mktemp(char *path_out, const char *filename);
  72 extern int gitfo_isdir(const char *path);
  73 extern int gitfo_isfile(const char *path);
  74 extern int gitfo_mkdir_recurs(const char *path, int mode);
  75 extern int gitfo_mkdir_2file(const char *path);
  76 #define gitfo_close(fd) close(fd)
  77
  78 extern int gitfo_read(git_file fd, void *buf, size_t cnt);
  79 extern int gitfo_write(git_file fd, void *buf, size_t cnt);
  80 #define gitfo_lseek(f,n,w) lseek(f, n, w)
  81 extern git_off_t gitfo_size(git_file fd);
  82
  83 extern int gitfo_read_file(gitfo_buf *obj, const char *path);
  84 extern void gitfo_free_buf(gitfo_buf *obj);
  85
  86 /* Move (rename) a file; this operation is atomic */
  87 extern int gitfo_mv(const char *from, const char *to);
  88
  89 /* Move a file (forced); this will create the destination
  90  * path if it doesn't exist */
  91 extern int gitfo_mv_force(const char *from, const char *to);
  92
  93 #define gitfo_stat(p,b) stat(p, b)
  94 #define gitfo_fstat(f,b) fstat(f, b)
  95
  96 #ifdef GIT_WIN32
  97 #  define gitfo_lstat(p,b) gitfo_lstat__w32(p,b)
  98 #  define gitfo_readlink(a, b, c) gitfo_readlink__w32(a, b, c)
  99
 100    extern int gitfo_lstat__w32(const char *file_name, struct stat *buf);
 101    extern int gitfo_readlink__w32(const char *link, char *target, size_t target_len);
 102 #else
 103 #  define gitfo_lstat(p,b) lstat(p,b)
 104 #  define gitfo_readlink(a, b, c) readlink(a, b, c)
 105 #endif
 106
 107 #define gitfo_unlink(p) unlink(p)
 108 #define gitfo_rmdir(p) rmdir(p)
 109 #define gitfo_chdir(p) chdir(p)
 110 #define gitfo_mkdir(p,m) mkdir(p, m)
 111
 112 #define gitfo_mkstemp(t) mkstemp(t)
 113 #define gitfo_fsync(fd) fsync(fd)
 114 #define gitfo_chmod(p,m) chmod(p, m)
 115
 116 /**
 117  * Read-only map all or part of a file into memory.
 118  * When possible this function should favor a virtual memory
 119  * style mapping over some form of malloc()+read(), as the
 120  * data access will be random and is not likely to touch the
 121  * majority of the region requested.
 122  *
 123  * @param out buffer to populate with the mapping information.
 124  * @param fd open descriptor to configure the mapping from.
 125  * @param begin first byte to map, this should be page aligned.
 126  * @param end number of bytes to map.
 127  * @return
 128  * - GIT_SUCCESS on success;
 129  * - GIT_EOSERR on an unspecified OS related error.
 130  */
 131 extern int gitfo_map_ro(
 132         git_map *out,
 133         git_file fd,
 134         git_off_t begin,
 135         size_t len);
 136
 137 /**
 138  * Release the memory associated with a previous memory mapping.
 139  * @param map the mapping description previously configured.
 140  */
 141 extern void gitfo_free_map(git_map *map);
 142
 143 /**
 144  * Walk each directory entry, except '.' and '..', calling fn(state).
 145  *
 146  * @param pathbuf buffer the function reads the initial directory
 147  *              path from, and updates with each successive entry's name.
 148  * @param pathmax maximum allocation of pathbuf.
 149  * @param fn function to invoke with each entry.  The first arg is
 150  *              the input state and the second arg is pathbuf.  The function
 151  *              may modify the pathbuf, but only by appending new text.
 152  * @param state to pass to fn as the first arg.
 153  */
 154 extern int gitfo_dirent(
 155         char *pathbuf,
 156         size_t pathmax,
 157         int (*fn)(void *, char *),
 158         void *state);
 159
 160 extern int gitfo_cmp_path(const char *name1, int len1, int isdir1,
 161                 const char *name2, int len2, int isdir2);
 162
 163 extern int gitfo_getcwd(char *buffer_out, size_t size);
 164
 165 /**
 166  * Clean up a provided absolute or relative directory path.
 167  *
 168  * This prettification relies on basic operations such as coalescing
 169  * multiple forward slashes into a single slash, removing '.' and
 170  * './' current directory segments, and removing parent directory
 171  * whenever '..' is encountered.
 172  *
 173  * If not empty, the returned path ends with a forward slash.
 174  *
 175  * For instance, this will turn "d1/s1///s2/..//../s3" into "d1/s3/".
 176  *
 177  * This only performs a string based analysis of the path.
 178  * No checks are done to make sure the path actually makes sense from
 179  * the file system perspective.
 180  *
 181  * @param buffer_out buffer to populate with the normalized path.
 182  * @param size buffer size.
 183  * @param path directory path to clean up.
 184  * @return
 185  * - GIT_SUCCESS on success;
 186  * - GIT_ERROR when the input path is invalid or escapes the current directory.
 187  */
 188 int gitfo_prettify_dir_path(char *buffer_out, size_t size, const char *path, const char *base_path);
 189
 190 /**
 191  * Clean up a provided absolute or relative file path.
 192  *
 193  * This prettification relies on basic operations such as coalescing
 194  * multiple forward slashes into a single slash, removing '.' and
 195  * './' current directory segments, and removing parent directory
 196  * whenever '..' is encountered.
 197  *
 198  * For instance, this will turn "d1/s1///s2/..//../s3" into "d1/s3".
 199  *
 200  * This only performs a string based analysis of the path.
 201  * No checks are done to make sure the path actually makes sense from
 202  * the file system perspective.
 203  *
 204  * @param buffer_out buffer to populate with the normalized path.
 205  * @param size buffer size.
 206  * @param path file path to clean up.
 207  * @return
 208  * - GIT_SUCCESS on success;
 209  * - GIT_ERROR when the input path is invalid or escapes the current directory.
 210  */
 211 int gitfo_prettify_file_path(char *buffer_out, size_t size, const char *path, const char *base_path);
 212
 213 void gitfo_posixify_path(char *path);
 214
 215 int gitfo_retrieve_path_root_offset(const char *path);
 216
 217 #endif /* INCLUDE_fileops_h__ */