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;
73 m->hdr[w] &= ~htonl(mask << pos);
74 m->hdr[w] |= htonl(val);
81 static inline u32 msg_version(struct tipc_msg *m)
83 return msg_bits(m, 0, 29, 7);
86 static inline void msg_set_version(struct tipc_msg *m)
88 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
91 static inline u32 msg_user(struct tipc_msg *m)
93 return msg_bits(m, 0, 25, 0xf);
96 static inline u32 msg_isdata(struct tipc_msg *m)
98 return (msg_user(m) <= TIPC_CRITICAL_IMPORTANCE);
101 static inline void msg_set_user(struct tipc_msg *m, u32 n)
103 msg_set_bits(m, 0, 25, 0xf, n);
106 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
111 static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
113 msg_set_bits(m, 0, 21, 0xf, n>>2);
116 static inline int msg_non_seq(struct tipc_msg *m)
118 return msg_bits(m, 0, 20, 1);
121 static inline void msg_set_non_seq(struct tipc_msg *m)
123 msg_set_bits(m, 0, 20, 1, 1);
126 static inline int msg_dest_droppable(struct tipc_msg *m)
128 return msg_bits(m, 0, 19, 1);
131 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
133 msg_set_bits(m, 0, 19, 1, d);
136 static inline int msg_src_droppable(struct tipc_msg *m)
138 return msg_bits(m, 0, 18, 1);
141 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
143 msg_set_bits(m, 0, 18, 1, d);
146 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
148 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
156 static inline void msg_set_type(struct tipc_msg *m, u32 n)
158 msg_set_bits(m, 1, 29, 0x7, n);
161 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
163 msg_set_bits(m, 1, 25, 0xf, err);
166 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
168 return msg_bits(m, 1, 21, 0xf);
171 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
173 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
176 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
178 msg_set_bits(m, 1, 21, 0xf, 0);
181 static inline u32 msg_lookup_scope(struct tipc_msg *m)
183 return msg_bits(m, 1, 19, 0x3);
186 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
188 msg_set_bits(m, 1, 19, 0x3, n);
191 static inline u32 msg_bcast_ack(struct tipc_msg *m)
193 return msg_bits(m, 1, 0, 0xffff);
196 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
198 msg_set_bits(m, 1, 0, 0xffff, n);
206 static inline u32 msg_ack(struct tipc_msg *m)
208 return msg_bits(m, 2, 16, 0xffff);
211 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
213 msg_set_bits(m, 2, 16, 0xffff, n);
216 static inline u32 msg_seqno(struct tipc_msg *m)
218 return msg_bits(m, 2, 0, 0xffff);
221 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
223 msg_set_bits(m, 2, 0, 0xffff, n);
232 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
234 msg_set_word(m, 3, a);
237 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
239 msg_set_word(m, 4, p);
242 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
244 msg_set_word(m, 5, p);
247 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
249 msg_set_word(m, 5, p);
252 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
254 msg_set_word(m, 6, a);
257 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
259 msg_set_word(m, 7, a);
262 static inline int msg_is_dest(struct tipc_msg *m, u32 d)
264 return(msg_short(m) || (msg_destnode(m) == d));
267 static inline u32 msg_routed(struct tipc_msg *m)
269 if (likely(msg_short(m)))
271 return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
274 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
276 msg_set_word(m, 8, n);
279 static inline u32 msg_transp_seqno(struct tipc_msg *m)
281 return msg_word(m, 8);
284 static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
286 msg_set_word(m, 8, n);
289 static inline u32 msg_timestamp(struct tipc_msg *m)
291 return msg_word(m, 8);
294 static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
296 msg_set_word(m, 8, n);
299 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
301 msg_set_word(m, 9, n);
304 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
306 msg_set_namelower(m, n);
309 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
311 msg_set_word(m, 10, n);
314 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
316 return (struct tipc_msg *)msg_data(m);
321 TIPC internal message header format, version 2
323 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
324 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
325 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
326 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
327 w1:|m typ|rsv=0| sequence gap | broadcast ack no |
328 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
329 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
330 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
332 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
333 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
334 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
335 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
336 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
337 w6:| originating node |
338 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
339 w7:| destination node |
340 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
341 w8:| transport sequence number |
342 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
343 w9:| msg count / bcast tag | link tolerance |
344 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
346 / User Specific Data /
348 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
350 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
357 #define BCAST_PROTOCOL 5
358 #define MSG_BUNDLER 6
359 #define LINK_PROTOCOL 7
360 #define CONN_MANAGER 8
361 #define ROUTE_DISTRIBUTOR 9
362 #define CHANGEOVER_PROTOCOL 10
363 #define NAME_DISTRIBUTOR 11
364 #define MSG_FRAGMENTER 12
365 #define LINK_CONFIG 13
366 #define DSC_H_SIZE 40
369 * Connection management protocol messages
373 #define CONN_PROBE_REPLY 1
377 * Name distributor messages
380 #define PUBLICATION 0
388 static inline u32 msg_seq_gap(struct tipc_msg *m)
390 return msg_bits(m, 1, 16, 0xff);
393 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
395 msg_set_bits(m, 1, 16, 0xff, n);
398 static inline u32 msg_req_links(struct tipc_msg *m)
400 return msg_bits(m, 1, 16, 0xfff);
403 static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
405 msg_set_bits(m, 1, 16, 0xfff, n);
413 static inline u32 msg_dest_domain(struct tipc_msg *m)
415 return msg_word(m, 2);
418 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
420 msg_set_word(m, 2, n);
423 static inline u32 msg_bcgap_after(struct tipc_msg *m)
425 return msg_bits(m, 2, 16, 0xffff);
428 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
430 msg_set_bits(m, 2, 16, 0xffff, n);
433 static inline u32 msg_bcgap_to(struct tipc_msg *m)
435 return msg_bits(m, 2, 0, 0xffff);
438 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
440 msg_set_bits(m, 2, 0, 0xffff, n);
448 static inline u32 msg_last_bcast(struct tipc_msg *m)
450 return msg_bits(m, 4, 16, 0xffff);
453 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
455 msg_set_bits(m, 4, 16, 0xffff, n);
459 static inline u32 msg_fragm_no(struct tipc_msg *m)
461 return msg_bits(m, 4, 16, 0xffff);
464 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
466 msg_set_bits(m, 4, 16, 0xffff, n);
470 static inline u32 msg_next_sent(struct tipc_msg *m)
472 return msg_bits(m, 4, 0, 0xffff);
475 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
477 msg_set_bits(m, 4, 0, 0xffff, n);
481 static inline u32 msg_long_msgno(struct tipc_msg *m)
483 return msg_bits(m, 4, 0, 0xffff);
486 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
488 msg_set_bits(m, 4, 0, 0xffff, n);
491 static inline u32 msg_bc_netid(struct tipc_msg *m)
493 return msg_word(m, 4);
496 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
498 msg_set_word(m, 4, id);
501 static inline u32 msg_link_selector(struct tipc_msg *m)
503 return msg_bits(m, 4, 0, 1);
506 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
508 msg_set_bits(m, 4, 0, 1, (n & 1));
515 static inline u32 msg_session(struct tipc_msg *m)
517 return msg_bits(m, 5, 16, 0xffff);
520 static inline void msg_set_session(struct tipc_msg *m, u32 n)
522 msg_set_bits(m, 5, 16, 0xffff, n);
525 static inline u32 msg_probe(struct tipc_msg *m)
527 return msg_bits(m, 5, 0, 1);
530 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
532 msg_set_bits(m, 5, 0, 1, (val & 1));
535 static inline char msg_net_plane(struct tipc_msg *m)
537 return msg_bits(m, 5, 1, 7) + 'A';
540 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
542 msg_set_bits(m, 5, 1, 7, (n - 'A'));
545 static inline u32 msg_linkprio(struct tipc_msg *m)
547 return msg_bits(m, 5, 4, 0x1f);
550 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
552 msg_set_bits(m, 5, 4, 0x1f, n);
555 static inline u32 msg_bearer_id(struct tipc_msg *m)
557 return msg_bits(m, 5, 9, 0x7);
560 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
562 msg_set_bits(m, 5, 9, 0x7, n);
565 static inline u32 msg_redundant_link(struct tipc_msg *m)
567 return msg_bits(m, 5, 12, 0x1);
570 static inline void msg_set_redundant_link(struct tipc_msg *m)
572 msg_set_bits(m, 5, 12, 0x1, 1);
575 static inline void msg_clear_redundant_link(struct tipc_msg *m)
577 msg_set_bits(m, 5, 12, 0x1, 0);
585 static inline u32 msg_msgcnt(struct tipc_msg *m)
587 return msg_bits(m, 9, 16, 0xffff);
590 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
592 msg_set_bits(m, 9, 16, 0xffff, n);
595 static inline u32 msg_bcast_tag(struct tipc_msg *m)
597 return msg_bits(m, 9, 16, 0xffff);
600 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
602 msg_set_bits(m, 9, 16, 0xffff, n);
605 static inline u32 msg_max_pkt(struct tipc_msg *m)
607 return (msg_bits(m, 9, 16, 0xffff) * 4);
610 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
612 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
615 static inline u32 msg_link_tolerance(struct tipc_msg *m)
617 return msg_bits(m, 9, 0, 0xffff);
620 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
622 msg_set_bits(m, 9, 0, 0xffff, n);
626 * Routing table message data
630 static inline u32 msg_remote_node(struct tipc_msg *m)
632 return msg_word(m, msg_hdr_sz(m)/4);
635 static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
637 msg_set_word(m, msg_hdr_sz(m)/4, a);
640 static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
642 msg_data(m)[pos + 4] = 1;
646 * Segmentation message types
649 #define FIRST_FRAGMENT 0
651 #define LAST_FRAGMENT 2
654 * Link management protocol message types
659 #define ACTIVATE_MSG 2
662 * Changeover tunnel message types
664 #define DUPLICATE_MSG 0
665 #define ORIGINAL_MSG 1
668 * Routing table message types
670 #define EXT_ROUTING_TABLE 0
671 #define LOCAL_ROUTING_TABLE 1
672 #define SLAVE_ROUTING_TABLE 2
673 #define ROUTE_ADDITION 3
674 #define ROUTE_REMOVAL 4
677 * Config protocol message types
680 #define DSC_REQ_MSG 0
681 #define DSC_RESP_MSG 1
683 static inline u32 msg_tot_importance(struct tipc_msg *m)
685 if (likely(msg_isdata(m))) {
686 if (likely(msg_orignode(m) == tipc_own_addr))
687 return msg_importance(m);
688 return msg_importance(m) + 4;
690 if ((msg_user(m) == MSG_FRAGMENTER) &&
691 (msg_type(m) == FIRST_FRAGMENT))
692 return msg_importance(msg_get_wrapped(m));
693 return msg_importance(m);
697 static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
698 u32 err, u32 hsize, u32 destnode)
702 msg_set_user(m, user);
703 msg_set_hdr_sz(m, hsize);
704 msg_set_size(m, hsize);
705 msg_set_prevnode(m, tipc_own_addr);
706 msg_set_type(m, type);
707 msg_set_errcode(m, err);
709 msg_set_orignode(m, tipc_own_addr);
710 msg_set_destnode(m, destnode);
715 * msg_calc_data_size - determine total data size for message
718 static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
723 for (i = 0; i < num_sect; i++)
724 dsz += msg_sect[i].iov_len;
729 * msg_build - create message using specified header and data
731 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
733 * Returns message data size or errno
736 static inline int msg_build(struct tipc_msg *hdr,
737 struct iovec const *msg_sect, u32 num_sect,
738 int max_size, int usrmem, struct sk_buff** buf)
740 int dsz, sz, hsz, pos, res, cnt;
742 dsz = msg_calc_data_size(msg_sect, num_sect);
743 if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
748 pos = hsz = msg_hdr_sz(hdr);
750 msg_set_size(hdr, sz);
751 if (unlikely(sz > max_size)) {
756 *buf = buf_acquire(sz);
759 skb_copy_to_linear_data(*buf, hdr, hsz);
760 for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
762 res = !copy_from_user((*buf)->data + pos,
763 msg_sect[cnt].iov_base,
764 msg_sect[cnt].iov_len);
766 skb_copy_to_linear_data_offset(*buf, pos,
767 msg_sect[cnt].iov_base,
768 msg_sect[cnt].iov_len);
769 pos += msg_sect[cnt].iov_len;
779 static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
781 memcpy(&((int *)m)[5], a, sizeof(*a));
784 static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
786 memcpy(a, &((int*)m)[5], sizeof(*a));