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