lib/got_lib_object_cache.h

   1 /*
   2  * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
   3  *
   4  * Permission to use, copy, modify, and distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 enum got_object_cache_type {
  18         GOT_OBJECT_CACHE_TYPE_OBJ,
  19         GOT_OBJECT_CACHE_TYPE_TREE,
  20         GOT_OBJECT_CACHE_TYPE_COMMIT,
  21         GOT_OBJECT_CACHE_TYPE_TAG,
  22         GOT_OBJECT_CACHE_TYPE_RAW,
  23 };
  24
  25 struct got_object_cache_entry {
  26         struct got_object_id id;
  27         union {
  28                 struct got_object *obj;
  29                 struct got_tree_object *tree;
  30                 struct got_commit_object *commit;
  31                 struct got_tag_object *tag;
  32                 struct got_raw_object *raw;
  33         } data;
  34 };
  35
  36 struct got_object_cache {
  37         enum got_object_cache_type type;
  38         struct got_object_idset *idset;
  39         size_t size;
  40         int cache_searches;
  41         int cache_hit;
  42         int cache_miss;
  43         int cache_evict;
  44         int cache_toolarge;
  45         size_t max_cached_size;
  46 };
  47
  48 const struct got_error *got_object_cache_init(struct got_object_cache *,
  49     enum got_object_cache_type);
  50 const struct got_error *got_object_cache_add(struct got_object_cache *,
  51     struct got_object_id *, void *);
  52 void *got_object_cache_get(struct got_object_cache *, struct got_object_id *);
  53 void got_object_cache_close(struct got_object_cache *);