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