2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2007, Ericsson AB
5 * Copyright (c) 2005-2007, Wind River Systems
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the names of the copyright holders nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
20 * Alternatively, this software may be distributed under the terms of the
21 * GNU General Public License ("GPL") version 2 as published by the Free
22 * Software Foundation.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
28 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
42 #define TIPC_VERSION 2
44 #define SHORT_H_SIZE 24 /* Connected, in-cluster messages */
45 #define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
46 #define LONG_H_SIZE 40 /* Named messages */
47 #define MCAST_H_SIZE 44 /* Multicast messages */
48 #define INT_H_SIZE 40 /* Internal messages */
49 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
50 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
52 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
56 TIPC user data message header format, version 2
58 - Fundamental definitions available to privileged TIPC users
59 are located in tipc_msg.h.
60 - Remaining definitions available to TIPC internal users appear below.
64 static inline void msg_set_word(struct tipc_msg
*m
, u32 w
, u32 val
)
66 m
->hdr
[w
] = htonl(val
);
69 static inline void msg_set_bits(struct tipc_msg
*m
, u32 w
,
70 u32 pos
, u32 mask
, u32 val
)
72 val
= (val
& mask
) << pos
;
74 m
->hdr
[w
] &= ~htonl(mask
);
75 m
->hdr
[w
] |= htonl(val
);
82 static inline u32
msg_version(struct tipc_msg
*m
)
84 return msg_bits(m
, 0, 29, 7);
87 static inline void msg_set_version(struct tipc_msg
*m
)
89 msg_set_bits(m
, 0, 29, 7, TIPC_VERSION
);
92 static inline u32
msg_user(struct tipc_msg
*m
)
94 return msg_bits(m
, 0, 25, 0xf);
97 static inline u32
msg_isdata(struct tipc_msg
*m
)
99 return (msg_user(m
) <= TIPC_CRITICAL_IMPORTANCE
);
102 static inline void msg_set_user(struct tipc_msg
*m
, u32 n
)
104 msg_set_bits(m
, 0, 25, 0xf, n
);
107 static inline void msg_set_importance(struct tipc_msg
*m
, u32 i
)
112 static inline void msg_set_hdr_sz(struct tipc_msg
*m
,u32 n
)
114 msg_set_bits(m
, 0, 21, 0xf, n
>>2);
117 static inline int msg_non_seq(struct tipc_msg
*m
)
119 return msg_bits(m
, 0, 20, 1);
122 static inline void msg_set_non_seq(struct tipc_msg
*m
)
124 msg_set_bits(m
, 0, 20, 1, 1);
127 static inline int msg_dest_droppable(struct tipc_msg
*m
)
129 return msg_bits(m
, 0, 19, 1);
132 static inline void msg_set_dest_droppable(struct tipc_msg
*m
, u32 d
)
134 msg_set_bits(m
, 0, 19, 1, d
);
137 static inline int msg_src_droppable(struct tipc_msg
*m
)
139 return msg_bits(m
, 0, 18, 1);
142 static inline void msg_set_src_droppable(struct tipc_msg
*m
, u32 d
)
144 msg_set_bits(m
, 0, 18, 1, d
);
147 static inline void msg_set_size(struct tipc_msg
*m
, u32 sz
)
149 m
->hdr
[0] = htonl((msg_word(m
, 0) & ~0x1ffff) | sz
);
157 static inline void msg_set_type(struct tipc_msg
*m
, u32 n
)
159 msg_set_bits(m
, 1, 29, 0x7, n
);
162 static inline void msg_set_errcode(struct tipc_msg
*m
, u32 err
)
164 msg_set_bits(m
, 1, 25, 0xf, err
);
167 static inline u32
msg_reroute_cnt(struct tipc_msg
*m
)
169 return msg_bits(m
, 1, 21, 0xf);
172 static inline void msg_incr_reroute_cnt(struct tipc_msg
*m
)
174 msg_set_bits(m
, 1, 21, 0xf, msg_reroute_cnt(m
) + 1);
177 static inline void msg_reset_reroute_cnt(struct tipc_msg
*m
)
179 msg_set_bits(m
, 1, 21, 0xf, 0);
182 static inline u32
msg_lookup_scope(struct tipc_msg
*m
)
184 return msg_bits(m
, 1, 19, 0x3);
187 static inline void msg_set_lookup_scope(struct tipc_msg
*m
, u32 n
)
189 msg_set_bits(m
, 1, 19, 0x3, n
);
192 static inline u32
msg_bcast_ack(struct tipc_msg
*m
)
194 return msg_bits(m
, 1, 0, 0xffff);
197 static inline void msg_set_bcast_ack(struct tipc_msg
*m
, u32 n
)
199 msg_set_bits(m
, 1, 0, 0xffff, n
);
207 static inline u32
msg_ack(struct tipc_msg
*m
)
209 return msg_bits(m
, 2, 16, 0xffff);
212 static inline void msg_set_ack(struct tipc_msg
*m
, u32 n
)
214 msg_set_bits(m
, 2, 16, 0xffff, n
);
217 static inline u32
msg_seqno(struct tipc_msg
*m
)
219 return msg_bits(m
, 2, 0, 0xffff);
222 static inline void msg_set_seqno(struct tipc_msg
*m
, u32 n
)
224 msg_set_bits(m
, 2, 0, 0xffff, n
);
233 static inline void msg_set_prevnode(struct tipc_msg
*m
, u32 a
)
235 msg_set_word(m
, 3, a
);
238 static inline void msg_set_origport(struct tipc_msg
*m
, u32 p
)
240 msg_set_word(m
, 4, p
);
243 static inline void msg_set_destport(struct tipc_msg
*m
, u32 p
)
245 msg_set_word(m
, 5, p
);
248 static inline void msg_set_mc_netid(struct tipc_msg
*m
, u32 p
)
250 msg_set_word(m
, 5, p
);
253 static inline void msg_set_orignode(struct tipc_msg
*m
, u32 a
)
255 msg_set_word(m
, 6, a
);
258 static inline void msg_set_destnode(struct tipc_msg
*m
, u32 a
)
260 msg_set_word(m
, 7, a
);
263 static inline int msg_is_dest(struct tipc_msg
*m
, u32 d
)
265 return(msg_short(m
) || (msg_destnode(m
) == d
));
268 static inline u32
msg_routed(struct tipc_msg
*m
)
270 if (likely(msg_short(m
)))
272 return(msg_destnode(m
) ^ msg_orignode(m
)) >> 11;
275 static inline void msg_set_nametype(struct tipc_msg
*m
, u32 n
)
277 msg_set_word(m
, 8, n
);
280 static inline u32
msg_transp_seqno(struct tipc_msg
*m
)
282 return msg_word(m
, 8);
285 static inline void msg_set_timestamp(struct tipc_msg
*m
, u32 n
)
287 msg_set_word(m
, 8, n
);
290 static inline u32
msg_timestamp(struct tipc_msg
*m
)
292 return msg_word(m
, 8);
295 static inline void msg_set_transp_seqno(struct tipc_msg
*m
, u32 n
)
297 msg_set_word(m
, 8, n
);
300 static inline void msg_set_namelower(struct tipc_msg
*m
, u32 n
)
302 msg_set_word(m
, 9, n
);
305 static inline void msg_set_nameinst(struct tipc_msg
*m
, u32 n
)
307 msg_set_namelower(m
, n
);
310 static inline void msg_set_nameupper(struct tipc_msg
*m
, u32 n
)
312 msg_set_word(m
, 10, n
);
315 static inline struct tipc_msg
*msg_get_wrapped(struct tipc_msg
*m
)
317 return (struct tipc_msg
*)msg_data(m
);
322 TIPC internal message header format, version 2
324 1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0
325 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
326 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
327 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
328 w1:|m typ|rsv=0| sequence gap | broadcast ack no |
329 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
330 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
331 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
333 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
334 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
335 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
336 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
337 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
338 w6:| originating node |
339 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
340 w7:| destination node |
341 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
342 w8:| transport sequence number |
343 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
344 w9:| msg count / bcast tag | link tolerance |
345 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
347 / User Specific Data /
349 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
351 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
358 #define BCAST_PROTOCOL 5
359 #define MSG_BUNDLER 6
360 #define LINK_PROTOCOL 7
361 #define CONN_MANAGER 8
362 #define ROUTE_DISTRIBUTOR 9
363 #define CHANGEOVER_PROTOCOL 10
364 #define NAME_DISTRIBUTOR 11
365 #define MSG_FRAGMENTER 12
366 #define LINK_CONFIG 13
367 #define DSC_H_SIZE 40
370 * Connection management protocol messages
374 #define CONN_PROBE_REPLY 1
378 * Name distributor messages
381 #define PUBLICATION 0
389 static inline u32
msg_seq_gap(struct tipc_msg
*m
)
391 return msg_bits(m
, 1, 16, 0xff);
394 static inline void msg_set_seq_gap(struct tipc_msg
*m
, u32 n
)
396 msg_set_bits(m
, 1, 16, 0xff, n
);
399 static inline u32
msg_req_links(struct tipc_msg
*m
)
401 return msg_bits(m
, 1, 16, 0xfff);
404 static inline void msg_set_req_links(struct tipc_msg
*m
, u32 n
)
406 msg_set_bits(m
, 1, 16, 0xfff, n
);
414 static inline u32
msg_dest_domain(struct tipc_msg
*m
)
416 return msg_word(m
, 2);
419 static inline void msg_set_dest_domain(struct tipc_msg
*m
, u32 n
)
421 msg_set_word(m
, 2, n
);
424 static inline u32
msg_bcgap_after(struct tipc_msg
*m
)
426 return msg_bits(m
, 2, 16, 0xffff);
429 static inline void msg_set_bcgap_after(struct tipc_msg
*m
, u32 n
)
431 msg_set_bits(m
, 2, 16, 0xffff, n
);
434 static inline u32
msg_bcgap_to(struct tipc_msg
*m
)
436 return msg_bits(m
, 2, 0, 0xffff);
439 static inline void msg_set_bcgap_to(struct tipc_msg
*m
, u32 n
)
441 msg_set_bits(m
, 2, 0, 0xffff, n
);
449 static inline u32
msg_last_bcast(struct tipc_msg
*m
)
451 return msg_bits(m
, 4, 16, 0xffff);
454 static inline void msg_set_last_bcast(struct tipc_msg
*m
, u32 n
)
456 msg_set_bits(m
, 4, 16, 0xffff, n
);
460 static inline u32
msg_fragm_no(struct tipc_msg
*m
)
462 return msg_bits(m
, 4, 16, 0xffff);
465 static inline void msg_set_fragm_no(struct tipc_msg
*m
, u32 n
)
467 msg_set_bits(m
, 4, 16, 0xffff, n
);
471 static inline u32
msg_next_sent(struct tipc_msg
*m
)
473 return msg_bits(m
, 4, 0, 0xffff);
476 static inline void msg_set_next_sent(struct tipc_msg
*m
, u32 n
)
478 msg_set_bits(m
, 4, 0, 0xffff, n
);
482 static inline u32
msg_long_msgno(struct tipc_msg
*m
)
484 return msg_bits(m
, 4, 0, 0xffff);
487 static inline void msg_set_long_msgno(struct tipc_msg
*m
, u32 n
)
489 msg_set_bits(m
, 4, 0, 0xffff, n
);
492 static inline u32
msg_bc_netid(struct tipc_msg
*m
)
494 return msg_word(m
, 4);
497 static inline void msg_set_bc_netid(struct tipc_msg
*m
, u32 id
)
499 msg_set_word(m
, 4, id
);
502 static inline u32
msg_link_selector(struct tipc_msg
*m
)
504 return msg_bits(m
, 4, 0, 1);
507 static inline void msg_set_link_selector(struct tipc_msg
*m
, u32 n
)
509 msg_set_bits(m
, 4, 0, 1, (n
& 1));
516 static inline u32
msg_session(struct tipc_msg
*m
)
518 return msg_bits(m
, 5, 16, 0xffff);
521 static inline void msg_set_session(struct tipc_msg
*m
, u32 n
)
523 msg_set_bits(m
, 5, 16, 0xffff, n
);
526 static inline u32
msg_probe(struct tipc_msg
*m
)
528 return msg_bits(m
, 5, 0, 1);
531 static inline void msg_set_probe(struct tipc_msg
*m
, u32 val
)
533 msg_set_bits(m
, 5, 0, 1, (val
& 1));
536 static inline char msg_net_plane(struct tipc_msg
*m
)
538 return msg_bits(m
, 5, 1, 7) + 'A';
541 static inline void msg_set_net_plane(struct tipc_msg
*m
, char n
)
543 msg_set_bits(m
, 5, 1, 7, (n
- 'A'));
546 static inline u32
msg_linkprio(struct tipc_msg
*m
)
548 return msg_bits(m
, 5, 4, 0x1f);
551 static inline void msg_set_linkprio(struct tipc_msg
*m
, u32 n
)
553 msg_set_bits(m
, 5, 4, 0x1f, n
);
556 static inline u32
msg_bearer_id(struct tipc_msg
*m
)
558 return msg_bits(m
, 5, 9, 0x7);
561 static inline void msg_set_bearer_id(struct tipc_msg
*m
, u32 n
)
563 msg_set_bits(m
, 5, 9, 0x7, n
);
566 static inline u32
msg_redundant_link(struct tipc_msg
*m
)
568 return msg_bits(m
, 5, 12, 0x1);
571 static inline void msg_set_redundant_link(struct tipc_msg
*m
)
573 msg_set_bits(m
, 5, 12, 0x1, 1);
576 static inline void msg_clear_redundant_link(struct tipc_msg
*m
)
578 msg_set_bits(m
, 5, 12, 0x1, 0);
586 static inline u32
msg_msgcnt(struct tipc_msg
*m
)
588 return msg_bits(m
, 9, 16, 0xffff);
591 static inline void msg_set_msgcnt(struct tipc_msg
*m
, u32 n
)
593 msg_set_bits(m
, 9, 16, 0xffff, n
);
596 static inline u32
msg_bcast_tag(struct tipc_msg
*m
)
598 return msg_bits(m
, 9, 16, 0xffff);
601 static inline void msg_set_bcast_tag(struct tipc_msg
*m
, u32 n
)
603 msg_set_bits(m
, 9, 16, 0xffff, n
);
606 static inline u32
msg_max_pkt(struct tipc_msg
*m
)
608 return (msg_bits(m
, 9, 16, 0xffff) * 4);
611 static inline void msg_set_max_pkt(struct tipc_msg
*m
, u32 n
)
613 msg_set_bits(m
, 9, 16, 0xffff, (n
/ 4));
616 static inline u32
msg_link_tolerance(struct tipc_msg
*m
)
618 return msg_bits(m
, 9, 0, 0xffff);
621 static inline void msg_set_link_tolerance(struct tipc_msg
*m
, u32 n
)
623 msg_set_bits(m
, 9, 0, 0xffff, n
);
627 * Routing table message data
631 static inline u32
msg_remote_node(struct tipc_msg
*m
)
633 return msg_word(m
, msg_hdr_sz(m
)/4);
636 static inline void msg_set_remote_node(struct tipc_msg
*m
, u32 a
)
638 msg_set_word(m
, msg_hdr_sz(m
)/4, a
);
641 static inline void msg_set_dataoctet(struct tipc_msg
*m
, u32 pos
)
643 msg_data(m
)[pos
+ 4] = 1;
647 * Segmentation message types
650 #define FIRST_FRAGMENT 0
652 #define LAST_FRAGMENT 2
655 * Link management protocol message types
660 #define ACTIVATE_MSG 2
663 * Changeover tunnel message types
665 #define DUPLICATE_MSG 0
666 #define ORIGINAL_MSG 1
669 * Routing table message types
671 #define EXT_ROUTING_TABLE 0
672 #define LOCAL_ROUTING_TABLE 1
673 #define SLAVE_ROUTING_TABLE 2
674 #define ROUTE_ADDITION 3
675 #define ROUTE_REMOVAL 4
678 * Config protocol message types
681 #define DSC_REQ_MSG 0
682 #define DSC_RESP_MSG 1
684 static inline u32
msg_tot_importance(struct tipc_msg
*m
)
686 if (likely(msg_isdata(m
))) {
687 if (likely(msg_orignode(m
) == tipc_own_addr
))
688 return msg_importance(m
);
689 return msg_importance(m
) + 4;
691 if ((msg_user(m
) == MSG_FRAGMENTER
) &&
692 (msg_type(m
) == FIRST_FRAGMENT
))
693 return msg_importance(msg_get_wrapped(m
));
694 return msg_importance(m
);
698 static inline void msg_init(struct tipc_msg
*m
, u32 user
, u32 type
,
699 u32 err
, u32 hsize
, u32 destnode
)
703 msg_set_user(m
, user
);
704 msg_set_hdr_sz(m
, hsize
);
705 msg_set_size(m
, hsize
);
706 msg_set_prevnode(m
, tipc_own_addr
);
707 msg_set_type(m
, type
);
708 msg_set_errcode(m
, err
);
710 msg_set_orignode(m
, tipc_own_addr
);
711 msg_set_destnode(m
, destnode
);
716 * msg_calc_data_size - determine total data size for message
719 static inline int msg_calc_data_size(struct iovec
const *msg_sect
, u32 num_sect
)
724 for (i
= 0; i
< num_sect
; i
++)
725 dsz
+= msg_sect
[i
].iov_len
;
730 * msg_build - create message using specified header and data
732 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
734 * Returns message data size or errno
737 static inline int msg_build(struct tipc_msg
*hdr
,
738 struct iovec
const *msg_sect
, u32 num_sect
,
739 int max_size
, int usrmem
, struct sk_buff
** buf
)
741 int dsz
, sz
, hsz
, pos
, res
, cnt
;
743 dsz
= msg_calc_data_size(msg_sect
, num_sect
);
744 if (unlikely(dsz
> TIPC_MAX_USER_MSG_SIZE
)) {
749 pos
= hsz
= msg_hdr_sz(hdr
);
751 msg_set_size(hdr
, sz
);
752 if (unlikely(sz
> max_size
)) {
757 *buf
= buf_acquire(sz
);
760 skb_copy_to_linear_data(*buf
, hdr
, hsz
);
761 for (res
= 1, cnt
= 0; res
&& (cnt
< num_sect
); cnt
++) {
763 res
= !copy_from_user((*buf
)->data
+ pos
,
764 msg_sect
[cnt
].iov_base
,
765 msg_sect
[cnt
].iov_len
);
767 skb_copy_to_linear_data_offset(*buf
, pos
,
768 msg_sect
[cnt
].iov_base
,
769 msg_sect
[cnt
].iov_len
);
770 pos
+= msg_sect
[cnt
].iov_len
;
780 static inline void msg_set_media_addr(struct tipc_msg
*m
, struct tipc_media_addr
*a
)
782 memcpy(&((int *)m
)[5], a
, sizeof(*a
));
785 static inline void msg_get_media_addr(struct tipc_msg
*m
, struct tipc_media_addr
*a
)
787 memcpy(a
, &((int*)m
)[5], sizeof(*a
));