bc044e9b4772eff159f34225f8019889b9c8a04c
[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                  = 9,
42
43         FIO_SERVER_MAX_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_NR                  = 16,
61
62         FIO_NET_CMD_F_MORE              = 1UL << 0,
63
64         /* crc does not include the crc fields */
65         FIO_NET_CMD_CRC_SZ              = sizeof(struct fio_net_cmd) -
66                                                 2 * sizeof(uint16_t),
67
68         FIO_NET_CLIENT_TIMEOUT          = 5000,
69 };
70
71 struct cmd_ts_pdu {
72         struct thread_stat ts;
73         struct group_run_stats rs;
74 };
75
76 struct cmd_du_pdu {
77         struct disk_util_stat dus;
78         struct disk_util_agg agg;
79 };
80
81 struct cmd_probe_pdu {
82         uint8_t hostname[64];
83         uint8_t bigendian;
84         uint8_t fio_major;
85         uint8_t fio_minor;
86         uint8_t fio_patch;
87         uint8_t os;
88         uint8_t arch;
89         uint8_t bpp;
90 };
91
92 struct cmd_single_line_pdu {
93         uint16_t len;
94         uint8_t text[0];
95 };
96
97 struct cmd_line_pdu {
98         uint16_t lines;
99         struct cmd_single_line_pdu options[0];
100 };
101
102 struct cmd_start_pdu {
103         uint32_t jobs;
104 };
105
106 struct cmd_end_pdu {
107         uint32_t error;
108 };
109
110 struct cmd_add_job_pdu {
111         struct thread_options_pack top;
112 };
113
114 struct cmd_text_pdu {
115         uint32_t level;
116         uint32_t buf_len;
117         uint64_t log_sec;
118         uint64_t log_usec;
119         uint8_t buf[0];
120 };
121
122 extern int fio_start_server(char *);
123 extern int fio_server_text_output(int, const char *, size_t);
124 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t);
125 extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
126 extern void fio_server_set_arg(const char *);
127 extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *, struct in6_addr *, int *);
128 extern int fio_server_parse_host(const char *, int *, struct in_addr *, struct in6_addr *);
129 extern const char *fio_server_op(unsigned int);
130 extern void fio_server_got_signal(int);
131
132 struct thread_stat;
133 struct group_run_stats;
134 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
135 extern void fio_server_send_gs(struct group_run_stats *);
136 extern void fio_server_send_du(void);
137 extern void fio_server_idle_loop(void);
138
139 extern int fio_recv_data(int sk, void *p, unsigned int len);
140 extern int fio_send_data(int sk, const void *p, unsigned int len);
141 extern void fio_net_cmd_crc(struct fio_net_cmd *);
142 extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
143
144 struct thread_options;
145 extern void fio_server_send_add_job(struct thread_options *, const char *);
146
147 extern int exit_backend;
148 extern int fio_net_port;
149
150 static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
151                                     const void *pdu, uint32_t pdu_len,
152                                     uint64_t tag)
153 {
154         memset(cmd, 0, sizeof(*cmd));
155
156         cmd->version    = __cpu_to_le16(FIO_SERVER_VER);
157         cmd->opcode     = cpu_to_le16(opcode);
158         cmd->tag        = cpu_to_le64(tag);
159
160         if (pdu) {
161                 cmd->pdu_len    = cpu_to_le32(pdu_len);
162                 memcpy(&cmd->payload, pdu, pdu_len);
163         }
164 }
165
166 #endif