server.h revision 714e85f340194409d0abcf643cd2f154a7380a74 
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 */
18struct 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
33struct fio_net_cmd_reply {
34	struct flist_head list;
35	struct timeval tv;
36	uint64_t saved_tag;
37	uint16_t opcode;
38};
39
40enum {
41	FIO_SERVER_VER			= 23,
42
43	FIO_SERVER_MAX_FRAGMENT_PDU	= 1024,
44
45	FIO_NET_CMD_QUIT		= 1,
46	FIO_NET_CMD_EXIT		= 2,
47	FIO_NET_CMD_JOB			= 3,
48	FIO_NET_CMD_JOBLINE		= 4,
49	FIO_NET_CMD_TEXT		= 5,
50	FIO_NET_CMD_TS			= 6,
51	FIO_NET_CMD_GS			= 7,
52	FIO_NET_CMD_SEND_ETA		= 8,
53	FIO_NET_CMD_ETA			= 9,
54	FIO_NET_CMD_PROBE		= 10,
55	FIO_NET_CMD_START		= 11,
56	FIO_NET_CMD_STOP		= 12,
57	FIO_NET_CMD_DU			= 13,
58	FIO_NET_CMD_SERVER_START	= 14,
59	FIO_NET_CMD_ADD_JOB		= 15,
60	FIO_NET_CMD_RUN			= 16,
61	FIO_NET_CMD_IOLOG		= 17,
62	FIO_NET_CMD_UPDATE_JOB		= 18,
63	FIO_NET_CMD_NR			= 19,
64
65	FIO_NET_CMD_F_MORE		= 1UL << 0,
66
67	/* crc does not include the crc fields */
68	FIO_NET_CMD_CRC_SZ		= sizeof(struct fio_net_cmd) -
69						2 * sizeof(uint16_t),
70
71	FIO_NET_NAME_MAX		= 256,
72
73	FIO_NET_CLIENT_TIMEOUT		= 5000,
74
75	FIO_PROBE_FLAG_ZLIB		= 1UL << 0,
76};
77
78struct cmd_ts_pdu {
79	struct thread_stat ts;
80	struct group_run_stats rs;
81};
82
83struct cmd_du_pdu {
84	struct disk_util_stat dus;
85	struct disk_util_agg agg;
86};
87
88struct cmd_client_probe_pdu {
89	uint64_t flags;
90};
91
92struct cmd_probe_reply_pdu {
93	uint8_t hostname[64];
94	uint8_t bigendian;
95	uint8_t fio_version[32];
96	uint8_t os;
97	uint8_t arch;
98	uint8_t bpp;
99	uint32_t cpus;
100	uint64_t flags;
101};
102
103struct cmd_single_line_pdu {
104	uint16_t len;
105	uint8_t text[];
106};
107
108struct cmd_line_pdu {
109	uint16_t lines;
110	uint16_t client_type;
111	struct cmd_single_line_pdu options[];
112};
113
114struct cmd_job_pdu {
115	uint32_t buf_len;
116	uint32_t client_type;
117	uint8_t buf[0];
118};
119
120struct cmd_start_pdu {
121	uint32_t jobs;
122	uint32_t stat_outputs;
123};
124
125struct cmd_end_pdu {
126	uint32_t error;
127	uint32_t signal;
128};
129
130struct cmd_add_job_pdu {
131	uint32_t thread_number;
132	uint32_t groupid;
133	struct thread_options_pack top;
134};
135
136struct cmd_text_pdu {
137	uint32_t level;
138	uint32_t buf_len;
139	uint64_t log_sec;
140	uint64_t log_usec;
141	uint8_t buf[0];
142};
143
144struct cmd_iolog_pdu {
145	uint32_t thread_number;
146	uint32_t nr_samples;
147	uint32_t log_type;
148	uint32_t compressed;
149	uint8_t name[FIO_NET_NAME_MAX];
150	struct io_sample samples[0];
151};
152
153extern int fio_start_server(char *);
154extern int fio_server_text_output(int, const char *, size_t);
155extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *);
156extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
157extern void fio_server_set_arg(const char *);
158extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
159extern int fio_server_parse_host(const char *, int *, struct in_addr *, struct in6_addr *);
160extern const char *fio_server_op(unsigned int);
161extern void fio_server_got_signal(int);
162
163struct thread_stat;
164struct group_run_stats;
165extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
166extern void fio_server_send_gs(struct group_run_stats *);
167extern void fio_server_send_du(void);
168extern void fio_server_idle_loop(void);
169
170extern int fio_clients_connect(void);
171extern int fio_clients_send_ini(const char *);
172extern void fio_client_add_cmd_option(void *, const char *);
173extern void fio_client_add_ini_file(void *, const char *);
174
175extern int fio_recv_data(int sk, void *p, unsigned int len);
176extern int fio_send_data(int sk, const void *p, unsigned int len);
177extern void fio_net_cmd_crc(struct fio_net_cmd *);
178extern void fio_net_cmd_crc_pdu(struct fio_net_cmd *, const void *);
179extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
180
181extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
182extern void fio_server_send_add_job(struct thread_data *);
183extern void fio_server_send_start(struct thread_data *);
184extern int fio_net_send_stop(int sk, int error, int signal);
185extern int fio_net_send_quit(int sk);
186
187extern int exit_backend;
188extern int fio_net_port;
189
190static inline void __fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
191				      uint32_t pdu_len, uint64_t tag)
192{
193	memset(cmd, 0, sizeof(*cmd));
194
195	cmd->version	= __cpu_to_le16(FIO_SERVER_VER);
196	cmd->opcode	= cpu_to_le16(opcode);
197	cmd->tag	= cpu_to_le64(tag);
198	cmd->pdu_len	= cpu_to_le32(pdu_len);
199}
200
201
202static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
203				    const void *pdu, uint32_t pdu_len,
204				    uint64_t tag)
205{
206	__fio_init_net_cmd(cmd, opcode, pdu_len, tag);
207
208	if (pdu)
209		memcpy(&cmd->payload, pdu, pdu_len);
210}
211
212#endif
213