Merge branch 'master' into client-server
[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 serial;        /* serial number */
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          = 1,
30         FIO_SERVER_VER1         = 1,
31
32         FIO_SERVER_MAX_PDU      = 64,
33
34         FIO_NET_CMD_QUIT        = 1,
35         FIO_NET_CMD_EXIT        = 2,
36         FIO_NET_CMD_JOB         = 3,
37         FIO_NET_CMD_JOBLINE     = 4,
38         FIO_NET_CMD_TEXT        = 5,
39         FIO_NET_CMD_TS          = 6,
40         FIO_NET_CMD_GS          = 7,
41         FIO_NET_CMD_ETA         = 8,
42         FIO_NET_CMD_PROBE       = 9,
43         FIO_NET_CMD_START       = 10,
44         FIO_NET_CMD_STOP        = 11,
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         FIO_NET_CMD_JOBLINE_ARGV        = 128,
53 };
54
55 struct cmd_ts_pdu {
56         struct thread_stat ts;
57         struct group_run_stats rs;
58 };
59
60 struct cmd_probe_pdu {
61         uint8_t hostname[64];
62         uint8_t bigendian;
63         uint8_t fio_major;
64         uint8_t fio_minor;
65         uint8_t fio_patch;
66 };
67
68 struct cmd_line_pdu {
69         uint16_t argc;
70         uint8_t argv[FIO_NET_CMD_JOBLINE_ARGV][64];
71 };
72
73 extern int fio_start_server(int);
74 extern int fio_server_text_output(const char *, unsigned int len);
75 extern int fio_server_log(const char *format, ...);
76 extern int fio_net_send_cmd(int, uint16_t, const void *, off_t);
77 extern int fio_net_send_simple_cmd(int sk, uint16_t opcode, uint64_t serial);
78
79 struct thread_stat;
80 struct group_run_stats;
81 extern void fio_server_send_ts(struct thread_stat *, struct group_run_stats *);
82 extern void fio_server_send_gs(struct group_run_stats *);
83 extern void fio_server_send_status(void);
84 extern void fio_server_idle_loop(void);
85
86 extern int fio_clients_connect(void);
87 extern int fio_clients_send_ini(const char *);
88 extern int fio_handle_clients(void);
89 extern void fio_client_add(const char *);
90 extern void fio_client_add_cmd_option(const char *, const char *);
91
92 extern int fio_recv_data(int sk, void *p, unsigned int len);
93 extern int fio_send_data(int sk, const void *p, unsigned int len);
94 extern void fio_net_cmd_crc(struct fio_net_cmd *);
95 extern struct fio_net_cmd *fio_net_recv_cmd(int sk, int block);
96
97 extern int exit_backend;
98 extern int fio_net_port;
99
100 #ifdef FIO_LITTLE_ENDIAN
101 #define __le16_to_cpu(x)                (x)
102 #define __le32_to_cpu(x)                (x)
103 #define __le64_to_cpu(x)                (x)
104 #define __cpu_to_le16(x)                (x)
105 #define __cpu_to_le32(x)                (x)
106 #define __cpu_to_le64(x)                (x)
107 #else
108 #define __le16_to_cpu(x)                fio_swap16(x)
109 #define __le32_to_cpu(x)                fio_swap32(x)
110 #define __le64_to_cpu(x)                fio_swap64(x)
111 #define __cpu_to_le16(x)                fio_swap16(x)
112 #define __cpu_to_le32(x)                fio_swap32(x)
113 #define __cpu_to_le64(x)                fio_swap64(x)
114 #endif
115
116 #define le16_to_cpu(val) ({                     \
117         uint16_t *__val = &(val);               \
118         __le16_to_cpu(*__val);                  \
119 })
120 #define le32_to_cpu(val) ({                     \
121         uint32_t *__val = &(val);               \
122         __le32_to_cpu(*__val);                  \
123 })
124 #define le64_to_cpu(val) ({                     \
125         uint64_t *__val = &(val);               \
126         __le64_to_cpu(*__val);                  \
127 })
128 #define cpu_to_le16(val) ({                     \
129         uint16_t *__val = &(val);               \
130         __cpu_to_le16(*__val);                  \
131 })
132 #define cpu_to_le32(val) ({                     \
133         uint32_t *__val = &(val);               \
134         __cpu_to_le32(*__val);                  \
135 })
136 #define cpu_to_le64(val) ({                     \
137         uint64_t *__val = &(val);               \
138         __cpu_to_le64(*__val);                  \
139 })
140
141 static inline void fio_init_net_cmd(struct fio_net_cmd *cmd, uint16_t opcode,
142                                     const void *pdu, uint32_t pdu_len)
143 {
144         memset(cmd, 0, sizeof(*cmd));
145
146         cmd->version    = __cpu_to_le16(FIO_SERVER_VER1);
147         cmd->opcode     = cpu_to_le16(opcode);
148
149         if (pdu) {
150                 cmd->pdu_len    = cpu_to_le32(pdu_len);
151                 memcpy(&cmd->payload, pdu, pdu_len);
152         }
153 }
154
155 #endif