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