Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
5cd068c2 SW |
2 | #ifndef CEPH_MSGR_H |
3 | #define CEPH_MSGR_H | |
0dee3c28 SW |
4 | |
5 | /* | |
6 | * Data types for message passing layer used by Ceph. | |
7 | */ | |
8 | ||
9 | #define CEPH_MON_PORT 6789 /* default monitor port */ | |
10 | ||
11 | /* | |
12 | * client-side processes will try to bind to ports in this | |
13 | * range, simply for the benefit of tools like nmap or wireshark | |
14 | * that would like to identify the protocol. | |
15 | */ | |
16 | #define CEPH_PORT_FIRST 6789 | |
17 | #define CEPH_PORT_START 6800 /* non-monitors start here */ | |
18 | #define CEPH_PORT_LAST 6900 | |
19 | ||
20 | /* | |
21 | * tcp connection banner. include a protocol version. and adjust | |
22 | * whenever the wire protocol changes. try to keep this string length | |
23 | * constant. | |
24 | */ | |
ac8839d7 | 25 | #define CEPH_BANNER "ceph v027" |
0dee3c28 SW |
26 | #define CEPH_BANNER_MAX_LEN 30 |
27 | ||
28 | ||
29 | /* | |
30 | * Rollover-safe type and comparator for 32-bit sequence numbers. | |
31 | * Comparator returns -1, 0, or 1. | |
32 | */ | |
33 | typedef __u32 ceph_seq_t; | |
34 | ||
35 | static inline __s32 ceph_seq_cmp(__u32 a, __u32 b) | |
36 | { | |
37 | return (__s32)a - (__s32)b; | |
38 | } | |
39 | ||
40 | ||
41 | /* | |
42 | * entity_name -- logical name for a process participating in the | |
43 | * network, e.g. 'mds0' or 'osd3'. | |
44 | */ | |
45 | struct ceph_entity_name { | |
46 | __u8 type; /* CEPH_ENTITY_TYPE_* */ | |
47 | __le64 num; | |
48 | } __attribute__ ((packed)); | |
49 | ||
4e7a5dcd SW |
50 | #define CEPH_ENTITY_TYPE_MON 0x01 |
51 | #define CEPH_ENTITY_TYPE_MDS 0x02 | |
52 | #define CEPH_ENTITY_TYPE_OSD 0x04 | |
53 | #define CEPH_ENTITY_TYPE_CLIENT 0x08 | |
4e7a5dcd SW |
54 | #define CEPH_ENTITY_TYPE_AUTH 0x20 |
55 | ||
56 | #define CEPH_ENTITY_TYPE_ANY 0xFF | |
57 | ||
58 | extern const char *ceph_entity_type_name(int type); | |
0dee3c28 SW |
59 | |
60 | /* | |
61 | * entity_addr -- network address | |
62 | */ | |
63 | struct ceph_entity_addr { | |
ac8839d7 SW |
64 | __le32 type; |
65 | __le32 nonce; /* unique id for process (e.g. pid) */ | |
0dee3c28 SW |
66 | struct sockaddr_storage in_addr; |
67 | } __attribute__ ((packed)); | |
68 | ||
0dee3c28 SW |
69 | struct ceph_entity_inst { |
70 | struct ceph_entity_name name; | |
71 | struct ceph_entity_addr addr; | |
72 | } __attribute__ ((packed)); | |
73 | ||
74 | ||
75 | /* used by message exchange protocol */ | |
76 | #define CEPH_MSGR_TAG_READY 1 /* server->client: ready for messages */ | |
77 | #define CEPH_MSGR_TAG_RESETSESSION 2 /* server->client: reset, try again */ | |
78 | #define CEPH_MSGR_TAG_WAIT 3 /* server->client: wait for racing | |
79 | incoming connection */ | |
80 | #define CEPH_MSGR_TAG_RETRY_SESSION 4 /* server->client + cseq: try again | |
81 | with higher cseq */ | |
82 | #define CEPH_MSGR_TAG_RETRY_GLOBAL 5 /* server->client + gseq: try again | |
83 | with higher gseq */ | |
84 | #define CEPH_MSGR_TAG_CLOSE 6 /* closing pipe */ | |
85 | #define CEPH_MSGR_TAG_MSG 7 /* message */ | |
86 | #define CEPH_MSGR_TAG_ACK 8 /* message ack */ | |
87 | #define CEPH_MSGR_TAG_KEEPALIVE 9 /* just a keepalive byte! */ | |
8b9558aa | 88 | #define CEPH_MSGR_TAG_BADPROTOVER 10 /* bad protocol version */ |
4e7a5dcd | 89 | #define CEPH_MSGR_TAG_BADAUTHORIZER 11 /* bad authorizer */ |
04a419f9 | 90 | #define CEPH_MSGR_TAG_FEATURES 12 /* insufficient features */ |
3a23083b | 91 | #define CEPH_MSGR_TAG_SEQ 13 /* 64-bit int follows with seen seq number */ |
8b9558aa YZ |
92 | #define CEPH_MSGR_TAG_KEEPALIVE2 14 /* keepalive2 byte + ceph_timespec */ |
93 | #define CEPH_MSGR_TAG_KEEPALIVE2_ACK 15 /* keepalive2 reply */ | |
6daca13d | 94 | #define CEPH_MSGR_TAG_CHALLENGE_AUTHORIZER 16 /* cephx v2 doing server challenge */ |
0dee3c28 SW |
95 | |
96 | /* | |
97 | * connection negotiation | |
98 | */ | |
99 | struct ceph_msg_connect { | |
04a419f9 | 100 | __le64 features; /* supported feature bits */ |
0dee3c28 SW |
101 | __le32 host_type; /* CEPH_ENTITY_TYPE_* */ |
102 | __le32 global_seq; /* count connections initiated by this host */ | |
103 | __le32 connect_seq; /* count connections initiated in this session */ | |
104 | __le32 protocol_version; | |
4e7a5dcd SW |
105 | __le32 authorizer_protocol; |
106 | __le32 authorizer_len; | |
0dee3c28 SW |
107 | __u8 flags; /* CEPH_MSG_CONNECT_* */ |
108 | } __attribute__ ((packed)); | |
109 | ||
110 | struct ceph_msg_connect_reply { | |
111 | __u8 tag; | |
04a419f9 | 112 | __le64 features; /* feature bits for this session */ |
0dee3c28 SW |
113 | __le32 global_seq; |
114 | __le32 connect_seq; | |
115 | __le32 protocol_version; | |
4e7a5dcd | 116 | __le32 authorizer_len; |
0dee3c28 SW |
117 | __u8 flags; |
118 | } __attribute__ ((packed)); | |
119 | ||
120 | #define CEPH_MSG_CONNECT_LOSSY 1 /* messages i send may be safely dropped */ | |
121 | ||
122 | ||
123 | /* | |
124 | * message header | |
125 | */ | |
dbad185d | 126 | struct ceph_msg_header_old { |
0dee3c28 | 127 | __le64 seq; /* message seq# for this session */ |
6df058c0 | 128 | __le64 tid; /* transaction id */ |
0dee3c28 SW |
129 | __le16 type; /* message type */ |
130 | __le16 priority; /* priority. higher value == higher priority */ | |
535bbb53 | 131 | __le16 version; /* version of message encoding */ |
0dee3c28 SW |
132 | |
133 | __le32 front_len; /* bytes in main payload */ | |
134 | __le32 middle_len;/* bytes in middle payload */ | |
135 | __le32 data_len; /* bytes of data payload */ | |
136 | __le16 data_off; /* sender: include full offset; | |
137 | receiver: mask against ~PAGE_MASK */ | |
138 | ||
139 | struct ceph_entity_inst src, orig_src; | |
103e2d3a | 140 | __le32 reserved; |
0dee3c28 SW |
141 | __le32 crc; /* header crc32c */ |
142 | } __attribute__ ((packed)); | |
143 | ||
dbad185d SW |
144 | struct ceph_msg_header { |
145 | __le64 seq; /* message seq# for this session */ | |
146 | __le64 tid; /* transaction id */ | |
147 | __le16 type; /* message type */ | |
148 | __le16 priority; /* priority. higher value == higher priority */ | |
149 | __le16 version; /* version of message encoding */ | |
150 | ||
151 | __le32 front_len; /* bytes in main payload */ | |
152 | __le32 middle_len;/* bytes in middle payload */ | |
153 | __le32 data_len; /* bytes of data payload */ | |
154 | __le16 data_off; /* sender: include full offset; | |
155 | receiver: mask against ~PAGE_MASK */ | |
156 | ||
157 | struct ceph_entity_name src; | |
d4e1a4e0 JS |
158 | __le16 compat_version; |
159 | __le16 reserved; | |
dbad185d SW |
160 | __le32 crc; /* header crc32c */ |
161 | } __attribute__ ((packed)); | |
162 | ||
0dee3c28 SW |
163 | #define CEPH_MSG_PRIO_LOW 64 |
164 | #define CEPH_MSG_PRIO_DEFAULT 127 | |
165 | #define CEPH_MSG_PRIO_HIGH 196 | |
166 | #define CEPH_MSG_PRIO_HIGHEST 255 | |
167 | ||
168 | /* | |
169 | * follows data payload | |
170 | */ | |
33d07337 YZ |
171 | struct ceph_msg_footer_old { |
172 | __le32 front_crc, middle_crc, data_crc; | |
173 | __u8 flags; | |
174 | } __attribute__ ((packed)); | |
175 | ||
0dee3c28 SW |
176 | struct ceph_msg_footer { |
177 | __le32 front_crc, middle_crc, data_crc; | |
33d07337 YZ |
178 | // sig holds the 64 bits of the digital signature for the message PLR |
179 | __le64 sig; | |
0dee3c28 SW |
180 | __u8 flags; |
181 | } __attribute__ ((packed)); | |
182 | ||
183 | #define CEPH_MSG_FOOTER_COMPLETE (1<<0) /* msg wasn't aborted */ | |
184 | #define CEPH_MSG_FOOTER_NOCRC (1<<1) /* no data crc */ | |
33d07337 | 185 | #define CEPH_MSG_FOOTER_SIGNED (1<<2) /* msg was signed */ |
0dee3c28 SW |
186 | |
187 | ||
188 | #endif |