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.
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
84 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
86 return ntohl(m->hdr[pos]);
89 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
91 m->hdr[w] = htonl(val);
94 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
96 return (msg_word(m, w) >> pos) & mask;
99 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
100 u32 pos, u32 mask, u32 val)
102 val = (val & mask) << pos;
104 m->hdr[w] &= ~htonl(mask);
105 m->hdr[w] |= htonl(val);
108 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
110 u32 temp = msg->hdr[a];
112 msg->hdr[a] = msg->hdr[b];
119 static inline u32 msg_version(struct tipc_msg *m)
121 return msg_bits(m, 0, 29, 7);
124 static inline void msg_set_version(struct tipc_msg *m)
126 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
129 static inline u32 msg_user(struct tipc_msg *m)
131 return msg_bits(m, 0, 25, 0xf);
134 static inline u32 msg_isdata(struct tipc_msg *m)
136 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
139 static inline void msg_set_user(struct tipc_msg *m, u32 n)
141 msg_set_bits(m, 0, 25, 0xf, n);
144 static inline u32 msg_importance(struct tipc_msg *m)
146 return msg_bits(m, 0, 25, 0xf);
149 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
154 static inline u32 msg_hdr_sz(struct tipc_msg *m)
156 return msg_bits(m, 0, 21, 0xf) << 2;
159 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
161 msg_set_bits(m, 0, 21, 0xf, n>>2);
164 static inline u32 msg_size(struct tipc_msg *m)
166 return msg_bits(m, 0, 0, 0x1ffff);
169 static inline u32 msg_data_sz(struct tipc_msg *m)
171 return msg_size(m) - msg_hdr_sz(m);
174 static inline int msg_non_seq(struct tipc_msg *m)
176 return msg_bits(m, 0, 20, 1);
179 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
181 msg_set_bits(m, 0, 20, 1, n);
184 static inline int msg_dest_droppable(struct tipc_msg *m)
186 return msg_bits(m, 0, 19, 1);
189 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
191 msg_set_bits(m, 0, 19, 1, d);
194 static inline int msg_src_droppable(struct tipc_msg *m)
196 return msg_bits(m, 0, 18, 1);
199 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
201 msg_set_bits(m, 0, 18, 1, d);
204 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
206 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
213 static inline u32 msg_type(struct tipc_msg *m)
215 return msg_bits(m, 1, 29, 0x7);
218 static inline void msg_set_type(struct tipc_msg *m, u32 n)
220 msg_set_bits(m, 1, 29, 0x7, n);
223 static inline u32 msg_named(struct tipc_msg *m)
225 return msg_type(m) == TIPC_NAMED_MSG;
228 static inline u32 msg_mcast(struct tipc_msg *m)
230 return msg_type(m) == TIPC_MCAST_MSG;
233 static inline u32 msg_connected(struct tipc_msg *m)
235 return msg_type(m) == TIPC_CONN_MSG;
238 static inline u32 msg_errcode(struct tipc_msg *m)
240 return msg_bits(m, 1, 25, 0xf);
243 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
245 msg_set_bits(m, 1, 25, 0xf, err);
248 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
250 return msg_bits(m, 1, 21, 0xf);
253 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
255 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
258 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
260 msg_set_bits(m, 1, 21, 0xf, 0);
263 static inline u32 msg_lookup_scope(struct tipc_msg *m)
265 return msg_bits(m, 1, 19, 0x3);
268 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
270 msg_set_bits(m, 1, 19, 0x3, n);
273 static inline u32 msg_bcast_ack(struct tipc_msg *m)
275 return msg_bits(m, 1, 0, 0xffff);
278 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
280 msg_set_bits(m, 1, 0, 0xffff, n);
287 static inline u32 msg_ack(struct tipc_msg *m)
289 return msg_bits(m, 2, 16, 0xffff);
292 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
294 msg_set_bits(m, 2, 16, 0xffff, n);
297 static inline u32 msg_seqno(struct tipc_msg *m)
299 return msg_bits(m, 2, 0, 0xffff);
302 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
304 msg_set_bits(m, 2, 0, 0xffff, n);
310 static inline u32 msg_prevnode(struct tipc_msg *m)
312 return msg_word(m, 3);
315 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
317 msg_set_word(m, 3, a);
320 static inline u32 msg_origport(struct tipc_msg *m)
322 return msg_word(m, 4);
325 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
327 msg_set_word(m, 4, p);
330 static inline u32 msg_destport(struct tipc_msg *m)
332 return msg_word(m, 5);
335 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
337 msg_set_word(m, 5, p);
340 static inline u32 msg_mc_netid(struct tipc_msg *m)
342 return msg_word(m, 5);
345 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
347 msg_set_word(m, 5, p);
350 static inline int msg_short(struct tipc_msg *m)
352 return msg_hdr_sz(m) == SHORT_H_SIZE;
355 static inline u32 msg_orignode(struct tipc_msg *m)
357 if (likely(msg_short(m)))
358 return msg_prevnode(m);
359 return msg_word(m, 6);
362 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
364 msg_set_word(m, 6, a);
367 static inline u32 msg_destnode(struct tipc_msg *m)
369 return msg_word(m, 7);
372 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
374 msg_set_word(m, 7, a);
377 static inline u32 msg_nametype(struct tipc_msg *m)
379 return msg_word(m, 8);
382 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
384 msg_set_word(m, 8, n);
387 static inline u32 msg_nameinst(struct tipc_msg *m)
389 return msg_word(m, 9);
392 static inline u32 msg_namelower(struct tipc_msg *m)
394 return msg_nameinst(m);
397 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
399 msg_set_word(m, 9, n);
402 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
404 msg_set_namelower(m, n);
407 static inline u32 msg_nameupper(struct tipc_msg *m)
409 return msg_word(m, 10);
412 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
414 msg_set_word(m, 10, n);
417 static inline unchar *msg_data(struct tipc_msg *m)
419 return ((unchar *)m) + msg_hdr_sz(m);
422 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
424 return (struct tipc_msg *)msg_data(m);
428 * Constants and routines used to read and write TIPC internal message headers
432 * Internal message users
434 #define BCAST_PROTOCOL 5
435 #define MSG_BUNDLER 6
436 #define LINK_PROTOCOL 7
437 #define CONN_MANAGER 8
438 #define ROUTE_DISTRIBUTOR 9 /* obsoleted */
439 #define CHANGEOVER_PROTOCOL 10
440 #define NAME_DISTRIBUTOR 11
441 #define MSG_FRAGMENTER 12
442 #define LINK_CONFIG 13
443 #define SOCK_WAKEUP 14 /* pseudo user */
446 * Connection management protocol message types
449 #define CONN_PROBE_REPLY 1
453 * Name distributor message types
455 #define PUBLICATION 0
459 * Segmentation message types
461 #define FIRST_FRAGMENT 0
463 #define LAST_FRAGMENT 2
466 * Link management protocol message types
470 #define ACTIVATE_MSG 2
473 * Changeover tunnel message types
475 #define DUPLICATE_MSG 0
476 #define ORIGINAL_MSG 1
479 * Config protocol message types
481 #define DSC_REQ_MSG 0
482 #define DSC_RESP_MSG 1
488 static inline u32 msg_seq_gap(struct tipc_msg *m)
490 return msg_bits(m, 1, 16, 0x1fff);
493 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
495 msg_set_bits(m, 1, 16, 0x1fff, n);
498 static inline u32 msg_node_sig(struct tipc_msg *m)
500 return msg_bits(m, 1, 0, 0xffff);
503 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
505 msg_set_bits(m, 1, 0, 0xffff, n);
512 static inline u32 msg_dest_domain(struct tipc_msg *m)
514 return msg_word(m, 2);
517 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
519 msg_set_word(m, 2, n);
522 static inline u32 msg_bcgap_after(struct tipc_msg *m)
524 return msg_bits(m, 2, 16, 0xffff);
527 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
529 msg_set_bits(m, 2, 16, 0xffff, n);
532 static inline u32 msg_bcgap_to(struct tipc_msg *m)
534 return msg_bits(m, 2, 0, 0xffff);
537 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
539 msg_set_bits(m, 2, 0, 0xffff, n);
546 static inline u32 msg_last_bcast(struct tipc_msg *m)
548 return msg_bits(m, 4, 16, 0xffff);
551 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
553 msg_set_bits(m, 4, 16, 0xffff, n);
556 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
558 msg_set_bits(m, 4, 16, 0xffff, n);
562 static inline u32 msg_next_sent(struct tipc_msg *m)
564 return msg_bits(m, 4, 0, 0xffff);
567 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
569 msg_set_bits(m, 4, 0, 0xffff, n);
572 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
574 msg_set_bits(m, 4, 0, 0xffff, n);
577 static inline u32 msg_bc_netid(struct tipc_msg *m)
579 return msg_word(m, 4);
582 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
584 msg_set_word(m, 4, id);
587 static inline u32 msg_link_selector(struct tipc_msg *m)
589 return msg_bits(m, 4, 0, 1);
592 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
594 msg_set_bits(m, 4, 0, 1, n);
600 static inline u32 msg_session(struct tipc_msg *m)
602 return msg_bits(m, 5, 16, 0xffff);
605 static inline void msg_set_session(struct tipc_msg *m, u32 n)
607 msg_set_bits(m, 5, 16, 0xffff, n);
610 static inline u32 msg_probe(struct tipc_msg *m)
612 return msg_bits(m, 5, 0, 1);
615 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
617 msg_set_bits(m, 5, 0, 1, val);
620 static inline char msg_net_plane(struct tipc_msg *m)
622 return msg_bits(m, 5, 1, 7) + 'A';
625 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
627 msg_set_bits(m, 5, 1, 7, (n - 'A'));
630 static inline u32 msg_linkprio(struct tipc_msg *m)
632 return msg_bits(m, 5, 4, 0x1f);
635 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
637 msg_set_bits(m, 5, 4, 0x1f, n);
640 static inline u32 msg_bearer_id(struct tipc_msg *m)
642 return msg_bits(m, 5, 9, 0x7);
645 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
647 msg_set_bits(m, 5, 9, 0x7, n);
650 static inline u32 msg_redundant_link(struct tipc_msg *m)
652 return msg_bits(m, 5, 12, 0x1);
655 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
657 msg_set_bits(m, 5, 12, 0x1, r);
660 static inline char *msg_media_addr(struct tipc_msg *m)
662 return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
668 static inline u32 msg_msgcnt(struct tipc_msg *m)
670 return msg_bits(m, 9, 16, 0xffff);
673 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
675 msg_set_bits(m, 9, 16, 0xffff, n);
678 static inline u32 msg_bcast_tag(struct tipc_msg *m)
680 return msg_bits(m, 9, 16, 0xffff);
683 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
685 msg_set_bits(m, 9, 16, 0xffff, n);
688 static inline u32 msg_max_pkt(struct tipc_msg *m)
690 return msg_bits(m, 9, 16, 0xffff) * 4;
693 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
695 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
698 static inline u32 msg_link_tolerance(struct tipc_msg *m)
700 return msg_bits(m, 9, 0, 0xffff);
703 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
705 msg_set_bits(m, 9, 0, 0xffff, n);
708 static inline u32 tipc_msg_tot_importance(struct tipc_msg *m)
710 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
711 return msg_importance(msg_get_wrapped(m));
712 return msg_importance(m);
715 static inline u32 msg_tot_origport(struct tipc_msg *m)
717 if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
718 return msg_origport(msg_get_wrapped(m));
719 return msg_origport(m);
722 bool tipc_msg_reverse(struct sk_buff *buf, u32 *dnode, int err);
724 int tipc_msg_eval(struct sk_buff *buf, u32 *dnode);
726 void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type, u32 hsize,
729 struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
730 uint data_sz, u32 dnode, u32 onode,
731 u32 dport, u32 oport, int errcode);
733 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
735 bool tipc_msg_bundle(struct sk_buff_head *list, struct sk_buff *skb, u32 mtu);
737 bool tipc_msg_make_bundle(struct sk_buff_head *list, struct sk_buff *skb,
740 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m, int offset,
741 int dsz, int mtu, struct sk_buff_head *list);
743 struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);