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                  = 38,
  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_NR                  = 20,
  66
  67         FIO_NET_CMD_F_MORE              = 1UL << 0,
  68
  69         /* crc does not include the crc fields */
  70         FIO_NET_CMD_CRC_SZ              = sizeof(struct fio_net_cmd) -
  71                                                 2 * sizeof(uint16_t),
  72
  73         FIO_NET_NAME_MAX                = 256,
  74
  75         FIO_NET_CLIENT_TIMEOUT          = 5000,
  76
  77         FIO_PROBE_FLAG_ZLIB             = 1UL << 0,
  78 };
  79
  80 struct cmd_load_file_pdu {
  81         uint16_t name_len;
  82         uint16_t client_type;
  83         uint8_t file[];
  84 };
  85
  86 struct cmd_ts_pdu {
  87         struct thread_stat ts;
  88         struct group_run_stats rs;
  89 };
  90
  91 struct cmd_du_pdu {
  92         struct disk_util_stat dus;
  93         struct disk_util_agg agg;
  94 };
  95
  96 struct cmd_client_probe_pdu {
  97         uint64_t flags;
  98 };
  99
 100 struct cmd_probe_reply_pdu {
 101         uint8_t hostname[64];
 102         uint8_t bigendian;
 103         uint8_t fio_version[32];
 104         uint8_t os;
 105         uint8_t arch;
 106         uint8_t bpp;
 107         uint32_t cpus;
 108         uint64_t flags;
 109 };
 110
 111 struct cmd_single_line_pdu {
 112         uint16_t len;
 113         uint8_t text[];
 114 };
 115
 116 struct cmd_line_pdu {
 117         uint16_t lines;
 118         uint16_t client_type;
 119         struct cmd_single_line_pdu options[];
 120 };
 121
 122 struct cmd_job_pdu {
 123         uint32_t buf_len;
 124         uint32_t client_type;
 125         uint8_t buf[0];
 126 };
 127
 128 struct cmd_start_pdu {
 129         uint32_t jobs;
 130         uint32_t stat_outputs;
 131 };
 132
 133 struct cmd_end_pdu {
 134         uint32_t error;
 135         uint32_t signal;
 136 };
 137
 138 struct cmd_add_job_pdu {
 139         uint32_t thread_number;
 140         uint32_t groupid;
 141         struct thread_options_pack top;
 142 };
 143
 144 struct cmd_text_pdu {
 145         uint32_t level;
 146         uint32_t buf_len;
 147         uint64_t log_sec;
 148         uint64_t log_usec;
 149         uint8_t buf[0];
 150 };
 151
 152 struct cmd_iolog_pdu {
 153         uint64_t nr_samples;
 154         uint32_t thread_number;
 155         uint32_t log_type;
 156         uint32_t compressed;
 157         uint32_t log_offset;
 158         uint8_t name[FIO_NET_NAME_MAX];
 159         struct io_sample samples[0];
 160 };
 161
 162 extern int fio_start_server(char *);
 163 extern int fio_server_text_output(int, const char *, size_t);
 164 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *);
 165 extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
 166 extern void fio_server_set_arg(const char *);
 167 extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
 168 extern int fio_server_parse_host(const char *, int, struct in_addr *, struct in6_addr *);
 169 extern const char *fio_server_op(unsigned int);
 170 extern void fio_server_got_signal(int);
 171
 172 struct thread_stat;
 173 struct group_run_stats;
 174 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
 175 extern void fio_server_send_gs(struct group_run_stats *);
 176 extern void fio_server_send_du(void);
 177 extern void fio_server_idle_loop(void);
 178
 179 extern int fio_recv_data(int sk, void *p, unsigned int len);
 180 extern int fio_send_data(int sk, const void *p, unsigned int len);
 181 extern void fio_net_cmd_crc(struct fio_net_cmd *);
 182 extern void fio_net_cmd_crc_pdu(struct fio_net_cmd *, const void *);
 183 extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
 184
 185 extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
 186 extern void fio_server_send_add_job(struct thread_data *);
 187 extern void fio_server_send_start(struct thread_data *);
 188 extern int fio_net_send_stop(int sk, int error, int signal);
 189 extern int fio_net_send_quit(int sk);
 190
 191 extern int exit_backend;
 192 extern int fio_net_port;
 193
 194 static inline void __fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
 195                                       uint32_t pdu_len, uint64_t tag)
 196 {
 197         memset(cmd, 0, sizeof(*cmd));
 198
 199         cmd->version    = __cpu_to_le16(FIO_SERVER_VER);
 200         cmd->opcode     = cpu_to_le16(opcode);
 201         cmd->tag        = cpu_to_le64(tag);
 202         cmd->pdu_len    = cpu_to_le32(pdu_len);
 203 }
 204
 205
 206 static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
 207                                     const void *pdu, uint32_t pdu_len,
 208                                     uint64_t tag)
 209 {
 210         __fio_init_net_cmd(cmd, opcode, pdu_len, tag);
 211
 212         if (pdu)
 213                 memcpy(&cmd->payload, pdu, pdu_len);
 214 }
 215
 216 #endif