2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2007, 2014-2015 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>
44 * Constants and routines used to read and write TIPC payload message headers
46 * Note: Some items are also used with TIPC internal message headers
48 #define TIPC_VERSION 2
52 * Payload message users are defined in TIPC's public API:
53 * - TIPC_LOW_IMPORTANCE
54 * - TIPC_MEDIUM_IMPORTANCE
55 * - TIPC_HIGH_IMPORTANCE
56 * - TIPC_CRITICAL_IMPORTANCE
58 #define TIPC_SYSTEM_IMPORTANCE 4
62 * Payload message types
64 #define TIPC_CONN_MSG 0
65 #define TIPC_MCAST_MSG 1
66 #define TIPC_NAMED_MSG 2
67 #define TIPC_DIRECT_MSG 3
70 * Internal message users
72 #define BCAST_PROTOCOL 5
74 #define LINK_PROTOCOL 7
75 #define CONN_MANAGER 8
76 #define TUNNEL_PROTOCOL 10
77 #define NAME_DISTRIBUTOR 11
78 #define MSG_FRAGMENTER 12
79 #define LINK_CONFIG 13
80 #define SOCK_WAKEUP 14 /* pseudo user */
83 * Message header sizes
85 #define SHORT_H_SIZE 24 /* In-cluster basic payload message */
86 #define BASIC_H_SIZE 32 /* Basic payload message */
87 #define NAMED_H_SIZE 40 /* Named payload message */
88 #define MCAST_H_SIZE 44 /* Multicast payload message */
89 #define INT_H_SIZE 40 /* Internal messages */
90 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
91 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
93 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
95 #define TIPC_MEDIA_INFO_OFFSET 5
98 * TIPC message buffer code
100 * TIPC message buffer headroom reserves space for the worst-case
101 * link-level device header (in case the message is sent off-node).
103 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
104 * are word aligned for quicker access
106 #define BUF_HEADROOM (LL_MAX_HEADER + 48)
110 struct sk_buff *tail;
118 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
124 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
126 return (struct tipc_msg *)skb->data;
129 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
131 return ntohl(m->hdr[pos]);
134 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
136 m->hdr[w] = htonl(val);
139 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
141 return (msg_word(m, w) >> pos) & mask;
144 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
145 u32 pos, u32 mask, u32 val)
147 val = (val & mask) << pos;
149 m->hdr[w] &= ~htonl(mask);
150 m->hdr[w] |= htonl(val);
153 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
155 u32 temp = msg->hdr[a];
157 msg->hdr[a] = msg->hdr[b];
164 static inline u32 msg_version(struct tipc_msg *m)
166 return msg_bits(m, 0, 29, 7);
169 static inline void msg_set_version(struct tipc_msg *m)
171 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
174 static inline u32 msg_user(struct tipc_msg *m)
176 return msg_bits(m, 0, 25, 0xf);
179 static inline u32 msg_isdata(struct tipc_msg *m)
181 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
184 static inline void msg_set_user(struct tipc_msg *m, u32 n)
186 msg_set_bits(m, 0, 25, 0xf, n);
189 static inline u32 msg_hdr_sz(struct tipc_msg *m)
191 return msg_bits(m, 0, 21, 0xf) << 2;
194 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
196 msg_set_bits(m, 0, 21, 0xf, n>>2);
199 static inline u32 msg_size(struct tipc_msg *m)
201 return msg_bits(m, 0, 0, 0x1ffff);
204 static inline u32 msg_data_sz(struct tipc_msg *m)
206 return msg_size(m) - msg_hdr_sz(m);
209 static inline int msg_non_seq(struct tipc_msg *m)
211 return msg_bits(m, 0, 20, 1);
214 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
216 msg_set_bits(m, 0, 20, 1, n);
219 static inline int msg_dest_droppable(struct tipc_msg *m)
221 return msg_bits(m, 0, 19, 1);
224 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
226 msg_set_bits(m, 0, 19, 1, d);
229 static inline int msg_src_droppable(struct tipc_msg *m)
231 return msg_bits(m, 0, 18, 1);
234 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
236 msg_set_bits(m, 0, 18, 1, d);
239 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
241 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
244 static inline unchar *msg_data(struct tipc_msg *m)
246 return ((unchar *)m) + msg_hdr_sz(m);
249 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
251 return (struct tipc_msg *)msg_data(m);
257 static inline u32 msg_type(struct tipc_msg *m)
259 return msg_bits(m, 1, 29, 0x7);
262 static inline void msg_set_type(struct tipc_msg *m, u32 n)
264 msg_set_bits(m, 1, 29, 0x7, n);
267 static inline u32 msg_named(struct tipc_msg *m)
269 return msg_type(m) == TIPC_NAMED_MSG;
272 static inline u32 msg_mcast(struct tipc_msg *m)
274 return msg_type(m) == TIPC_MCAST_MSG;
277 static inline u32 msg_connected(struct tipc_msg *m)
279 return msg_type(m) == TIPC_CONN_MSG;
282 static inline u32 msg_errcode(struct tipc_msg *m)
284 return msg_bits(m, 1, 25, 0xf);
287 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
289 msg_set_bits(m, 1, 25, 0xf, err);
292 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
294 return msg_bits(m, 1, 21, 0xf);
297 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
299 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
302 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
304 msg_set_bits(m, 1, 21, 0xf, 0);
307 static inline u32 msg_lookup_scope(struct tipc_msg *m)
309 return msg_bits(m, 1, 19, 0x3);
312 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
314 msg_set_bits(m, 1, 19, 0x3, n);
317 static inline u16 msg_bcast_ack(struct tipc_msg *m)
319 return msg_bits(m, 1, 0, 0xffff);
322 static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
324 msg_set_bits(m, 1, 0, 0xffff, n);
331 static inline u16 msg_ack(struct tipc_msg *m)
333 return msg_bits(m, 2, 16, 0xffff);
336 static inline void msg_set_ack(struct tipc_msg *m, u16 n)
338 msg_set_bits(m, 2, 16, 0xffff, n);
341 static inline u16 msg_seqno(struct tipc_msg *m)
343 return msg_bits(m, 2, 0, 0xffff);
346 static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
348 msg_set_bits(m, 2, 0, 0xffff, n);
354 static inline u32 msg_importance(struct tipc_msg *m)
356 int usr = msg_user(m);
358 if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
360 if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
361 return msg_bits(m, 9, 0, 0x7);
362 return TIPC_SYSTEM_IMPORTANCE;
365 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
367 int usr = msg_user(m);
369 if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
370 msg_set_bits(m, 9, 0, 0x7, i);
371 else if (i < TIPC_SYSTEM_IMPORTANCE)
374 pr_warn("Trying to set illegal importance in message\n");
377 static inline u32 msg_prevnode(struct tipc_msg *m)
379 return msg_word(m, 3);
382 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
384 msg_set_word(m, 3, a);
387 static inline u32 msg_origport(struct tipc_msg *m)
389 if (msg_user(m) == MSG_FRAGMENTER)
390 m = msg_get_wrapped(m);
391 return msg_word(m, 4);
394 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
396 msg_set_word(m, 4, p);
399 static inline u32 msg_destport(struct tipc_msg *m)
401 return msg_word(m, 5);
404 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
406 msg_set_word(m, 5, p);
409 static inline u32 msg_mc_netid(struct tipc_msg *m)
411 return msg_word(m, 5);
414 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
416 msg_set_word(m, 5, p);
419 static inline int msg_short(struct tipc_msg *m)
421 return msg_hdr_sz(m) == SHORT_H_SIZE;
424 static inline u32 msg_orignode(struct tipc_msg *m)
426 if (likely(msg_short(m)))
427 return msg_prevnode(m);
428 return msg_word(m, 6);
431 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
433 msg_set_word(m, 6, a);
436 static inline u32 msg_destnode(struct tipc_msg *m)
438 return msg_word(m, 7);
441 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
443 msg_set_word(m, 7, a);
446 static inline u32 msg_nametype(struct tipc_msg *m)
448 return msg_word(m, 8);
451 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
453 msg_set_word(m, 8, n);
456 static inline u32 msg_nameinst(struct tipc_msg *m)
458 return msg_word(m, 9);
461 static inline u32 msg_namelower(struct tipc_msg *m)
463 return msg_nameinst(m);
466 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
468 msg_set_word(m, 9, n);
471 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
473 msg_set_namelower(m, n);
476 static inline u32 msg_nameupper(struct tipc_msg *m)
478 return msg_word(m, 10);
481 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
483 msg_set_word(m, 10, n);
487 * Constants and routines used to read and write TIPC internal message headers
491 * Connection management protocol message types
494 #define CONN_PROBE_REPLY 1
498 * Name distributor message types
500 #define PUBLICATION 0
504 * Segmentation message types
506 #define FIRST_FRAGMENT 0
508 #define LAST_FRAGMENT 2
511 * Link management protocol message types
515 #define ACTIVATE_MSG 2
518 * Changeover tunnel message types
521 #define FAILOVER_MSG 1
524 * Config protocol message types
526 #define DSC_REQ_MSG 0
527 #define DSC_RESP_MSG 1
532 static inline u32 msg_seq_gap(struct tipc_msg *m)
534 return msg_bits(m, 1, 16, 0x1fff);
537 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
539 msg_set_bits(m, 1, 16, 0x1fff, n);
542 static inline u32 msg_node_sig(struct tipc_msg *m)
544 return msg_bits(m, 1, 0, 0xffff);
547 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
549 msg_set_bits(m, 1, 0, 0xffff, n);
552 static inline u32 msg_node_capabilities(struct tipc_msg *m)
554 return msg_bits(m, 1, 15, 0x1fff);
557 static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
559 msg_set_bits(m, 1, 15, 0x1fff, n);
565 static inline u32 msg_dest_domain(struct tipc_msg *m)
567 return msg_word(m, 2);
570 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
572 msg_set_word(m, 2, n);
575 static inline u32 msg_bcgap_after(struct tipc_msg *m)
577 return msg_bits(m, 2, 16, 0xffff);
580 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
582 msg_set_bits(m, 2, 16, 0xffff, n);
585 static inline u32 msg_bcgap_to(struct tipc_msg *m)
587 return msg_bits(m, 2, 0, 0xffff);
590 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
592 msg_set_bits(m, 2, 0, 0xffff, n);
599 static inline u32 msg_last_bcast(struct tipc_msg *m)
601 return msg_bits(m, 4, 16, 0xffff);
604 static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
606 return msg_last_bcast(m) + 1;
609 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
611 msg_set_bits(m, 4, 16, 0xffff, n);
614 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
616 msg_set_bits(m, 4, 16, 0xffff, n);
620 static inline u16 msg_next_sent(struct tipc_msg *m)
622 return msg_bits(m, 4, 0, 0xffff);
625 static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
627 msg_set_bits(m, 4, 0, 0xffff, n);
630 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
632 msg_set_bits(m, 4, 0, 0xffff, n);
635 static inline u32 msg_bc_netid(struct tipc_msg *m)
637 return msg_word(m, 4);
640 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
642 msg_set_word(m, 4, id);
645 static inline u32 msg_link_selector(struct tipc_msg *m)
647 return msg_bits(m, 4, 0, 1);
650 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
652 msg_set_bits(m, 4, 0, 1, n);
658 static inline u16 msg_session(struct tipc_msg *m)
660 return msg_bits(m, 5, 16, 0xffff);
663 static inline void msg_set_session(struct tipc_msg *m, u16 n)
665 msg_set_bits(m, 5, 16, 0xffff, n);
668 static inline u32 msg_probe(struct tipc_msg *m)
670 return msg_bits(m, 5, 0, 1);
673 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
675 msg_set_bits(m, 5, 0, 1, val);
678 static inline char msg_net_plane(struct tipc_msg *m)
680 return msg_bits(m, 5, 1, 7) + 'A';
683 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
685 msg_set_bits(m, 5, 1, 7, (n - 'A'));
688 static inline u32 msg_linkprio(struct tipc_msg *m)
690 return msg_bits(m, 5, 4, 0x1f);
693 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
695 msg_set_bits(m, 5, 4, 0x1f, n);
698 static inline u32 msg_bearer_id(struct tipc_msg *m)
700 return msg_bits(m, 5, 9, 0x7);
703 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
705 msg_set_bits(m, 5, 9, 0x7, n);
708 static inline u32 msg_redundant_link(struct tipc_msg *m)
710 return msg_bits(m, 5, 12, 0x1);
713 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
715 msg_set_bits(m, 5, 12, 0x1, r);
718 static inline char *msg_media_addr(struct tipc_msg *m)
720 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
726 static inline u16 msg_msgcnt(struct tipc_msg *m)
728 return msg_bits(m, 9, 16, 0xffff);
731 static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
733 msg_set_bits(m, 9, 16, 0xffff, n);
736 static inline u32 msg_bcast_tag(struct tipc_msg *m)
738 return msg_bits(m, 9, 16, 0xffff);
741 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
743 msg_set_bits(m, 9, 16, 0xffff, n);
746 static inline u32 msg_max_pkt(struct tipc_msg *m)
748 return msg_bits(m, 9, 16, 0xffff) * 4;
751 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
753 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
756 static inline u32 msg_link_tolerance(struct tipc_msg *m)
758 return msg_bits(m, 9, 0, 0xffff);
761 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
763 msg_set_bits(m, 9, 0, 0xffff, n);
766 static inline bool msg_peer_link_is_up(struct tipc_msg *m)
768 if (likely(msg_user(m) != LINK_PROTOCOL))
770 if (msg_type(m) == STATE_MSG)
775 static inline bool msg_peer_node_is_up(struct tipc_msg *m)
777 if (msg_peer_link_is_up(m))
779 return msg_redundant_link(m);
782 struct sk_buff *tipc_buf_acquire(u32 size);
783 bool tipc_msg_validate(struct sk_buff *skb);
784 bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
785 void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
786 u32 hsize, u32 destnode);
787 struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
788 uint data_sz, u32 dnode, u32 onode,
789 u32 dport, u32 oport, int errcode);
790 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
791 bool tipc_msg_bundle(struct sk_buff *skb, struct tipc_msg *msg, u32 mtu);
792 bool tipc_msg_make_bundle(struct sk_buff **skb, struct tipc_msg *msg,
794 bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
795 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
796 int offset, int dsz, int mtu, struct sk_buff_head *list);
797 bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
798 bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
799 void __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
800 struct sk_buff *skb);
802 static inline u16 buf_seqno(struct sk_buff *skb)
804 return msg_seqno(buf_msg(skb));
807 /* tipc_skb_peek(): peek and reserve first buffer in list
808 * @list: list to be peeked in
809 * Returns pointer to first buffer in list, if any
811 static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
817 skb = skb_peek(list);
820 spin_unlock_bh(lock);
824 /* tipc_skb_peek_port(): find a destination port, ignoring all destinations
825 * up to and including 'filter'.
826 * Note: ignoring previously tried destinations minimizes the risk of
827 * contention on the socket lock
828 * @list: list to be peeked in
829 * @filter: last destination to be ignored from search
830 * Returns a destination port number, of applicable.
832 static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
838 spin_lock_bh(&list->lock);
839 skb_queue_walk(list, skb) {
840 dport = msg_destport(buf_msg(skb));
841 if (!filter || skb_queue_is_last(list, skb))
848 spin_unlock_bh(&list->lock);
852 /* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
853 * @list: list to be unlinked from
854 * @dport: selection criteria for buffer to unlink
856 static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
859 struct sk_buff *_skb, *tmp, *skb = NULL;
861 spin_lock_bh(&list->lock);
862 skb_queue_walk_safe(list, _skb, tmp) {
863 if (msg_destport(buf_msg(_skb)) == dport) {
864 __skb_unlink(_skb, list);
869 spin_unlock_bh(&list->lock);
873 /* tipc_skb_queue_splice_tail - append an skb list to lock protected list
874 * @list: the new list to append. Not lock protected
875 * @head: target list. Lock protected.
877 static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
878 struct sk_buff_head *head)
880 spin_lock_bh(&head->lock);
881 skb_queue_splice_tail(list, head);
882 spin_unlock_bh(&head->lock);
885 /* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
886 * @list: the new list to add. Lock protected. Will be reinitialized
887 * @head: target list. Lock protected.
889 static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
890 struct sk_buff_head *head)
892 struct sk_buff_head tmp;
894 __skb_queue_head_init(&tmp);
896 spin_lock_bh(&list->lock);
897 skb_queue_splice_tail_init(list, &tmp);
898 spin_unlock_bh(&list->lock);
899 tipc_skb_queue_splice_tail(&tmp, head);