server: bump protocol version
[fio.git] / server.h
CommitLineData
50d16976
JA
1#ifndef FIO_SERVER_H
2#define FIO_SERVER_H
3
132159a5 4#include <inttypes.h>
142575e6 5#include <string.h>
89c1707c 6#include <sys/time.h>
811826be 7#include <netinet/in.h>
132159a5 8
a64e88da 9#include "stat.h"
610a730c 10#include "os/os.h"
d09a64a0 11#include "diskutil.h"
a64e88da 12
5adc2447
SC
13#define FIO_NET_PORT 8765
14
132159a5
JA
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 */
af9c9fb3 22 uint64_t tag; /* passed back on reply */
132159a5 23 uint32_t pdu_len; /* length of post-cmd layload */
a64e88da
JA
24 /*
25 * These must be immediately before the payload, anything before
26 * these fields are checksummed.
27 */
fcee5ff6
JA
28 uint16_t cmd_crc16; /* cmd checksum */
29 uint16_t pdu_crc16; /* payload checksum */
372aecb9 30 uint8_t payload[]; /* payload */
132159a5
JA
31};
32
40c60516 33struct fio_net_cmd_reply {
89c1707c
JA
34 struct flist_head list;
35 struct timeval tv;
36 uint64_t saved_tag;
40c60516 37 uint16_t opcode;
89c1707c
JA
38};
39
132159a5 40enum {
68cebb4b 41 FIO_SERVER_VER = 55,
132159a5 42
b9d2f30a 43 FIO_SERVER_MAX_FRAGMENT_PDU = 1024,
dfbf1f6f 44 FIO_SERVER_MAX_CMD_MB = 2048,
132159a5 45
5d7793aa
JA
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,
b9d2f30a 61 FIO_NET_CMD_RUN = 16,
1b42725f 62 FIO_NET_CMD_IOLOG = 17,
f58bd2a4 63 FIO_NET_CMD_UPDATE_JOB = 18,
323255cc 64 FIO_NET_CMD_LOAD_FILE = 19,
ca09be4b
JA
65 FIO_NET_CMD_VTRIGGER = 20,
66 FIO_NET_CMD_SENDFILE = 21,
0279b880
JA
67 FIO_NET_CMD_JOB_OPT = 22,
68 FIO_NET_CMD_NR = 23,
794d69ca 69
5d7793aa 70 FIO_NET_CMD_F_MORE = 1UL << 0,
fcee5ff6
JA
71
72 /* crc does not include the crc fields */
5d7793aa
JA
73 FIO_NET_CMD_CRC_SZ = sizeof(struct fio_net_cmd) -
74 2 * sizeof(uint16_t),
89c1707c 75
1b42725f
JA
76 FIO_NET_NAME_MAX = 256,
77
a64c13a4 78 FIO_NET_CLIENT_TIMEOUT = 5000,
3989b143
JA
79
80 FIO_PROBE_FLAG_ZLIB = 1UL << 0,
132159a5
JA
81};
82
ca09be4b
JA
83struct cmd_sendfile {
84 uint8_t path[FIO_NET_NAME_MAX];
85};
86
87struct cmd_sendfile_reply {
88 uint32_t size;
89 uint32_t error;
90 uint8_t data[0];
91};
92
93/*
94 * Client sends this to server on VTRIGGER, server sends back a full
95 * all_io_list structure.
96 */
97struct cmd_vtrigger_pdu {
98 uint16_t len;
99 uint8_t cmd[];
100};
101
323255cc
JA
102struct cmd_load_file_pdu {
103 uint16_t name_len;
104 uint16_t client_type;
105 uint8_t file[];
106};
107
a64e88da
JA
108struct cmd_ts_pdu {
109 struct thread_stat ts;
110 struct group_run_stats rs;
111};
112
d09a64a0
JA
113struct cmd_du_pdu {
114 struct disk_util_stat dus;
115 struct disk_util_agg agg;
116};
117
3989b143
JA
118struct cmd_client_probe_pdu {
119 uint64_t flags;
ca09be4b 120 uint8_t server[128];
3989b143
JA
121};
122
123struct cmd_probe_reply_pdu {
c28e8e8c 124 uint8_t hostname[64];
6eb24791 125 uint8_t bigendian;
750db473 126 uint8_t fio_version[32];
cca84643
JA
127 uint8_t os;
128 uint8_t arch;
38fdef22 129 uint8_t bpp;
d31e26d0
JA
130 uint32_t cpus;
131 uint64_t flags;
c28e8e8c
JA
132};
133
fa2ea806
JA
134struct cmd_single_line_pdu {
135 uint16_t len;
372aecb9 136 uint8_t text[];
fa2ea806
JA
137};
138
81179eec 139struct cmd_line_pdu {
fa2ea806 140 uint16_t lines;
46bcd498 141 uint16_t client_type;
372aecb9 142 struct cmd_single_line_pdu options[];
81179eec
JA
143};
144
46bcd498
JA
145struct cmd_job_pdu {
146 uint32_t buf_len;
147 uint32_t client_type;
148 uint8_t buf[0];
149};
150
11e950bd
JA
151struct cmd_start_pdu {
152 uint32_t jobs;
108fea77 153 uint32_t stat_outputs;
11e950bd
JA
154};
155
156struct cmd_end_pdu {
157 uint32_t error;
122c7725 158 uint32_t signal;
11e950bd
JA
159};
160
807f9971 161struct cmd_add_job_pdu {
2f122b13
JA
162 uint32_t thread_number;
163 uint32_t groupid;
dcaeb606 164 struct thread_options_pack top;
807f9971
JA
165};
166
084d1c6f
JA
167struct cmd_text_pdu {
168 uint32_t level;
169 uint32_t buf_len;
170 uint64_t log_sec;
171 uint64_t log_usec;
172 uint8_t buf[0];
173};
174
0cba0f91
JA
175enum {
176 XMIT_COMPRESSED = 1U,
177 STORE_COMPRESSED = 2U,
178};
179
1b42725f 180struct cmd_iolog_pdu {
ae588852 181 uint64_t nr_samples;
2f122b13 182 uint32_t thread_number;
1b42725f 183 uint32_t log_type;
3989b143 184 uint32_t compressed;
ae588852 185 uint32_t log_offset;
1b42725f
JA
186 uint8_t name[FIO_NET_NAME_MAX];
187 struct io_sample samples[0];
188};
189
0279b880
JA
190struct cmd_job_option {
191 uint16_t global;
bc0fec0e
JA
192 uint16_t truncated;
193 uint32_t groupid;
0279b880
JA
194 uint8_t name[64];
195 uint8_t value[128];
196};
197
402668f3 198extern int fio_start_server(char *);
084d1c6f 199extern int fio_server_text_output(int, const char *, size_t);
40c60516 200extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *);
89c1707c 201extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
bebe6398 202extern void fio_server_set_arg(const char *);
811826be 203extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
3aa3ceeb 204extern int fio_server_parse_host(const char *, int, struct in_addr *, struct in6_addr *);
89c1707c 205extern const char *fio_server_op(unsigned int);
7b821684 206extern void fio_server_got_signal(int);
a64e88da
JA
207
208struct thread_stat;
209struct group_run_stats;
210extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
211extern void fio_server_send_gs(struct group_run_stats *);
d09a64a0 212extern void fio_server_send_du(void);
0279b880 213extern void fio_server_send_job_options(struct flist_head *, unsigned int);
94a6e1bb 214extern int fio_server_get_verify_state(const char *, int, void **);
132159a5 215
54e62ad4 216extern struct fio_net_cmd *fio_net_recv_cmd(int sk, bool wait);
132159a5 217
1b42725f 218extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
2f122b13 219extern void fio_server_send_add_job(struct thread_data *);
122c7725 220extern void fio_server_send_start(struct thread_data *);
122c7725 221extern int fio_net_send_quit(int sk);
807f9971 222
3d80c735 223extern int fio_server_create_sk_key(void);
518a1cf0 224extern void fio_server_destroy_sk_key(void);
3d80c735 225
009b1be4 226extern int exit_backend;
132159a5
JA
227extern int fio_net_port;
228
50d16976 229#endif