server.h

   1 #ifndef FIO_SERVER_H
   2 #define FIO_SERVER_H
   3
   4 #include <inttypes.h>
   5 #include <string.h>
   6 #include <sys/time.h>
   7 #include <netinet/in.h>
   8
   9 #include "stat.h"
  10 #include "os/os.h"
  11 #include "diskutil.h"
  12
  13 #define FIO_NET_PORT 8765
  14
  15 /*
  16  * On-wire encoding is little endian
  17  */
  18 struct fio_net_cmd {
  19         uint16_t version;       /* protocol version */
  20         uint16_t opcode;        /* command opcode */
  21         uint32_t flags;         /* modifier flags */
  22         uint64_t tag;           /* passed back on reply */
  23         uint32_t pdu_len;       /* length of post-cmd layload */
  24         /*
  25          * These must be immediately before the payload, anything before
  26          * these fields are checksummed.
  27          */
  28         uint16_t cmd_crc16;     /* cmd checksum */
  29         uint16_t pdu_crc16;     /* payload checksum */
  30         uint8_t payload[];      /* payload */
  31 };
  32
  33 struct fio_net_cmd_reply {
  34         struct flist_head list;
  35         struct timeval tv;
  36         uint64_t saved_tag;
  37         uint16_t opcode;
  38 };
  39
  40 enum {
  41         FIO_SERVER_VER                  = 54,
  42
  43         FIO_SERVER_MAX_FRAGMENT_PDU     = 1024,
  44         FIO_SERVER_MAX_CMD_MB           = 2048,
  45
  46         FIO_NET_CMD_QUIT                = 1,
  47         FIO_NET_CMD_EXIT                = 2,
  48         FIO_NET_CMD_JOB                 = 3,
  49         FIO_NET_CMD_JOBLINE             = 4,
  50         FIO_NET_CMD_TEXT                = 5,
  51         FIO_NET_CMD_TS                  = 6,
  52         FIO_NET_CMD_GS                  = 7,
  53         FIO_NET_CMD_SEND_ETA            = 8,
  54         FIO_NET_CMD_ETA                 = 9,
  55         FIO_NET_CMD_PROBE               = 10,
  56         FIO_NET_CMD_START               = 11,
  57         FIO_NET_CMD_STOP                = 12,
  58         FIO_NET_CMD_DU                  = 13,
  59         FIO_NET_CMD_SERVER_START        = 14,
  60         FIO_NET_CMD_ADD_JOB             = 15,
  61         FIO_NET_CMD_RUN                 = 16,
  62         FIO_NET_CMD_IOLOG               = 17,
  63         FIO_NET_CMD_UPDATE_JOB          = 18,
  64         FIO_NET_CMD_LOAD_FILE           = 19,
  65         FIO_NET_CMD_VTRIGGER            = 20,
  66         FIO_NET_CMD_SENDFILE            = 21,
  67         FIO_NET_CMD_JOB_OPT             = 22,
  68         FIO_NET_CMD_NR                  = 23,
  69
  70         FIO_NET_CMD_F_MORE              = 1UL << 0,
  71
  72         /* crc does not include the crc fields */
  73         FIO_NET_CMD_CRC_SZ              = sizeof(struct fio_net_cmd) -
  74                                                 2 * sizeof(uint16_t),
  75
  76         FIO_NET_NAME_MAX                = 256,
  77
  78         FIO_NET_CLIENT_TIMEOUT          = 5000,
  79
  80         FIO_PROBE_FLAG_ZLIB             = 1UL << 0,
  81 };
  82
  83 struct cmd_sendfile {
  84         uint8_t path[FIO_NET_NAME_MAX];
  85 };
  86
  87 struct cmd_sendfile_reply {
  88         uint32_t size;
  89         uint32_t error;
  90         uint8_t data[0];
  91 };
  92
  93 /*
  94  * Client sends this to server on VTRIGGER, server sends back a full
  95  * all_io_list structure.
  96  */
  97 struct cmd_vtrigger_pdu {
  98         uint16_t len;
  99         uint8_t cmd[];
 100 };
 101
 102 struct cmd_load_file_pdu {
 103         uint16_t name_len;
 104         uint16_t client_type;
 105         uint8_t file[];
 106 };
 107
 108 struct cmd_ts_pdu {
 109         struct thread_stat ts;
 110         struct group_run_stats rs;
 111 };
 112
 113 struct cmd_du_pdu {
 114         struct disk_util_stat dus;
 115         struct disk_util_agg agg;
 116 };
 117
 118 struct cmd_client_probe_pdu {
 119         uint64_t flags;
 120         uint8_t server[128];
 121 };
 122
 123 struct cmd_probe_reply_pdu {
 124         uint8_t hostname[64];
 125         uint8_t bigendian;
 126         uint8_t fio_version[32];
 127         uint8_t os;
 128         uint8_t arch;
 129         uint8_t bpp;
 130         uint32_t cpus;
 131         uint64_t flags;
 132 };
 133
 134 struct cmd_single_line_pdu {
 135         uint16_t len;
 136         uint8_t text[];
 137 };
 138
 139 struct cmd_line_pdu {
 140         uint16_t lines;
 141         uint16_t client_type;
 142         struct cmd_single_line_pdu options[];
 143 };
 144
 145 struct cmd_job_pdu {
 146         uint32_t buf_len;
 147         uint32_t client_type;
 148         uint8_t buf[0];
 149 };
 150
 151 struct cmd_start_pdu {
 152         uint32_t jobs;
 153         uint32_t stat_outputs;
 154 };
 155
 156 struct cmd_end_pdu {
 157         uint32_t error;
 158         uint32_t signal;
 159 };
 160
 161 struct cmd_add_job_pdu {
 162         uint32_t thread_number;
 163         uint32_t groupid;
 164         struct thread_options_pack top;
 165 };
 166
 167 struct cmd_text_pdu {
 168         uint32_t level;
 169         uint32_t buf_len;
 170         uint64_t log_sec;
 171         uint64_t log_usec;
 172         uint8_t buf[0];
 173 };
 174
 175 enum {
 176         XMIT_COMPRESSED         = 1U,
 177         STORE_COMPRESSED        = 2U,
 178 };
 179
 180 struct cmd_iolog_pdu {
 181         uint64_t nr_samples;
 182         uint32_t thread_number;
 183         uint32_t log_type;
 184         uint32_t compressed;
 185         uint32_t log_offset;
 186         uint8_t name[FIO_NET_NAME_MAX];
 187         struct io_sample samples[0];
 188 };
 189
 190 struct cmd_job_option {
 191         uint16_t global;
 192         uint16_t truncated;
 193         uint32_t groupid;
 194         uint8_t name[64];
 195         uint8_t value[128];
 196 };
 197
 198 extern int fio_start_server(char *);
 199 extern int fio_server_text_output(int, const char *, size_t);
 200 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *);
 201 extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
 202 extern void fio_server_set_arg(const char *);
 203 extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
 204 extern int fio_server_parse_host(const char *, int, struct in_addr *, struct in6_addr *);
 205 extern const char *fio_server_op(unsigned int);
 206 extern void fio_server_got_signal(int);
 207
 208 struct thread_stat;
 209 struct group_run_stats;
 210 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
 211 extern void fio_server_send_gs(struct group_run_stats *);
 212 extern void fio_server_send_du(void);
 213 extern void fio_server_send_job_options(struct flist_head *, unsigned int);
 214 extern int fio_server_get_verify_state(const char *, int, void **);
 215
 216 extern struct fio_net_cmd *fio_net_recv_cmd(int sk, bool wait);
 217
 218 extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
 219 extern void fio_server_send_add_job(struct thread_data *);
 220 extern void fio_server_send_start(struct thread_data *);
 221 extern int fio_net_send_quit(int sk);
 222
 223 extern int fio_server_create_sk_key(void);
 224 extern void fio_server_destroy_sk_key(void);
 225
 226 extern int exit_backend;
 227 extern int fio_net_port;
 228
 229 #endif