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