0ea7b695ac4d891a7556ae2f08110d11306369f9
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
86 static inline u32
msg_word(struct tipc_msg
*m
, u32 pos
)
88 return ntohl(m
->hdr
[pos
]);
91 static inline void msg_set_word(struct tipc_msg
*m
, u32 w
, u32 val
)
93 m
->hdr
[w
] = htonl(val
);
96 static inline u32
msg_bits(struct tipc_msg
*m
, u32 w
, u32 pos
, u32 mask
)
98 return (msg_word(m
, w
) >> pos
) & mask
;
101 static inline void msg_set_bits(struct tipc_msg
*m
, u32 w
,
102 u32 pos
, u32 mask
, u32 val
)
104 val
= (val
& mask
) << pos
;
106 m
->hdr
[w
] &= ~htonl(mask
);
107 m
->hdr
[w
] |= htonl(val
);
110 static inline void msg_swap_words(struct tipc_msg
*msg
, u32 a
, u32 b
)
112 u32 temp
= msg
->hdr
[a
];
114 msg
->hdr
[a
] = msg
->hdr
[b
];
121 static inline u32
msg_version(struct tipc_msg
*m
)
123 return msg_bits(m
, 0, 29, 7);
126 static inline void msg_set_version(struct tipc_msg
*m
)
128 msg_set_bits(m
, 0, 29, 7, TIPC_VERSION
);
131 static inline u32
msg_user(struct tipc_msg
*m
)
133 return msg_bits(m
, 0, 25, 0xf);
136 static inline u32
msg_isdata(struct tipc_msg
*m
)
138 return msg_user(m
) <= TIPC_CRITICAL_IMPORTANCE
;
141 static inline void msg_set_user(struct tipc_msg
*m
, u32 n
)
143 msg_set_bits(m
, 0, 25, 0xf, n
);
146 static inline u32
msg_importance(struct tipc_msg
*m
)
148 return msg_bits(m
, 0, 25, 0xf);
151 static inline void msg_set_importance(struct tipc_msg
*m
, u32 i
)
156 static inline u32
msg_hdr_sz(struct tipc_msg
*m
)
158 return msg_bits(m
, 0, 21, 0xf) << 2;
161 static inline void msg_set_hdr_sz(struct tipc_msg
*m
, u32 n
)
163 msg_set_bits(m
, 0, 21, 0xf, n
>>2);
166 static inline u32
msg_size(struct tipc_msg
*m
)
168 return msg_bits(m
, 0, 0, 0x1ffff);
171 static inline u32
msg_data_sz(struct tipc_msg
*m
)
173 return msg_size(m
) - msg_hdr_sz(m
);
176 static inline int msg_non_seq(struct tipc_msg
*m
)
178 return msg_bits(m
, 0, 20, 1);
181 static inline void msg_set_non_seq(struct tipc_msg
*m
, u32 n
)
183 msg_set_bits(m
, 0, 20, 1, n
);
186 static inline int msg_dest_droppable(struct tipc_msg
*m
)
188 return msg_bits(m
, 0, 19, 1);
191 static inline void msg_set_dest_droppable(struct tipc_msg
*m
, u32 d
)
193 msg_set_bits(m
, 0, 19, 1, d
);
196 static inline int msg_src_droppable(struct tipc_msg
*m
)
198 return msg_bits(m
, 0, 18, 1);
201 static inline void msg_set_src_droppable(struct tipc_msg
*m
, u32 d
)
203 msg_set_bits(m
, 0, 18, 1, d
);
206 static inline void msg_set_size(struct tipc_msg
*m
, u32 sz
)
208 m
->hdr
[0] = htonl((msg_word(m
, 0) & ~0x1ffff) | sz
);
215 static inline u32
msg_type(struct tipc_msg
*m
)
217 return msg_bits(m
, 1, 29, 0x7);
220 static inline void msg_set_type(struct tipc_msg
*m
, u32 n
)
222 msg_set_bits(m
, 1, 29, 0x7, n
);
225 static inline u32
msg_named(struct tipc_msg
*m
)
227 return msg_type(m
) == TIPC_NAMED_MSG
;
230 static inline u32
msg_mcast(struct tipc_msg
*m
)
232 return msg_type(m
) == TIPC_MCAST_MSG
;
235 static inline u32
msg_connected(struct tipc_msg
*m
)
237 return msg_type(m
) == TIPC_CONN_MSG
;
240 static inline u32
msg_errcode(struct tipc_msg
*m
)
242 return msg_bits(m
, 1, 25, 0xf);
245 static inline void msg_set_errcode(struct tipc_msg
*m
, u32 err
)
247 msg_set_bits(m
, 1, 25, 0xf, err
);
250 static inline u32
msg_reroute_cnt(struct tipc_msg
*m
)
252 return msg_bits(m
, 1, 21, 0xf);
255 static inline void msg_incr_reroute_cnt(struct tipc_msg
*m
)
257 msg_set_bits(m
, 1, 21, 0xf, msg_reroute_cnt(m
) + 1);
260 static inline void msg_reset_reroute_cnt(struct tipc_msg
*m
)
262 msg_set_bits(m
, 1, 21, 0xf, 0);
265 static inline u32
msg_lookup_scope(struct tipc_msg
*m
)
267 return msg_bits(m
, 1, 19, 0x3);
270 static inline void msg_set_lookup_scope(struct tipc_msg
*m
, u32 n
)
272 msg_set_bits(m
, 1, 19, 0x3, n
);
275 static inline u32
msg_bcast_ack(struct tipc_msg
*m
)
277 return msg_bits(m
, 1, 0, 0xffff);
280 static inline void msg_set_bcast_ack(struct tipc_msg
*m
, u32 n
)
282 msg_set_bits(m
, 1, 0, 0xffff, n
);
289 static inline u32
msg_ack(struct tipc_msg
*m
)
291 return msg_bits(m
, 2, 16, 0xffff);
294 static inline void msg_set_ack(struct tipc_msg
*m
, u32 n
)
296 msg_set_bits(m
, 2, 16, 0xffff, n
);
299 static inline u32
msg_seqno(struct tipc_msg
*m
)
301 return msg_bits(m
, 2, 0, 0xffff);
304 static inline void msg_set_seqno(struct tipc_msg
*m
, u32 n
)
306 msg_set_bits(m
, 2, 0, 0xffff, n
);
312 static inline u32
msg_prevnode(struct tipc_msg
*m
)
314 return msg_word(m
, 3);
317 static inline void msg_set_prevnode(struct tipc_msg
*m
, u32 a
)
319 msg_set_word(m
, 3, a
);
322 static inline u32
msg_origport(struct tipc_msg
*m
)
324 return msg_word(m
, 4);
327 static inline void msg_set_origport(struct tipc_msg
*m
, u32 p
)
329 msg_set_word(m
, 4, p
);
332 static inline u32
msg_destport(struct tipc_msg
*m
)
334 return msg_word(m
, 5);
337 static inline void msg_set_destport(struct tipc_msg
*m
, u32 p
)
339 msg_set_word(m
, 5, p
);
342 static inline u32
msg_mc_netid(struct tipc_msg
*m
)
344 return msg_word(m
, 5);
347 static inline void msg_set_mc_netid(struct tipc_msg
*m
, u32 p
)
349 msg_set_word(m
, 5, p
);
352 static inline int msg_short(struct tipc_msg
*m
)
354 return msg_hdr_sz(m
) == SHORT_H_SIZE
;
357 static inline u32
msg_orignode(struct tipc_msg
*m
)
359 if (likely(msg_short(m
)))
360 return msg_prevnode(m
);
361 return msg_word(m
, 6);
364 static inline void msg_set_orignode(struct tipc_msg
*m
, u32 a
)
366 msg_set_word(m
, 6, a
);
369 static inline u32
msg_destnode(struct tipc_msg
*m
)
371 return msg_word(m
, 7);
374 static inline void msg_set_destnode(struct tipc_msg
*m
, u32 a
)
376 msg_set_word(m
, 7, a
);
379 static inline u32
msg_nametype(struct tipc_msg
*m
)
381 return msg_word(m
, 8);
384 static inline void msg_set_nametype(struct tipc_msg
*m
, u32 n
)
386 msg_set_word(m
, 8, n
);
389 static inline u32
msg_nameinst(struct tipc_msg
*m
)
391 return msg_word(m
, 9);
394 static inline u32
msg_namelower(struct tipc_msg
*m
)
396 return msg_nameinst(m
);
399 static inline void msg_set_namelower(struct tipc_msg
*m
, u32 n
)
401 msg_set_word(m
, 9, n
);
404 static inline void msg_set_nameinst(struct tipc_msg
*m
, u32 n
)
406 msg_set_namelower(m
, n
);
409 static inline u32
msg_nameupper(struct tipc_msg
*m
)
411 return msg_word(m
, 10);
414 static inline void msg_set_nameupper(struct tipc_msg
*m
, u32 n
)
416 msg_set_word(m
, 10, n
);
419 static inline unchar
*msg_data(struct tipc_msg
*m
)
421 return ((unchar
*)m
) + msg_hdr_sz(m
);
424 static inline struct tipc_msg
*msg_get_wrapped(struct tipc_msg
*m
)
426 return (struct tipc_msg
*)msg_data(m
);
430 * Constants and routines used to read and write TIPC internal message headers
434 * Internal message users
436 #define BCAST_PROTOCOL 5
437 #define MSG_BUNDLER 6
438 #define LINK_PROTOCOL 7
439 #define CONN_MANAGER 8
440 #define ROUTE_DISTRIBUTOR 9 /* obsoleted */
441 #define CHANGEOVER_PROTOCOL 10
442 #define NAME_DISTRIBUTOR 11
443 #define MSG_FRAGMENTER 12
444 #define LINK_CONFIG 13
445 #define SOCK_WAKEUP 14 /* pseudo user */
448 * Connection management protocol message types
451 #define CONN_PROBE_REPLY 1
455 * Name distributor message types
457 #define PUBLICATION 0
461 * Segmentation message types
463 #define FIRST_FRAGMENT 0
465 #define LAST_FRAGMENT 2
467 /* Bundling protocol message types
469 #define BUNDLE_OPEN 0
470 #define BUNDLE_CLOSED 1
473 * Link management protocol message types
477 #define ACTIVATE_MSG 2
480 * Changeover tunnel message types
482 #define DUPLICATE_MSG 0
483 #define ORIGINAL_MSG 1
486 * Config protocol message types
488 #define DSC_REQ_MSG 0
489 #define DSC_RESP_MSG 1
495 static inline u32
msg_seq_gap(struct tipc_msg
*m
)
497 return msg_bits(m
, 1, 16, 0x1fff);
500 static inline void msg_set_seq_gap(struct tipc_msg
*m
, u32 n
)
502 msg_set_bits(m
, 1, 16, 0x1fff, n
);
505 static inline u32
msg_node_sig(struct tipc_msg
*m
)
507 return msg_bits(m
, 1, 0, 0xffff);
510 static inline void msg_set_node_sig(struct tipc_msg
*m
, u32 n
)
512 msg_set_bits(m
, 1, 0, 0xffff, n
);
519 static inline u32
msg_dest_domain(struct tipc_msg
*m
)
521 return msg_word(m
, 2);
524 static inline void msg_set_dest_domain(struct tipc_msg
*m
, u32 n
)
526 msg_set_word(m
, 2, n
);
529 static inline u32
msg_bcgap_after(struct tipc_msg
*m
)
531 return msg_bits(m
, 2, 16, 0xffff);
534 static inline void msg_set_bcgap_after(struct tipc_msg
*m
, u32 n
)
536 msg_set_bits(m
, 2, 16, 0xffff, n
);
539 static inline u32
msg_bcgap_to(struct tipc_msg
*m
)
541 return msg_bits(m
, 2, 0, 0xffff);
544 static inline void msg_set_bcgap_to(struct tipc_msg
*m
, u32 n
)
546 msg_set_bits(m
, 2, 0, 0xffff, n
);
553 static inline u32
msg_last_bcast(struct tipc_msg
*m
)
555 return msg_bits(m
, 4, 16, 0xffff);
558 static inline void msg_set_last_bcast(struct tipc_msg
*m
, u32 n
)
560 msg_set_bits(m
, 4, 16, 0xffff, n
);
563 static inline void msg_set_fragm_no(struct tipc_msg
*m
, u32 n
)
565 msg_set_bits(m
, 4, 16, 0xffff, n
);
569 static inline u32
msg_next_sent(struct tipc_msg
*m
)
571 return msg_bits(m
, 4, 0, 0xffff);
574 static inline void msg_set_next_sent(struct tipc_msg
*m
, u32 n
)
576 msg_set_bits(m
, 4, 0, 0xffff, n
);
579 static inline void msg_set_long_msgno(struct tipc_msg
*m
, u32 n
)
581 msg_set_bits(m
, 4, 0, 0xffff, n
);
584 static inline u32
msg_bc_netid(struct tipc_msg
*m
)
586 return msg_word(m
, 4);
589 static inline void msg_set_bc_netid(struct tipc_msg
*m
, u32 id
)
591 msg_set_word(m
, 4, id
);
594 static inline u32
msg_link_selector(struct tipc_msg
*m
)
596 return msg_bits(m
, 4, 0, 1);
599 static inline void msg_set_link_selector(struct tipc_msg
*m
, u32 n
)
601 msg_set_bits(m
, 4, 0, 1, n
);
607 static inline u32
msg_session(struct tipc_msg
*m
)
609 return msg_bits(m
, 5, 16, 0xffff);
612 static inline void msg_set_session(struct tipc_msg
*m
, u32 n
)
614 msg_set_bits(m
, 5, 16, 0xffff, n
);
617 static inline u32
msg_probe(struct tipc_msg
*m
)
619 return msg_bits(m
, 5, 0, 1);
622 static inline void msg_set_probe(struct tipc_msg
*m
, u32 val
)
624 msg_set_bits(m
, 5, 0, 1, val
);
627 static inline char msg_net_plane(struct tipc_msg
*m
)
629 return msg_bits(m
, 5, 1, 7) + 'A';
632 static inline void msg_set_net_plane(struct tipc_msg
*m
, char n
)
634 msg_set_bits(m
, 5, 1, 7, (n
- 'A'));
637 static inline u32
msg_linkprio(struct tipc_msg
*m
)
639 return msg_bits(m
, 5, 4, 0x1f);
642 static inline void msg_set_linkprio(struct tipc_msg
*m
, u32 n
)
644 msg_set_bits(m
, 5, 4, 0x1f, n
);
647 static inline u32
msg_bearer_id(struct tipc_msg
*m
)
649 return msg_bits(m
, 5, 9, 0x7);
652 static inline void msg_set_bearer_id(struct tipc_msg
*m
, u32 n
)
654 msg_set_bits(m
, 5, 9, 0x7, n
);
657 static inline u32
msg_redundant_link(struct tipc_msg
*m
)
659 return msg_bits(m
, 5, 12, 0x1);
662 static inline void msg_set_redundant_link(struct tipc_msg
*m
, u32 r
)
664 msg_set_bits(m
, 5, 12, 0x1, r
);
667 static inline char *msg_media_addr(struct tipc_msg
*m
)
669 return (char *)&m
->hdr
[TIPC_MEDIA_ADDR_OFFSET
];
675 static inline u32
msg_msgcnt(struct tipc_msg
*m
)
677 return msg_bits(m
, 9, 16, 0xffff);
680 static inline void msg_set_msgcnt(struct tipc_msg
*m
, u32 n
)
682 msg_set_bits(m
, 9, 16, 0xffff, n
);
685 static inline u32
msg_bcast_tag(struct tipc_msg
*m
)
687 return msg_bits(m
, 9, 16, 0xffff);
690 static inline void msg_set_bcast_tag(struct tipc_msg
*m
, u32 n
)
692 msg_set_bits(m
, 9, 16, 0xffff, n
);
695 static inline u32
msg_max_pkt(struct tipc_msg
*m
)
697 return msg_bits(m
, 9, 16, 0xffff) * 4;
700 static inline void msg_set_max_pkt(struct tipc_msg
*m
, u32 n
)
702 msg_set_bits(m
, 9, 16, 0xffff, (n
/ 4));
705 static inline u32
msg_link_tolerance(struct tipc_msg
*m
)
707 return msg_bits(m
, 9, 0, 0xffff);
710 static inline void msg_set_link_tolerance(struct tipc_msg
*m
, u32 n
)
712 msg_set_bits(m
, 9, 0, 0xffff, n
);
715 static inline u32
tipc_msg_tot_importance(struct tipc_msg
*m
)
717 if ((msg_user(m
) == MSG_FRAGMENTER
) && (msg_type(m
) == FIRST_FRAGMENT
))
718 return msg_importance(msg_get_wrapped(m
));
719 return msg_importance(m
);
722 static inline u32
msg_tot_origport(struct tipc_msg
*m
)
724 if ((msg_user(m
) == MSG_FRAGMENTER
) && (msg_type(m
) == FIRST_FRAGMENT
))
725 return msg_origport(msg_get_wrapped(m
));
726 return msg_origport(m
);
729 bool tipc_msg_reverse(struct sk_buff
*buf
, u32
*dnode
, int err
);
731 int tipc_msg_eval(struct sk_buff
*buf
, u32
*dnode
);
733 void tipc_msg_init(struct tipc_msg
*m
, u32 user
, u32 type
, u32 hsize
,
736 struct sk_buff
*tipc_msg_create(uint user
, uint type
, uint hdr_sz
,
737 uint data_sz
, u32 dnode
, u32 onode
,
738 u32 dport
, u32 oport
, int errcode
);
740 int tipc_buf_append(struct sk_buff
**headbuf
, struct sk_buff
**buf
);
742 bool tipc_msg_bundle(struct sk_buff
*bbuf
, struct sk_buff
*buf
, u32 mtu
);
744 bool tipc_msg_make_bundle(struct sk_buff
**buf
, u32 mtu
, u32 dnode
);
746 int tipc_msg_build(struct tipc_msg
*mhdr
, struct iovec
const *iov
,
747 int offset
, int dsz
, int mtu
, struct sk_buff
**chain
);
749 struct sk_buff
*tipc_msg_reassemble(struct sk_buff
*chain
);
This page took 0.045143 seconds and 5 git commands to generate.