hammer2 - Change freemap segment delineation, other stuff
[dragonfly.git] / sbin / hammer2 / hammer2.h
CommitLineData
2910a90c
MD
1/*
2 * Copyright (c) 2011-2012 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@dragonflybsd.org>
6 * by Venkatesh Srinivas <vsrinivas@dragonflybsd.org>
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 */
35
36/*
37 * Rollup headers for hammer2 utility
38 */
39#include <sys/types.h>
9ab15106 40#include <sys/uio.h>
185ace93 41#include <sys/queue.h>
2910a90c
MD
42#include <sys/mount.h>
43#include <sys/file.h>
5ba65e34
MD
44#include <sys/socket.h>
45#include <sys/time.h>
46#include <sys/wait.h>
47#include <sys/tty.h>
9ab15106 48#include <sys/endian.h>
5bc5bca2
MD
49#include <sys/sysctl.h>
50#include <sys/udev.h>
185ace93 51#include <sys/diskslice.h>
0c3a8cd0 52#include <dmsg.h>
5ba65e34
MD
53
54#include <netinet/in.h>
55#include <netinet/tcp.h>
56#include <arpa/inet.h>
57#include <netdb.h>
58
2910a90c
MD
59#include <vfs/hammer2/hammer2_disk.h>
60#include <vfs/hammer2/hammer2_mount.h>
61#include <vfs/hammer2/hammer2_ioctl.h>
62
63#include <stdio.h>
64#include <stdlib.h>
65#include <stdarg.h>
66#include <stddef.h>
5ba65e34 67
2910a90c 68#include <errno.h>
5ba65e34
MD
69#include <fcntl.h>
70#include <signal.h>
71#include <string.h>
72#include <unistd.h>
9ab15106 73#include <ctype.h>
ae183399 74#include <uuid.h>
9ab15106
MD
75#include <assert.h>
76#include <pthread.h>
77#include <poll.h>
78
62efe6ec
MD
79#include <libutil.h>
80
62efe6ec
MD
81#define HAMMER2_DEFAULT_DIR "/etc/hammer2"
82#define HAMMER2_PATH_REMOTE HAMMER2_DEFAULT_DIR "/remote"
5bc5bca2
MD
83#ifndef UDEV_DEVICE_PATH
84#define UDEV_DEVICE_PATH "/dev/udev"
85#endif
62efe6ec 86
8c280d5d
MD
87struct hammer2_idmap {
88 struct hammer2_idmap *next;
89 uint32_t ran_beg; /* inclusive */
90 uint32_t ran_end; /* inclusive */
91};
92
93typedef struct hammer2_idmap hammer2_idmap_t;
94
5ba65e34 95extern int DebugOpt;
bd878fc9 96extern int VerboseOpt;
9b8b748f 97extern int QuietOpt;
5ba65e34 98extern int NormalExit;
2910a90c 99
8c280d5d
MD
100/*
101 * Hammer2 command APIs
102 */
2910a90c 103int hammer2_ioctl_handle(const char *sel_path);
9ab15106 104void hammer2_demon(void *(*func)(void *), void *arg);
2910a90c
MD
105
106int cmd_remote_connect(const char *sel_path, const char *url);
107int cmd_remote_disconnect(const char *sel_path, const char *url);
108int cmd_remote_status(const char *sel_path, int all_opt);
ae183399 109
7dc0f844 110int cmd_pfs_getid(const char *sel_path, const char *name, int privateid);
ae183399
MD
111int cmd_pfs_list(const char *sel_path);
112int cmd_pfs_create(const char *sel_path, const char *name,
113 uint8_t pfs_type, const char *uuid_str);
114int cmd_pfs_delete(const char *sel_path, const char *name);
87b1094e 115int cmd_pfs_snapshot(const char *sel_path, const char *name);
ae183399 116
62efe6ec 117int cmd_service(void);
775153c2 118int cmd_hash(int ac, const char **av);
ad7cf8ea 119int cmd_stat(int ac, const char **av);
9ab15106 120int cmd_leaf(const char *sel_path);
bd878fc9 121int cmd_shell(const char *hostname);
02454b3e 122int cmd_debugspan(const char *hostname);
78ac5385 123int cmd_show(const char *devpath, int dofreemap);
62efe6ec
MD
124int cmd_rsainit(const char *dir_path);
125int cmd_rsaenc(const char **keys, int nkeys);
126int cmd_rsadec(const char **keys, int nkeys);
9ab15106 127
8c280d5d
MD
128/*
129 * Misc functions
130 */
bd878fc9
MD
131const char *hammer2_time64_to_str(uint64_t htime64, char **strp);
132const char *hammer2_uuid_to_str(uuid_t *uuid, char **strp);
133const char *hammer2_iptype_to_str(uint8_t type);
134const char *hammer2_pfstype_to_str(uint8_t type);
ad7cf8ea 135const char *sizetostr(hammer2_off_t size);
775153c2 136hammer2_key_t dirhash(const unsigned char *name, size_t len);
62efe6ec 137
0c3a8cd0
MD
138uint32_t hammer2_icrc32(const void *buf, size_t size);
139uint32_t hammer2_icrc32c(const void *buf, size_t size, uint32_t crc);
11f7caf4
MD
140
141void hammer2_shell_parse(dmsg_msg_t *msg);