2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2007, 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
48 #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
62 #define TIPC_CONN_MSG 0
63 #define TIPC_MCAST_MSG 1
64 #define TIPC_NAMED_MSG 2
65 #define TIPC_DIRECT_MSG 3
68 * Message header sizes
71 #define SHORT_H_SIZE 24 /* In-cluster basic payload message */
72 #define BASIC_H_SIZE 32 /* Basic payload message */
73 #define NAMED_H_SIZE 40 /* Named payload message */
74 #define MCAST_H_SIZE 44 /* Multicast payload message */
75 #define INT_H_SIZE 40 /* Internal messages */
76 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
77 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
79 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
81 #define TIPC_MEDIA_ADDR_OFFSET 5
89 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
91 return ntohl(m->hdr[pos]);
94 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
96 m->hdr[w] = htonl(val);
99 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
101 return (msg_word(m, w) >> pos) & mask;
104 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
105 u32 pos, u32 mask, u32 val)
107 val = (val & mask) << pos;
109 m->hdr[w] &= ~htonl(mask);
110 m->hdr[w] |= htonl(val);
113 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
115 u32 temp = msg->hdr[a];
117 msg->hdr[a] = msg->hdr[b];
125 static inline u32 msg_version(struct tipc_msg *m)
127 return msg_bits(m, 0, 29, 7);
130 static inline void msg_set_version(struct tipc_msg *m)
132 msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
135 static inline u32 msg_user(struct tipc_msg *m)
137 return msg_bits(m, 0, 25, 0xf);
140 static inline u32 msg_isdata(struct tipc_msg *m)
142 return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
145 static inline void msg_set_user(struct tipc_msg *m, u32 n)
147 msg_set_bits(m, 0, 25, 0xf, n);
150 static inline u32 msg_importance(struct tipc_msg *m)
152 return msg_bits(m, 0, 25, 0xf);
155 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
160 static inline u32 msg_hdr_sz(struct tipc_msg *m)
162 return msg_bits(m, 0, 21, 0xf) << 2;
165 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
167 msg_set_bits(m, 0, 21, 0xf, n>>2);
170 static inline u32 msg_size(struct tipc_msg *m)
172 return msg_bits(m, 0, 0, 0x1ffff);
175 static inline u32 msg_data_sz(struct tipc_msg *m)
177 return msg_size(m) - msg_hdr_sz(m);
180 static inline int msg_non_seq(struct tipc_msg *m)
182 return msg_bits(m, 0, 20, 1);
185 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
187 msg_set_bits(m, 0, 20, 1, n);
190 static inline int msg_dest_droppable(struct tipc_msg *m)
192 return msg_bits(m, 0, 19, 1);
195 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
197 msg_set_bits(m, 0, 19, 1, d);
200 static inline int msg_src_droppable(struct tipc_msg *m)
202 return msg_bits(m, 0, 18, 1);
205 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
207 msg_set_bits(m, 0, 18, 1, d);
210 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
212 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
220 static inline u32 msg_type(struct tipc_msg *m)
222 return msg_bits(m, 1, 29, 0x7);
225 static inline void msg_set_type(struct tipc_msg *m, u32 n)
227 msg_set_bits(m, 1, 29, 0x7, n);
230 static inline u32 msg_named(struct tipc_msg *m)
232 return msg_type(m) == TIPC_NAMED_MSG;
235 static inline u32 msg_mcast(struct tipc_msg *m)
237 return msg_type(m) == TIPC_MCAST_MSG;
240 static inline u32 msg_connected(struct tipc_msg *m)
242 return msg_type(m) == TIPC_CONN_MSG;
245 static inline u32 msg_errcode(struct tipc_msg *m)
247 return msg_bits(m, 1, 25, 0xf);
250 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
252 msg_set_bits(m, 1, 25, 0xf, err);
255 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
257 return msg_bits(m, 1, 21, 0xf);
260 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
262 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
265 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
267 msg_set_bits(m, 1, 21, 0xf, 0);
270 static inline u32 msg_lookup_scope(struct tipc_msg *m)
272 return msg_bits(m, 1, 19, 0x3);
275 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
277 msg_set_bits(m, 1, 19, 0x3, n);
280 static inline u32 msg_bcast_ack(struct tipc_msg *m)
282 return msg_bits(m, 1, 0, 0xffff);
285 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
287 msg_set_bits(m, 1, 0, 0xffff, n);
295 static inline u32 msg_ack(struct tipc_msg *m)
297 return msg_bits(m, 2, 16, 0xffff);
300 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
302 msg_set_bits(m, 2, 16, 0xffff, n);
305 static inline u32 msg_seqno(struct tipc_msg *m)
307 return msg_bits(m, 2, 0, 0xffff);
310 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
312 msg_set_bits(m, 2, 0, 0xffff, n);
320 static inline u32 msg_prevnode(struct tipc_msg *m)
322 return msg_word(m, 3);
325 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
327 msg_set_word(m, 3, a);
330 static inline u32 msg_origport(struct tipc_msg *m)
332 return msg_word(m, 4);
335 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
337 msg_set_word(m, 4, p);
340 static inline u32 msg_destport(struct tipc_msg *m)
342 return msg_word(m, 5);
345 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
347 msg_set_word(m, 5, p);
350 static inline u32 msg_mc_netid(struct tipc_msg *m)
352 return msg_word(m, 5);
355 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
357 msg_set_word(m, 5, p);
360 static inline int msg_short(struct tipc_msg *m)
362 return msg_hdr_sz(m) == SHORT_H_SIZE;
365 static inline u32 msg_orignode(struct tipc_msg *m)
367 if (likely(msg_short(m)))
368 return msg_prevnode(m);
369 return msg_word(m, 6);
372 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
374 msg_set_word(m, 6, a);
377 static inline u32 msg_destnode(struct tipc_msg *m)
379 return msg_word(m, 7);
382 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
384 msg_set_word(m, 7, a);
387 static inline u32 msg_nametype(struct tipc_msg *m)
389 return msg_word(m, 8);
392 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
394 msg_set_word(m, 8, n);
397 static inline u32 msg_nameinst(struct tipc_msg *m)
399 return msg_word(m, 9);
402 static inline u32 msg_namelower(struct tipc_msg *m)
404 return msg_nameinst(m);
407 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
409 msg_set_word(m, 9, n);
412 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
414 msg_set_namelower(m, n);
417 static inline u32 msg_nameupper(struct tipc_msg *m)
419 return msg_word(m, 10);
422 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
424 msg_set_word(m, 10, n);
427 static inline unchar *msg_data(struct tipc_msg *m)
429 return ((unchar *)m) + msg_hdr_sz(m);
432 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
434 return (struct tipc_msg *)msg_data(m);
439 * Constants and routines used to read and write TIPC internal message headers
443 * Internal message users
446 #define BCAST_PROTOCOL 5
447 #define MSG_BUNDLER 6
448 #define LINK_PROTOCOL 7
449 #define CONN_MANAGER 8
450 #define ROUTE_DISTRIBUTOR 9 /* obsoleted */
451 #define CHANGEOVER_PROTOCOL 10
452 #define NAME_DISTRIBUTOR 11
453 #define MSG_FRAGMENTER 12
454 #define LINK_CONFIG 13
457 * Connection management protocol message types
461 #define CONN_PROBE_REPLY 1
465 * Name distributor message types
468 #define PUBLICATION 0
472 * Segmentation message types
475 #define FIRST_FRAGMENT 0
477 #define LAST_FRAGMENT 2
480 * Link management protocol message types
485 #define ACTIVATE_MSG 2
488 * Changeover tunnel message types
490 #define DUPLICATE_MSG 0
491 #define ORIGINAL_MSG 1
494 * Config protocol message types
497 #define DSC_REQ_MSG 0
498 #define DSC_RESP_MSG 1
505 static inline u32 msg_seq_gap(struct tipc_msg *m)
507 return msg_bits(m, 1, 16, 0x1fff);
510 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
512 msg_set_bits(m, 1, 16, 0x1fff, n);
515 static inline u32 msg_node_sig(struct tipc_msg *m)
517 return msg_bits(m, 1, 0, 0xffff);
520 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
522 msg_set_bits(m, 1, 0, 0xffff, n);
530 static inline u32 msg_dest_domain(struct tipc_msg *m)
532 return msg_word(m, 2);
535 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
537 msg_set_word(m, 2, n);
540 static inline u32 msg_bcgap_after(struct tipc_msg *m)
542 return msg_bits(m, 2, 16, 0xffff);
545 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
547 msg_set_bits(m, 2, 16, 0xffff, n);
550 static inline u32 msg_bcgap_to(struct tipc_msg *m)
552 return msg_bits(m, 2, 0, 0xffff);
555 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
557 msg_set_bits(m, 2, 0, 0xffff, n);
565 static inline u32 msg_last_bcast(struct tipc_msg *m)
567 return msg_bits(m, 4, 16, 0xffff);
570 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
572 msg_set_bits(m, 4, 16, 0xffff, n);
576 static inline u32 msg_fragm_no(struct tipc_msg *m)
578 return msg_bits(m, 4, 16, 0xffff);
581 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
583 msg_set_bits(m, 4, 16, 0xffff, n);
587 static inline u32 msg_next_sent(struct tipc_msg *m)
589 return msg_bits(m, 4, 0, 0xffff);
592 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
594 msg_set_bits(m, 4, 0, 0xffff, n);
598 static inline u32 msg_long_msgno(struct tipc_msg *m)
600 return msg_bits(m, 4, 0, 0xffff);
603 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
605 msg_set_bits(m, 4, 0, 0xffff, n);
608 static inline u32 msg_bc_netid(struct tipc_msg *m)
610 return msg_word(m, 4);
613 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
615 msg_set_word(m, 4, id);
618 static inline u32 msg_link_selector(struct tipc_msg *m)
620 return msg_bits(m, 4, 0, 1);
623 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
625 msg_set_bits(m, 4, 0, 1, n);
632 static inline u32 msg_session(struct tipc_msg *m)
634 return msg_bits(m, 5, 16, 0xffff);
637 static inline void msg_set_session(struct tipc_msg *m, u32 n)
639 msg_set_bits(m, 5, 16, 0xffff, n);
642 static inline u32 msg_probe(struct tipc_msg *m)
644 return msg_bits(m, 5, 0, 1);
647 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
649 msg_set_bits(m, 5, 0, 1, val);
652 static inline char msg_net_plane(struct tipc_msg *m)
654 return msg_bits(m, 5, 1, 7) + 'A';
657 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
659 msg_set_bits(m, 5, 1, 7, (n - 'A'));
662 static inline u32 msg_linkprio(struct tipc_msg *m)
664 return msg_bits(m, 5, 4, 0x1f);
667 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
669 msg_set_bits(m, 5, 4, 0x1f, n);
672 static inline u32 msg_bearer_id(struct tipc_msg *m)
674 return msg_bits(m, 5, 9, 0x7);
677 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
679 msg_set_bits(m, 5, 9, 0x7, n);
682 static inline u32 msg_redundant_link(struct tipc_msg *m)
684 return msg_bits(m, 5, 12, 0x1);
687 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
689 msg_set_bits(m, 5, 12, 0x1, r);
692 static inline char *msg_media_addr(struct tipc_msg *m)
694 return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
701 static inline u32 msg_msgcnt(struct tipc_msg *m)
703 return msg_bits(m, 9, 16, 0xffff);
706 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
708 msg_set_bits(m, 9, 16, 0xffff, n);
711 static inline u32 msg_bcast_tag(struct tipc_msg *m)
713 return msg_bits(m, 9, 16, 0xffff);
716 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
718 msg_set_bits(m, 9, 16, 0xffff, n);
721 static inline u32 msg_max_pkt(struct tipc_msg *m)
723 return msg_bits(m, 9, 16, 0xffff) * 4;
726 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
728 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
731 static inline u32 msg_link_tolerance(struct tipc_msg *m)
733 return msg_bits(m, 9, 0, 0xffff);
736 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
738 msg_set_bits(m, 9, 0, 0xffff, n);
741 u32 tipc_msg_tot_importance(struct tipc_msg *m);
742 void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type,
743 u32 hsize, u32 destnode);
744 int tipc_msg_build(struct tipc_msg *hdr, struct iovec const *msg_sect,
745 u32 num_sect, unsigned int total_len,
746 int max_size, int usrmem, struct sk_buff **buf);