thodg/libgit2/src/oidmap.h

• Show log

  Commit

• Hash : 94af9155
  Author :
  Date : 2017-03-20T09:01:18
  

  map: remove `*map_free` macros The `map_free` functions were not implemented as functions but instead as macros which also set the map to NULL. While this is most certainly sensible in most cases, we should prefer the more obvious behavior, namingly leaving the map pointer intact. Furthermore, this macro has been refactored incorrectly during the map-refactorings: the two statements are not actually grouped together by a `do { ... } while (0)` block, as it is required for macros to match the behavior of functions more closely. This has led to at least one subtle nesting error in `pack-objects.c`. The following code block ``` if (pb->object_ix) git_oidmap_free(pb->object_ix); ``` would be expanded to ``` if (pb->object_ix) git_oidmap__free(pb->object_ix); pb->object_ix = NULL; ``` which is not what one woudl expect. While it is not a bug here as it would simply become a no-op, the wrong implementation could lead to bugs in other occasions. Fix this by simply removing the macro altogether and replacing it with real function calls. This leaves the burden of setting the pointer to NULL afterwards to the caller, but this is actually expected and behaves like other `free` functions.

Download

• src/oidmap.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_oidmap_h__
  #define INCLUDE_oidmap_h__
  
  #include "common.h"
  #include "git2/oid.h"
  
  #define kmalloc git__malloc
  #define kcalloc git__calloc
  #define krealloc git__realloc
  #define kreallocarray git__reallocarray
  #define kfree git__free
  #include "khash.h"
  
  __KHASH_TYPE(oid, const git_oid *, void *)
  typedef khash_t(oid) git_oidmap;
  
  git_oidmap *git_oidmap_alloc(void);
  void git_oidmap_free(git_oidmap *map);
  void git_oidmap_clear(git_oidmap *map);
  
  size_t git_oidmap_size(git_oidmap *map);
  
  size_t git_oidmap_lookup_index(git_oidmap *map, const git_oid *key);
  int git_oidmap_valid_index(git_oidmap *map, size_t idx);
  
  int git_oidmap_exists(git_oidmap *map, const git_oid *key);
  int git_oidmap_has_data(git_oidmap *map, size_t idx);
  
  const git_oid *git_oidmap_key(git_oidmap *map, size_t idx);
  void git_oidmap_set_key_at(git_oidmap *map, size_t idx, git_oid *key);
  void *git_oidmap_value_at(git_oidmap *map, size_t idx);
  void git_oidmap_set_value_at(git_oidmap *map, size_t idx, void *value);
  void git_oidmap_delete_at(git_oidmap *map, size_t idx);
  
  int git_oidmap_put(git_oidmap *map, const git_oid *key, int *err);
  void git_oidmap_insert(git_oidmap *map, const git_oid *key, void *value, int *rval);
  void git_oidmap_delete(git_oidmap *map, const git_oid *key);
  
  #define git_oidmap_foreach_value kh_foreach_value
  
  #define git_oidmap_begin	kh_begin
  #define git_oidmap_end		kh_end
  
  #endif
  

Download