46555ceea491444df213497564d23c227789d075
[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
8 #include "stat.h"
9 #include "os/os.h"
10
11 /*
12  * On-wire encoding is little endian
13  */
14 struct fio_net_cmd {
15         uint16_t version;       /* protocol version */
16         uint16_t opcode;        /* command opcode */
17         uint32_t flags;         /* modifier flags */
18         uint64_t tag;           /* passed back on reply */
19         uint32_t pdu_len;       /* length of post-cmd layload */
20         /*
21          * These must be immediately before the payload, anything before
22          * these fields are checksummed.
23          */
24         uint16_t cmd_crc16;     /* cmd checksum */
25         uint16_t pdu_crc16;     /* payload checksum */
26         uint8_t payload[0];     /* payload */
27 };
28
29 struct fio_net_int_cmd {
30         struct fio_net_cmd cmd;
31         struct flist_head list;
32         struct timeval tv;
33         uint64_t saved_tag;
34 };
35
36 enum {
37         FIO_SERVER_VER          = 5,
38
39         FIO_SERVER_MAX_PDU      = 1024,
40
41         FIO_NET_CMD_QUIT        = 1,
42         FIO_NET_CMD_EXIT        = 2,
43         FIO_NET_CMD_JOB         = 3,
44         FIO_NET_CMD_JOBLINE     = 4,
45         FIO_NET_CMD_TEXT        = 5,
46         FIO_NET_CMD_TS          = 6,
47         FIO_NET_CMD_GS          = 7,
48         FIO_NET_CMD_SEND_ETA    = 8,
49         FIO_NET_CMD_ETA         = 9,
50         FIO_NET_CMD_PROBE       = 10,
51         FIO_NET_CMD_START       = 11,
52         FIO_NET_CMD_STOP        = 12,
53         FIO_NET_CMD_NR          = 13,
54
55         FIO_NET_CMD_F_MORE      = 1UL << 0,
56
57         /* crc does not include the crc fields */
58         FIO_NET_CMD_CRC_SZ      = sizeof(struct fio_net_cmd) -
59                                         2 * sizeof(uint16_t),
60
61         FIO_NET_CLIENT_TIMEOUT  = 5000,
62 };
63
64 struct cmd_ts_pdu {
65         struct thread_stat ts;
66         struct group_run_stats rs;
67 };
68
69 struct cmd_probe_pdu {
70         uint8_t hostname[64];
71         uint8_t bigendian;
72         uint8_t fio_major;
73         uint8_t fio_minor;
74         uint8_t fio_patch;
75         uint8_t os;
76         uint8_t arch;
77         uint8_t bpp;
78 };
79
80 struct cmd_single_line_pdu {
81         uint16_t len;
82         uint8_t text[0];
83 };
84
85 struct cmd_line_pdu {
86         uint16_t lines;
87         struct cmd_single_line_pdu options[0];
88 };
89
90 extern int fio_start_server(char *);
91 extern int fio_server_text_output(const char *, size_t);
92 extern int fio_server_log(const char *format, ...);
93 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t, uint64_t);
94 extern int fio_net_send_simple_cmd(int, uint16_t, uint64_t, struct flist_head *);
95 extern void fio_server_set_arg(const char *);
96 extern int fio_server_parse_string(const char *, char **, int *, int *, struct in_addr *);
97 extern const char *fio_server_op(unsigned int);
98 extern void fio_server_got_signal(int);
99
100 struct thread_stat;
101 struct group_run_stats;
102 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
103 extern void fio_server_send_gs(struct group_run_stats *);
104 extern void fio_server_idle_loop(void);
105
106 extern int fio_clients_connect(void);
107 extern int fio_clients_send_ini(const char *);
108 extern int fio_handle_clients(void);
109 extern int fio_client_add(const char *, void **);
110 extern void fio_client_add_cmd_option(void *, const char *);
111
112 extern int fio_recv_data(int sk, void *p, unsigned int len);
113 extern int fio_send_data(int sk, const void *p, unsigned int len);
114 extern void fio_net_cmd_crc(struct fio_net_cmd *);
115 extern struct fio_net_cmd *fio_net_recv_cmd(int sk);
116
117 extern int exit_backend;
118 extern int fio_net_port;
119
120 static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
121                                     const void *pdu, uint32_t pdu_len,
122                                     uint64_t tag)
123 {
124         memset(cmd, 0, sizeof(*cmd));
125
126         cmd->version    = __cpu_to_le16(FIO_SERVER_VER);
127         cmd->opcode     = cpu_to_le16(opcode);
128         cmd->tag        = cpu_to_le64(tag);
129
130         if (pdu) {
131                 cmd->pdu_len    = cpu_to_le32(pdu_len);
132                 memcpy(&cmd->payload, pdu, pdu_len);
133         }
134 }
135
136 #endif