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
43 #define DATA_LOW TIPC_LOW_IMPORTANCE
44 #define DATA_MEDIUM TIPC_MEDIUM_IMPORTANCE
45 #define DATA_HIGH TIPC_HIGH_IMPORTANCE
46 #define DATA_CRITICAL TIPC_CRITICAL_IMPORTANCE
47 #define SHORT_H_SIZE 24 /* Connected,in cluster */
48 #define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
49 #define CONN_MSG_H_SIZE 36 /* Routed connected msgs*/
50 #define LONG_H_SIZE 40 /* Named Messages */
51 #define MCAST_H_SIZE 44 /* Multicast messages */
52 #define MAX_H_SIZE 60 /* Inclusive full options */
53 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
54 #define LINK_CONFIG 13
58 TIPC user data message header format, version 2
60 - Fundamental definitions available to privileged TIPC users
61 are located in tipc_msg.h.
62 - Remaining definitions available to TIPC internal users appear below.
66 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
68 m->hdr[w] = htonl(val);
71 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
72 u32 pos, u32 mask, u32 val)
74 val = (val & mask) << pos;
75 m->hdr[w] &= ~htonl(mask << pos);
76 m->hdr[w] |= htonl(val);
83 static inline u32 msg_version(struct tipc_msg *m)
85 return msg_bits(m, 0, 29, 7);
88 static inline void msg_set_version(struct tipc_msg *m)
90 msg_set_bits(m, 0, 29, 0xf, TIPC_VERSION);
93 static inline u32 msg_user(struct tipc_msg *m)
95 return msg_bits(m, 0, 25, 0xf);
98 static inline u32 msg_isdata(struct tipc_msg *m)
100 return (msg_user(m) <= DATA_CRITICAL);
103 static inline void msg_set_user(struct tipc_msg *m, u32 n)
105 msg_set_bits(m, 0, 25, 0xf, n);
108 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
113 static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
115 msg_set_bits(m, 0, 21, 0xf, n>>2);
118 static inline int msg_non_seq(struct tipc_msg *m)
120 return msg_bits(m, 0, 20, 1);
123 static inline void msg_set_non_seq(struct tipc_msg *m)
125 msg_set_bits(m, 0, 20, 1, 1);
128 static inline int msg_dest_droppable(struct tipc_msg *m)
130 return msg_bits(m, 0, 19, 1);
133 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
135 msg_set_bits(m, 0, 19, 1, d);
138 static inline int msg_src_droppable(struct tipc_msg *m)
140 return msg_bits(m, 0, 18, 1);
143 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
145 msg_set_bits(m, 0, 18, 1, d);
148 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
150 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
158 static inline void msg_set_type(struct tipc_msg *m, u32 n)
160 msg_set_bits(m, 1, 29, 0x7, n);
163 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
165 msg_set_bits(m, 1, 25, 0xf, err);
168 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
170 return msg_bits(m, 1, 21, 0xf);
173 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
175 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
178 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
180 msg_set_bits(m, 1, 21, 0xf, 0);
183 static inline u32 msg_lookup_scope(struct tipc_msg *m)
185 return msg_bits(m, 1, 19, 0x3);
188 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
190 msg_set_bits(m, 1, 19, 0x3, n);
193 static inline u32 msg_bcast_ack(struct tipc_msg *m)
195 return msg_bits(m, 1, 0, 0xffff);
198 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
200 msg_set_bits(m, 1, 0, 0xffff, n);
208 static inline u32 msg_ack(struct tipc_msg *m)
210 return msg_bits(m, 2, 16, 0xffff);
213 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
215 msg_set_bits(m, 2, 16, 0xffff, n);
218 static inline u32 msg_seqno(struct tipc_msg *m)
220 return msg_bits(m, 2, 0, 0xffff);
223 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
225 msg_set_bits(m, 2, 0, 0xffff, n);
234 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
236 msg_set_word(m, 3, a);
239 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
241 msg_set_word(m, 4, p);
244 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
246 msg_set_word(m, 5, p);
249 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
251 msg_set_word(m, 5, p);
254 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
256 msg_set_word(m, 6, a);
259 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
261 msg_set_word(m, 7, a);
264 static inline int msg_is_dest(struct tipc_msg *m, u32 d)
266 return(msg_short(m) || (msg_destnode(m) == d));
269 static inline u32 msg_routed(struct tipc_msg *m)
271 if (likely(msg_short(m)))
273 return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
276 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
278 msg_set_word(m, 8, n);
281 static inline u32 msg_transp_seqno(struct tipc_msg *m)
283 return msg_word(m, 8);
286 static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
288 msg_set_word(m, 8, n);
291 static inline u32 msg_timestamp(struct tipc_msg *m)
293 return msg_word(m, 8);
296 static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
298 msg_set_word(m, 8, n);
301 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
303 msg_set_word(m, 9, n);
306 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
308 msg_set_namelower(m, n);
311 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
313 msg_set_word(m, 10, n);
316 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
318 return (struct tipc_msg *)msg_data(m);
323 TIPC internal message header format, version 2
325 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
326 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
327 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
328 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
329 w1:|m typ|rsv=0| sequence gap | broadcast ack no |
330 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
331 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
332 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
334 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
335 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
336 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
337 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
338 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
339 w6:| originating node |
340 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
341 w7:| destination node |
342 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
343 w8:| transport sequence number |
344 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
345 w9:| msg count / bcast tag | link tolerance |
346 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
348 / User Specific Data /
350 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
352 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
359 #define BCAST_PROTOCOL 5
360 #define MSG_BUNDLER 6
361 #define LINK_PROTOCOL 7
362 #define CONN_MANAGER 8
363 #define ROUTE_DISTRIBUTOR 9
364 #define CHANGEOVER_PROTOCOL 10
365 #define NAME_DISTRIBUTOR 11
366 #define MSG_FRAGMENTER 12
367 #define LINK_CONFIG 13
368 #define INT_H_SIZE 40
369 #define DSC_H_SIZE 40
372 * Connection management protocol messages
376 #define CONN_PROBE_REPLY 1
380 * Name distributor messages
383 #define PUBLICATION 0
391 static inline u32 msg_seq_gap(struct tipc_msg *m)
393 return msg_bits(m, 1, 16, 0xff);
396 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
398 msg_set_bits(m, 1, 16, 0xff, n);
401 static inline u32 msg_req_links(struct tipc_msg *m)
403 return msg_bits(m, 1, 16, 0xfff);
406 static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
408 msg_set_bits(m, 1, 16, 0xfff, n);
416 static inline u32 msg_dest_domain(struct tipc_msg *m)
418 return msg_word(m, 2);
421 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
423 msg_set_word(m, 2, n);
426 static inline u32 msg_bcgap_after(struct tipc_msg *m)
428 return msg_bits(m, 2, 16, 0xffff);
431 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
433 msg_set_bits(m, 2, 16, 0xffff, n);
436 static inline u32 msg_bcgap_to(struct tipc_msg *m)
438 return msg_bits(m, 2, 0, 0xffff);
441 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
443 msg_set_bits(m, 2, 0, 0xffff, n);
451 static inline u32 msg_last_bcast(struct tipc_msg *m)
453 return msg_bits(m, 4, 16, 0xffff);
456 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
458 msg_set_bits(m, 4, 16, 0xffff, n);
462 static inline u32 msg_fragm_no(struct tipc_msg *m)
464 return msg_bits(m, 4, 16, 0xffff);
467 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
469 msg_set_bits(m, 4, 16, 0xffff, n);
473 static inline u32 msg_next_sent(struct tipc_msg *m)
475 return msg_bits(m, 4, 0, 0xffff);
478 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
480 msg_set_bits(m, 4, 0, 0xffff, n);
484 static inline u32 msg_long_msgno(struct tipc_msg *m)
486 return msg_bits(m, 4, 0, 0xffff);
489 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
491 msg_set_bits(m, 4, 0, 0xffff, n);
494 static inline u32 msg_bc_netid(struct tipc_msg *m)
496 return msg_word(m, 4);
499 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
501 msg_set_word(m, 4, id);
504 static inline u32 msg_link_selector(struct tipc_msg *m)
506 return msg_bits(m, 4, 0, 1);
509 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
511 msg_set_bits(m, 4, 0, 1, (n & 1));
518 static inline u32 msg_session(struct tipc_msg *m)
520 return msg_bits(m, 5, 16, 0xffff);
523 static inline void msg_set_session(struct tipc_msg *m, u32 n)
525 msg_set_bits(m, 5, 16, 0xffff, n);
528 static inline u32 msg_probe(struct tipc_msg *m)
530 return msg_bits(m, 5, 0, 1);
533 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
535 msg_set_bits(m, 5, 0, 1, (val & 1));
538 static inline char msg_net_plane(struct tipc_msg *m)
540 return msg_bits(m, 5, 1, 7) + 'A';
543 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
545 msg_set_bits(m, 5, 1, 7, (n - 'A'));
548 static inline u32 msg_linkprio(struct tipc_msg *m)
550 return msg_bits(m, 5, 4, 0x1f);
553 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
555 msg_set_bits(m, 5, 4, 0x1f, n);
558 static inline u32 msg_bearer_id(struct tipc_msg *m)
560 return msg_bits(m, 5, 9, 0x7);
563 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
565 msg_set_bits(m, 5, 9, 0x7, n);
568 static inline u32 msg_redundant_link(struct tipc_msg *m)
570 return msg_bits(m, 5, 12, 0x1);
573 static inline void msg_set_redundant_link(struct tipc_msg *m)
575 msg_set_bits(m, 5, 12, 0x1, 1);
578 static inline void msg_clear_redundant_link(struct tipc_msg *m)
580 msg_set_bits(m, 5, 12, 0x1, 0);
588 static inline u32 msg_msgcnt(struct tipc_msg *m)
590 return msg_bits(m, 9, 16, 0xffff);
593 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
595 msg_set_bits(m, 9, 16, 0xffff, n);
598 static inline u32 msg_bcast_tag(struct tipc_msg *m)
600 return msg_bits(m, 9, 16, 0xffff);
603 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
605 msg_set_bits(m, 9, 16, 0xffff, n);
608 static inline u32 msg_max_pkt(struct tipc_msg *m)
610 return (msg_bits(m, 9, 16, 0xffff) * 4);
613 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
615 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
618 static inline u32 msg_link_tolerance(struct tipc_msg *m)
620 return msg_bits(m, 9, 0, 0xffff);
623 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
625 msg_set_bits(m, 9, 0, 0xffff, n);
629 * Routing table message data
633 static inline u32 msg_remote_node(struct tipc_msg *m)
635 return msg_word(m, msg_hdr_sz(m)/4);
638 static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
640 msg_set_word(m, msg_hdr_sz(m)/4, a);
643 static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
645 msg_data(m)[pos + 4] = 1;
649 * Segmentation message types
652 #define FIRST_FRAGMENT 0
654 #define LAST_FRAGMENT 2
657 * Link management protocol message types
662 #define ACTIVATE_MSG 2
665 * Changeover tunnel message types
667 #define DUPLICATE_MSG 0
668 #define ORIGINAL_MSG 1
671 * Routing table message types
673 #define EXT_ROUTING_TABLE 0
674 #define LOCAL_ROUTING_TABLE 1
675 #define SLAVE_ROUTING_TABLE 2
676 #define ROUTE_ADDITION 3
677 #define ROUTE_REMOVAL 4
680 * Config protocol message types
683 #define DSC_REQ_MSG 0
684 #define DSC_RESP_MSG 1
686 static inline u32 msg_tot_importance(struct tipc_msg *m)
688 if (likely(msg_isdata(m))) {
689 if (likely(msg_orignode(m) == tipc_own_addr))
690 return msg_importance(m);
691 return msg_importance(m) + 4;
693 if ((msg_user(m) == MSG_FRAGMENTER) &&
694 (msg_type(m) == FIRST_FRAGMENT))
695 return msg_importance(msg_get_wrapped(m));
696 return msg_importance(m);
700 static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
701 u32 err, u32 hsize, u32 destnode)
705 msg_set_user(m, user);
706 msg_set_hdr_sz(m, hsize);
707 msg_set_size(m, hsize);
708 msg_set_prevnode(m, tipc_own_addr);
709 msg_set_type(m, type);
710 msg_set_errcode(m, err);
712 msg_set_orignode(m, tipc_own_addr);
713 msg_set_destnode(m, destnode);
718 * msg_calc_data_size - determine total data size for message
721 static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
726 for (i = 0; i < num_sect; i++)
727 dsz += msg_sect[i].iov_len;
732 * msg_build - create message using specified header and data
734 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
736 * Returns message data size or errno
739 static inline int msg_build(struct tipc_msg *hdr,
740 struct iovec const *msg_sect, u32 num_sect,
741 int max_size, int usrmem, struct sk_buff** buf)
743 int dsz, sz, hsz, pos, res, cnt;
745 dsz = msg_calc_data_size(msg_sect, num_sect);
746 if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
751 pos = hsz = msg_hdr_sz(hdr);
753 msg_set_size(hdr, sz);
754 if (unlikely(sz > max_size)) {
759 *buf = buf_acquire(sz);
762 skb_copy_to_linear_data(*buf, hdr, hsz);
763 for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
765 res = !copy_from_user((*buf)->data + pos,
766 msg_sect[cnt].iov_base,
767 msg_sect[cnt].iov_len);
769 skb_copy_to_linear_data_offset(*buf, pos,
770 msg_sect[cnt].iov_base,
771 msg_sect[cnt].iov_len);
772 pos += msg_sect[cnt].iov_len;
782 static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
784 memcpy(&((int *)m)[5], a, sizeof(*a));
787 static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
789 memcpy(a, &((int*)m)[5], sizeof(*a));