067cdc0bb29408234d39ffbf639c1f0ac4dde6a6
[fio.git] / server.h
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                  = 21,
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
76 struct cmd_ts_pdu {
77         struct thread_stat ts;
78         struct group_run_stats rs;
79 };
80
81 struct cmd_du_pdu {
82         struct disk_util_stat dus;
83         struct disk_util_agg agg;
84 };
85
86 struct cmd_probe_pdu {
87         uint8_t hostname[64];
88         uint8_t bigendian;
89         uint8_t fio_version[32];
90         uint8_t os;
91         uint8_t arch;
92         uint8_t bpp;
93         uint32_t cpus;
94         uint64_t flags;
95 };
96
97 struct cmd_single_line_pdu {
98         uint16_t len;
99         uint8_t text[];
100 };
101
102 struct cmd_line_pdu {
103         uint16_t lines;
104         uint16_t client_type;
105         struct cmd_single_line_pdu options[];
106 };
107
108 struct cmd_job_pdu {
109         uint32_t buf_len;
110         uint32_t client_type;
111         uint8_t buf[0];
112 };
113
114 struct cmd_start_pdu {
115         uint32_t jobs;
116         uint32_t stat_outputs;
117 };
118
119 struct cmd_end_pdu {
120         uint32_t error;
121         uint32_t signal;
122 };
123
124 struct cmd_add_job_pdu {
125         uint32_t thread_number;
126         uint32_t groupid;
127         struct thread_options_pack top;
128 };
129
130 struct cmd_text_pdu {
131         uint32_t level;
132         uint32_t buf_len;
133         uint64_t log_sec;
134         uint64_t log_usec;
135         uint8_t buf[0];
136 };
137
138 struct cmd_iolog_pdu {
139         uint32_t thread_number;
140         uint32_t nr_samples;
141         uint32_t log_type;
142         uint8_t name[FIO_NET_NAME_MAX];
143         struct io_sample samples[0];
144 };
145
146 extern int fio_start_server(char *);
147 extern int fio_server_text_output(int, const char *, size_t);
148 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t *, struct flist_head *);
149 extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
150 extern void fio_server_set_arg(const char *);
151 extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
152 extern int fio_server_parse_host(const char *, int *, struct in_addr *, struct in6_addr *);
153 extern const char *fio_server_op(unsigned int);
154 extern void fio_server_got_signal(int);
155
156 struct thread_stat;
157 struct group_run_stats;
158 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
159 extern void fio_server_send_gs(struct group_run_stats *);
160 extern void fio_server_send_du(void);
161 extern void fio_server_idle_loop(void);
162
163 extern int fio_clients_connect(void);
164 extern int fio_clients_send_ini(const char *);
165 extern void fio_client_add_cmd_option(void *, const char *);
166 extern void fio_client_add_ini_file(void *, const char *);
167
168 extern int fio_recv_data(int sk, void *p, unsigned int len);
169 extern int fio_send_data(int sk, const void *p, unsigned int len);
170 extern void fio_net_cmd_crc(struct fio_net_cmd *);
171 extern void fio_net_cmd_crc_pdu(struct fio_net_cmd *, const void *);
172 extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
173
174 extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
175 extern void fio_server_send_add_job(struct thread_data *);
176 extern void fio_server_send_start(struct thread_data *);
177 extern int fio_net_send_stop(int sk, int error, int signal);
178 extern int fio_net_send_quit(int sk);
179
180 extern int exit_backend;
181 extern int fio_net_port;
182
183 static inline void __fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
184                                       uint32_t pdu_len, uint64_t tag)
185 {
186         memset(cmd, 0, sizeof(*cmd));
187
188         cmd->version    = __cpu_to_le16(FIO_SERVER_VER);
189         cmd->opcode     = cpu_to_le16(opcode);
190         cmd->tag        = cpu_to_le64(tag);
191         cmd->pdu_len    = cpu_to_le32(pdu_len);
192 }
193
194
195 static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
196                                     const void *pdu, uint32_t pdu_len,
197                                     uint64_t tag)
198 {
199         __fio_init_net_cmd(cmd, opcode, pdu_len, tag);
200
201         if (pdu)
202                 memcpy(&cmd->payload, pdu, pdu_len);
203 }
204
205 #endif