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