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
50 * Payload message users are defined in TIPC's public API:
51 * - TIPC_LOW_IMPORTANCE
52 * - TIPC_MEDIUM_IMPORTANCE
53 * - TIPC_HIGH_IMPORTANCE
54 * - TIPC_CRITICAL_IMPORTANCE
58 * Payload message types
60 #define TIPC_CONN_MSG 0
61 #define TIPC_MCAST_MSG 1
62 #define TIPC_NAMED_MSG 2
63 #define TIPC_DIRECT_MSG 3
66 * Message header sizes
68 #define SHORT_H_SIZE 24 /* In-cluster basic payload message */
69 #define BASIC_H_SIZE 32 /* Basic payload message */
70 #define NAMED_H_SIZE 40 /* Named payload message */
71 #define MCAST_H_SIZE 44 /* Multicast payload message */
72 #define INT_H_SIZE 40 /* Internal messages */
73 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
74 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
76 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
78 #define TIPC_MEDIA_ADDR_OFFSET 5
81 * TIPC message buffer code
83 * TIPC message buffer headroom reserves space for the worst-case
84 * link-level device header (in case the message is sent off-node).
86 * Note: Headroom should be a multiple of 4 to ensure the TIPC header fields
87 * are word aligned for quicker access
89 #define BUF_HEADROOM LL_MAX_HEADER
101 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
107 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
109 return (struct tipc_msg *)skb->data;
112 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
114 return ntohl(m->hdr[pos]);
117 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
119 m->hdr[w] = htonl(val);
122 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
124 return (msg_word(m, w) >> pos) & mask;
127 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
128 u32 pos, u32 mask, u32 val)
130 val = (val & mask) << pos;
132 m->hdr[w] &= ~htonl(mask);
133 m->hdr[w] |= htonl(val);
136 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
138 u32 temp = msg->hdr[a];
140 msg->hdr[a] = msg->hdr[b];
147 static inline u32 msg_version(struct tipc_msg *m)
149 return msg_bits(m, 0, 29, 7);
152 static inline void msg_set_version(struct tipc_msg *m)
154 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
157 static inline u32 msg_user(struct tipc_msg *m)
159 return msg_bits(m, 0, 25, 0xf);
162 static inline u32 msg_isdata(struct tipc_msg *m)
164 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
167 static inline void msg_set_user(struct tipc_msg *m, u32 n)
169 msg_set_bits(m, 0, 25, 0xf, n);
172 static inline u32 msg_importance(struct tipc_msg *m)
174 return msg_bits(m, 0, 25, 0xf);
177 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
182 static inline u32 msg_hdr_sz(struct tipc_msg *m)
184 return msg_bits(m, 0, 21, 0xf) << 2;
187 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
189 msg_set_bits(m, 0, 21, 0xf, n>>2);
192 static inline u32 msg_size(struct tipc_msg *m)
194 return msg_bits(m, 0, 0, 0x1ffff);
197 static inline u32 msg_data_sz(struct tipc_msg *m)
199 return msg_size(m) - msg_hdr_sz(m);
202 static inline int msg_non_seq(struct tipc_msg *m)
204 return msg_bits(m, 0, 20, 1);
207 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
209 msg_set_bits(m, 0, 20, 1, n);
212 static inline int msg_dest_droppable(struct tipc_msg *m)
214 return msg_bits(m, 0, 19, 1);
217 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
219 msg_set_bits(m, 0, 19, 1, d);
222 static inline int msg_src_droppable(struct tipc_msg *m)
224 return msg_bits(m, 0, 18, 1);
227 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
229 msg_set_bits(m, 0, 18, 1, d);
232 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
234 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
241 static inline u32 msg_type(struct tipc_msg *m)
243 return msg_bits(m, 1, 29, 0x7);
246 static inline void msg_set_type(struct tipc_msg *m, u32 n)
248 msg_set_bits(m, 1, 29, 0x7, n);
251 static inline u32 msg_named(struct tipc_msg *m)
253 return msg_type(m) == TIPC_NAMED_MSG;
256 static inline u32 msg_mcast(struct tipc_msg *m)
258 return msg_type(m) == TIPC_MCAST_MSG;
261 static inline u32 msg_connected(struct tipc_msg *m)
263 return msg_type(m) == TIPC_CONN_MSG;
266 static inline u32 msg_errcode(struct tipc_msg *m)
268 return msg_bits(m, 1, 25, 0xf);
271 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
273 msg_set_bits(m, 1, 25, 0xf, err);
276 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
278 return msg_bits(m, 1, 21, 0xf);
281 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
283 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
286 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
288 msg_set_bits(m, 1, 21, 0xf, 0);
291 static inline u32 msg_lookup_scope(struct tipc_msg *m)
293 return msg_bits(m, 1, 19, 0x3);
296 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
298 msg_set_bits(m, 1, 19, 0x3, n);
301 static inline u32 msg_bcast_ack(struct tipc_msg *m)
303 return msg_bits(m, 1, 0, 0xffff);
306 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
308 msg_set_bits(m, 1, 0, 0xffff, n);
315 static inline u32 msg_ack(struct tipc_msg *m)
317 return msg_bits(m, 2, 16, 0xffff);
320 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
322 msg_set_bits(m, 2, 16, 0xffff, n);
325 static inline u32 msg_seqno(struct tipc_msg *m)
327 return msg_bits(m, 2, 0, 0xffff);
330 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
332 msg_set_bits(m, 2, 0, 0xffff, n);
338 static inline u32 msg_prevnode(struct tipc_msg *m)
340 return msg_word(m, 3);
343 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
345 msg_set_word(m, 3, a);
348 static inline u32 msg_origport(struct tipc_msg *m)
350 return msg_word(m, 4);
353 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
355 msg_set_word(m, 4, p);
358 static inline u32 msg_destport(struct tipc_msg *m)
360 return msg_word(m, 5);
363 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
365 msg_set_word(m, 5, p);
368 static inline u32 msg_mc_netid(struct tipc_msg *m)
370 return msg_word(m, 5);
373 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
375 msg_set_word(m, 5, p);
378 static inline int msg_short(struct tipc_msg *m)
380 return msg_hdr_sz(m) == SHORT_H_SIZE;
383 static inline u32 msg_orignode(struct tipc_msg *m)
385 if (likely(msg_short(m)))
386 return msg_prevnode(m);
387 return msg_word(m, 6);
390 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
392 msg_set_word(m, 6, a);
395 static inline u32 msg_destnode(struct tipc_msg *m)
397 return msg_word(m, 7);
400 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
402 msg_set_word(m, 7, a);
405 static inline u32 msg_nametype(struct tipc_msg *m)
407 return msg_word(m, 8);
410 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
412 msg_set_word(m, 8, n);
415 static inline u32 msg_nameinst(struct tipc_msg *m)
417 return msg_word(m, 9);
420 static inline u32 msg_namelower(struct tipc_msg *m)
422 return msg_nameinst(m);
425 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
427 msg_set_word(m, 9, n);
430 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
432 msg_set_namelower(m, n);
435 static inline u32 msg_nameupper(struct tipc_msg *m)
437 return msg_word(m, 10);
440 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
442 msg_set_word(m, 10, n);
445 static inline unchar *msg_data(struct tipc_msg *m)
447 return ((unchar *)m) + msg_hdr_sz(m);
450 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
452 return (struct tipc_msg *)msg_data(m);
456 * Constants and routines used to read and write TIPC internal message headers
460 * Internal message users
462 #define BCAST_PROTOCOL 5
463 #define MSG_BUNDLER 6
464 #define LINK_PROTOCOL 7
465 #define CONN_MANAGER 8
466 #define ROUTE_DISTRIBUTOR 9 /* obsoleted */
467 #define CHANGEOVER_PROTOCOL 10
468 #define NAME_DISTRIBUTOR 11
469 #define MSG_FRAGMENTER 12
470 #define LINK_CONFIG 13
471 #define SOCK_WAKEUP 14 /* pseudo user */
474 * Connection management protocol message types
477 #define CONN_PROBE_REPLY 1
481 * Name distributor message types
483 #define PUBLICATION 0
487 * Segmentation message types
489 #define FIRST_FRAGMENT 0
491 #define LAST_FRAGMENT 2
494 * Link management protocol message types
498 #define ACTIVATE_MSG 2
501 * Changeover tunnel message types
503 #define DUPLICATE_MSG 0
504 #define ORIGINAL_MSG 1
507 * Config protocol message types
509 #define DSC_REQ_MSG 0
510 #define DSC_RESP_MSG 1
516 static inline u32 msg_seq_gap(struct tipc_msg *m)
518 return msg_bits(m, 1, 16, 0x1fff);
521 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
523 msg_set_bits(m, 1, 16, 0x1fff, n);
526 static inline u32 msg_node_sig(struct tipc_msg *m)
528 return msg_bits(m, 1, 0, 0xffff);
531 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
533 msg_set_bits(m, 1, 0, 0xffff, n);
540 static inline u32 msg_dest_domain(struct tipc_msg *m)
542 return msg_word(m, 2);
545 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
547 msg_set_word(m, 2, n);
550 static inline u32 msg_bcgap_after(struct tipc_msg *m)
552 return msg_bits(m, 2, 16, 0xffff);
555 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
557 msg_set_bits(m, 2, 16, 0xffff, n);
560 static inline u32 msg_bcgap_to(struct tipc_msg *m)
562 return msg_bits(m, 2, 0, 0xffff);
565 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
567 msg_set_bits(m, 2, 0, 0xffff, n);
574 static inline u32 msg_last_bcast(struct tipc_msg *m)
576 return msg_bits(m, 4, 16, 0xffff);
579 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
581 msg_set_bits(m, 4, 16, 0xffff, n);
584 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
586 msg_set_bits(m, 4, 16, 0xffff, n);
590 static inline u32 msg_next_sent(struct tipc_msg *m)
592 return msg_bits(m, 4, 0, 0xffff);
595 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
597 msg_set_bits(m, 4, 0, 0xffff, n);
600 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
602 msg_set_bits(m, 4, 0, 0xffff, n);
605 static inline u32 msg_bc_netid(struct tipc_msg *m)
607 return msg_word(m, 4);
610 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
612 msg_set_word(m, 4, id);
615 static inline u32 msg_link_selector(struct tipc_msg *m)
617 return msg_bits(m, 4, 0, 1);
620 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
622 msg_set_bits(m, 4, 0, 1, n);
628 static inline u32 msg_session(struct tipc_msg *m)
630 return msg_bits(m, 5, 16, 0xffff);
633 static inline void msg_set_session(struct tipc_msg *m, u32 n)
635 msg_set_bits(m, 5, 16, 0xffff, n);
638 static inline u32 msg_probe(struct tipc_msg *m)
640 return msg_bits(m, 5, 0, 1);
643 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
645 msg_set_bits(m, 5, 0, 1, val);
648 static inline char msg_net_plane(struct tipc_msg *m)
650 return msg_bits(m, 5, 1, 7) + 'A';
653 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
655 msg_set_bits(m, 5, 1, 7, (n - 'A'));
658 static inline u32 msg_linkprio(struct tipc_msg *m)
660 return msg_bits(m, 5, 4, 0x1f);
663 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
665 msg_set_bits(m, 5, 4, 0x1f, n);
668 static inline u32 msg_bearer_id(struct tipc_msg *m)
670 return msg_bits(m, 5, 9, 0x7);
673 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
675 msg_set_bits(m, 5, 9, 0x7, n);
678 static inline u32 msg_redundant_link(struct tipc_msg *m)
680 return msg_bits(m, 5, 12, 0x1);
683 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
685 msg_set_bits(m, 5, 12, 0x1, r);
688 static inline char *msg_media_addr(struct tipc_msg *m)
690 return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
696 static inline u32 msg_msgcnt(struct tipc_msg *m)
698 return msg_bits(m, 9, 16, 0xffff);
701 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
703 msg_set_bits(m, 9, 16, 0xffff, n);
706 static inline u32 msg_bcast_tag(struct tipc_msg *m)
708 return msg_bits(m, 9, 16, 0xffff);
711 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
713 msg_set_bits(m, 9, 16, 0xffff, n);
716 static inline u32 msg_max_pkt(struct tipc_msg *m)
718 return msg_bits(m, 9, 16, 0xffff) * 4;
721 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
723 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
726 static inline u32 msg_link_tolerance(struct tipc_msg *m)
728 return msg_bits(m, 9, 0, 0xffff);
731 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
733 msg_set_bits(m, 9, 0, 0xffff, n);
736 static inline u32 tipc_msg_tot_importance(struct tipc_msg *m)
738 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
739 return msg_importance(msg_get_wrapped(m));
740 return msg_importance(m);
743 static inline u32 msg_tot_origport(struct tipc_msg *m)
745 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
746 return msg_origport(msg_get_wrapped(m));
747 return msg_origport(m);
750 struct sk_buff *tipc_buf_acquire(u32 size);
751 bool tipc_msg_reverse(u32 own_addr, struct sk_buff *buf, u32 *dnode,
753 int tipc_msg_eval(struct net *net, 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,
757 uint hdr_sz, uint data_sz, u32 dnode,
758 u32 onode, 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 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
764 int offset, int dsz, int mtu, struct sk_buff_head *list);
765 struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);