upscaledb_int.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2017 Christoph Rupp (chris@crupp.de).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * See the file COPYING for License information.
 */

#ifndef UPS_UPSCALEDB_INT_H
#define UPS_UPSCALEDB_INT_H

#include <ups/types.h>
#include <ups/upscaledb.h>

#ifdef __cplusplus
extern "C" {
#endif

#define ups_key_get_intflags(key)       (key)->_flags

#define ups_key_set_intflags(key, f)    (key)->_flags=(f)

UPS_EXPORT int UPS_CALLCONV
ups_key_get_approximate_match_type(ups_key_t *key);

UPS_EXPORT ups_status_t UPS_CALLCONV
ups_db_check_integrity(ups_db_t *db, uint32_t flags);

#define UPS_PRINT_GRAPH             1

UPS_EXPORT void UPS_CALLCONV
ups_set_context_data(ups_db_t *db, void *data);

UPS_EXPORT void * UPS_CALLCONV
ups_get_context_data(ups_db_t *db, ups_bool_t dont_lock);

UPS_EXPORT ups_db_t * UPS_CALLCONV
ups_cursor_get_database(ups_cursor_t *cursor);

typedef struct min_max_avg_u32_t {
  uint32_t min;
  uint32_t max;
  uint32_t avg;
  uint32_t _total;      /* for calculating the average */
  uint32_t _instances;  /* for calculating the average */
} min_max_avg_u32_t;

/* btree metrics */
typedef struct btree_metrics_t {
  /* the database name of the btree */
  uint16_t database_name;

  /* number of pages */
  uint64_t number_of_pages;

  /* number of keys */
  uint64_t number_of_keys;

  /* total btree space, including overhead */
  uint64_t total_btree_space;

  /* static overhead per page */
  uint32_t overhead_per_page;

  /* number of keys stored per page (w/o duplicates) */
  min_max_avg_u32_t keys_per_page;

  /* payload storage assigned to the KeyLists */
  min_max_avg_u32_t keylist_ranges;

  /* payload storage assigned to the RecordLists */
  min_max_avg_u32_t recordlist_ranges;

  /* storage assigned to the Indices (if available) */
  min_max_avg_u32_t keylist_index;

  /* storage assigned to the Indices (if available) */
  min_max_avg_u32_t recordlist_index;

  /* unused storage (i.e. gaps between pages, underfilled blocks etc) */
  min_max_avg_u32_t keylist_unused;

  /* unused storage (i.e. gaps between pages, underfilled blocks etc) */
  min_max_avg_u32_t recordlist_unused;

  /* number of blocks per page (if available) */
  min_max_avg_u32_t keylist_blocks_per_page;

  /* block sizes (if available) */
  min_max_avg_u32_t keylist_block_sizes;
} btree_metrics_t;

#define UPS_METRICS_VERSION         9

typedef struct ups_env_metrics_t {
  /* the version indicator - must be UPS_METRICS_VERSION */
  uint16_t version;

  /* number of total allocations for the whole lifetime of the process */
  uint64_t mem_total_allocations;

  /* currently active allocations for the whole process */
  uint64_t mem_current_allocations;

  /* current amount of memory allocated and tracked by the process
   * (excludes memory used by the kernel or not allocated with
   * malloc/free) */
  uint64_t mem_current_usage;

  /* peak usage of memory (for the whole process) */
  uint64_t mem_peak_usage;

  /* the heap size of this process */
  uint64_t mem_heap_size;

  /* amount of pages fetched from disk */
  uint64_t page_count_fetched;

  /* amount of pages written to disk */
  uint64_t page_count_flushed;

  /* number of index pages in this Environment */
  uint64_t page_count_type_index;

  /* number of blob pages in this Environment */
  uint64_t page_count_type_blob;

  /* number of page-manager pages in this Environment */
  uint64_t page_count_type_page_manager;

  /* number of successful freelist hits */
  uint64_t freelist_hits;

  /* number of freelist misses */
  uint64_t freelist_misses;

  /* number of successful cache hits */
  uint64_t cache_hits;

  /* number of cache misses */
  uint64_t cache_misses;

  /* number of blobs allocated */
  uint64_t blob_total_allocated;

  /* number of blobs read */
  uint64_t blob_total_read;

  /* (global) number of btree page splits */
  uint64_t btree_smo_split;

  /* (global) number of btree page merges */
  uint64_t btree_smo_merge;

  /* (global) number of extended keys */
  uint64_t extended_keys;

  /* (global) number of extended duplicate tables */
  uint64_t extended_duptables;

  /* number of bytes that the log/journal flushes to disk */
  uint64_t journal_bytes_flushed;

  /* log/journal bytes before compression */
  uint64_t journal_bytes_before_compression;

  /* log/journal bytes after compression */
  uint64_t journal_bytes_after_compression;

  /* record bytes before compression */
  uint64_t record_bytes_before_compression;

  /* record bytes after compression */
  uint64_t record_bytes_after_compression;

  /* key bytes before compression */
  uint64_t key_bytes_before_compression;

  /* key bytes after compression */
  uint64_t key_bytes_after_compression;

  /* btree metrics for leaf nodes */
  btree_metrics_t btree_leaf_metrics;

  /* btree metrics for internal nodes */
  btree_metrics_t btree_internal_metrics;

  // set to true if AVX is enabled
  ups_bool_t is_avx_enabled;

} ups_env_metrics_t;

UPS_EXPORT ups_status_t UPS_CALLCONV
ups_env_get_metrics(ups_env_t *env, ups_env_metrics_t *metrics);

UPS_EXPORT ups_bool_t UPS_CALLCONV
ups_is_debug();

UPS_EXPORT uint32_t UPS_CALLCONV
ups_calc_compare_name_hash(const char *zname);

UPS_EXPORT uint32_t UPS_CALLCONV
ups_db_get_compare_name_hash(ups_db_t *db);

UPS_EXPORT uint16_t UPS_CALLCONV
ups_db_get_name(ups_db_t *hdb);

UPS_EXPORT uint32_t UPS_CALLCONV
ups_db_get_flags(ups_db_t *hdb);

UPS_EXPORT ups_db_t *UPS_CALLCONV
ups_env_get_open_database(ups_env_t *env, uint16_t name);

UPS_EXPORT void UPS_CALLCONV
ups_set_committed_flush_threshold(int threshold);

UPS_EXPORT void UPS_CALLCONV
ups_at_exit();

struct ups_operation_t {
  int type;

  ups_key_t key;

  ups_record_t record;

  uint32_t flags;

  ups_status_t result;
};

#define UPS_OP_INSERT       1
#define UPS_OP_ERASE        2
#define UPS_OP_FIND         3

UPS_EXPORT ups_status_t UPS_CALLCONV
ups_db_bulk_operations(ups_db_t *db, ups_txn_t *txn,
                    struct ups_operation_t *operations,
                    size_t operations_length, uint32_t flags);

#ifdef __cplusplus
} // extern "C"
#endif

#endif /* UPS_UPSCALEDB_INT_H */