sbin/hammer/hammer.h

   1 /*
   2  * Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Matthew Dillon <dillon@backplane.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #ifndef HAMMER_HAMMER_H_
  36 #define HAMMER_HAMMER_H_
  37
  38 #include <sys/types.h>
  39 #include <sys/stat.h>
  40 #include <sys/time.h>
  41 #include <sys/mount.h>
  42 #include <sys/wait.h>
  43
  44 #include <stdio.h>
  45 #include <stdlib.h>
  46 #include <stdarg.h>
  47 #include <stddef.h>
  48 #include <unistd.h>
  49 #include <string.h>
  50 #include <errno.h>
  51 #include <fcntl.h>
  52 #include <fstab.h>
  53 #include <assert.h>
  54 #include <err.h>
  55 #include <ctype.h>
  56 #include <limits.h>
  57 #include <time.h>
  58 #include <signal.h>
  59 #include <dirent.h>
  60 #include <uuid.h>
  61
  62 #include "hammer_util.h"
  63
  64 /*
  65  * pidfile management - common definitions so code is more robust
  66  */
  67 #define PIDFILE_BUFSIZE 64
  68 static const char pidfile_loc[] = "/var/run";
  69
  70 /*
  71  * WARNING: Do not make the SNAPSHOTS_BASE "/var/snapshots" because
  72  * it will interfere with the older HAMMER VERS < 3 snapshots directory
  73  * for the /var PFS.
  74  */
  75 #define SNAPSHOTS_BASE  "/var/hammer"   /* HAMMER VERS >= 3 */
  76
  77 extern int RecurseOpt;
  78 extern int VerboseOpt;
  79 extern int QuietOpt;
  80 extern int TwoWayPipeOpt;
  81 extern int TimeoutOpt;
  82 extern int DelayOpt;
  83 extern char *SshPort;
  84 extern int CompressOpt;
  85 extern int ForceYesOpt;
  86 extern int RunningIoctl;
  87 extern int DidInterrupt;
  88 extern int ForceOpt;
  89 extern int BulkOpt;
  90 extern int AllPFS;
  91 extern uint64_t BandwidthOpt;
  92 extern uint64_t SplitupOpt;
  93 extern uint64_t MemoryLimit;
  94 extern const char *SplitupOptStr;
  95 extern const char *CyclePath;
  96 extern const char *ScoreBoardFile;
  97 extern const char *RestrictTarget;
  98
  99 void hammer_cmd_show(const char *arg, int filter, int obfuscate, int indent);
 100 void hammer_cmd_show_undo(void);
 101 void hammer_cmd_sshremote(const char *cmd, const char *target);
 102 void hammer_cmd_recover(char **av, int ac);
 103 void hammer_cmd_blockmap(void);
 104 void hammer_cmd_checkmap(void);
 105 void hammer_cmd_softprune(char **av, int ac, int everything_opt);
 106 void hammer_cmd_bstats(char **av, int ac);
 107 void hammer_cmd_iostats(char **av, int ac);
 108 void hammer_cmd_stats(char **av, int ac);
 109 void hammer_cmd_synctid(char **av, int ac);
 110 void hammer_cmd_mirror_read(char **av, int ac, int streaming);
 111 void hammer_cmd_mirror_write(char **av, int ac);
 112 void hammer_cmd_mirror_copy(char **av, int ac, int streaming);
 113 void hammer_cmd_mirror_dump(char **av, int ac);
 114 void hammer_cmd_history(const char *offset_str, char **av, int ac);
 115 void hammer_cmd_reblock(char **av, int ac, int flags);
 116 void hammer_cmd_rebalance(char **av, int ac);
 117 void hammer_cmd_pseudofs_status(char **av, int ac);
 118 void hammer_cmd_pseudofs_create(char **av, int ac, int is_slave);
 119 void hammer_cmd_pseudofs_update(char **av, int ac);
 120 void hammer_cmd_pseudofs_destroy(char **av, int ac);
 121 void hammer_cmd_pseudofs_upgrade(char **av, int ac);
 122 void hammer_cmd_pseudofs_downgrade(char **av, int ac);
 123 void hammer_cmd_snapshot(char **av, int ac);
 124 void hammer_cmd_snap(char **av, int ac, int tostdout, int fsbase);
 125 void hammer_cmd_snapls(char **av, int ac);
 126 void hammer_cmd_snaprm(char **av, int ac);
 127 void hammer_cmd_cleanup(char **av, int ac);
 128 void hammer_cmd_config(char **av, int ac);
 129 void hammer_cmd_viconfig(char **av, int ac);
 130 void hammer_cmd_info(char **av, int ac);
 131 void hammer_cmd_get_version(char **av, int ac);
 132 void hammer_cmd_set_version(char **av, int ac);
 133 void hammer_cmd_volume_add(char **av, int ac);
 134 void hammer_cmd_volume_del(char **av, int ac);
 135 void hammer_cmd_volume_list(char **av, int ac);
 136 void hammer_cmd_volume_blkdevs(char **av, int ac);
 137 void hammer_cmd_dedup_simulate(char **av, int ac);
 138 void hammer_cmd_dedup(char **av, int ac);
 139 void hammer_cmd_abort_cleanup(char **av, int ac);
 140 void hammer_cmd_strip(void);
 141
 142 void hammer_get_cycle(hammer_base_elm_t base, hammer_tid_t *tidp);
 143 void hammer_set_cycle(hammer_base_elm_t base, hammer_tid_t tid);
 144 void hammer_reset_cycle(void);
 145
 146 void clrpfs(struct hammer_ioc_pseudofs_rw *pfs, hammer_pseudofs_data_t pfsd,
 147         int pfs_id);
 148 int getpfs(struct hammer_ioc_pseudofs_rw *pfs, const char *path);
 149 void relpfs(int fd, struct hammer_ioc_pseudofs_rw *pfs);
 150 void dump_pfsd(hammer_pseudofs_data_t, int);
 151 int hammer_softprune_testdir(const char *dirname);
 152
 153 #endif /* !HAMMER_HAMMER_H_ */