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 <vfs/hammer/hammer_crc.h>
  59 #include <uuid.h>
  60
  61 #define HAMMER_BUFLISTS         64
  62 #define HAMMER_BUFLISTMASK      (HAMMER_BUFLISTS - 1)
  63
  64 /*
  65  * These structures are used by hammer(8) and newfs_hammer(8)
  66  * to track the filesystem buffers.
  67  *
  68  * vol_free_off and vol_free_end are zone-2 offsets.
  69  * These two are initialized only when newly creating a filesystem.
  70  */
  71 typedef struct volume_info {
  72         TAILQ_ENTRY(volume_info) entry;
  73         const char              *name;
  74         const char              *type;
  75         int                     vol_no;
  76         int                     rdonly;
  77         int                     fd;
  78         off_t                   size;
  79         off_t                   device_offset;
  80
  81         hammer_off_t            vol_free_off;
  82         hammer_off_t            vol_free_end;
  83
  84         hammer_volume_ondisk_t ondisk;
  85
  86         TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
  87 } *volume_info_t;
  88
  89 typedef struct cache_info {
  90         TAILQ_ENTRY(cache_info) entry;
  91         int                     refs;           /* structural references */
  92         int                     modified;       /* ondisk modified flag */
  93         int                     delete;         /* delete flag - delete on last ref */
  94 } *cache_info_t;
  95
  96 typedef struct buffer_info {
  97         struct cache_info       cache;          /* must be at offset 0 */
  98         TAILQ_ENTRY(buffer_info) entry;
  99         hammer_off_t            zone2_offset;   /* zone-2 offset */
 100         int64_t                 raw_offset;     /* physical offset */
 101         volume_info_t           volume;
 102         void                    *ondisk;
 103 } *buffer_info_t;
 104
 105 /*
 106  * Data structure for zone statistics.
 107  */
 108 typedef struct zone_stat {
 109         int64_t                 blocks;         /* number of big-blocks */
 110         int64_t                 items;          /* number of items */
 111         int64_t                 used;           /* bytes used */
 112 } *zone_stat_t;
 113
 114 extern hammer_uuid_t Hammer_FSType;
 115 extern hammer_uuid_t Hammer_FSId;
 116 extern int UseReadBehind;
 117 extern int UseReadAhead;
 118 extern int DebugOpt;
 119 extern uint32_t HammerVersion;
 120 extern const char *zone_labels[];
 121
 122 volume_info_t init_volume(const char *filename, int oflags, int32_t vol_no);
 123 volume_info_t load_volume(const char *filename, int oflags, int verify_volume);
 124 int is_regfile(const volume_info_t volume);
 125 void assert_volume_offset(const volume_info_t volume);
 126 volume_info_t get_volume(int32_t vol_no);
 127 volume_info_t get_root_volume(void);
 128 void rel_buffer(buffer_info_t buffer);
 129 void *get_buffer_data(hammer_off_t buf_offset, buffer_info_t *bufferp,
 130                         int isnew);
 131 hammer_node_ondisk_t alloc_btree_node(hammer_off_t *offp,
 132                         buffer_info_t *data_bufferp);
 133 void *alloc_meta_element(hammer_off_t *offp, int32_t data_len,
 134                         buffer_info_t *data_bufferp);
 135 void format_blockmap(volume_info_t root_vol, int zone, hammer_off_t offset);
 136 void format_freemap(volume_info_t root_vol);
 137 int64_t initialize_freemap(volume_info_t volume);
 138 int64_t count_freemap(const volume_info_t volume);
 139 void format_undomap(volume_info_t root_vol, int64_t *undo_buffer_size);
 140 void print_blockmap(const volume_info_t volume);
 141 void flush_all_volumes(void);
 142 void flush_volume(volume_info_t volume);
 143 void flush_buffer(buffer_info_t buffer);
 144 int64_t init_boot_area_size(int64_t value, off_t avg_vol_size);
 145 int64_t init_memory_log_size(int64_t value, off_t avg_vol_size);
 146
 147 hammer_off_t bootstrap_bigblock(volume_info_t volume);
 148 hammer_off_t alloc_undo_bigblock(volume_info_t volume);
 149 void *alloc_blockmap(int zone, int bytes, hammer_off_t *result_offp,
 150                         buffer_info_t *bufferp);
 151 hammer_off_t blockmap_lookup(hammer_off_t bmap_off, int *errorp);
 152 hammer_off_t blockmap_lookup_save(hammer_off_t bmap_off,
 153                                 hammer_blockmap_layer1_t layer1,
 154                                 hammer_blockmap_layer2_t layer2,
 155                                 int *errorp);
 156
 157 int hammer_parse_cache_size(const char *arg);
 158 void hammer_cache_add(cache_info_t cache);
 159 void hammer_cache_del(cache_info_t cache);
 160 void hammer_cache_used(cache_info_t cache);
 161 void hammer_cache_flush(void);
 162
 163 void hammer_key_beg_init(hammer_base_elm_t base);
 164 void hammer_key_end_init(hammer_base_elm_t base);
 165 int getyn(void);
 166 const char *sizetostr(off_t size);
 167 int hammer_fs_to_vol(const char *fs, struct hammer_ioc_volume_list *iocp);
 168 int hammer_fs_to_rootvol(const char *fs, char *buf, int len);
 169 zone_stat_t hammer_init_zone_stat(void);
 170 zone_stat_t hammer_init_zone_stat_bits(void);
 171 void hammer_cleanup_zone_stat(zone_stat_t stats);
 172 void hammer_add_zone_stat(zone_stat_t stats, hammer_off_t offset, int bytes);
 173 void hammer_add_zone_stat_layer2(zone_stat_t stats,
 174                         hammer_blockmap_layer2_t layer2);
 175 void hammer_print_zone_stat(const zone_stat_t stats);
 176
 177 void hammer_uuid_create(hammer_uuid_t *uuid);
 178 int hammer_uuid_from_string(const char *str, hammer_uuid_t *uuid);
 179 int hammer_uuid_to_string(const hammer_uuid_t *uuid, char **str);
 180 int hammer_uuid_name_lookup(hammer_uuid_t *u, const char *str);
 181 int hammer_uuid_compare(const hammer_uuid_t *uuid1, const hammer_uuid_t *uuid2);
 182
 183 #define hwarn(format, args...)  warn("WARNING: "format,## args)
 184 #define hwarnx(format, args...) warnx("WARNING: "format,## args)
 185
 186 #endif /* !HAMMER_UTIL_H_ */