2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2007, Ericsson AB
5 * Copyright (c) 2005-2008, 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.
42 #define TIPC_VERSION 2
44 #define SHORT_H_SIZE 24 /* Connected, in-cluster messages */
45 #define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
46 #define LONG_H_SIZE 40 /* Named messages */
47 #define MCAST_H_SIZE 44 /* Multicast messages */
48 #define INT_H_SIZE 40 /* Internal messages */
49 #define MIN_H_SIZE 24 /* Smallest legal TIPC header size */
50 #define MAX_H_SIZE 60 /* Largest possible TIPC header size */
52 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
56 TIPC user data message header format, version 2
58 - Fundamental definitions available to privileged TIPC users
59 are located in tipc_msg.h.
60 - Remaining definitions available to TIPC internal users appear below.
64 static inline void msg_set_word(struct tipc_msg
*m
, u32 w
, u32 val
)
66 m
->hdr
[w
] = htonl(val
);
69 static inline void msg_set_bits(struct tipc_msg
*m
, u32 w
,
70 u32 pos
, u32 mask
, u32 val
)
72 val
= (val
& mask
) << pos
;
74 m
->hdr
[w
] &= ~htonl(mask
);
75 m
->hdr
[w
] |= htonl(val
);
78 static inline void msg_swap_words(struct tipc_msg
*msg
, u32 a
, u32 b
)
80 u32 temp
= msg
->hdr
[a
];
82 msg
->hdr
[a
] = msg
->hdr
[b
];
90 static inline u32
msg_version(struct tipc_msg
*m
)
92 return msg_bits(m
, 0, 29, 7);
95 static inline void msg_set_version(struct tipc_msg
*m
)
97 msg_set_bits(m
, 0, 29, 7, TIPC_VERSION
);
100 static inline u32
msg_user(struct tipc_msg
*m
)
102 return msg_bits(m
, 0, 25, 0xf);
105 static inline u32
msg_isdata(struct tipc_msg
*m
)
107 return msg_user(m
) <= TIPC_CRITICAL_IMPORTANCE
;
110 static inline void msg_set_user(struct tipc_msg
*m
, u32 n
)
112 msg_set_bits(m
, 0, 25, 0xf, n
);
115 static inline void msg_set_importance(struct tipc_msg
*m
, u32 i
)
120 static inline void msg_set_hdr_sz(struct tipc_msg
*m
,u32 n
)
122 msg_set_bits(m
, 0, 21, 0xf, n
>>2);
125 static inline int msg_non_seq(struct tipc_msg
*m
)
127 return msg_bits(m
, 0, 20, 1);
130 static inline void msg_set_non_seq(struct tipc_msg
*m
, u32 n
)
132 msg_set_bits(m
, 0, 20, 1, n
);
135 static inline int msg_dest_droppable(struct tipc_msg
*m
)
137 return msg_bits(m
, 0, 19, 1);
140 static inline void msg_set_dest_droppable(struct tipc_msg
*m
, u32 d
)
142 msg_set_bits(m
, 0, 19, 1, d
);
145 static inline int msg_src_droppable(struct tipc_msg
*m
)
147 return msg_bits(m
, 0, 18, 1);
150 static inline void msg_set_src_droppable(struct tipc_msg
*m
, u32 d
)
152 msg_set_bits(m
, 0, 18, 1, d
);
155 static inline void msg_set_size(struct tipc_msg
*m
, u32 sz
)
157 m
->hdr
[0] = htonl((msg_word(m
, 0) & ~0x1ffff) | sz
);
165 static inline void msg_set_type(struct tipc_msg
*m
, u32 n
)
167 msg_set_bits(m
, 1, 29, 0x7, n
);
170 static inline void msg_set_errcode(struct tipc_msg
*m
, u32 err
)
172 msg_set_bits(m
, 1, 25, 0xf, err
);
175 static inline u32
msg_reroute_cnt(struct tipc_msg
*m
)
177 return msg_bits(m
, 1, 21, 0xf);
180 static inline void msg_incr_reroute_cnt(struct tipc_msg
*m
)
182 msg_set_bits(m
, 1, 21, 0xf, msg_reroute_cnt(m
) + 1);
185 static inline void msg_reset_reroute_cnt(struct tipc_msg
*m
)
187 msg_set_bits(m
, 1, 21, 0xf, 0);
190 static inline u32
msg_lookup_scope(struct tipc_msg
*m
)
192 return msg_bits(m
, 1, 19, 0x3);
195 static inline void msg_set_lookup_scope(struct tipc_msg
*m
, u32 n
)
197 msg_set_bits(m
, 1, 19, 0x3, n
);
200 static inline u32
msg_bcast_ack(struct tipc_msg
*m
)
202 return msg_bits(m
, 1, 0, 0xffff);
205 static inline void msg_set_bcast_ack(struct tipc_msg
*m
, u32 n
)
207 msg_set_bits(m
, 1, 0, 0xffff, n
);
215 static inline u32
msg_ack(struct tipc_msg
*m
)
217 return msg_bits(m
, 2, 16, 0xffff);
220 static inline void msg_set_ack(struct tipc_msg
*m
, u32 n
)
222 msg_set_bits(m
, 2, 16, 0xffff, n
);
225 static inline u32
msg_seqno(struct tipc_msg
*m
)
227 return msg_bits(m
, 2, 0, 0xffff);
230 static inline void msg_set_seqno(struct tipc_msg
*m
, u32 n
)
232 msg_set_bits(m
, 2, 0, 0xffff, n
);
236 * TIPC may utilize the "link ack #" and "link seq #" fields of a short
237 * message header to hold the destination node for the message, since the
238 * normal "dest node" field isn't present. This cache is only referenced
239 * when required, so populating the cache of a longer message header is
240 * harmless (as long as the header has the two link sequence fields present).
242 * Note: Host byte order is OK here, since the info never goes off-card.
245 static inline u32
msg_destnode_cache(struct tipc_msg
*m
)
250 static inline void msg_set_destnode_cache(struct tipc_msg
*m
, u32 dnode
)
260 static inline void msg_set_prevnode(struct tipc_msg
*m
, u32 a
)
262 msg_set_word(m
, 3, a
);
265 static inline void msg_set_origport(struct tipc_msg
*m
, u32 p
)
267 msg_set_word(m
, 4, p
);
270 static inline void msg_set_destport(struct tipc_msg
*m
, u32 p
)
272 msg_set_word(m
, 5, p
);
275 static inline void msg_set_mc_netid(struct tipc_msg
*m
, u32 p
)
277 msg_set_word(m
, 5, p
);
280 static inline void msg_set_orignode(struct tipc_msg
*m
, u32 a
)
282 msg_set_word(m
, 6, a
);
285 static inline void msg_set_destnode(struct tipc_msg
*m
, u32 a
)
287 msg_set_word(m
, 7, a
);
290 static inline int msg_is_dest(struct tipc_msg
*m
, u32 d
)
292 return msg_short(m
) || (msg_destnode(m
) == d
);
295 static inline u32
msg_routed(struct tipc_msg
*m
)
297 if (likely(msg_short(m
)))
299 return(msg_destnode(m
) ^ msg_orignode(m
)) >> 11;
302 static inline void msg_set_nametype(struct tipc_msg
*m
, u32 n
)
304 msg_set_word(m
, 8, n
);
307 static inline u32
msg_transp_seqno(struct tipc_msg
*m
)
309 return msg_word(m
, 8);
312 static inline void msg_set_timestamp(struct tipc_msg
*m
, u32 n
)
314 msg_set_word(m
, 8, n
);
317 static inline u32
msg_timestamp(struct tipc_msg
*m
)
319 return msg_word(m
, 8);
322 static inline void msg_set_transp_seqno(struct tipc_msg
*m
, u32 n
)
324 msg_set_word(m
, 8, n
);
327 static inline void msg_set_namelower(struct tipc_msg
*m
, u32 n
)
329 msg_set_word(m
, 9, n
);
332 static inline void msg_set_nameinst(struct tipc_msg
*m
, u32 n
)
334 msg_set_namelower(m
, n
);
337 static inline void msg_set_nameupper(struct tipc_msg
*m
, u32 n
)
339 msg_set_word(m
, 10, n
);
342 static inline struct tipc_msg
*msg_get_wrapped(struct tipc_msg
*m
)
344 return (struct tipc_msg
*)msg_data(m
);
349 TIPC internal message header format, version 2
351 1 0 9 8 7 6 5 4|3 2 1 0 9 8 7 6|5 4 3 2 1 0 9 8|7 6 5 4 3 2 1 0
352 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
353 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
354 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
355 w1:|m typ| sequence gap | broadcast ack no |
356 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
357 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
358 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
360 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
361 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
362 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
363 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
364 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
365 w6:| originating node |
366 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
367 w7:| destination node |
368 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
369 w8:| transport sequence number |
370 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
371 w9:| msg count / bcast tag | link tolerance |
372 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
374 / User Specific Data /
376 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
378 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
385 #define BCAST_PROTOCOL 5
386 #define MSG_BUNDLER 6
387 #define LINK_PROTOCOL 7
388 #define CONN_MANAGER 8
389 #define ROUTE_DISTRIBUTOR 9
390 #define CHANGEOVER_PROTOCOL 10
391 #define NAME_DISTRIBUTOR 11
392 #define MSG_FRAGMENTER 12
393 #define LINK_CONFIG 13
394 #define DSC_H_SIZE 40
397 * Connection management protocol messages
401 #define CONN_PROBE_REPLY 1
405 * Name distributor messages
408 #define PUBLICATION 0
416 static inline u32
msg_seq_gap(struct tipc_msg
*m
)
418 return msg_bits(m
, 1, 16, 0x1fff);
421 static inline void msg_set_seq_gap(struct tipc_msg
*m
, u32 n
)
423 msg_set_bits(m
, 1, 16, 0x1fff, n
);
426 static inline u32
msg_req_links(struct tipc_msg
*m
)
428 return msg_bits(m
, 1, 16, 0xfff);
431 static inline void msg_set_req_links(struct tipc_msg
*m
, u32 n
)
433 msg_set_bits(m
, 1, 16, 0xfff, n
);
441 static inline u32
msg_dest_domain(struct tipc_msg
*m
)
443 return msg_word(m
, 2);
446 static inline void msg_set_dest_domain(struct tipc_msg
*m
, u32 n
)
448 msg_set_word(m
, 2, n
);
451 static inline u32
msg_bcgap_after(struct tipc_msg
*m
)
453 return msg_bits(m
, 2, 16, 0xffff);
456 static inline void msg_set_bcgap_after(struct tipc_msg
*m
, u32 n
)
458 msg_set_bits(m
, 2, 16, 0xffff, n
);
461 static inline u32
msg_bcgap_to(struct tipc_msg
*m
)
463 return msg_bits(m
, 2, 0, 0xffff);
466 static inline void msg_set_bcgap_to(struct tipc_msg
*m
, u32 n
)
468 msg_set_bits(m
, 2, 0, 0xffff, n
);
476 static inline u32
msg_last_bcast(struct tipc_msg
*m
)
478 return msg_bits(m
, 4, 16, 0xffff);
481 static inline void msg_set_last_bcast(struct tipc_msg
*m
, u32 n
)
483 msg_set_bits(m
, 4, 16, 0xffff, n
);
487 static inline u32
msg_fragm_no(struct tipc_msg
*m
)
489 return msg_bits(m
, 4, 16, 0xffff);
492 static inline void msg_set_fragm_no(struct tipc_msg
*m
, u32 n
)
494 msg_set_bits(m
, 4, 16, 0xffff, n
);
498 static inline u32
msg_next_sent(struct tipc_msg
*m
)
500 return msg_bits(m
, 4, 0, 0xffff);
503 static inline void msg_set_next_sent(struct tipc_msg
*m
, u32 n
)
505 msg_set_bits(m
, 4, 0, 0xffff, n
);
509 static inline u32
msg_long_msgno(struct tipc_msg
*m
)
511 return msg_bits(m
, 4, 0, 0xffff);
514 static inline void msg_set_long_msgno(struct tipc_msg
*m
, u32 n
)
516 msg_set_bits(m
, 4, 0, 0xffff, n
);
519 static inline u32
msg_bc_netid(struct tipc_msg
*m
)
521 return msg_word(m
, 4);
524 static inline void msg_set_bc_netid(struct tipc_msg
*m
, u32 id
)
526 msg_set_word(m
, 4, id
);
529 static inline u32
msg_link_selector(struct tipc_msg
*m
)
531 return msg_bits(m
, 4, 0, 1);
534 static inline void msg_set_link_selector(struct tipc_msg
*m
, u32 n
)
536 msg_set_bits(m
, 4, 0, 1, (n
& 1));
543 static inline u32
msg_session(struct tipc_msg
*m
)
545 return msg_bits(m
, 5, 16, 0xffff);
548 static inline void msg_set_session(struct tipc_msg
*m
, u32 n
)
550 msg_set_bits(m
, 5, 16, 0xffff, n
);
553 static inline u32
msg_probe(struct tipc_msg
*m
)
555 return msg_bits(m
, 5, 0, 1);
558 static inline void msg_set_probe(struct tipc_msg
*m
, u32 val
)
560 msg_set_bits(m
, 5, 0, 1, (val
& 1));
563 static inline char msg_net_plane(struct tipc_msg
*m
)
565 return msg_bits(m
, 5, 1, 7) + 'A';
568 static inline void msg_set_net_plane(struct tipc_msg
*m
, char n
)
570 msg_set_bits(m
, 5, 1, 7, (n
- 'A'));
573 static inline u32
msg_linkprio(struct tipc_msg
*m
)
575 return msg_bits(m
, 5, 4, 0x1f);
578 static inline void msg_set_linkprio(struct tipc_msg
*m
, u32 n
)
580 msg_set_bits(m
, 5, 4, 0x1f, n
);
583 static inline u32
msg_bearer_id(struct tipc_msg
*m
)
585 return msg_bits(m
, 5, 9, 0x7);
588 static inline void msg_set_bearer_id(struct tipc_msg
*m
, u32 n
)
590 msg_set_bits(m
, 5, 9, 0x7, n
);
593 static inline u32
msg_redundant_link(struct tipc_msg
*m
)
595 return msg_bits(m
, 5, 12, 0x1);
598 static inline void msg_set_redundant_link(struct tipc_msg
*m
)
600 msg_set_bits(m
, 5, 12, 0x1, 1);
603 static inline void msg_clear_redundant_link(struct tipc_msg
*m
)
605 msg_set_bits(m
, 5, 12, 0x1, 0);
613 static inline u32
msg_msgcnt(struct tipc_msg
*m
)
615 return msg_bits(m
, 9, 16, 0xffff);
618 static inline void msg_set_msgcnt(struct tipc_msg
*m
, u32 n
)
620 msg_set_bits(m
, 9, 16, 0xffff, n
);
623 static inline u32
msg_bcast_tag(struct tipc_msg
*m
)
625 return msg_bits(m
, 9, 16, 0xffff);
628 static inline void msg_set_bcast_tag(struct tipc_msg
*m
, u32 n
)
630 msg_set_bits(m
, 9, 16, 0xffff, n
);
633 static inline u32
msg_max_pkt(struct tipc_msg
*m
)
635 return msg_bits(m
, 9, 16, 0xffff) * 4;
638 static inline void msg_set_max_pkt(struct tipc_msg
*m
, u32 n
)
640 msg_set_bits(m
, 9, 16, 0xffff, (n
/ 4));
643 static inline u32
msg_link_tolerance(struct tipc_msg
*m
)
645 return msg_bits(m
, 9, 0, 0xffff);
648 static inline void msg_set_link_tolerance(struct tipc_msg
*m
, u32 n
)
650 msg_set_bits(m
, 9, 0, 0xffff, n
);
654 * Routing table message data
658 static inline u32
msg_remote_node(struct tipc_msg
*m
)
660 return msg_word(m
, msg_hdr_sz(m
)/4);
663 static inline void msg_set_remote_node(struct tipc_msg
*m
, u32 a
)
665 msg_set_word(m
, msg_hdr_sz(m
)/4, a
);
668 static inline void msg_set_dataoctet(struct tipc_msg
*m
, u32 pos
)
670 msg_data(m
)[pos
+ 4] = 1;
674 * Segmentation message types
677 #define FIRST_FRAGMENT 0
679 #define LAST_FRAGMENT 2
682 * Link management protocol message types
687 #define ACTIVATE_MSG 2
690 * Changeover tunnel message types
692 #define DUPLICATE_MSG 0
693 #define ORIGINAL_MSG 1
696 * Routing table message types
698 #define EXT_ROUTING_TABLE 0
699 #define LOCAL_ROUTING_TABLE 1
700 #define SLAVE_ROUTING_TABLE 2
701 #define ROUTE_ADDITION 3
702 #define ROUTE_REMOVAL 4
705 * Config protocol message types
708 #define DSC_REQ_MSG 0
709 #define DSC_RESP_MSG 1
711 u32
tipc_msg_tot_importance(struct tipc_msg
*m
);
712 void tipc_msg_init(struct tipc_msg
*m
, u32 user
, u32 type
,
713 u32 hsize
, u32 destnode
);
714 int tipc_msg_calc_data_size(struct iovec
const *msg_sect
, u32 num_sect
);
715 int tipc_msg_build(struct tipc_msg
*hdr
,
716 struct iovec
const *msg_sect
, u32 num_sect
,
717 int max_size
, int usrmem
, struct sk_buff
** buf
);
719 static inline void msg_set_media_addr(struct tipc_msg
*m
, struct tipc_media_addr
*a
)
721 memcpy(&((int *)m
)[5], a
, sizeof(*a
));
724 static inline void msg_get_media_addr(struct tipc_msg
*m
, struct tipc_media_addr
*a
)
726 memcpy(a
, &((int*)m
)[5], sizeof(*a
));
This page took 0.044442 seconds and 5 git commands to generate.