thodg/libgit2/src/mwindow.h

• Show log

  Commit

• Hash : 0c7f49dd
  Author :
  Date : 2017-06-30T13:39:01
  

  Make sure to always include "common.h" first
  
  Next to including several files, our "common.h" header also declares
  various macros which are then used throughout the project. As such, we
  have to make sure to always include this file first in all
  implementation files. Otherwise, we might encounter problems or even
  silent behavioural differences due to macros or defines not being
  defined as they should be. So in fact, our header and implementation
  files should make sure to always include "common.h" first.
  
  This commit does so by establishing a common include pattern. Header
  files inside of "src" will now always include "common.h" as its first
  other file, separated by a newline from all the other includes to make
  it stand out as special. There are two cases for the implementation
  files. If they do have a matching header file, they will always include
  this one first, leading to "common.h" being transitively included as
  first file. If they do not have a matching header file, they instead
  include "common.h" as first file themselves.
  
  This fixes the outlined problems and will become our standard practice
  for header and source files inside of the "src/" from now on.
  

Download

• src/mwindow.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * 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_mwindow__
  #define INCLUDE_mwindow__
  
  #include "common.h"
  
  #include "map.h"
  #include "vector.h"
  
  typedef struct git_mwindow {
  	struct git_mwindow *next;
  	git_map window_map;
  	git_off_t offset;
  	size_t last_used;
  	size_t inuse_cnt;
  } git_mwindow;
  
  typedef struct git_mwindow_file {
  	git_mwindow *windows;
  	int fd;
  	git_off_t size;
  } git_mwindow_file;
  
  typedef struct git_mwindow_ctl {
  	size_t mapped;
  	unsigned int open_windows;
  	unsigned int mmap_calls;
  	unsigned int peak_open_windows;
  	size_t peak_mapped;
  	size_t used_ctr;
  	git_vector windowfiles;
  } git_mwindow_ctl;
  
  int git_mwindow_contains(git_mwindow *win, git_off_t offset);
  void git_mwindow_free_all(git_mwindow_file *mwf); /* locks */
  void git_mwindow_free_all_locked(git_mwindow_file *mwf); /* run under lock */
  unsigned char *git_mwindow_open(git_mwindow_file *mwf, git_mwindow **cursor, git_off_t offset, size_t extra, unsigned int *left);
  int git_mwindow_file_register(git_mwindow_file *mwf);
  void git_mwindow_file_deregister(git_mwindow_file *mwf);
  void git_mwindow_close(git_mwindow **w_cursor);
  
  extern int git_mwindow_global_init(void);
  
  struct git_pack_file; /* just declaration to avoid cyclical includes */
  int git_mwindow_get_pack(struct git_pack_file **out, const char *path);
  void git_mwindow_put_pack(struct git_pack_file *pack);
  
  #endif
  

Download