UPGRADING: Mention the recent removal of 'device virtio_pci'.
[dragonfly.git] / sbin / hammer2 / hammer2.h
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 #ifndef HAMMER2_HAMMER2_H_
37 #define HAMMER2_HAMMER2_H_
38
39 /*
40  * Rollup headers for hammer2 utility
41  */
42 #include <sys/types.h>
43 #include <sys/uio.h>
44 #include <sys/queue.h>
45 #include <sys/mount.h>
46 #include <sys/file.h>
47 #include <sys/socket.h>
48 #include <sys/time.h>
49 #include <sys/wait.h>
50 #include <sys/tty.h>
51 #include <sys/endian.h>
52 #include <sys/sysctl.h>
53 #include <sys/udev.h>
54 #include <sys/diskslice.h>
55 #include <sys/dtype.h>
56 #include <dmsg.h>
57 #include <dirent.h>
58
59 #include <netinet/in.h>
60 #include <netinet/ip.h>
61 #include <netinet/tcp.h>
62 #include <arpa/inet.h>
63 #include <netdb.h>
64
65 #include <vfs/hammer2/hammer2_disk.h>
66 #include <vfs/hammer2/hammer2_mount.h>
67 #include <vfs/hammer2/hammer2_ioctl.h>
68 #include <vfs/hammer2/hammer2_xxhash.h>
69
70 #include <stdio.h>
71 #include <stdlib.h>
72 #include <stdarg.h>
73 #include <stddef.h>
74
75 #include <errno.h>
76 #include <fcntl.h>
77 #include <signal.h>
78 #include <string.h>
79 #include <unistd.h>
80 #include <ctype.h>
81 #include <uuid.h>
82 #include <assert.h>
83 #include <pthread.h>
84 #include <poll.h>
85
86 #include <libutil.h>
87
88 #define HAMMER2_DEFAULT_DIR     "/etc/hammer2"
89 #define HAMMER2_PATH_REMOTE     HAMMER2_DEFAULT_DIR "/remote"
90 #ifndef UDEV_DEVICE_PATH
91 #define UDEV_DEVICE_PATH        "/dev/udev"
92 #endif
93
94 struct hammer2_idmap {
95         struct hammer2_idmap *next;
96         uint32_t ran_beg;       /* inclusive */
97         uint32_t ran_end;       /* inclusive */
98 };
99
100 typedef struct hammer2_idmap hammer2_idmap_t;
101
102 /*
103  * UDP broadcast structure (must be endian neutral)
104  */
105 struct hammer2_udppkt {
106         char    key[8];         /* HAMMER2.01 */
107         char    gen[8];
108         char    label[64];
109 };
110
111 typedef struct hammer2_udppkt hammer2_udppkt_t;
112
113 extern int DebugOpt;
114 extern int ForceOpt;
115 extern int RecurseOpt;
116 extern int VerboseOpt;
117 extern int QuietOpt;
118 extern int NormalExit;
119
120 /*
121  * Hammer2 command APIs
122  */
123 int hammer2_ioctl_handle(const char *sel_path);
124 void hammer2_demon(void *(*func)(void *), void *arg);
125
126 int cmd_remote_connect(const char *sel_path, const char *url);
127 int cmd_remote_disconnect(const char *sel_path, const char *url);
128 int cmd_remote_status(const char *sel_path, int all_opt);
129
130 int cmd_pfs_getid(const char *sel_path, const char *name, int privateid);
131 int cmd_pfs_list(int ac, const char **av);
132 int cmd_pfs_create(const char *sel_path, const char *name,
133                         uint8_t pfs_type, const char *uuid_str);
134 int cmd_pfs_delete(const char *sel_path, const char *name);
135 int cmd_pfs_snapshot(const char *sel_path, const char *name, const char *label);
136
137 int cmd_service(void);
138 int cmd_hash(int ac, const char **av);
139 int cmd_info(int ac, const char **av);
140 int cmd_mountall(int ac, const char **av);
141 int cmd_stat(int ac, const char **av);
142 int cmd_leaf(const char *sel_path);
143 int cmd_shell(const char *hostname);
144 int cmd_debugspan(const char *hostname);
145 int cmd_destroy_path(int ac, const char **av);
146 int cmd_chaindump(const char *path);
147 int cmd_show(const char *devpath, int dofreemap);
148 int cmd_rsainit(const char *dir_path);
149 int cmd_rsaenc(const char **keys, int nkeys);
150 int cmd_rsadec(const char **keys, int nkeys);
151 int cmd_setcomp(const char *comp_str, char **paths);
152 int cmd_setcheck(const char *comp_str, char **paths);
153 int cmd_bulkfree(const char *dir_path);
154 int cmd_cleanup(const char *dir_path);
155 #if 0
156 int cmd_bulkfree_async(const char *dir_path);
157 #endif
158
159 /*
160  * Misc functions
161  */
162 const char *hammer2_time64_to_str(uint64_t htime64, char **strp);
163 const char *hammer2_uuid_to_str(uuid_t *uuid, char **strp);
164 const char *hammer2_iptype_to_str(uint8_t type);
165 const char *hammer2_pfstype_to_str(uint8_t type);
166 const char *sizetostr(hammer2_off_t size);
167 const char *counttostr(hammer2_off_t size);
168 hammer2_key_t dirhash(const unsigned char *name, size_t len);
169
170 uint32_t hammer2_icrc32(const void *buf, size_t size);
171 uint32_t hammer2_icrc32c(const void *buf, size_t size, uint32_t crc);
172
173 void hammer2_shell_parse(dmsg_msg_t *msg, int unmanaged);
174 void print_inode(char* inode_string);
175
176 #endif /* !HAMMER2_HAMMER2_H_ */