2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2007, 2014, Ericsson AB
5 * Copyright (c) 2005-2008, 2010-2011, 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.
40 #include <linux/tipc.h>
43 * Constants and routines used to read and write TIPC payload message headers
45 * Note: Some items are also used with TIPC internal message headers
47 #define TIPC_VERSION 2
51 * Payload message users are defined in TIPC's public API:
52 * - TIPC_LOW_IMPORTANCE
53 * - TIPC_MEDIUM_IMPORTANCE
54 * - TIPC_HIGH_IMPORTANCE
55 * - TIPC_CRITICAL_IMPORTANCE
59 * Payload message types
61 #define TIPC_CONN_MSG 0
62 #define TIPC_MCAST_MSG 1
63 #define TIPC_NAMED_MSG 2
64 #define TIPC_DIRECT_MSG 3
67 * Message header sizes
69 #define SHORT_H_SIZE 24 /* In-cluster basic payload message */
70 #define BASIC_H_SIZE 32 /* Basic payload message */
71 #define NAMED_H_SIZE 40 /* Named payload message */
72 #define MCAST_H_SIZE 44 /* Multicast payload message */
73 #define INT_H_SIZE 40 /* Internal messages */
74 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
75 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
77 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
79 #define TIPC_MEDIA_ADDR_OFFSET 5
82 * TIPC message buffer code
84 * TIPC message buffer headroom reserves space for the worst-case
85 * link-level device header (in case the message is sent off-node).
87 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
88 * are word aligned for quicker access
90 #define BUF_HEADROOM LL_MAX_HEADER
102 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
108 static inline struct tipc_msg
*buf_msg(struct sk_buff
*skb
)
110 return (struct tipc_msg
*)skb
->data
;
113 static inline u32
msg_word(struct tipc_msg
*m
, u32 pos
)
115 return ntohl(m
->hdr
[pos
]);
118 static inline void msg_set_word(struct tipc_msg
*m
, u32 w
, u32 val
)
120 m
->hdr
[w
] = htonl(val
);
123 static inline u32
msg_bits(struct tipc_msg
*m
, u32 w
, u32 pos
, u32 mask
)
125 return (msg_word(m
, w
) >> pos
) & mask
;
128 static inline void msg_set_bits(struct tipc_msg
*m
, u32 w
,
129 u32 pos
, u32 mask
, u32 val
)
131 val
= (val
& mask
) << pos
;
133 m
->hdr
[w
] &= ~htonl(mask
);
134 m
->hdr
[w
] |= htonl(val
);
137 static inline void msg_swap_words(struct tipc_msg
*msg
, u32 a
, u32 b
)
139 u32 temp
= msg
->hdr
[a
];
141 msg
->hdr
[a
] = msg
->hdr
[b
];
148 static inline u32
msg_version(struct tipc_msg
*m
)
150 return msg_bits(m
, 0, 29, 7);
153 static inline void msg_set_version(struct tipc_msg
*m
)
155 msg_set_bits(m
, 0, 29, 7, TIPC_VERSION
);
158 static inline u32
msg_user(struct tipc_msg
*m
)
160 return msg_bits(m
, 0, 25, 0xf);
163 static inline u32
msg_isdata(struct tipc_msg
*m
)
165 return msg_user(m
) <= TIPC_CRITICAL_IMPORTANCE
;
168 static inline void msg_set_user(struct tipc_msg
*m
, u32 n
)
170 msg_set_bits(m
, 0, 25, 0xf, n
);
173 static inline u32
msg_importance(struct tipc_msg
*m
)
175 return msg_bits(m
, 0, 25, 0xf);
178 static inline void msg_set_importance(struct tipc_msg
*m
, u32 i
)
183 static inline u32
msg_hdr_sz(struct tipc_msg
*m
)
185 return msg_bits(m
, 0, 21, 0xf) << 2;
188 static inline void msg_set_hdr_sz(struct tipc_msg
*m
, u32 n
)
190 msg_set_bits(m
, 0, 21, 0xf, n
>>2);
193 static inline u32
msg_size(struct tipc_msg
*m
)
195 return msg_bits(m
, 0, 0, 0x1ffff);
198 static inline u32
msg_data_sz(struct tipc_msg
*m
)
200 return msg_size(m
) - msg_hdr_sz(m
);
203 static inline int msg_non_seq(struct tipc_msg
*m
)
205 return msg_bits(m
, 0, 20, 1);
208 static inline void msg_set_non_seq(struct tipc_msg
*m
, u32 n
)
210 msg_set_bits(m
, 0, 20, 1, n
);
213 static inline int msg_dest_droppable(struct tipc_msg
*m
)
215 return msg_bits(m
, 0, 19, 1);
218 static inline void msg_set_dest_droppable(struct tipc_msg
*m
, u32 d
)
220 msg_set_bits(m
, 0, 19, 1, d
);
223 static inline int msg_src_droppable(struct tipc_msg
*m
)
225 return msg_bits(m
, 0, 18, 1);
228 static inline void msg_set_src_droppable(struct tipc_msg
*m
, u32 d
)
230 msg_set_bits(m
, 0, 18, 1, d
);
233 static inline void msg_set_size(struct tipc_msg
*m
, u32 sz
)
235 m
->hdr
[0] = htonl((msg_word(m
, 0) & ~0x1ffff) | sz
);
242 static inline u32
msg_type(struct tipc_msg
*m
)
244 return msg_bits(m
, 1, 29, 0x7);
247 static inline void msg_set_type(struct tipc_msg
*m
, u32 n
)
249 msg_set_bits(m
, 1, 29, 0x7, n
);
252 static inline u32
msg_named(struct tipc_msg
*m
)
254 return msg_type(m
) == TIPC_NAMED_MSG
;
257 static inline u32
msg_mcast(struct tipc_msg
*m
)
259 return msg_type(m
) == TIPC_MCAST_MSG
;
262 static inline u32
msg_connected(struct tipc_msg
*m
)
264 return msg_type(m
) == TIPC_CONN_MSG
;
267 static inline u32
msg_errcode(struct tipc_msg
*m
)
269 return msg_bits(m
, 1, 25, 0xf);
272 static inline void msg_set_errcode(struct tipc_msg
*m
, u32 err
)
274 msg_set_bits(m
, 1, 25, 0xf, err
);
277 static inline u32
msg_reroute_cnt(struct tipc_msg
*m
)
279 return msg_bits(m
, 1, 21, 0xf);
282 static inline void msg_incr_reroute_cnt(struct tipc_msg
*m
)
284 msg_set_bits(m
, 1, 21, 0xf, msg_reroute_cnt(m
) + 1);
287 static inline void msg_reset_reroute_cnt(struct tipc_msg
*m
)
289 msg_set_bits(m
, 1, 21, 0xf, 0);
292 static inline u32
msg_lookup_scope(struct tipc_msg
*m
)
294 return msg_bits(m
, 1, 19, 0x3);
297 static inline void msg_set_lookup_scope(struct tipc_msg
*m
, u32 n
)
299 msg_set_bits(m
, 1, 19, 0x3, n
);
302 static inline u32
msg_bcast_ack(struct tipc_msg
*m
)
304 return msg_bits(m
, 1, 0, 0xffff);
307 static inline void msg_set_bcast_ack(struct tipc_msg
*m
, u32 n
)
309 msg_set_bits(m
, 1, 0, 0xffff, n
);
316 static inline u32
msg_ack(struct tipc_msg
*m
)
318 return msg_bits(m
, 2, 16, 0xffff);
321 static inline void msg_set_ack(struct tipc_msg
*m
, u32 n
)
323 msg_set_bits(m
, 2, 16, 0xffff, n
);
326 static inline u32
msg_seqno(struct tipc_msg
*m
)
328 return msg_bits(m
, 2, 0, 0xffff);
331 static inline void msg_set_seqno(struct tipc_msg
*m
, u32 n
)
333 msg_set_bits(m
, 2, 0, 0xffff, n
);
339 static inline u32
msg_prevnode(struct tipc_msg
*m
)
341 return msg_word(m
, 3);
344 static inline void msg_set_prevnode(struct tipc_msg
*m
, u32 a
)
346 msg_set_word(m
, 3, a
);
349 static inline u32
msg_origport(struct tipc_msg
*m
)
351 return msg_word(m
, 4);
354 static inline void msg_set_origport(struct tipc_msg
*m
, u32 p
)
356 msg_set_word(m
, 4, p
);
359 static inline u32
msg_destport(struct tipc_msg
*m
)
361 return msg_word(m
, 5);
364 static inline void msg_set_destport(struct tipc_msg
*m
, u32 p
)
366 msg_set_word(m
, 5, p
);
369 static inline u32
msg_mc_netid(struct tipc_msg
*m
)
371 return msg_word(m
, 5);
374 static inline void msg_set_mc_netid(struct tipc_msg
*m
, u32 p
)
376 msg_set_word(m
, 5, p
);
379 static inline int msg_short(struct tipc_msg
*m
)
381 return msg_hdr_sz(m
) == SHORT_H_SIZE
;
384 static inline u32
msg_orignode(struct tipc_msg
*m
)
386 if (likely(msg_short(m
)))
387 return msg_prevnode(m
);
388 return msg_word(m
, 6);
391 static inline void msg_set_orignode(struct tipc_msg
*m
, u32 a
)
393 msg_set_word(m
, 6, a
);
396 static inline u32
msg_destnode(struct tipc_msg
*m
)
398 return msg_word(m
, 7);
401 static inline void msg_set_destnode(struct tipc_msg
*m
, u32 a
)
403 msg_set_word(m
, 7, a
);
406 static inline u32
msg_nametype(struct tipc_msg
*m
)
408 return msg_word(m
, 8);
411 static inline void msg_set_nametype(struct tipc_msg
*m
, u32 n
)
413 msg_set_word(m
, 8, n
);
416 static inline u32
msg_nameinst(struct tipc_msg
*m
)
418 return msg_word(m
, 9);
421 static inline u32
msg_namelower(struct tipc_msg
*m
)
423 return msg_nameinst(m
);
426 static inline void msg_set_namelower(struct tipc_msg
*m
, u32 n
)
428 msg_set_word(m
, 9, n
);
431 static inline void msg_set_nameinst(struct tipc_msg
*m
, u32 n
)
433 msg_set_namelower(m
, n
);
436 static inline u32
msg_nameupper(struct tipc_msg
*m
)
438 return msg_word(m
, 10);
441 static inline void msg_set_nameupper(struct tipc_msg
*m
, u32 n
)
443 msg_set_word(m
, 10, n
);
446 static inline unchar
*msg_data(struct tipc_msg
*m
)
448 return ((unchar
*)m
) + msg_hdr_sz(m
);
451 static inline struct tipc_msg
*msg_get_wrapped(struct tipc_msg
*m
)
453 return (struct tipc_msg
*)msg_data(m
);
457 * Constants and routines used to read and write TIPC internal message headers
461 * Internal message users
463 #define BCAST_PROTOCOL 5
464 #define MSG_BUNDLER 6
465 #define LINK_PROTOCOL 7
466 #define CONN_MANAGER 8
467 #define ROUTE_DISTRIBUTOR 9 /* obsoleted */
468 #define CHANGEOVER_PROTOCOL 10
469 #define NAME_DISTRIBUTOR 11
470 #define MSG_FRAGMENTER 12
471 #define LINK_CONFIG 13
472 #define SOCK_WAKEUP 14 /* pseudo user */
475 * Connection management protocol message types
478 #define CONN_PROBE_REPLY 1
482 * Name distributor message types
484 #define PUBLICATION 0
488 * Segmentation message types
490 #define FIRST_FRAGMENT 0
492 #define LAST_FRAGMENT 2
495 * Link management protocol message types
499 #define ACTIVATE_MSG 2
502 * Changeover tunnel message types
504 #define DUPLICATE_MSG 0
505 #define ORIGINAL_MSG 1
508 * Config protocol message types
510 #define DSC_REQ_MSG 0
511 #define DSC_RESP_MSG 1
517 static inline u32
msg_seq_gap(struct tipc_msg
*m
)
519 return msg_bits(m
, 1, 16, 0x1fff);
522 static inline void msg_set_seq_gap(struct tipc_msg
*m
, u32 n
)
524 msg_set_bits(m
, 1, 16, 0x1fff, n
);
527 static inline u32
msg_node_sig(struct tipc_msg
*m
)
529 return msg_bits(m
, 1, 0, 0xffff);
532 static inline void msg_set_node_sig(struct tipc_msg
*m
, u32 n
)
534 msg_set_bits(m
, 1, 0, 0xffff, n
);
541 static inline u32
msg_dest_domain(struct tipc_msg
*m
)
543 return msg_word(m
, 2);
546 static inline void msg_set_dest_domain(struct tipc_msg
*m
, u32 n
)
548 msg_set_word(m
, 2, n
);
551 static inline u32
msg_bcgap_after(struct tipc_msg
*m
)
553 return msg_bits(m
, 2, 16, 0xffff);
556 static inline void msg_set_bcgap_after(struct tipc_msg
*m
, u32 n
)
558 msg_set_bits(m
, 2, 16, 0xffff, n
);
561 static inline u32
msg_bcgap_to(struct tipc_msg
*m
)
563 return msg_bits(m
, 2, 0, 0xffff);
566 static inline void msg_set_bcgap_to(struct tipc_msg
*m
, u32 n
)
568 msg_set_bits(m
, 2, 0, 0xffff, n
);
575 static inline u32
msg_last_bcast(struct tipc_msg
*m
)
577 return msg_bits(m
, 4, 16, 0xffff);
580 static inline void msg_set_last_bcast(struct tipc_msg
*m
, u32 n
)
582 msg_set_bits(m
, 4, 16, 0xffff, n
);
585 static inline void msg_set_fragm_no(struct tipc_msg
*m
, u32 n
)
587 msg_set_bits(m
, 4, 16, 0xffff, n
);
591 static inline u32
msg_next_sent(struct tipc_msg
*m
)
593 return msg_bits(m
, 4, 0, 0xffff);
596 static inline void msg_set_next_sent(struct tipc_msg
*m
, u32 n
)
598 msg_set_bits(m
, 4, 0, 0xffff, n
);
601 static inline void msg_set_long_msgno(struct tipc_msg
*m
, u32 n
)
603 msg_set_bits(m
, 4, 0, 0xffff, n
);
606 static inline u32
msg_bc_netid(struct tipc_msg
*m
)
608 return msg_word(m
, 4);
611 static inline void msg_set_bc_netid(struct tipc_msg
*m
, u32 id
)
613 msg_set_word(m
, 4, id
);
616 static inline u32
msg_link_selector(struct tipc_msg
*m
)
618 return msg_bits(m
, 4, 0, 1);
621 static inline void msg_set_link_selector(struct tipc_msg
*m
, u32 n
)
623 msg_set_bits(m
, 4, 0, 1, n
);
629 static inline u32
msg_session(struct tipc_msg
*m
)
631 return msg_bits(m
, 5, 16, 0xffff);
634 static inline void msg_set_session(struct tipc_msg
*m
, u32 n
)
636 msg_set_bits(m
, 5, 16, 0xffff, n
);
639 static inline u32
msg_probe(struct tipc_msg
*m
)
641 return msg_bits(m
, 5, 0, 1);
644 static inline void msg_set_probe(struct tipc_msg
*m
, u32 val
)
646 msg_set_bits(m
, 5, 0, 1, val
);
649 static inline char msg_net_plane(struct tipc_msg
*m
)
651 return msg_bits(m
, 5, 1, 7) + 'A';
654 static inline void msg_set_net_plane(struct tipc_msg
*m
, char n
)
656 msg_set_bits(m
, 5, 1, 7, (n
- 'A'));
659 static inline u32
msg_linkprio(struct tipc_msg
*m
)
661 return msg_bits(m
, 5, 4, 0x1f);
664 static inline void msg_set_linkprio(struct tipc_msg
*m
, u32 n
)
666 msg_set_bits(m
, 5, 4, 0x1f, n
);
669 static inline u32
msg_bearer_id(struct tipc_msg
*m
)
671 return msg_bits(m
, 5, 9, 0x7);
674 static inline void msg_set_bearer_id(struct tipc_msg
*m
, u32 n
)
676 msg_set_bits(m
, 5, 9, 0x7, n
);
679 static inline u32
msg_redundant_link(struct tipc_msg
*m
)
681 return msg_bits(m
, 5, 12, 0x1);
684 static inline void msg_set_redundant_link(struct tipc_msg
*m
, u32 r
)
686 msg_set_bits(m
, 5, 12, 0x1, r
);
689 static inline char *msg_media_addr(struct tipc_msg
*m
)
691 return (char *)&m
->hdr
[TIPC_MEDIA_ADDR_OFFSET
];
697 static inline u32
msg_msgcnt(struct tipc_msg
*m
)
699 return msg_bits(m
, 9, 16, 0xffff);
702 static inline void msg_set_msgcnt(struct tipc_msg
*m
, u32 n
)
704 msg_set_bits(m
, 9, 16, 0xffff, n
);
707 static inline u32
msg_bcast_tag(struct tipc_msg
*m
)
709 return msg_bits(m
, 9, 16, 0xffff);
712 static inline void msg_set_bcast_tag(struct tipc_msg
*m
, u32 n
)
714 msg_set_bits(m
, 9, 16, 0xffff, n
);
717 static inline u32
msg_max_pkt(struct tipc_msg
*m
)
719 return msg_bits(m
, 9, 16, 0xffff) * 4;
722 static inline void msg_set_max_pkt(struct tipc_msg
*m
, u32 n
)
724 msg_set_bits(m
, 9, 16, 0xffff, (n
/ 4));
727 static inline u32
msg_link_tolerance(struct tipc_msg
*m
)
729 return msg_bits(m
, 9, 0, 0xffff);
732 static inline void msg_set_link_tolerance(struct tipc_msg
*m
, u32 n
)
734 msg_set_bits(m
, 9, 0, 0xffff, n
);
737 static inline u32
tipc_msg_tot_importance(struct tipc_msg
*m
)
739 if ((msg_user(m
) == MSG_FRAGMENTER
) && (msg_type(m
) == FIRST_FRAGMENT
))
740 return msg_importance(msg_get_wrapped(m
));
741 return msg_importance(m
);
744 static inline u32
msg_tot_origport(struct tipc_msg
*m
)
746 if ((msg_user(m
) == MSG_FRAGMENTER
) && (msg_type(m
) == FIRST_FRAGMENT
))
747 return msg_origport(msg_get_wrapped(m
));
748 return msg_origport(m
);
751 struct sk_buff
*tipc_buf_acquire(u32 size
);
752 bool tipc_msg_reverse(u32 own_addr
, struct sk_buff
*buf
, u32
*dnode
,
754 void tipc_msg_init(u32 own_addr
, struct tipc_msg
*m
, u32 user
, u32 type
,
755 u32 hsize
, u32 destnode
);
756 struct sk_buff
*tipc_msg_create(uint user
, uint type
, uint hdr_sz
,
757 uint data_sz
, u32 dnode
, u32 onode
,
758 u32 dport
, u32 oport
, int errcode
);
759 int tipc_buf_append(struct sk_buff
**headbuf
, struct sk_buff
**buf
);
760 bool tipc_msg_bundle(struct sk_buff_head
*list
, struct sk_buff
*skb
, u32 mtu
);
761 bool tipc_msg_make_bundle(struct sk_buff_head
*list
,
762 struct sk_buff
*skb
, u32 mtu
, u32 dnode
);
763 bool tipc_msg_extract(struct sk_buff
*skb
, struct sk_buff
**iskb
, int *pos
);
764 int tipc_msg_build(struct tipc_msg
*mhdr
, struct msghdr
*m
,
765 int offset
, int dsz
, int mtu
, struct sk_buff_head
*list
);
766 bool tipc_msg_lookup_dest(struct net
*net
, struct sk_buff
*skb
, u32
*dnode
,
768 struct sk_buff
*tipc_msg_reassemble(struct sk_buff_head
*list
);
770 /* tipc_skb_peek(): peek and reserve first buffer in list
771 * @list: list to be peeked in
772 * Returns pointer to first buffer in list, if any
774 static inline struct sk_buff
*tipc_skb_peek(struct sk_buff_head
*list
,
780 skb
= skb_peek(list
);
783 spin_unlock_bh(lock
);
787 /* tipc_skb_peek_port(): find a destination port, ignoring all destinations
788 * up to and including 'filter'.
789 * Note: ignoring previously tried destinations minimizes the risk of
790 * contention on the socket lock
791 * @list: list to be peeked in
792 * @filter: last destination to be ignored from search
793 * Returns a destination port number, of applicable.
795 static inline u32
tipc_skb_peek_port(struct sk_buff_head
*list
, u32 filter
)
801 spin_lock_bh(&list
->lock
);
802 skb_queue_walk(list
, skb
) {
803 dport
= msg_destport(buf_msg(skb
));
804 if (!filter
|| skb_queue_is_last(list
, skb
))
811 spin_unlock_bh(&list
->lock
);
815 /* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
816 * @list: list to be unlinked from
817 * @dport: selection criteria for buffer to unlink
819 static inline struct sk_buff
*tipc_skb_dequeue(struct sk_buff_head
*list
,
822 struct sk_buff
*_skb
, *tmp
, *skb
= NULL
;
824 spin_lock_bh(&list
->lock
);
825 skb_queue_walk_safe(list
, _skb
, tmp
) {
826 if (msg_destport(buf_msg(_skb
)) == dport
) {
827 __skb_unlink(_skb
, list
);
832 spin_unlock_bh(&list
->lock
);
836 /* tipc_skb_queue_tail(): add buffer to tail of list;
837 * @list: list to be appended to
838 * @skb: buffer to append. Always appended
839 * @dport: the destination port of the buffer
840 * returns true if dport differs from previous destination
842 static inline bool tipc_skb_queue_tail(struct sk_buff_head
*list
,
843 struct sk_buff
*skb
, u32 dport
)
845 struct sk_buff
*_skb
= NULL
;
848 spin_lock_bh(&list
->lock
);
849 _skb
= skb_peek_tail(list
);
850 if (!_skb
|| (msg_destport(buf_msg(_skb
)) != dport
) ||
851 (skb_queue_len(list
) > 32))
853 __skb_queue_tail(list
, skb
);
854 spin_unlock_bh(&list
->lock
);