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>
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
57 #define TIPC_SYSTEM_IMPORTANCE 4
61 * Payload message types
63 #define TIPC_CONN_MSG 0
64 #define TIPC_MCAST_MSG 1
65 #define TIPC_NAMED_MSG 2
66 #define TIPC_DIRECT_MSG 3
69 * Internal message users
71 #define BCAST_PROTOCOL 5
73 #define LINK_PROTOCOL 7
74 #define CONN_MANAGER 8
75 #define TUNNEL_PROTOCOL 10
76 #define NAME_DISTRIBUTOR 11
77 #define MSG_FRAGMENTER 12
78 #define LINK_CONFIG 13
79 #define SOCK_WAKEUP 14 /* pseudo user */
82 * Message header sizes
84 #define SHORT_H_SIZE 24 /* In-cluster basic payload message */
85 #define BASIC_H_SIZE 32 /* Basic payload message */
86 #define NAMED_H_SIZE 40 /* Named payload message */
87 #define MCAST_H_SIZE 44 /* Multicast payload message */
88 #define INT_H_SIZE 40 /* Internal messages */
89 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
90 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
92 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
94 #define TIPC_MEDIA_INFO_OFFSET 5
97 * TIPC message buffer code
99 * TIPC message buffer headroom reserves space for the worst-case
100 * link-level device header (in case the message is sent off-node).
102 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
103 * are word aligned for quicker access
105 #define BUF_HEADROOM (LL_MAX_HEADER + 48)
109 struct sk_buff *tail;
117 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
123 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
125 return (struct tipc_msg *)skb->data;
128 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
130 return ntohl(m->hdr[pos]);
133 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
135 m->hdr[w] = htonl(val);
138 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
140 return (msg_word(m, w) >> pos) & mask;
143 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
144 u32 pos, u32 mask, u32 val)
146 val = (val & mask) << pos;
148 m->hdr[w] &= ~htonl(mask);
149 m->hdr[w] |= htonl(val);
152 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
154 u32 temp = msg->hdr[a];
156 msg->hdr[a] = msg->hdr[b];
163 static inline u32 msg_version(struct tipc_msg *m)
165 return msg_bits(m, 0, 29, 7);
168 static inline void msg_set_version(struct tipc_msg *m)
170 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
173 static inline u32 msg_user(struct tipc_msg *m)
175 return msg_bits(m, 0, 25, 0xf);
178 static inline u32 msg_isdata(struct tipc_msg *m)
180 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
183 static inline void msg_set_user(struct tipc_msg *m, u32 n)
185 msg_set_bits(m, 0, 25, 0xf, n);
188 static inline u32 msg_hdr_sz(struct tipc_msg *m)
190 return msg_bits(m, 0, 21, 0xf) << 2;
193 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
195 msg_set_bits(m, 0, 21, 0xf, n>>2);
198 static inline u32 msg_size(struct tipc_msg *m)
200 return msg_bits(m, 0, 0, 0x1ffff);
203 static inline u32 msg_data_sz(struct tipc_msg *m)
205 return msg_size(m) - msg_hdr_sz(m);
208 static inline int msg_non_seq(struct tipc_msg *m)
210 return msg_bits(m, 0, 20, 1);
213 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
215 msg_set_bits(m, 0, 20, 1, n);
218 static inline int msg_dest_droppable(struct tipc_msg *m)
220 return msg_bits(m, 0, 19, 1);
223 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
225 msg_set_bits(m, 0, 19, 1, d);
228 static inline int msg_src_droppable(struct tipc_msg *m)
230 return msg_bits(m, 0, 18, 1);
233 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
235 msg_set_bits(m, 0, 18, 1, d);
238 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
240 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
243 static inline unchar *msg_data(struct tipc_msg *m)
245 return ((unchar *)m) + msg_hdr_sz(m);
248 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
250 return (struct tipc_msg *)msg_data(m);
256 static inline u32 msg_type(struct tipc_msg *m)
258 return msg_bits(m, 1, 29, 0x7);
261 static inline void msg_set_type(struct tipc_msg *m, u32 n)
263 msg_set_bits(m, 1, 29, 0x7, n);
266 static inline u32 msg_named(struct tipc_msg *m)
268 return msg_type(m) == TIPC_NAMED_MSG;
271 static inline u32 msg_mcast(struct tipc_msg *m)
273 return msg_type(m) == TIPC_MCAST_MSG;
276 static inline u32 msg_connected(struct tipc_msg *m)
278 return msg_type(m) == TIPC_CONN_MSG;
281 static inline u32 msg_errcode(struct tipc_msg *m)
283 return msg_bits(m, 1, 25, 0xf);
286 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
288 msg_set_bits(m, 1, 25, 0xf, err);
291 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
293 return msg_bits(m, 1, 21, 0xf);
296 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
298 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
301 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
303 msg_set_bits(m, 1, 21, 0xf, 0);
306 static inline u32 msg_lookup_scope(struct tipc_msg *m)
308 return msg_bits(m, 1, 19, 0x3);
311 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
313 msg_set_bits(m, 1, 19, 0x3, n);
316 static inline u32 msg_bcast_ack(struct tipc_msg *m)
318 return msg_bits(m, 1, 0, 0xffff);
321 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
323 msg_set_bits(m, 1, 0, 0xffff, n);
330 static inline u32 msg_ack(struct tipc_msg *m)
332 return msg_bits(m, 2, 16, 0xffff);
335 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
337 msg_set_bits(m, 2, 16, 0xffff, n);
340 static inline u32 msg_seqno(struct tipc_msg *m)
342 return msg_bits(m, 2, 0, 0xffff);
345 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
347 msg_set_bits(m, 2, 0, 0xffff, n);
353 static inline u32 msg_importance(struct tipc_msg *m)
355 if (unlikely(msg_user(m) == MSG_FRAGMENTER))
356 return msg_bits(m, 5, 13, 0x7);
357 if (likely(msg_isdata(m) && !msg_errcode(m)))
359 return TIPC_SYSTEM_IMPORTANCE;
362 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
364 if (unlikely(msg_user(m) == MSG_FRAGMENTER))
365 msg_set_bits(m, 5, 13, 0x7, i);
366 else if (likely(i < TIPC_SYSTEM_IMPORTANCE))
369 pr_warn("Trying to set illegal importance in message\n");
372 static inline u32 msg_prevnode(struct tipc_msg *m)
374 return msg_word(m, 3);
377 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
379 msg_set_word(m, 3, a);
382 static inline u32 msg_origport(struct tipc_msg *m)
384 if (msg_user(m) == MSG_FRAGMENTER)
385 m = msg_get_wrapped(m);
386 return msg_word(m, 4);
389 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
391 msg_set_word(m, 4, p);
394 static inline u32 msg_destport(struct tipc_msg *m)
396 return msg_word(m, 5);
399 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
401 msg_set_word(m, 5, p);
404 static inline u32 msg_mc_netid(struct tipc_msg *m)
406 return msg_word(m, 5);
409 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
411 msg_set_word(m, 5, p);
414 static inline int msg_short(struct tipc_msg *m)
416 return msg_hdr_sz(m) == SHORT_H_SIZE;
419 static inline u32 msg_orignode(struct tipc_msg *m)
421 if (likely(msg_short(m)))
422 return msg_prevnode(m);
423 return msg_word(m, 6);
426 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
428 msg_set_word(m, 6, a);
431 static inline u32 msg_destnode(struct tipc_msg *m)
433 return msg_word(m, 7);
436 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
438 msg_set_word(m, 7, a);
441 static inline u32 msg_nametype(struct tipc_msg *m)
443 return msg_word(m, 8);
446 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
448 msg_set_word(m, 8, n);
451 static inline u32 msg_nameinst(struct tipc_msg *m)
453 return msg_word(m, 9);
456 static inline u32 msg_namelower(struct tipc_msg *m)
458 return msg_nameinst(m);
461 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
463 msg_set_word(m, 9, n);
466 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
468 msg_set_namelower(m, n);
471 static inline u32 msg_nameupper(struct tipc_msg *m)
473 return msg_word(m, 10);
476 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
478 msg_set_word(m, 10, n);
482 * Constants and routines used to read and write TIPC internal message headers
486 * Connection management protocol message types
489 #define CONN_PROBE_REPLY 1
493 * Name distributor message types
495 #define PUBLICATION 0
499 * Segmentation message types
501 #define FIRST_FRAGMENT 0
503 #define LAST_FRAGMENT 2
506 * Link management protocol message types
510 #define ACTIVATE_MSG 2
513 * Changeover tunnel message types
516 #define FAILOVER_MSG 1
519 * Config protocol message types
521 #define DSC_REQ_MSG 0
522 #define DSC_RESP_MSG 1
527 static inline u32 msg_seq_gap(struct tipc_msg *m)
529 return msg_bits(m, 1, 16, 0x1fff);
532 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
534 msg_set_bits(m, 1, 16, 0x1fff, n);
537 static inline u32 msg_node_sig(struct tipc_msg *m)
539 return msg_bits(m, 1, 0, 0xffff);
542 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
544 msg_set_bits(m, 1, 0, 0xffff, n);
547 static inline u32 msg_node_capabilities(struct tipc_msg *m)
549 return msg_bits(m, 1, 15, 0x1fff);
552 static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
554 msg_set_bits(m, 1, 15, 0x1fff, n);
557 static inline bool msg_dup(struct tipc_msg *m)
559 if (likely(msg_user(m) != TUNNEL_PROTOCOL))
561 if (msg_type(m) != SYNCH_MSG)
569 static inline u32 msg_dest_domain(struct tipc_msg *m)
571 return msg_word(m, 2);
574 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
576 msg_set_word(m, 2, n);
579 static inline u32 msg_bcgap_after(struct tipc_msg *m)
581 return msg_bits(m, 2, 16, 0xffff);
584 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
586 msg_set_bits(m, 2, 16, 0xffff, n);
589 static inline u32 msg_bcgap_to(struct tipc_msg *m)
591 return msg_bits(m, 2, 0, 0xffff);
594 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
596 msg_set_bits(m, 2, 0, 0xffff, n);
603 static inline u32 msg_last_bcast(struct tipc_msg *m)
605 return msg_bits(m, 4, 16, 0xffff);
608 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
610 msg_set_bits(m, 4, 16, 0xffff, n);
613 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
615 msg_set_bits(m, 4, 16, 0xffff, n);
619 static inline u32 msg_next_sent(struct tipc_msg *m)
621 return msg_bits(m, 4, 0, 0xffff);
624 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
626 msg_set_bits(m, 4, 0, 0xffff, n);
629 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
631 msg_set_bits(m, 4, 0, 0xffff, n);
634 static inline u32 msg_bc_netid(struct tipc_msg *m)
636 return msg_word(m, 4);
639 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
641 msg_set_word(m, 4, id);
644 static inline u32 msg_link_selector(struct tipc_msg *m)
646 return msg_bits(m, 4, 0, 1);
649 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
651 msg_set_bits(m, 4, 0, 1, n);
657 static inline u32 msg_session(struct tipc_msg *m)
659 return msg_bits(m, 5, 16, 0xffff);
662 static inline void msg_set_session(struct tipc_msg *m, u32 n)
664 msg_set_bits(m, 5, 16, 0xffff, n);
667 static inline u32 msg_probe(struct tipc_msg *m)
669 return msg_bits(m, 5, 0, 1);
672 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
674 msg_set_bits(m, 5, 0, 1, val);
677 static inline char msg_net_plane(struct tipc_msg *m)
679 return msg_bits(m, 5, 1, 7) + 'A';
682 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
684 msg_set_bits(m, 5, 1, 7, (n - 'A'));
687 static inline u32 msg_linkprio(struct tipc_msg *m)
689 return msg_bits(m, 5, 4, 0x1f);
692 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
694 msg_set_bits(m, 5, 4, 0x1f, n);
697 static inline u32 msg_bearer_id(struct tipc_msg *m)
699 return msg_bits(m, 5, 9, 0x7);
702 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
704 msg_set_bits(m, 5, 9, 0x7, n);
707 static inline u32 msg_redundant_link(struct tipc_msg *m)
709 return msg_bits(m, 5, 12, 0x1);
712 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
714 msg_set_bits(m, 5, 12, 0x1, r);
717 static inline char *msg_media_addr(struct tipc_msg *m)
719 return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
725 static inline u32 msg_msgcnt(struct tipc_msg *m)
727 return msg_bits(m, 9, 16, 0xffff);
730 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
732 msg_set_bits(m, 9, 16, 0xffff, n);
735 static inline u32 msg_bcast_tag(struct tipc_msg *m)
737 return msg_bits(m, 9, 16, 0xffff);
740 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
742 msg_set_bits(m, 9, 16, 0xffff, n);
745 static inline u32 msg_max_pkt(struct tipc_msg *m)
747 return msg_bits(m, 9, 16, 0xffff) * 4;
750 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
752 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
755 static inline u32 msg_link_tolerance(struct tipc_msg *m)
757 return msg_bits(m, 9, 0, 0xffff);
760 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
762 msg_set_bits(m, 9, 0, 0xffff, n);
765 struct sk_buff *tipc_buf_acquire(u32 size);
766 bool tipc_msg_validate(struct sk_buff *skb);
767 bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
769 void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
770 u32 hsize, u32 destnode);
771 struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
772 uint data_sz, u32 dnode, u32 onode,
773 u32 dport, u32 oport, int errcode);
774 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
775 bool tipc_msg_bundle(struct sk_buff *bskb, struct sk_buff *skb, u32 mtu);
777 bool tipc_msg_make_bundle(struct sk_buff **skb, u32 mtu, u32 dnode);
778 bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
779 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
780 int offset, int dsz, int mtu, struct sk_buff_head *list);
781 bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, u32 *dnode,
783 struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
785 /* tipc_skb_peek(): peek and reserve first buffer in list
786 * @list: list to be peeked in
787 * Returns pointer to first buffer in list, if any
789 static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
795 skb = skb_peek(list);
798 spin_unlock_bh(lock);
802 /* tipc_skb_peek_port(): find a destination port, ignoring all destinations
803 * up to and including 'filter'.
804 * Note: ignoring previously tried destinations minimizes the risk of
805 * contention on the socket lock
806 * @list: list to be peeked in
807 * @filter: last destination to be ignored from search
808 * Returns a destination port number, of applicable.
810 static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
816 spin_lock_bh(&list->lock);
817 skb_queue_walk(list, skb) {
818 dport = msg_destport(buf_msg(skb));
819 if (!filter || skb_queue_is_last(list, skb))
826 spin_unlock_bh(&list->lock);
830 /* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
831 * @list: list to be unlinked from
832 * @dport: selection criteria for buffer to unlink
834 static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
837 struct sk_buff *_skb, *tmp, *skb = NULL;
839 spin_lock_bh(&list->lock);
840 skb_queue_walk_safe(list, _skb, tmp) {
841 if (msg_destport(buf_msg(_skb)) == dport) {
842 __skb_unlink(_skb, list);
847 spin_unlock_bh(&list->lock);
851 /* tipc_skb_queue_tail(): add buffer to tail of list;
852 * @list: list to be appended to
853 * @skb: buffer to append. Always appended
854 * @dport: the destination port of the buffer
855 * returns true if dport differs from previous destination
857 static inline bool tipc_skb_queue_tail(struct sk_buff_head *list,
858 struct sk_buff *skb, u32 dport)
860 struct sk_buff *_skb = NULL;
863 spin_lock_bh(&list->lock);
864 _skb = skb_peek_tail(list);
865 if (!_skb || (msg_destport(buf_msg(_skb)) != dport) ||
866 (skb_queue_len(list) > 32))
868 __skb_queue_tail(list, skb);
869 spin_unlock_bh(&list->lock);