thodg/libgit2/src/filebuf.h

• Show log

  Commit

• Hash : 744cc03e
  Author :
  Date : 2012-10-30T12:10:36
  

  Add git_config_refresh() API to reload config This adds a new API that allows users to reload the config if the file has changed on disk. A new config callback function to refresh the config was added. The modified time and file size are used to test if the file needs to be reloaded (and are now stored in the disk backend object). In writing tests, just using mtime was a problem / race, so I wanted to check file size as well. To support that, I extended `git_futils_readbuffer_updated` to optionally check file size in addition to mtime, and I added a new function `git_filebuf_stats` to fetch the mtime and size for an open filebuf (so that the config could be easily refreshed after a write). Lastly, I moved some similar file checking code for attributes into filebuf. It is still only being used for attrs, but it seems potentially reusable, so I thought I'd move it over.

Download

• src/filebuf.h

• /*
   * 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_filebuf_h__
  #define INCLUDE_filebuf_h__
  
  #include "fileops.h"
  #include "hash.h"
  #include <zlib.h>
  
  #ifdef GIT_THREADS
  #	define GIT_FILEBUF_THREADS
  #endif
  
  #define GIT_FILEBUF_HASH_CONTENTS		(1 << 0)
  #define GIT_FILEBUF_APPEND				(1 << 2)
  #define GIT_FILEBUF_FORCE				(1 << 3)
  #define GIT_FILEBUF_TEMPORARY			(1 << 4)
  #define GIT_FILEBUF_DO_NOT_BUFFER		(1 << 5)
  #define GIT_FILEBUF_DEFLATE_SHIFT		(6)
  
  #define GIT_FILELOCK_EXTENSION ".lock\0"
  #define GIT_FILELOCK_EXTLENGTH 6
  
  struct git_filebuf {
  	char *path_original;
  	char *path_lock;
  
  	int (*write)(struct git_filebuf *file, void *source, size_t len);
  
  	git_hash_ctx *digest;
  
  	unsigned char *buffer;
  	unsigned char *z_buf;
  
  	z_stream zs;
  	int flush_mode;
  
  	size_t buf_size, buf_pos;
  	git_file fd;
  	bool fd_is_open;
  	bool do_not_buffer;
  	int last_error;
  };
  
  typedef struct git_filebuf git_filebuf;
  
  #define GIT_FILEBUF_INIT {0}
  
  /*
   * The git_filebuf object lifecycle is:
   * - Allocate git_filebuf, preferably using GIT_FILEBUF_INIT.
   *
   * - Call git_filebuf_open() to initialize the filebuf for use.
   *
   * - Make as many calls to git_filebuf_write(), git_filebuf_printf(),
   *   git_filebuf_reserve() as you like. The error codes for these
   *   functions don't need to be checked. They are stored internally
   *   by the file buffer.
   *
   * - While you are writing, you may call git_filebuf_hash() to get
   *   the hash of all you have written so far. This function will
   *   fail if any of the previous writes to the buffer failed.
   *
   * - To close the git_filebuf, you may call git_filebuf_commit() or
   *   git_filebuf_commit_at() to save the file, or
   *   git_filebuf_cleanup() to abandon the file.  All of these will
   *   free the git_filebuf object. Likewise, all of these will fail
   *   if any of the previous writes to the buffer failed, and set
   *   an error code accordingly.
   */
  int git_filebuf_write(git_filebuf *lock, const void *buff, size_t len);
  int git_filebuf_reserve(git_filebuf *file, void **buff, size_t len);
  int git_filebuf_printf(git_filebuf *file, const char *format, ...) GIT_FORMAT_PRINTF(2, 3);
  
  int git_filebuf_open(git_filebuf *lock, const char *path, int flags);
  int git_filebuf_commit(git_filebuf *lock, mode_t mode);
  int git_filebuf_commit_at(git_filebuf *lock, const char *path, mode_t mode);
  void git_filebuf_cleanup(git_filebuf *lock);
  int git_filebuf_hash(git_oid *oid, git_filebuf *file);
  int git_filebuf_flush(git_filebuf *file);
  int git_filebuf_stats(time_t *mtime, size_t *size, git_filebuf *file);
  
  #endif
  

Download