mirror of
https://git.proxmox.com/git/libgit2
synced 2025-05-13 08:47:36 +00:00
13224ea4aa
This makes so much sense that I can't believe it hasn't been done before. Kill the old `git_fbuffer` and read files straight into `git_buf` objects. Also: In order to fully support 4GB files in 32-bit systems, the `git_buf` implementation has been changed from using `ssize_t` for storage and storing negative values on allocation failure, to using `size_t` and changing the buffer pointer to a magical pointer on allocation failure. Hopefully this won't break anything.
142 lines
4.0 KiB
C
142 lines
4.0 KiB
C
/*
|
|
* Copyright (C) 2009-2012 the libgit2 contributors
|
|
*
|
|
* This file is part of libgit2, distributed under the GNU GPL v2 with
|
|
* a Linking Exception. For full terms see the included COPYING file.
|
|
*/
|
|
#ifndef INCLUDE_fileops_h__
|
|
#define INCLUDE_fileops_h__
|
|
|
|
#include "common.h"
|
|
#include "map.h"
|
|
#include "posix.h"
|
|
#include "path.h"
|
|
|
|
/**
|
|
* Filebuffer methods
|
|
*
|
|
* Read whole files into an in-memory buffer for processing
|
|
*/
|
|
extern int git_futils_readbuffer(git_buf *obj, const char *path);
|
|
extern int git_futils_readbuffer_updated(git_buf *obj, const char *path, time_t *mtime, int *updated);
|
|
|
|
/**
|
|
* File utils
|
|
*
|
|
* These are custom filesystem-related helper methods. They are
|
|
* rather high level, and wrap the underlying POSIX methods
|
|
*
|
|
* All these methods return GIT_SUCCESS on success,
|
|
* or an error code on failure and an error message is set.
|
|
*/
|
|
|
|
/**
|
|
* Create and open a file, while also
|
|
* creating all the folders in its path
|
|
*/
|
|
extern int git_futils_creat_withpath(const char *path, const mode_t dirmode, const mode_t mode);
|
|
|
|
/**
|
|
* Create an open a process-locked file
|
|
*/
|
|
extern int git_futils_creat_locked(const char *path, const mode_t mode);
|
|
|
|
/**
|
|
* Create an open a process-locked file, while
|
|
* also creating all the folders in its path
|
|
*/
|
|
extern int git_futils_creat_locked_withpath(const char *path, const mode_t dirmode, const mode_t mode);
|
|
|
|
/**
|
|
* Create a path recursively
|
|
*/
|
|
extern int git_futils_mkdir_r(const char *path, const char *base, const mode_t mode);
|
|
|
|
/**
|
|
* Create all the folders required to contain
|
|
* the full path of a file
|
|
*/
|
|
extern int git_futils_mkpath2file(const char *path, const mode_t mode);
|
|
|
|
/**
|
|
* Remove path and any files and directories beneath it.
|
|
*/
|
|
extern int git_futils_rmdir_r(const char *path, int force);
|
|
|
|
/**
|
|
* Create and open a temporary file with a `_git2_` suffix.
|
|
* Writes the filename into path_out.
|
|
* @return On success, an open file descriptor, else an error code < 0.
|
|
*/
|
|
extern int git_futils_mktmp(git_buf *path_out, const char *filename);
|
|
|
|
/**
|
|
* Move a file on the filesystem, create the
|
|
* destination path if it doesn't exist
|
|
*/
|
|
extern int git_futils_mv_withpath(const char *from, const char *to, const mode_t dirmode);
|
|
|
|
/**
|
|
* Get the filesize in bytes of a file
|
|
*/
|
|
extern git_off_t git_futils_filesize(git_file fd);
|
|
|
|
/**
|
|
* Convert a mode_t from the OS to a legal git mode_t value.
|
|
*/
|
|
extern mode_t git_futils_canonical_mode(mode_t raw_mode);
|
|
|
|
|
|
/**
|
|
* Read-only map all or part of a file into memory.
|
|
* When possible this function should favor a virtual memory
|
|
* style mapping over some form of malloc()+read(), as the
|
|
* data access will be random and is not likely to touch the
|
|
* majority of the region requested.
|
|
*
|
|
* @param out buffer to populate with the mapping information.
|
|
* @param fd open descriptor to configure the mapping from.
|
|
* @param begin first byte to map, this should be page aligned.
|
|
* @param end number of bytes to map.
|
|
* @return
|
|
* - GIT_SUCCESS on success;
|
|
* - GIT_EOSERR on an unspecified OS related error.
|
|
*/
|
|
extern int git_futils_mmap_ro(
|
|
git_map *out,
|
|
git_file fd,
|
|
git_off_t begin,
|
|
size_t len);
|
|
|
|
/**
|
|
* Release the memory associated with a previous memory mapping.
|
|
* @param map the mapping description previously configured.
|
|
*/
|
|
extern void git_futils_mmap_free(git_map *map);
|
|
|
|
/**
|
|
* Find a "global" file (i.e. one in a user's home directory).
|
|
*
|
|
* @param pathbuf buffer to write the full path into
|
|
* @param filename name of file to find in the home directory
|
|
* @return
|
|
* - GIT_SUCCESS if found;
|
|
* - GIT_ENOTFOUND if not found;
|
|
* - GIT_EOSERR on an unspecified OS related error.
|
|
*/
|
|
extern int git_futils_find_global_file(git_buf *path, const char *filename);
|
|
|
|
/**
|
|
* Find a "system" file (i.e. one shared for all users of the system).
|
|
*
|
|
* @param pathbuf buffer to write the full path into
|
|
* @param filename name of file to find in the home directory
|
|
* @return
|
|
* - GIT_SUCCESS if found;
|
|
* - GIT_ENOTFOUND if not found;
|
|
* - GIT_EOSERR on an unspecified OS related error.
|
|
*/
|
|
extern int git_futils_find_system_file(git_buf *path, const char *filename);
|
|
|
|
#endif /* INCLUDE_fileops_h__ */
|