Jens Axboe | 50d1697 | 2011-09-29 17:45:28 -0600 | [diff] [blame] | 1 | #ifndef FIO_SERVER_H |
| 2 | #define FIO_SERVER_H |
| 3 | |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 4 | #include <inttypes.h> |
Jens Axboe | 142575e | 2011-09-30 17:35:45 -0600 | [diff] [blame] | 5 | #include <string.h> |
Jens Axboe | 89c1707 | 2011-10-11 10:15:51 +0200 | [diff] [blame] | 6 | #include <sys/time.h> |
Jens Axboe | 811826b | 2011-10-24 09:11:50 +0200 | [diff] [blame] | 7 | #include <netinet/in.h> |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 8 | |
Jens Axboe | a64e88d | 2011-10-03 14:20:01 +0200 | [diff] [blame] | 9 | #include "stat.h" |
Jens Axboe | 610a730 | 2011-10-04 13:53:35 +0200 | [diff] [blame] | 10 | #include "os/os.h" |
Jens Axboe | d09a64a | 2011-10-13 11:38:56 +0200 | [diff] [blame] | 11 | #include "diskutil.h" |
Jens Axboe | a64e88d | 2011-10-03 14:20:01 +0200 | [diff] [blame] | 12 | |
Stephen M. Cameron | 5adc244 | 2012-02-24 08:17:31 +0100 | [diff] [blame] | 13 | #define FIO_NET_PORT 8765 |
| 14 | |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 15 | struct sk_out { |
| 16 | unsigned int refs; /* frees sk_out when it drops to zero. |
| 17 | * protected by below ->lock */ |
| 18 | |
| 19 | int sk; /* socket fd to talk to client */ |
| 20 | struct fio_mutex lock; /* protects ref and below list */ |
| 21 | struct flist_head list; /* list of pending transmit work */ |
| 22 | struct fio_mutex wait; /* wake backend when items added to list */ |
| 23 | struct fio_mutex xmit; /* held while sending data */ |
| 24 | }; |
| 25 | |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 26 | /* |
| 27 | * On-wire encoding is little endian |
| 28 | */ |
| 29 | struct fio_net_cmd { |
| 30 | uint16_t version; /* protocol version */ |
| 31 | uint16_t opcode; /* command opcode */ |
| 32 | uint32_t flags; /* modifier flags */ |
Jens Axboe | af9c9fb | 2011-10-09 21:54:10 +0200 | [diff] [blame] | 33 | uint64_t tag; /* passed back on reply */ |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 34 | uint32_t pdu_len; /* length of post-cmd layload */ |
Jens Axboe | a64e88d | 2011-10-03 14:20:01 +0200 | [diff] [blame] | 35 | /* |
| 36 | * These must be immediately before the payload, anything before |
| 37 | * these fields are checksummed. |
| 38 | */ |
Jens Axboe | fcee5ff | 2011-09-30 22:50:39 -0600 | [diff] [blame] | 39 | uint16_t cmd_crc16; /* cmd checksum */ |
| 40 | uint16_t pdu_crc16; /* payload checksum */ |
Jens Axboe | 372aecb | 2013-01-08 13:42:41 +0100 | [diff] [blame] | 41 | uint8_t payload[]; /* payload */ |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 42 | }; |
| 43 | |
Jens Axboe | 40c6051 | 2012-03-27 16:03:04 +0200 | [diff] [blame] | 44 | struct fio_net_cmd_reply { |
Jens Axboe | 89c1707 | 2011-10-11 10:15:51 +0200 | [diff] [blame] | 45 | struct flist_head list; |
| 46 | struct timeval tv; |
| 47 | uint64_t saved_tag; |
Jens Axboe | 40c6051 | 2012-03-27 16:03:04 +0200 | [diff] [blame] | 48 | uint16_t opcode; |
Jens Axboe | 89c1707 | 2011-10-11 10:15:51 +0200 | [diff] [blame] | 49 | }; |
| 50 | |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 51 | enum { |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 52 | FIO_SERVER_VER = 61, |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 53 | |
Jens Axboe | b9d2f30 | 2012-03-08 20:36:28 +0100 | [diff] [blame] | 54 | FIO_SERVER_MAX_FRAGMENT_PDU = 1024, |
Jens Axboe | dfbf1f6 | 2014-04-14 11:43:47 -0600 | [diff] [blame] | 55 | FIO_SERVER_MAX_CMD_MB = 2048, |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 56 | |
Jens Axboe | 5d7793a | 2012-03-08 19:59:16 +0100 | [diff] [blame] | 57 | FIO_NET_CMD_QUIT = 1, |
| 58 | FIO_NET_CMD_EXIT = 2, |
| 59 | FIO_NET_CMD_JOB = 3, |
| 60 | FIO_NET_CMD_JOBLINE = 4, |
| 61 | FIO_NET_CMD_TEXT = 5, |
| 62 | FIO_NET_CMD_TS = 6, |
| 63 | FIO_NET_CMD_GS = 7, |
| 64 | FIO_NET_CMD_SEND_ETA = 8, |
| 65 | FIO_NET_CMD_ETA = 9, |
| 66 | FIO_NET_CMD_PROBE = 10, |
| 67 | FIO_NET_CMD_START = 11, |
| 68 | FIO_NET_CMD_STOP = 12, |
| 69 | FIO_NET_CMD_DU = 13, |
| 70 | FIO_NET_CMD_SERVER_START = 14, |
| 71 | FIO_NET_CMD_ADD_JOB = 15, |
Jens Axboe | b9d2f30 | 2012-03-08 20:36:28 +0100 | [diff] [blame] | 72 | FIO_NET_CMD_RUN = 16, |
Jens Axboe | 1b42725 | 2012-03-14 15:03:03 +0100 | [diff] [blame] | 73 | FIO_NET_CMD_IOLOG = 17, |
Jens Axboe | f58bd2a | 2012-03-27 10:06:42 +0200 | [diff] [blame] | 74 | FIO_NET_CMD_UPDATE_JOB = 18, |
Jens Axboe | 3589918 | 2014-10-07 20:56:28 -0600 | [diff] [blame] | 75 | FIO_NET_CMD_LOAD_FILE = 19, |
Jens Axboe | de54cfd | 2014-11-10 20:34:00 -0700 | [diff] [blame] | 76 | FIO_NET_CMD_VTRIGGER = 20, |
| 77 | FIO_NET_CMD_SENDFILE = 21, |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 78 | FIO_NET_CMD_JOB_OPT = 22, |
| 79 | FIO_NET_CMD_NR = 23, |
Jens Axboe | 794d69c | 2011-10-01 08:48:50 -0600 | [diff] [blame] | 80 | |
Jens Axboe | 5d7793a | 2012-03-08 19:59:16 +0100 | [diff] [blame] | 81 | FIO_NET_CMD_F_MORE = 1UL << 0, |
Jens Axboe | fcee5ff | 2011-09-30 22:50:39 -0600 | [diff] [blame] | 82 | |
| 83 | /* crc does not include the crc fields */ |
Jens Axboe | 5d7793a | 2012-03-08 19:59:16 +0100 | [diff] [blame] | 84 | FIO_NET_CMD_CRC_SZ = sizeof(struct fio_net_cmd) - |
| 85 | 2 * sizeof(uint16_t), |
Jens Axboe | 89c1707 | 2011-10-11 10:15:51 +0200 | [diff] [blame] | 86 | |
Jens Axboe | 1b42725 | 2012-03-14 15:03:03 +0100 | [diff] [blame] | 87 | FIO_NET_NAME_MAX = 256, |
| 88 | |
Jens Axboe | 5d7793a | 2012-03-08 19:59:16 +0100 | [diff] [blame] | 89 | FIO_NET_CLIENT_TIMEOUT = 5000, |
Jens Axboe | 3989b14 | 2013-04-12 13:13:24 +0200 | [diff] [blame] | 90 | |
| 91 | FIO_PROBE_FLAG_ZLIB = 1UL << 0, |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 92 | }; |
| 93 | |
Jens Axboe | de54cfd | 2014-11-10 20:34:00 -0700 | [diff] [blame] | 94 | struct cmd_sendfile { |
| 95 | uint8_t path[FIO_NET_NAME_MAX]; |
| 96 | }; |
| 97 | |
| 98 | struct cmd_sendfile_reply { |
| 99 | uint32_t size; |
| 100 | uint32_t error; |
| 101 | uint8_t data[0]; |
| 102 | }; |
| 103 | |
| 104 | /* |
| 105 | * Client sends this to server on VTRIGGER, server sends back a full |
| 106 | * all_io_list structure. |
| 107 | */ |
| 108 | struct cmd_vtrigger_pdu { |
| 109 | uint16_t len; |
| 110 | uint8_t cmd[]; |
| 111 | }; |
| 112 | |
Jens Axboe | 3589918 | 2014-10-07 20:56:28 -0600 | [diff] [blame] | 113 | struct cmd_load_file_pdu { |
| 114 | uint16_t name_len; |
| 115 | uint16_t client_type; |
| 116 | uint8_t file[]; |
| 117 | }; |
| 118 | |
Jens Axboe | a64e88d | 2011-10-03 14:20:01 +0200 | [diff] [blame] | 119 | struct cmd_ts_pdu { |
| 120 | struct thread_stat ts; |
| 121 | struct group_run_stats rs; |
| 122 | }; |
| 123 | |
Jens Axboe | d09a64a | 2011-10-13 11:38:56 +0200 | [diff] [blame] | 124 | struct cmd_du_pdu { |
| 125 | struct disk_util_stat dus; |
| 126 | struct disk_util_agg agg; |
| 127 | }; |
| 128 | |
Jens Axboe | 3989b14 | 2013-04-12 13:13:24 +0200 | [diff] [blame] | 129 | struct cmd_client_probe_pdu { |
| 130 | uint64_t flags; |
Jens Axboe | de54cfd | 2014-11-10 20:34:00 -0700 | [diff] [blame] | 131 | uint8_t server[128]; |
Jens Axboe | 3989b14 | 2013-04-12 13:13:24 +0200 | [diff] [blame] | 132 | }; |
| 133 | |
| 134 | struct cmd_probe_reply_pdu { |
Jens Axboe | c28e8e8 | 2011-10-04 08:57:39 +0200 | [diff] [blame] | 135 | uint8_t hostname[64]; |
Jens Axboe | 6eb2479 | 2011-10-04 15:00:30 +0200 | [diff] [blame] | 136 | uint8_t bigendian; |
Jens Axboe | 750db47 | 2012-04-16 11:44:48 +0200 | [diff] [blame] | 137 | uint8_t fio_version[32]; |
Jens Axboe | cca8464 | 2011-10-07 12:47:57 +0200 | [diff] [blame] | 138 | uint8_t os; |
| 139 | uint8_t arch; |
Jens Axboe | 38fdef2 | 2011-10-11 14:30:06 +0200 | [diff] [blame] | 140 | uint8_t bpp; |
Jens Axboe | d31e26d | 2012-03-28 21:38:24 +0200 | [diff] [blame] | 141 | uint32_t cpus; |
| 142 | uint64_t flags; |
Jens Axboe | c28e8e8 | 2011-10-04 08:57:39 +0200 | [diff] [blame] | 143 | }; |
| 144 | |
Jens Axboe | fa2ea80 | 2011-10-08 21:07:29 +0200 | [diff] [blame] | 145 | struct cmd_single_line_pdu { |
| 146 | uint16_t len; |
Jens Axboe | 372aecb | 2013-01-08 13:42:41 +0100 | [diff] [blame] | 147 | uint8_t text[]; |
Jens Axboe | fa2ea80 | 2011-10-08 21:07:29 +0200 | [diff] [blame] | 148 | }; |
| 149 | |
Jens Axboe | 81179ee | 2011-10-04 12:42:06 +0200 | [diff] [blame] | 150 | struct cmd_line_pdu { |
Jens Axboe | fa2ea80 | 2011-10-08 21:07:29 +0200 | [diff] [blame] | 151 | uint16_t lines; |
Jens Axboe | 46bcd49 | 2012-03-14 11:31:21 +0100 | [diff] [blame] | 152 | uint16_t client_type; |
Jens Axboe | 372aecb | 2013-01-08 13:42:41 +0100 | [diff] [blame] | 153 | struct cmd_single_line_pdu options[]; |
Jens Axboe | 81179ee | 2011-10-04 12:42:06 +0200 | [diff] [blame] | 154 | }; |
| 155 | |
Jens Axboe | 46bcd49 | 2012-03-14 11:31:21 +0100 | [diff] [blame] | 156 | struct cmd_job_pdu { |
| 157 | uint32_t buf_len; |
| 158 | uint32_t client_type; |
| 159 | uint8_t buf[0]; |
| 160 | }; |
| 161 | |
Jens Axboe | 11e950b | 2011-10-16 21:34:14 +0200 | [diff] [blame] | 162 | struct cmd_start_pdu { |
| 163 | uint32_t jobs; |
Jens Axboe | 108fea7 | 2012-11-14 13:09:45 -0700 | [diff] [blame] | 164 | uint32_t stat_outputs; |
Jens Axboe | 11e950b | 2011-10-16 21:34:14 +0200 | [diff] [blame] | 165 | }; |
| 166 | |
| 167 | struct cmd_end_pdu { |
| 168 | uint32_t error; |
Jens Axboe | 122c772 | 2012-03-19 09:13:15 +0100 | [diff] [blame] | 169 | uint32_t signal; |
Jens Axboe | 11e950b | 2011-10-16 21:34:14 +0200 | [diff] [blame] | 170 | }; |
| 171 | |
Jens Axboe | 807f997 | 2012-03-02 10:25:24 +0100 | [diff] [blame] | 172 | struct cmd_add_job_pdu { |
Jens Axboe | 2f122b1 | 2012-03-15 13:10:19 +0100 | [diff] [blame] | 173 | uint32_t thread_number; |
| 174 | uint32_t groupid; |
Jens Axboe | dcaeb60 | 2012-03-08 19:45:37 +0100 | [diff] [blame] | 175 | struct thread_options_pack top; |
Jens Axboe | 807f997 | 2012-03-02 10:25:24 +0100 | [diff] [blame] | 176 | }; |
| 177 | |
Jens Axboe | 084d1c6 | 2012-03-03 20:28:07 +0100 | [diff] [blame] | 178 | struct cmd_text_pdu { |
| 179 | uint32_t level; |
| 180 | uint32_t buf_len; |
| 181 | uint64_t log_sec; |
| 182 | uint64_t log_usec; |
| 183 | uint8_t buf[0]; |
| 184 | }; |
| 185 | |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 186 | enum { |
| 187 | XMIT_COMPRESSED = 1U, |
| 188 | STORE_COMPRESSED = 2U, |
| 189 | }; |
| 190 | |
Jens Axboe | 1b42725 | 2012-03-14 15:03:03 +0100 | [diff] [blame] | 191 | struct cmd_iolog_pdu { |
Jens Axboe | ccefd5f | 2014-06-30 20:59:03 -0600 | [diff] [blame] | 192 | uint64_t nr_samples; |
Jens Axboe | 2f122b1 | 2012-03-15 13:10:19 +0100 | [diff] [blame] | 193 | uint32_t thread_number; |
Jens Axboe | 1b42725 | 2012-03-14 15:03:03 +0100 | [diff] [blame] | 194 | uint32_t log_type; |
Jens Axboe | 3989b14 | 2013-04-12 13:13:24 +0200 | [diff] [blame] | 195 | uint32_t compressed; |
Jens Axboe | ccefd5f | 2014-06-30 20:59:03 -0600 | [diff] [blame] | 196 | uint32_t log_offset; |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 197 | uint32_t log_hist_coarseness; |
Jens Axboe | 1b42725 | 2012-03-14 15:03:03 +0100 | [diff] [blame] | 198 | uint8_t name[FIO_NET_NAME_MAX]; |
| 199 | struct io_sample samples[0]; |
| 200 | }; |
| 201 | |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 202 | struct cmd_job_option { |
| 203 | uint16_t global; |
| 204 | uint16_t truncated; |
| 205 | uint32_t groupid; |
| 206 | uint8_t name[64]; |
| 207 | uint8_t value[128]; |
| 208 | }; |
| 209 | |
Jens Axboe | 402668f | 2011-10-10 15:28:58 +0200 | [diff] [blame] | 210 | extern int fio_start_server(char *); |
Jens Axboe | 084d1c6 | 2012-03-03 20:28:07 +0100 | [diff] [blame] | 211 | extern int fio_server_text_output(int, const char *, size_t); |
Jens Axboe | 40c6051 | 2012-03-27 16:03:04 +0200 | [diff] [blame] | 212 | extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *); |
Jens Axboe | 89c1707 | 2011-10-11 10:15:51 +0200 | [diff] [blame] | 213 | extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *); |
Jens Axboe | bebe639 | 2011-10-07 10:00:51 +0200 | [diff] [blame] | 214 | extern void fio_server_set_arg(const char *); |
Jens Axboe | 811826b | 2011-10-24 09:11:50 +0200 | [diff] [blame] | 215 | extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *); |
Jens Axboe | 3aa3cee | 2014-01-24 18:56:56 -0800 | [diff] [blame] | 216 | extern int fio_server_parse_host(const char *, int, struct in_addr *, struct in6_addr *); |
Jens Axboe | 89c1707 | 2011-10-11 10:15:51 +0200 | [diff] [blame] | 217 | extern const char *fio_server_op(unsigned int); |
Jens Axboe | 7b82168 | 2011-10-11 12:16:32 +0200 | [diff] [blame] | 218 | extern void fio_server_got_signal(int); |
Jens Axboe | a64e88d | 2011-10-03 14:20:01 +0200 | [diff] [blame] | 219 | |
| 220 | struct thread_stat; |
| 221 | struct group_run_stats; |
| 222 | extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *); |
| 223 | extern void fio_server_send_gs(struct group_run_stats *); |
Jens Axboe | d09a64a | 2011-10-13 11:38:56 +0200 | [diff] [blame] | 224 | extern void fio_server_send_du(void); |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 225 | extern void fio_server_send_job_options(struct flist_head *, unsigned int); |
Jens Axboe | de54cfd | 2014-11-10 20:34:00 -0700 | [diff] [blame] | 226 | extern int fio_server_get_verify_state(const char *, int, void **); |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 227 | |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 228 | extern struct fio_net_cmd *fio_net_recv_cmd(int sk, bool wait); |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 229 | |
Jens Axboe | 1b42725 | 2012-03-14 15:03:03 +0100 | [diff] [blame] | 230 | extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *); |
Jens Axboe | 2f122b1 | 2012-03-15 13:10:19 +0100 | [diff] [blame] | 231 | extern void fio_server_send_add_job(struct thread_data *); |
Jens Axboe | 122c772 | 2012-03-19 09:13:15 +0100 | [diff] [blame] | 232 | extern void fio_server_send_start(struct thread_data *); |
Jens Axboe | 122c772 | 2012-03-19 09:13:15 +0100 | [diff] [blame] | 233 | extern int fio_net_send_quit(int sk); |
Jens Axboe | 807f997 | 2012-03-02 10:25:24 +0100 | [diff] [blame] | 234 | |
Elliott Hughes | eda3a60 | 2017-05-19 18:53:02 -0700 | [diff] [blame] | 235 | extern int fio_server_create_sk_key(void); |
| 236 | extern void fio_server_destroy_sk_key(void); |
| 237 | |
Jens Axboe | 009b1be | 2011-09-29 18:27:02 -0600 | [diff] [blame] | 238 | extern int exit_backend; |
Jens Axboe | 132159a | 2011-09-30 15:01:32 -0600 | [diff] [blame] | 239 | extern int fio_net_port; |
| 240 | |
Jens Axboe | 50d1697 | 2011-09-29 17:45:28 -0600 | [diff] [blame] | 241 | #endif |