blob: dc5a69e82ad6821d96e7a7c5f9e5ca2d6b9524cd [file] [log] [blame]
Jens Axboe50d16972011-09-29 17:45:28 -06001#ifndef FIO_SERVER_H
2#define FIO_SERVER_H
3
Jens Axboe132159a2011-09-30 15:01:32 -06004#include <inttypes.h>
Jens Axboe142575e2011-09-30 17:35:45 -06005#include <string.h>
Jens Axboe89c17072011-10-11 10:15:51 +02006#include <sys/time.h>
Jens Axboe811826b2011-10-24 09:11:50 +02007#include <netinet/in.h>
Jens Axboe132159a2011-09-30 15:01:32 -06008
Jens Axboea64e88d2011-10-03 14:20:01 +02009#include "stat.h"
Jens Axboe610a7302011-10-04 13:53:35 +020010#include "os/os.h"
Jens Axboed09a64a2011-10-13 11:38:56 +020011#include "diskutil.h"
Jens Axboea64e88d2011-10-03 14:20:01 +020012
Stephen M. Cameron5adc2442012-02-24 08:17:31 +010013#define FIO_NET_PORT 8765
14
Jens Axboe132159a2011-09-30 15:01:32 -060015/*
16 * On-wire encoding is little endian
17 */
18struct fio_net_cmd {
19 uint16_t version; /* protocol version */
20 uint16_t opcode; /* command opcode */
21 uint32_t flags; /* modifier flags */
Jens Axboeaf9c9fb2011-10-09 21:54:10 +020022 uint64_t tag; /* passed back on reply */
Jens Axboe132159a2011-09-30 15:01:32 -060023 uint32_t pdu_len; /* length of post-cmd layload */
Jens Axboea64e88d2011-10-03 14:20:01 +020024 /*
25 * These must be immediately before the payload, anything before
26 * these fields are checksummed.
27 */
Jens Axboefcee5ff2011-09-30 22:50:39 -060028 uint16_t cmd_crc16; /* cmd checksum */
29 uint16_t pdu_crc16; /* payload checksum */
Jens Axboe372aecb2013-01-08 13:42:41 +010030 uint8_t payload[]; /* payload */
Jens Axboe132159a2011-09-30 15:01:32 -060031};
32
Jens Axboe40c60512012-03-27 16:03:04 +020033struct fio_net_cmd_reply {
Jens Axboe89c17072011-10-11 10:15:51 +020034 struct flist_head list;
35 struct timeval tv;
36 uint64_t saved_tag;
Jens Axboe40c60512012-03-27 16:03:04 +020037 uint16_t opcode;
Jens Axboe89c17072011-10-11 10:15:51 +020038};
39
Jens Axboe132159a2011-09-30 15:01:32 -060040enum {
Jens Axboe80ac0202014-12-16 20:38:53 -070041 FIO_SERVER_VER = 42,
Jens Axboe132159a2011-09-30 15:01:32 -060042
Jens Axboeb9d2f302012-03-08 20:36:28 +010043 FIO_SERVER_MAX_FRAGMENT_PDU = 1024,
Jens Axboedfbf1f62014-04-14 11:43:47 -060044 FIO_SERVER_MAX_CMD_MB = 2048,
Jens Axboe132159a2011-09-30 15:01:32 -060045
Jens Axboe5d7793a2012-03-08 19:59:16 +010046 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,
Jens Axboeb9d2f302012-03-08 20:36:28 +010061 FIO_NET_CMD_RUN = 16,
Jens Axboe1b427252012-03-14 15:03:03 +010062 FIO_NET_CMD_IOLOG = 17,
Jens Axboef58bd2a2012-03-27 10:06:42 +020063 FIO_NET_CMD_UPDATE_JOB = 18,
Jens Axboe35899182014-10-07 20:56:28 -060064 FIO_NET_CMD_LOAD_FILE = 19,
Jens Axboede54cfd2014-11-10 20:34:00 -070065 FIO_NET_CMD_VTRIGGER = 20,
66 FIO_NET_CMD_SENDFILE = 21,
67 FIO_NET_CMD_NR = 22,
Jens Axboe794d69c2011-10-01 08:48:50 -060068
Jens Axboe5d7793a2012-03-08 19:59:16 +010069 FIO_NET_CMD_F_MORE = 1UL << 0,
Jens Axboefcee5ff2011-09-30 22:50:39 -060070
71 /* crc does not include the crc fields */
Jens Axboe5d7793a2012-03-08 19:59:16 +010072 FIO_NET_CMD_CRC_SZ = sizeof(struct fio_net_cmd) -
73 2 * sizeof(uint16_t),
Jens Axboe89c17072011-10-11 10:15:51 +020074
Jens Axboe1b427252012-03-14 15:03:03 +010075 FIO_NET_NAME_MAX = 256,
76
Jens Axboe5d7793a2012-03-08 19:59:16 +010077 FIO_NET_CLIENT_TIMEOUT = 5000,
Jens Axboe3989b142013-04-12 13:13:24 +020078
79 FIO_PROBE_FLAG_ZLIB = 1UL << 0,
Jens Axboe132159a2011-09-30 15:01:32 -060080};
81
Jens Axboede54cfd2014-11-10 20:34:00 -070082struct cmd_sendfile {
83 uint8_t path[FIO_NET_NAME_MAX];
84};
85
86struct cmd_sendfile_reply {
87 uint32_t size;
88 uint32_t error;
89 uint8_t data[0];
90};
91
92/*
93 * Client sends this to server on VTRIGGER, server sends back a full
94 * all_io_list structure.
95 */
96struct cmd_vtrigger_pdu {
97 uint16_t len;
98 uint8_t cmd[];
99};
100
Jens Axboe35899182014-10-07 20:56:28 -0600101struct cmd_load_file_pdu {
102 uint16_t name_len;
103 uint16_t client_type;
104 uint8_t file[];
105};
106
Jens Axboea64e88d2011-10-03 14:20:01 +0200107struct cmd_ts_pdu {
108 struct thread_stat ts;
109 struct group_run_stats rs;
110};
111
Jens Axboed09a64a2011-10-13 11:38:56 +0200112struct cmd_du_pdu {
113 struct disk_util_stat dus;
114 struct disk_util_agg agg;
115};
116
Jens Axboe3989b142013-04-12 13:13:24 +0200117struct cmd_client_probe_pdu {
118 uint64_t flags;
Jens Axboede54cfd2014-11-10 20:34:00 -0700119 uint8_t server[128];
Jens Axboe3989b142013-04-12 13:13:24 +0200120};
121
122struct cmd_probe_reply_pdu {
Jens Axboec28e8e82011-10-04 08:57:39 +0200123 uint8_t hostname[64];
Jens Axboe6eb24792011-10-04 15:00:30 +0200124 uint8_t bigendian;
Jens Axboe750db472012-04-16 11:44:48 +0200125 uint8_t fio_version[32];
Jens Axboecca84642011-10-07 12:47:57 +0200126 uint8_t os;
127 uint8_t arch;
Jens Axboe38fdef22011-10-11 14:30:06 +0200128 uint8_t bpp;
Jens Axboed31e26d2012-03-28 21:38:24 +0200129 uint32_t cpus;
130 uint64_t flags;
Jens Axboec28e8e82011-10-04 08:57:39 +0200131};
132
Jens Axboefa2ea802011-10-08 21:07:29 +0200133struct cmd_single_line_pdu {
134 uint16_t len;
Jens Axboe372aecb2013-01-08 13:42:41 +0100135 uint8_t text[];
Jens Axboefa2ea802011-10-08 21:07:29 +0200136};
137
Jens Axboe81179ee2011-10-04 12:42:06 +0200138struct cmd_line_pdu {
Jens Axboefa2ea802011-10-08 21:07:29 +0200139 uint16_t lines;
Jens Axboe46bcd492012-03-14 11:31:21 +0100140 uint16_t client_type;
Jens Axboe372aecb2013-01-08 13:42:41 +0100141 struct cmd_single_line_pdu options[];
Jens Axboe81179ee2011-10-04 12:42:06 +0200142};
143
Jens Axboe46bcd492012-03-14 11:31:21 +0100144struct cmd_job_pdu {
145 uint32_t buf_len;
146 uint32_t client_type;
147 uint8_t buf[0];
148};
149
Jens Axboe11e950b2011-10-16 21:34:14 +0200150struct cmd_start_pdu {
151 uint32_t jobs;
Jens Axboe108fea72012-11-14 13:09:45 -0700152 uint32_t stat_outputs;
Jens Axboe11e950b2011-10-16 21:34:14 +0200153};
154
155struct cmd_end_pdu {
156 uint32_t error;
Jens Axboe122c7722012-03-19 09:13:15 +0100157 uint32_t signal;
Jens Axboe11e950b2011-10-16 21:34:14 +0200158};
159
Jens Axboe807f9972012-03-02 10:25:24 +0100160struct cmd_add_job_pdu {
Jens Axboe2f122b12012-03-15 13:10:19 +0100161 uint32_t thread_number;
162 uint32_t groupid;
Jens Axboedcaeb602012-03-08 19:45:37 +0100163 struct thread_options_pack top;
Jens Axboe807f9972012-03-02 10:25:24 +0100164};
165
Jens Axboe084d1c62012-03-03 20:28:07 +0100166struct cmd_text_pdu {
167 uint32_t level;
168 uint32_t buf_len;
169 uint64_t log_sec;
170 uint64_t log_usec;
171 uint8_t buf[0];
172};
173
Jens Axboe1b427252012-03-14 15:03:03 +0100174struct cmd_iolog_pdu {
Jens Axboeccefd5f2014-06-30 20:59:03 -0600175 uint64_t nr_samples;
Jens Axboe2f122b12012-03-15 13:10:19 +0100176 uint32_t thread_number;
Jens Axboe1b427252012-03-14 15:03:03 +0100177 uint32_t log_type;
Jens Axboe3989b142013-04-12 13:13:24 +0200178 uint32_t compressed;
Jens Axboeccefd5f2014-06-30 20:59:03 -0600179 uint32_t log_offset;
Jens Axboe1b427252012-03-14 15:03:03 +0100180 uint8_t name[FIO_NET_NAME_MAX];
181 struct io_sample samples[0];
182};
183
Jens Axboe402668f2011-10-10 15:28:58 +0200184extern int fio_start_server(char *);
Jens Axboe084d1c62012-03-03 20:28:07 +0100185extern int fio_server_text_output(int, const char *, size_t);
Jens Axboe40c60512012-03-27 16:03:04 +0200186extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *);
Jens Axboe89c17072011-10-11 10:15:51 +0200187extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
Jens Axboebebe6392011-10-07 10:00:51 +0200188extern void fio_server_set_arg(const char *);
Jens Axboe811826b2011-10-24 09:11:50 +0200189extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
Jens Axboe3aa3cee2014-01-24 18:56:56 -0800190extern int fio_server_parse_host(const char *, int, struct in_addr *, struct in6_addr *);
Jens Axboe89c17072011-10-11 10:15:51 +0200191extern const char *fio_server_op(unsigned int);
Jens Axboe7b821682011-10-11 12:16:32 +0200192extern void fio_server_got_signal(int);
Jens Axboea64e88d2011-10-03 14:20:01 +0200193
194struct thread_stat;
195struct group_run_stats;
196extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
197extern void fio_server_send_gs(struct group_run_stats *);
Jens Axboed09a64a2011-10-13 11:38:56 +0200198extern void fio_server_send_du(void);
Jens Axboecc0df002011-10-03 20:53:32 +0200199extern void fio_server_idle_loop(void);
Jens Axboede54cfd2014-11-10 20:34:00 -0700200extern int fio_server_get_verify_state(const char *, int, void **);
Jens Axboe132159a2011-09-30 15:01:32 -0600201
Jens Axboe132159a2011-09-30 15:01:32 -0600202extern int fio_recv_data(int sk, void *p, unsigned int len);
203extern int fio_send_data(int sk, const void *p, unsigned int len);
204extern void fio_net_cmd_crc(struct fio_net_cmd *);
Jens Axboe53bd8db2012-03-14 21:51:38 +0100205extern void fio_net_cmd_crc_pdu(struct fio_net_cmd *, const void *);
Jens Axboee951bdc2011-10-05 21:58:45 +0200206extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
Jens Axboe132159a2011-09-30 15:01:32 -0600207
Jens Axboe1b427252012-03-14 15:03:03 +0100208extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
Jens Axboe2f122b12012-03-15 13:10:19 +0100209extern void fio_server_send_add_job(struct thread_data *);
Jens Axboe122c7722012-03-19 09:13:15 +0100210extern void fio_server_send_start(struct thread_data *);
211extern int fio_net_send_stop(int sk, int error, int signal);
212extern int fio_net_send_quit(int sk);
Jens Axboe807f9972012-03-02 10:25:24 +0100213
Jens Axboe009b1be2011-09-29 18:27:02 -0600214extern int exit_backend;
Jens Axboe132159a2011-09-30 15:01:32 -0600215extern int fio_net_port;
216
Jens Axboe1b427252012-03-14 15:03:03 +0100217static inline void __fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
218 uint32_t pdu_len, uint64_t tag)
Jens Axboe132159a2011-09-30 15:01:32 -0600219{
220 memset(cmd, 0, sizeof(*cmd));
Jens Axboe4d8f8782011-09-30 22:24:17 -0600221
Jens Axboefa2ea802011-10-08 21:07:29 +0200222 cmd->version = __cpu_to_le16(FIO_SERVER_VER);
Jens Axboe82fa6b22011-09-30 22:29:08 -0600223 cmd->opcode = cpu_to_le16(opcode);
Jens Axboeaf9c9fb2011-10-09 21:54:10 +0200224 cmd->tag = cpu_to_le64(tag);
Jens Axboe1b427252012-03-14 15:03:03 +0100225 cmd->pdu_len = cpu_to_le32(pdu_len);
226}
Jens Axboe4d8f8782011-09-30 22:24:17 -0600227
Jens Axboe1b427252012-03-14 15:03:03 +0100228
229static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
230 const void *pdu, uint32_t pdu_len,
231 uint64_t tag)
232{
233 __fio_init_net_cmd(cmd, opcode, pdu_len, tag);
234
235 if (pdu)
Jens Axboe4d8f8782011-09-30 22:24:17 -0600236 memcpy(&cmd->payload, pdu, pdu_len);
Jens Axboe132159a2011-09-30 15:01:32 -0600237}
Jens Axboe50d16972011-09-29 17:45:28 -0600238
239#endif