sbin/hammer/hammer_util.h

   1 /*
   2  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #ifndef HAMMER_UTIL_H_
  36 #define HAMMER_UTIL_H_
  37
  38 #include <sys/types.h>
  39 #include <sys/stat.h>
  40 #include <sys/time.h>
  41 #include <sys/tree.h>
  42 #include <sys/queue.h>
  43 #include <sys/mount.h>
  44
  45 #include <assert.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <stdarg.h>
  49 #include <string.h>
  50 #include <unistd.h>
  51 #include <stddef.h>
  52 #include <err.h>
  53 #include <errno.h>
  54 #include <fcntl.h>
  55
  56 #include <vfs/hammer/hammer_disk.h>
  57 #include <vfs/hammer/hammer_ioctl.h>
  58 #include <uuid.h>
  59
  60 /*
  61  * pidfile management - common definitions so code is more robust
  62  */
  63 #define PIDFILE_BUFSIZE 64
  64 static const char pidfile_loc[] = "/var/run";
  65
  66 struct cache_info {
  67         TAILQ_ENTRY(cache_info) entry;
  68         int refs;       /* structural references */
  69         int modified;   /* ondisk modified flag */
  70         int delete;     /* delete flag - delete on last ref */
  71 };
  72
  73 #define HAMMER_BUFLISTS         64
  74 #define HAMMER_BUFLISTMASK      (HAMMER_BUFLISTS - 1)
  75
  76 /*
  77  * These structures are used by hammer(8) and newfs_hammer(8)
  78  * to track the filesystem buffers.
  79  */
  80 struct volume_info {
  81         TAILQ_ENTRY(volume_info) entry;
  82         int                     vol_no;
  83         int                     rdonly;
  84
  85         hammer_off_t            vol_free_off;   /* zone-2 offset */
  86         hammer_off_t            vol_free_end;   /* zone-2 offset */
  87
  88         const char              *name;
  89         const char              *type;
  90         int                     fd;
  91         off_t                   size;
  92         off_t                   device_offset;
  93
  94         hammer_volume_ondisk_t ondisk;
  95
  96         TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
  97 };
  98
  99 struct buffer_info {
 100         struct cache_info       cache;          /* must be at offset 0 */
 101         TAILQ_ENTRY(buffer_info) entry;
 102         hammer_off_t            buf_offset;     /* full hammer offset spec */
 103         int64_t                 raw_offset;     /* physical offset */
 104         struct volume_info      *volume;
 105         void                    *ondisk;
 106 };
 107
 108 /*
 109  * Data structure for zone statistics.
 110  */
 111 struct zone_stat {
 112         int                     zone;           /* zone index, not used */
 113         hammer_off_t            blocks;         /* number of big-blocks */
 114         hammer_off_t            items;          /* number of items */
 115         hammer_off_t            used;           /* bytes used */
 116 };
 117
 118 extern uuid_t Hammer_FSType;
 119 extern uuid_t Hammer_FSId;
 120 extern int UseReadBehind;
 121 extern int UseReadAhead;
 122 extern int DebugOpt;
 123 extern const char *zone_labels[];
 124
 125 /* prototypes for sys/libkern/crc32.c */
 126 uint32_t crc32(const void *buf, size_t size);
 127 uint32_t crc32_ext(const void *buf, size_t size, uint32_t ocrc);
 128
 129 struct volume_info *init_volume(int32_t vol_no, const char *filename,
 130                                 int oflags);
 131 struct volume_info *load_volume(const char *filename, int oflags);
 132 void check_volume(struct volume_info *vol);
 133 struct volume_info *get_volume(int32_t vol_no);
 134 struct volume_info *get_root_volume(void);
 135 void *get_buffer_data(hammer_off_t buf_offset, struct buffer_info **bufferp,
 136                                 int isnew);
 137 hammer_node_ondisk_t get_node(hammer_off_t node_offset,
 138                                 struct buffer_info **bufp);
 139
 140 void rel_buffer(struct buffer_info *buffer);
 141
 142 hammer_off_t alloc_bigblock(struct volume_info *volume, int zone);
 143 void *alloc_blockmap(int zone, int bytes, hammer_off_t *result_offp,
 144                struct buffer_info **bufferp);
 145 hammer_off_t blockmap_lookup(hammer_off_t bmap_off,
 146                                 hammer_blockmap_layer1_t layer1,
 147                                 hammer_blockmap_layer2_t layer2,
 148                                 int *errorp);
 149 void format_undomap(struct volume_info *root_vol, int64_t *undo_buffer_size);
 150
 151 void *alloc_btree_element(hammer_off_t *offp,
 152                          struct buffer_info **data_bufferp);
 153 void *alloc_meta_element(hammer_off_t *offp, int32_t data_len,
 154                          struct buffer_info **data_bufferp);
 155 void *alloc_data_element(hammer_off_t *offp, int32_t data_len,
 156                          struct buffer_info **data_bufferp);
 157
 158 void format_blockmap(struct volume_info *vol, int zone, hammer_off_t offset);
 159 void format_freemap(struct volume_info *root_vol);
 160 int64_t initialize_freemap(struct volume_info *vol);
 161 int64_t count_freemap(struct volume_info *vol);
 162 void print_blockmap(const struct volume_info *root_vol);
 163
 164 void flush_all_volumes(void);
 165 void flush_volume(struct volume_info *vol);
 166 void flush_buffer(struct buffer_info *buf);
 167
 168 int64_t init_boot_area_size(int64_t value, off_t avg_vol_size);
 169 int64_t init_mem_area_size(int64_t value, off_t avg_vol_size);
 170
 171 int hammer_parse_cache_size(const char *arg);
 172 void hammer_cache_set(int bytes);
 173 void hammer_cache_add(struct cache_info *cache);
 174 void hammer_cache_del(struct cache_info *cache);
 175 void hammer_cache_used(struct cache_info *cache);
 176 void hammer_cache_flush(void);
 177
 178 int hammer_btree_cmp(hammer_base_elm_t key1, hammer_base_elm_t key2);
 179 void hammer_key_beg_init(hammer_base_elm_t base);
 180 void hammer_key_end_init(hammer_base_elm_t base);
 181 int hammer_crc_test_leaf(void *data, hammer_btree_leaf_elm_t leaf);
 182 int getyn(void);
 183 const char *sizetostr(off_t size);
 184 int hammer_fs_to_vol(const char *fs, struct hammer_ioc_volume_list *iocp);
 185 int hammer_fs_to_rootvol(const char *fs, char *buf, int len);
 186
 187 struct zone_stat *hammer_init_zone_stat(void);
 188 struct zone_stat *hammer_init_zone_stat_bits(void);
 189 void hammer_cleanup_zone_stat(struct zone_stat *stats);
 190 void hammer_add_zone_stat(struct zone_stat *stats, hammer_off_t offset,
 191                         hammer_off_t bytes);
 192 void hammer_add_zone_stat_layer2(struct zone_stat *stats,
 193                         hammer_blockmap_layer2_t layer2);
 194 void hammer_print_zone_stat(const struct zone_stat *stats);
 195
 196 #endif /* !HAMMER_UTIL_H_ */