hammer2 - SPAN protocol work, router work
[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>
2910a90c
MD
41#include <sys/mount.h>
42#include <sys/file.h>
5ba65e34
MD
43#include <sys/socket.h>
44#include <sys/time.h>
45#include <sys/wait.h>
46#include <sys/tty.h>
9ab15106 47#include <sys/endian.h>
5ba65e34
MD
48
49#include <netinet/in.h>
50#include <netinet/tcp.h>
51#include <arpa/inet.h>
52#include <netdb.h>
53
2910a90c
MD
54#include <vfs/hammer2/hammer2_disk.h>
55#include <vfs/hammer2/hammer2_mount.h>
56#include <vfs/hammer2/hammer2_ioctl.h>
9ab15106 57#include <vfs/hammer2/hammer2_network.h>
2910a90c
MD
58
59#include <stdio.h>
60#include <stdlib.h>
61#include <stdarg.h>
62#include <stddef.h>
5ba65e34 63
2910a90c 64#include <errno.h>
5ba65e34
MD
65#include <fcntl.h>
66#include <signal.h>
67#include <string.h>
68#include <unistd.h>
9ab15106 69#include <ctype.h>
ae183399 70#include <uuid.h>
9ab15106
MD
71#include <assert.h>
72#include <pthread.h>
73#include <poll.h>
74
62efe6ec
MD
75#include <libutil.h>
76
9ab15106 77#include "network.h"
5ba65e34 78
62efe6ec
MD
79#define HAMMER2_DEFAULT_DIR "/etc/hammer2"
80#define HAMMER2_PATH_REMOTE HAMMER2_DEFAULT_DIR "/remote"
81
8c280d5d
MD
82struct hammer2_idmap {
83 struct hammer2_idmap *next;
84 uint32_t ran_beg; /* inclusive */
85 uint32_t ran_end; /* inclusive */
86};
87
88typedef struct hammer2_idmap hammer2_idmap_t;
89
5ba65e34 90extern int DebugOpt;
bd878fc9 91extern int VerboseOpt;
9b8b748f 92extern int QuietOpt;
5ba65e34 93extern int NormalExit;
2910a90c 94
8c280d5d
MD
95/*
96 * Hammer2 command APIs
97 */
2910a90c 98int hammer2_ioctl_handle(const char *sel_path);
9ab15106 99void hammer2_demon(void *(*func)(void *), void *arg);
2910a90c
MD
100
101int cmd_remote_connect(const char *sel_path, const char *url);
102int cmd_remote_disconnect(const char *sel_path, const char *url);
103int cmd_remote_status(const char *sel_path, int all_opt);
ae183399 104
7dc0f844 105int cmd_pfs_getid(const char *sel_path, const char *name, int privateid);
ae183399
MD
106int cmd_pfs_list(const char *sel_path);
107int cmd_pfs_create(const char *sel_path, const char *name,
108 uint8_t pfs_type, const char *uuid_str);
109int cmd_pfs_delete(const char *sel_path, const char *name);
110
62efe6ec 111int cmd_service(void);
ad7cf8ea 112int cmd_stat(int ac, const char **av);
9ab15106 113int cmd_leaf(const char *sel_path);
bd878fc9 114int cmd_shell(const char *hostname);
02454b3e 115int cmd_debugspan(const char *hostname);
bd878fc9 116int cmd_show(const char *devpath);
62efe6ec
MD
117int cmd_rsainit(const char *dir_path);
118int cmd_rsaenc(const char **keys, int nkeys);
119int cmd_rsadec(const char **keys, int nkeys);
9ab15106 120
8c280d5d
MD
121/*
122 * Msg support functions
123 */
124void hammer2_bswap_head(hammer2_msg_hdr_t *head);
9ab15106
MD
125void hammer2_ioq_init(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq);
126void hammer2_ioq_done(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq);
5903497c 127void hammer2_iocom_init(hammer2_iocom_t *iocom, int sock_fd, int alt_fd,
29ead430
MD
128 void (*state_func)(hammer2_router_t *),
129 void (*rcvmsg_func)(hammer2_msg_t *),
5903497c 130 void (*altmsg_func)(hammer2_iocom_t *));
29ead430
MD
131void hammer2_router_restate(hammer2_router_t *router,
132 void (*state_func)(hammer2_router_t *),
133 void (*rcvmsg_func)(hammer2_msg_t *),
5903497c 134 void (*altmsg_func)(hammer2_iocom_t *));
29ead430 135void hammer2_router_signal(hammer2_router_t *router);
9ab15106 136void hammer2_iocom_done(hammer2_iocom_t *iocom);
29ead430
MD
137hammer2_msg_t *hammer2_msg_alloc(hammer2_router_t *router,
138 size_t aux_size, uint32_t cmd,
139 void (*func)(hammer2_msg_t *), void *data);
140void hammer2_msg_reply(hammer2_msg_t *msg, uint32_t error);
141void hammer2_msg_result(hammer2_msg_t *msg, uint32_t error);
8c280d5d
MD
142void hammer2_state_reply(hammer2_state_t *state, uint32_t error);
143
29ead430 144void hammer2_msg_free(hammer2_msg_t *msg);
9ab15106 145
5903497c 146void hammer2_iocom_core(hammer2_iocom_t *iocom);
4a2e0eae 147hammer2_msg_t *hammer2_ioq_read(hammer2_iocom_t *iocom);
29ead430 148void hammer2_msg_write(hammer2_msg_t *msg);
4a2e0eae 149
4a2e0eae 150void hammer2_iocom_drain(hammer2_iocom_t *iocom);
7dc0f844
MD
151void hammer2_iocom_flush1(hammer2_iocom_t *iocom);
152void hammer2_iocom_flush2(hammer2_iocom_t *iocom);
9ab15106 153
78476205
MD
154void hammer2_state_cleanuprx(hammer2_iocom_t *iocom, hammer2_msg_t *msg);
155void hammer2_state_free(hammer2_state_t *state);
156
8c280d5d
MD
157/*
158 * Msg protocol functions
159 */
29ead430
MD
160void hammer2_msg_lnk_signal(hammer2_router_t *router);
161void hammer2_msg_lnk(hammer2_msg_t *msg);
162void hammer2_msg_dbg(hammer2_msg_t *msg);
8c280d5d
MD
163
164/*
165 * Crypto functions
166 */
02454b3e 167void hammer2_crypto_setup(void);
62efe6ec 168void hammer2_crypto_negotiate(hammer2_iocom_t *iocom);
5cf97ec5
MD
169void hammer2_crypto_decrypt(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq);
170void hammer2_crypto_decrypt_aux(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq,
171 hammer2_msg_t *msg, int already);
172int hammer2_crypto_encrypt(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq,
02454b3e 173 struct iovec *iov, int n, size_t *nmaxp);
5cf97ec5
MD
174void hammer2_crypto_encrypt_wrote(hammer2_iocom_t *iocom, hammer2_ioq_t *ioq,
175 int nact);
176
8c280d5d
MD
177/*
178 * Misc functions
179 */
bd878fc9
MD
180const char *hammer2_time64_to_str(uint64_t htime64, char **strp);
181const char *hammer2_uuid_to_str(uuid_t *uuid, char **strp);
182const char *hammer2_iptype_to_str(uint8_t type);
183const char *hammer2_pfstype_to_str(uint8_t type);
ad7cf8ea 184const char *sizetostr(hammer2_off_t size);
81666e1b
MD
185const char * hammer2_basecmd_str(uint32_t cmd);
186const char *hammer2_msg_str(hammer2_msg_t *msg);
02454b3e
MD
187int hammer2_connect(const char *hostname);
188
29ead430 189void shell_tree(hammer2_router_t *router, char *cmdbuf);
81666e1b 190
02454b3e 191void *master_service(void *data);
62efe6ec 192
8c280d5d 193void hammer2_msg_debug(hammer2_iocom_t *iocom, hammer2_msg_t *msg);
29ead430 194void router_printf(hammer2_router_t *router, const char *ctl, ...);
8c280d5d
MD
195void *hammer2_alloc(size_t bytes);
196void hammer2_free(void *ptr);