422bfbf2b571617aeda1af3da8ce2ba86be0eeba
[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[0];     /* payload */
31 };
32
33 struct fio_net_int_cmd {
34         struct fio_net_cmd cmd;
35         struct flist_head list;
36         struct timeval tv;
37         uint64_t saved_tag;
38 };
39
40 enum {
41         FIO_SERVER_VER                  = 14,
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_NR                  = 18,
63
64         FIO_NET_CMD_F_MORE              = 1UL << 0,
65
66         /* crc does not include the crc fields */
67         FIO_NET_CMD_CRC_SZ              = sizeof(struct fio_net_cmd) -
68                                                 2 * sizeof(uint16_t),
69
70         FIO_NET_NAME_MAX                = 256,
71
72         FIO_NET_CLIENT_TIMEOUT          = 5000,
73 };
74
75 struct cmd_ts_pdu {
76         struct thread_stat ts;
77         struct group_run_stats rs;
78 };
79
80 struct cmd_du_pdu {
81         struct disk_util_stat dus;
82         struct disk_util_agg agg;
83 };
84
85 struct cmd_probe_pdu {
86         uint8_t hostname[64];
87         uint8_t bigendian;
88         uint8_t fio_major;
89         uint8_t fio_minor;
90         uint8_t fio_patch;
91         uint8_t os;
92         uint8_t arch;
93         uint8_t bpp;
94 };
95
96 struct cmd_single_line_pdu {
97         uint16_t len;
98         uint8_t text[0];
99 };
100
101 struct cmd_line_pdu {
102         uint16_t lines;
103         uint16_t client_type;
104         struct cmd_single_line_pdu options[0];
105 };
106
107 struct cmd_job_pdu {
108         uint32_t buf_len;
109         uint32_t client_type;
110         uint8_t buf[0];
111 };
112
113 struct cmd_start_pdu {
114         uint32_t jobs;
115 };
116
117 struct cmd_end_pdu {
118         uint32_t error;
119         uint32_t signal;
120 };
121
122 struct cmd_add_job_pdu {
123         uint32_t thread_number;
124         uint32_t groupid;
125         struct thread_options_pack top;
126 };
127
128 struct cmd_text_pdu {
129         uint32_t level;
130         uint32_t buf_len;
131         uint64_t log_sec;
132         uint64_t log_usec;
133         uint8_t buf[0];
134 };
135
136 struct cmd_iolog_pdu {
137         uint32_t thread_number;
138         uint32_t nr_samples;
139         uint32_t log_type;
140         uint8_t name[FIO_NET_NAME_MAX];
141         struct io_sample samples[0];
142 };
143
144 extern int fio_start_server(char *);
145 extern int fio_server_text_output(int, const char *, size_t);
146 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t);
147 extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
148 extern void fio_server_set_arg(const char *);
149 extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
150 extern int fio_server_parse_host(const char *, int *, struct in_addr *, struct in6_addr *);
151 extern const char *fio_server_op(unsigned int);
152 extern void fio_server_got_signal(int);
153
154 struct thread_stat;
155 struct group_run_stats;
156 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
157 extern void fio_server_send_gs(struct group_run_stats *);
158 extern void fio_server_send_du(void);
159
160 extern int fio_recv_data(int sk, void *p, unsigned int len);
161 extern int fio_send_data(int sk, const void *p, unsigned int len);
162 extern void fio_net_cmd_crc(struct fio_net_cmd *);
163 extern void fio_net_cmd_crc_pdu(struct fio_net_cmd *, const void *);
164 extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
165
166 extern int fio_send_iolog(struct thread_data *, struct io_log *, const char *);
167 extern void fio_server_send_add_job(struct thread_data *);
168 extern void fio_server_send_start(struct thread_data *);
169 extern int fio_net_send_stop(int sk, int error, int signal);
170 extern int fio_net_send_quit(int sk);
171
172 extern int exit_backend;
173 extern int fio_net_port;
174
175 static inline void __fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
176                                       uint32_t pdu_len, uint64_t tag)
177 {
178         memset(cmd, 0, sizeof(*cmd));
179
180         cmd->version    = __cpu_to_le16(FIO_SERVER_VER);
181         cmd->opcode     = cpu_to_le16(opcode);
182         cmd->tag        = cpu_to_le64(tag);
183         cmd->pdu_len    = cpu_to_le32(pdu_len);
184 }
185
186
187 static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
188                                     const void *pdu, uint32_t pdu_len,
189                                     uint64_t tag)
190 {
191         __fio_init_net_cmd(cmd, opcode, pdu_len, tag);
192
193         if (pdu)
194                 memcpy(&cmd->payload, pdu, pdu_len);
195 }
196
197 #endif