xref: /dflybsd-src/sbin/hammer/hammer_util.h (revision 1ebd8403f3e872874ddfb128deb1dd406be19f17)

/*
 * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
 *
 * This code is derived from software contributed to The DragonFly Project
 * by Matthew Dillon <dillon@backplane.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of The DragonFly Project nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific, prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef HAMMER_UTIL_H_
#define HAMMER_UTIL_H_

#include <sys/types.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/queue.h>
#include <sys/mount.h>
#include <sys/wait.h>
#include <sys/ioctl.h>

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stddef.h>
#include <string.h>
#include <ctype.h>
#include <dirent.h>
#include <errno.h>
#include <err.h>
#include <fcntl.h>
#include <libgen.h>
#include <limits.h>
#include <signal.h>
#include <time.h>
#include <unistd.h>
#include <assert.h>

#include <vfs/hammer/hammer_disk.h>
#include <vfs/hammer/hammer_ioctl.h>
#include <vfs/hammer/hammer_crc.h>

#define HAMMER_BUFLISTS		64
#define HAMMER_BUFLISTMASK	(HAMMER_BUFLISTS - 1)

/*
 * These structures are used by hammer(8) and newfs_hammer(8)
 * to track the filesystem buffers.
 *
 * vol_free_off and vol_free_end are zone-2 offsets.
 * These two are initialized only when newly creating a filesystem.
 */
typedef struct volume_info {
	TAILQ_ENTRY(volume_info) entry;
	const char		*name;
	const char		*type;
	int			vol_no;
	int			rdonly;
	int			fd;
	off_t			size;
	off_t			device_offset;

	hammer_off_t		vol_free_off;
	hammer_off_t		vol_free_end;

	hammer_volume_ondisk_t ondisk;

	TAILQ_HEAD(, buffer_info) buffer_lists[HAMMER_BUFLISTS];
} *volume_info_t;

typedef struct cache_info {
	TAILQ_ENTRY(cache_info) entry;
	int			refs;		/* structural references */
	int			modified;	/* ondisk modified flag */
	int			delete;		/* delete flag - delete on last ref */
} *cache_info_t;

typedef struct buffer_info {
	struct cache_info	cache;		/* must be at offset 0 */
	TAILQ_ENTRY(buffer_info) entry;
	hammer_off_t		zone2_offset;	/* zone-2 offset */
	int64_t			raw_offset;	/* physical offset */
	volume_info_t		volume;
	void			*ondisk;
} *buffer_info_t;

/*
 * Data structure for zone statistics.
 */
typedef struct zone_stat {
	int64_t			blocks;		/* number of big-blocks */
	int64_t			items;		/* number of items */
	int64_t			used;		/* bytes used */
} *zone_stat_t;

extern hammer_uuid_t Hammer_FSType;
extern hammer_uuid_t Hammer_FSId;
extern int UseReadBehind;
extern int UseReadAhead;
extern int DebugOpt;
extern uint32_t HammerVersion;
extern const char *zone_labels[];

volume_info_t init_volume(const char *filename, int oflags, int32_t vol_no);
volume_info_t load_volume(const char *filename, int oflags, int verify_volume);
int is_regfile(const volume_info_t volume);
void assert_volume_offset(const volume_info_t volume);
volume_info_t get_volume(int32_t vol_no);
volume_info_t get_root_volume(void);
void rel_buffer(buffer_info_t buffer);
void *get_buffer_data(hammer_off_t buf_offset, buffer_info_t *bufferp,
			int isnew);
hammer_node_ondisk_t alloc_btree_node(hammer_off_t *offp,
			buffer_info_t *data_bufferp);
void *alloc_meta_element(hammer_off_t *offp, int32_t data_len,
			buffer_info_t *data_bufferp);
void format_blockmap(volume_info_t root_vol, int zone, hammer_off_t offset);
void format_freemap(volume_info_t root_vol);
int64_t initialize_freemap(volume_info_t volume);
int64_t count_freemap(const volume_info_t volume);
void format_undomap(volume_info_t root_vol, int64_t *undo_buffer_size);
void print_blockmap(const volume_info_t volume);
void flush_all_volumes(void);
void flush_volume(volume_info_t volume);
void flush_buffer(buffer_info_t buffer);
int64_t init_boot_area_size(int64_t value, off_t avg_vol_size);
int64_t init_memory_log_size(int64_t value, off_t avg_vol_size);

hammer_off_t bootstrap_bigblock(volume_info_t volume);
hammer_off_t alloc_undo_bigblock(volume_info_t volume);
void *alloc_blockmap(int zone, int bytes, hammer_off_t *result_offp,
			buffer_info_t *bufferp);
hammer_off_t blockmap_lookup(hammer_off_t bmap_off, int *errorp);
hammer_off_t blockmap_lookup_save(hammer_off_t bmap_off,
				hammer_blockmap_layer1_t layer1,
				hammer_blockmap_layer2_t layer2,
				int *errorp);

int hammer_parse_cache_size(const char *arg);
void hammer_cache_add(cache_info_t cache);
void hammer_cache_del(cache_info_t cache);
void hammer_cache_used(cache_info_t cache);
void hammer_cache_flush(void);

void hammer_key_beg_init(hammer_base_elm_t base);
void hammer_key_end_init(hammer_base_elm_t base);
int getyn(void);
const char *sizetostr(off_t size);
int hammer_fs_to_vol(const char *fs, struct hammer_ioc_volume_list *iocp);
int hammer_fs_to_rootvol(const char *fs, char *buf, int len);
zone_stat_t hammer_init_zone_stat(void);
zone_stat_t hammer_init_zone_stat_bits(void);
void hammer_cleanup_zone_stat(zone_stat_t stats);
void hammer_add_zone_stat(zone_stat_t stats, hammer_off_t offset, int bytes);
void hammer_add_zone_stat_layer2(zone_stat_t stats,
			hammer_blockmap_layer2_t layer2);
void hammer_print_zone_stat(const zone_stat_t stats);

void hammer_uuid_create(hammer_uuid_t *uuid);
int hammer_uuid_from_string(const char *str, hammer_uuid_t *uuid);
int hammer_uuid_to_string(const hammer_uuid_t *uuid, char **str);
int hammer_uuid_name_lookup(hammer_uuid_t *uuid, const char *str);
int hammer_uuid_compare(const hammer_uuid_t *uuid1, const hammer_uuid_t *uuid2);

#define hwarn(format, args...)	warn("WARNING: "format,## args)
#define hwarnx(format, args...)	warnx("WARNING: "format,## args)

#endif /* !HAMMER_UTIL_H_ */