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)
87 static inline u32
msg_word(struct tipc_msg
*m
, u32 pos
)
89 return ntohl(m
->hdr
[pos
]);
92 static inline void msg_set_word(struct tipc_msg
*m
, u32 w
, u32 val
)
94 m
->hdr
[w
] = htonl(val
);
97 static inline u32
msg_bits(struct tipc_msg
*m
, u32 w
, u32 pos
, u32 mask
)
99 return (msg_word(m
, w
) >> pos
) & mask
;
102 static inline void msg_set_bits(struct tipc_msg
*m
, u32 w
,
103 u32 pos
, u32 mask
, u32 val
)
105 val
= (val
& mask
) << pos
;
107 m
->hdr
[w
] &= ~htonl(mask
);
108 m
->hdr
[w
] |= htonl(val
);
111 static inline void msg_swap_words(struct tipc_msg
*msg
, u32 a
, u32 b
)
113 u32 temp
= msg
->hdr
[a
];
115 msg
->hdr
[a
] = msg
->hdr
[b
];
123 static inline u32
msg_version(struct tipc_msg
*m
)
125 return msg_bits(m
, 0, 29, 7);
128 static inline void msg_set_version(struct tipc_msg
*m
)
130 msg_set_bits(m
, 0, 29, 7, TIPC_VERSION
);
133 static inline u32
msg_user(struct tipc_msg
*m
)
135 return msg_bits(m
, 0, 25, 0xf);
138 static inline u32
msg_isdata(struct tipc_msg
*m
)
140 return msg_user(m
) <= TIPC_CRITICAL_IMPORTANCE
;
143 static inline void msg_set_user(struct tipc_msg
*m
, u32 n
)
145 msg_set_bits(m
, 0, 25, 0xf, n
);
148 static inline u32
msg_importance(struct tipc_msg
*m
)
150 return msg_bits(m
, 0, 25, 0xf);
153 static inline void msg_set_importance(struct tipc_msg
*m
, u32 i
)
158 static inline u32
msg_hdr_sz(struct tipc_msg
*m
)
160 return msg_bits(m
, 0, 21, 0xf) << 2;
163 static inline void msg_set_hdr_sz(struct tipc_msg
*m
, u32 n
)
165 msg_set_bits(m
, 0, 21, 0xf, n
>>2);
168 static inline u32
msg_size(struct tipc_msg
*m
)
170 return msg_bits(m
, 0, 0, 0x1ffff);
173 static inline u32
msg_data_sz(struct tipc_msg
*m
)
175 return msg_size(m
) - msg_hdr_sz(m
);
178 static inline int msg_non_seq(struct tipc_msg
*m
)
180 return msg_bits(m
, 0, 20, 1);
183 static inline void msg_set_non_seq(struct tipc_msg
*m
, u32 n
)
185 msg_set_bits(m
, 0, 20, 1, n
);
188 static inline int msg_dest_droppable(struct tipc_msg
*m
)
190 return msg_bits(m
, 0, 19, 1);
193 static inline void msg_set_dest_droppable(struct tipc_msg
*m
, u32 d
)
195 msg_set_bits(m
, 0, 19, 1, d
);
198 static inline int msg_src_droppable(struct tipc_msg
*m
)
200 return msg_bits(m
, 0, 18, 1);
203 static inline void msg_set_src_droppable(struct tipc_msg
*m
, u32 d
)
205 msg_set_bits(m
, 0, 18, 1, d
);
208 static inline void msg_set_size(struct tipc_msg
*m
, u32 sz
)
210 m
->hdr
[0] = htonl((msg_word(m
, 0) & ~0x1ffff) | sz
);
218 static inline u32
msg_type(struct tipc_msg
*m
)
220 return msg_bits(m
, 1, 29, 0x7);
223 static inline void msg_set_type(struct tipc_msg
*m
, u32 n
)
225 msg_set_bits(m
, 1, 29, 0x7, n
);
228 static inline u32
msg_named(struct tipc_msg
*m
)
230 return msg_type(m
) == TIPC_NAMED_MSG
;
233 static inline u32
msg_mcast(struct tipc_msg
*m
)
235 return msg_type(m
) == TIPC_MCAST_MSG
;
238 static inline u32
msg_connected(struct tipc_msg
*m
)
240 return msg_type(m
) == TIPC_CONN_MSG
;
243 static inline u32
msg_errcode(struct tipc_msg
*m
)
245 return msg_bits(m
, 1, 25, 0xf);
248 static inline void msg_set_errcode(struct tipc_msg
*m
, u32 err
)
250 msg_set_bits(m
, 1, 25, 0xf, err
);
253 static inline u32
msg_reroute_cnt(struct tipc_msg
*m
)
255 return msg_bits(m
, 1, 21, 0xf);
258 static inline void msg_incr_reroute_cnt(struct tipc_msg
*m
)
260 msg_set_bits(m
, 1, 21, 0xf, msg_reroute_cnt(m
) + 1);
263 static inline void msg_reset_reroute_cnt(struct tipc_msg
*m
)
265 msg_set_bits(m
, 1, 21, 0xf, 0);
268 static inline u32
msg_lookup_scope(struct tipc_msg
*m
)
270 return msg_bits(m
, 1, 19, 0x3);
273 static inline void msg_set_lookup_scope(struct tipc_msg
*m
, u32 n
)
275 msg_set_bits(m
, 1, 19, 0x3, n
);
278 static inline u32
msg_bcast_ack(struct tipc_msg
*m
)
280 return msg_bits(m
, 1, 0, 0xffff);
283 static inline void msg_set_bcast_ack(struct tipc_msg
*m
, u32 n
)
285 msg_set_bits(m
, 1, 0, 0xffff, n
);
293 static inline u32
msg_ack(struct tipc_msg
*m
)
295 return msg_bits(m
, 2, 16, 0xffff);
298 static inline void msg_set_ack(struct tipc_msg
*m
, u32 n
)
300 msg_set_bits(m
, 2, 16, 0xffff, n
);
303 static inline u32
msg_seqno(struct tipc_msg
*m
)
305 return msg_bits(m
, 2, 0, 0xffff);
308 static inline void msg_set_seqno(struct tipc_msg
*m
, u32 n
)
310 msg_set_bits(m
, 2, 0, 0xffff, n
);
318 static inline u32
msg_prevnode(struct tipc_msg
*m
)
320 return msg_word(m
, 3);
323 static inline void msg_set_prevnode(struct tipc_msg
*m
, u32 a
)
325 msg_set_word(m
, 3, a
);
328 static inline u32
msg_origport(struct tipc_msg
*m
)
330 return msg_word(m
, 4);
333 static inline void msg_set_origport(struct tipc_msg
*m
, u32 p
)
335 msg_set_word(m
, 4, p
);
338 static inline u32
msg_destport(struct tipc_msg
*m
)
340 return msg_word(m
, 5);
343 static inline void msg_set_destport(struct tipc_msg
*m
, u32 p
)
345 msg_set_word(m
, 5, p
);
348 static inline u32
msg_mc_netid(struct tipc_msg
*m
)
350 return msg_word(m
, 5);
353 static inline void msg_set_mc_netid(struct tipc_msg
*m
, u32 p
)
355 msg_set_word(m
, 5, p
);
358 static inline int msg_short(struct tipc_msg
*m
)
360 return msg_hdr_sz(m
) == SHORT_H_SIZE
;
363 static inline u32
msg_orignode(struct tipc_msg
*m
)
365 if (likely(msg_short(m
)))
366 return msg_prevnode(m
);
367 return msg_word(m
, 6);
370 static inline void msg_set_orignode(struct tipc_msg
*m
, u32 a
)
372 msg_set_word(m
, 6, a
);
375 static inline u32
msg_destnode(struct tipc_msg
*m
)
377 return msg_word(m
, 7);
380 static inline void msg_set_destnode(struct tipc_msg
*m
, u32 a
)
382 msg_set_word(m
, 7, a
);
385 static inline int msg_is_dest(struct tipc_msg
*m
, u32 d
)
387 return msg_short(m
) || (msg_destnode(m
) == d
);
390 static inline u32
msg_nametype(struct tipc_msg
*m
)
392 return msg_word(m
, 8);
395 static inline void msg_set_nametype(struct tipc_msg
*m
, u32 n
)
397 msg_set_word(m
, 8, n
);
400 static inline u32
msg_nameinst(struct tipc_msg
*m
)
402 return msg_word(m
, 9);
405 static inline u32
msg_namelower(struct tipc_msg
*m
)
407 return msg_nameinst(m
);
410 static inline void msg_set_namelower(struct tipc_msg
*m
, u32 n
)
412 msg_set_word(m
, 9, n
);
415 static inline void msg_set_nameinst(struct tipc_msg
*m
, u32 n
)
417 msg_set_namelower(m
, n
);
420 static inline u32
msg_nameupper(struct tipc_msg
*m
)
422 return msg_word(m
, 10);
425 static inline void msg_set_nameupper(struct tipc_msg
*m
, u32 n
)
427 msg_set_word(m
, 10, n
);
430 static inline unchar
*msg_data(struct tipc_msg
*m
)
432 return ((unchar
*)m
) + msg_hdr_sz(m
);
435 static inline struct tipc_msg
*msg_get_wrapped(struct tipc_msg
*m
)
437 return (struct tipc_msg
*)msg_data(m
);
442 * Constants and routines used to read and write TIPC internal message headers
446 * Internal message users
449 #define BCAST_PROTOCOL 5
450 #define MSG_BUNDLER 6
451 #define LINK_PROTOCOL 7
452 #define CONN_MANAGER 8
453 #define ROUTE_DISTRIBUTOR 9 /* obsoleted */
454 #define CHANGEOVER_PROTOCOL 10
455 #define NAME_DISTRIBUTOR 11
456 #define MSG_FRAGMENTER 12
457 #define LINK_CONFIG 13
460 * Connection management protocol message types
464 #define CONN_PROBE_REPLY 1
468 * Name distributor message types
471 #define PUBLICATION 0
475 * Segmentation message types
478 #define FIRST_FRAGMENT 0
480 #define LAST_FRAGMENT 2
483 * Link management protocol message types
488 #define ACTIVATE_MSG 2
491 * Changeover tunnel message types
493 #define DUPLICATE_MSG 0
494 #define ORIGINAL_MSG 1
497 * Config protocol message types
500 #define DSC_REQ_MSG 0
501 #define DSC_RESP_MSG 1
508 static inline u32
msg_seq_gap(struct tipc_msg
*m
)
510 return msg_bits(m
, 1, 16, 0x1fff);
513 static inline void msg_set_seq_gap(struct tipc_msg
*m
, u32 n
)
515 msg_set_bits(m
, 1, 16, 0x1fff, n
);
523 static inline u32
msg_dest_domain(struct tipc_msg
*m
)
525 return msg_word(m
, 2);
528 static inline void msg_set_dest_domain(struct tipc_msg
*m
, u32 n
)
530 msg_set_word(m
, 2, n
);
533 static inline u32
msg_bcgap_after(struct tipc_msg
*m
)
535 return msg_bits(m
, 2, 16, 0xffff);
538 static inline void msg_set_bcgap_after(struct tipc_msg
*m
, u32 n
)
540 msg_set_bits(m
, 2, 16, 0xffff, n
);
543 static inline u32
msg_bcgap_to(struct tipc_msg
*m
)
545 return msg_bits(m
, 2, 0, 0xffff);
548 static inline void msg_set_bcgap_to(struct tipc_msg
*m
, u32 n
)
550 msg_set_bits(m
, 2, 0, 0xffff, n
);
558 static inline u32
msg_last_bcast(struct tipc_msg
*m
)
560 return msg_bits(m
, 4, 16, 0xffff);
563 static inline void msg_set_last_bcast(struct tipc_msg
*m
, u32 n
)
565 msg_set_bits(m
, 4, 16, 0xffff, n
);
569 static inline u32
msg_fragm_no(struct tipc_msg
*m
)
571 return msg_bits(m
, 4, 16, 0xffff);
574 static inline void msg_set_fragm_no(struct tipc_msg
*m
, u32 n
)
576 msg_set_bits(m
, 4, 16, 0xffff, n
);
580 static inline u32
msg_next_sent(struct tipc_msg
*m
)
582 return msg_bits(m
, 4, 0, 0xffff);
585 static inline void msg_set_next_sent(struct tipc_msg
*m
, u32 n
)
587 msg_set_bits(m
, 4, 0, 0xffff, n
);
591 static inline u32
msg_long_msgno(struct tipc_msg
*m
)
593 return msg_bits(m
, 4, 0, 0xffff);
596 static inline void msg_set_long_msgno(struct tipc_msg
*m
, u32 n
)
598 msg_set_bits(m
, 4, 0, 0xffff, n
);
601 static inline u32
msg_bc_netid(struct tipc_msg
*m
)
603 return msg_word(m
, 4);
606 static inline void msg_set_bc_netid(struct tipc_msg
*m
, u32 id
)
608 msg_set_word(m
, 4, id
);
611 static inline u32
msg_link_selector(struct tipc_msg
*m
)
613 return msg_bits(m
, 4, 0, 1);
616 static inline void msg_set_link_selector(struct tipc_msg
*m
, u32 n
)
618 msg_set_bits(m
, 4, 0, 1, n
);
625 static inline u32
msg_session(struct tipc_msg
*m
)
627 return msg_bits(m
, 5, 16, 0xffff);
630 static inline void msg_set_session(struct tipc_msg
*m
, u32 n
)
632 msg_set_bits(m
, 5, 16, 0xffff, n
);
635 static inline u32
msg_probe(struct tipc_msg
*m
)
637 return msg_bits(m
, 5, 0, 1);
640 static inline void msg_set_probe(struct tipc_msg
*m
, u32 val
)
642 msg_set_bits(m
, 5, 0, 1, val
);
645 static inline char msg_net_plane(struct tipc_msg
*m
)
647 return msg_bits(m
, 5, 1, 7) + 'A';
650 static inline void msg_set_net_plane(struct tipc_msg
*m
, char n
)
652 msg_set_bits(m
, 5, 1, 7, (n
- 'A'));
655 static inline u32
msg_linkprio(struct tipc_msg
*m
)
657 return msg_bits(m
, 5, 4, 0x1f);
660 static inline void msg_set_linkprio(struct tipc_msg
*m
, u32 n
)
662 msg_set_bits(m
, 5, 4, 0x1f, n
);
665 static inline u32
msg_bearer_id(struct tipc_msg
*m
)
667 return msg_bits(m
, 5, 9, 0x7);
670 static inline void msg_set_bearer_id(struct tipc_msg
*m
, u32 n
)
672 msg_set_bits(m
, 5, 9, 0x7, n
);
675 static inline u32
msg_redundant_link(struct tipc_msg
*m
)
677 return msg_bits(m
, 5, 12, 0x1);
680 static inline void msg_set_redundant_link(struct tipc_msg
*m
, u32 r
)
682 msg_set_bits(m
, 5, 12, 0x1, r
);
690 static inline u32
msg_msgcnt(struct tipc_msg
*m
)
692 return msg_bits(m
, 9, 16, 0xffff);
695 static inline void msg_set_msgcnt(struct tipc_msg
*m
, u32 n
)
697 msg_set_bits(m
, 9, 16, 0xffff, n
);
700 static inline u32
msg_bcast_tag(struct tipc_msg
*m
)
702 return msg_bits(m
, 9, 16, 0xffff);
705 static inline void msg_set_bcast_tag(struct tipc_msg
*m
, u32 n
)
707 msg_set_bits(m
, 9, 16, 0xffff, n
);
710 static inline u32
msg_max_pkt(struct tipc_msg
*m
)
712 return msg_bits(m
, 9, 16, 0xffff) * 4;
715 static inline void msg_set_max_pkt(struct tipc_msg
*m
, u32 n
)
717 msg_set_bits(m
, 9, 16, 0xffff, (n
/ 4));
720 static inline u32
msg_link_tolerance(struct tipc_msg
*m
)
722 return msg_bits(m
, 9, 0, 0xffff);
725 static inline void msg_set_link_tolerance(struct tipc_msg
*m
, u32 n
)
727 msg_set_bits(m
, 9, 0, 0xffff, n
);
730 u32
tipc_msg_tot_importance(struct tipc_msg
*m
);
731 void tipc_msg_init(struct tipc_msg
*m
, u32 user
, u32 type
,
732 u32 hsize
, u32 destnode
);
733 int tipc_msg_build(struct tipc_msg
*hdr
, struct iovec
const *msg_sect
,
734 u32 num_sect
, unsigned int total_len
,
735 int max_size
, int usrmem
, struct sk_buff
**buf
);
737 static inline void msg_set_media_addr(struct tipc_msg
*m
, struct tipc_media_addr
*a
)
739 memcpy(&((int *)m
)[5], a
, sizeof(*a
));
742 static inline void msg_get_media_addr(struct tipc_msg
*m
, struct tipc_media_addr
*a
)
744 memcpy(a
, &((int *)m
)[5], sizeof(*a
));