2 * net/tipc/msg.h: Include file for TIPC message header routines
4 * Copyright (c) 2000-2006, Ericsson AB
5 * Copyright (c) 2005, 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
43 #define DATA_LOW TIPC_LOW_IMPORTANCE
44 #define DATA_MEDIUM TIPC_MEDIUM_IMPORTANCE
45 #define DATA_HIGH TIPC_HIGH_IMPORTANCE
46 #define DATA_CRITICAL TIPC_CRITICAL_IMPORTANCE
47 #define SHORT_H_SIZE 24 /* Connected,in cluster */
48 #define DIR_MSG_H_SIZE 32 /* Directly addressed messages */
49 #define CONN_MSG_H_SIZE 36 /* Routed connected msgs*/
50 #define LONG_H_SIZE 40 /* Named Messages */
51 #define MCAST_H_SIZE 44 /* Multicast messages */
52 #define MAX_H_SIZE 60 /* Inclusive full options */
53 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
54 #define LINK_CONFIG 13
58 TIPC user data message header format, version 2
60 - Fundamental definitions available to privileged TIPC users
61 are located in tipc_msg.h.
62 - Remaining definitions available to TIPC internal users appear below.
66 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
68 m->hdr[w] = htonl(val);
71 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
72 u32 pos, u32 mask, u32 val)
74 u32 word = msg_word(m,w) & ~(mask << pos);
75 msg_set_word(m, w, (word |= (val << pos)));
82 static inline u32 msg_version(struct tipc_msg *m)
84 return msg_bits(m, 0, 29, 7);
87 static inline void msg_set_version(struct tipc_msg *m)
89 msg_set_bits(m, 0, 29, 0xf, TIPC_VERSION);
92 static inline u32 msg_user(struct tipc_msg *m)
94 return msg_bits(m, 0, 25, 0xf);
97 static inline u32 msg_isdata(struct tipc_msg *m)
99 return (msg_user(m) <= DATA_CRITICAL);
102 static inline void msg_set_user(struct tipc_msg *m, u32 n)
104 msg_set_bits(m, 0, 25, 0xf, n);
107 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
112 static inline void msg_set_hdr_sz(struct tipc_msg *m,u32 n)
114 msg_set_bits(m, 0, 21, 0xf, n>>2);
117 static inline int msg_non_seq(struct tipc_msg *m)
119 return msg_bits(m, 0, 20, 1);
122 static inline void msg_set_non_seq(struct tipc_msg *m)
124 msg_set_bits(m, 0, 20, 1, 1);
127 static inline int msg_dest_droppable(struct tipc_msg *m)
129 return msg_bits(m, 0, 19, 1);
132 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
134 msg_set_bits(m, 0, 19, 1, d);
137 static inline int msg_src_droppable(struct tipc_msg *m)
139 return msg_bits(m, 0, 18, 1);
142 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
144 msg_set_bits(m, 0, 18, 1, d);
147 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
149 m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
157 static inline void msg_set_type(struct tipc_msg *m, u32 n)
159 msg_set_bits(m, 1, 29, 0x7, n);
162 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
164 msg_set_bits(m, 1, 25, 0xf, err);
167 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
169 return msg_bits(m, 1, 21, 0xf);
172 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
174 msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
177 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
179 msg_set_bits(m, 1, 21, 0xf, 0);
182 static inline u32 msg_lookup_scope(struct tipc_msg *m)
184 return msg_bits(m, 1, 19, 0x3);
187 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
189 msg_set_bits(m, 1, 19, 0x3, n);
192 static inline void msg_set_options(struct tipc_msg *m, const char *opt, u32 sz)
194 u32 hsz = msg_hdr_sz(m);
195 char *to = (char *)&m->hdr[hsz/4];
197 if ((hsz < DIR_MSG_H_SIZE) || ((hsz + sz) > MAX_H_SIZE))
199 msg_set_bits(m, 1, 16, 0x7, (hsz - 28)/4);
200 msg_set_hdr_sz(m, hsz + sz);
204 static inline u32 msg_bcast_ack(struct tipc_msg *m)
206 return msg_bits(m, 1, 0, 0xffff);
209 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
211 msg_set_bits(m, 1, 0, 0xffff, n);
219 static inline u32 msg_ack(struct tipc_msg *m)
221 return msg_bits(m, 2, 16, 0xffff);
224 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
226 msg_set_bits(m, 2, 16, 0xffff, n);
229 static inline u32 msg_seqno(struct tipc_msg *m)
231 return msg_bits(m, 2, 0, 0xffff);
234 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
236 msg_set_bits(m, 2, 0, 0xffff, n);
245 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
247 msg_set_word(m, 3, a);
250 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
252 msg_set_word(m, 4, p);
255 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
257 msg_set_word(m, 5, p);
260 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
262 msg_set_word(m, 5, p);
265 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
267 msg_set_word(m, 6, a);
270 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
272 msg_set_word(m, 7, a);
275 static inline int msg_is_dest(struct tipc_msg *m, u32 d)
277 return(msg_short(m) || (msg_destnode(m) == d));
280 static inline u32 msg_routed(struct tipc_msg *m)
282 if (likely(msg_short(m)))
284 return(msg_destnode(m) ^ msg_orignode(m)) >> 11;
287 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
289 msg_set_word(m, 8, n);
292 static inline u32 msg_transp_seqno(struct tipc_msg *m)
294 return msg_word(m, 8);
297 static inline void msg_set_timestamp(struct tipc_msg *m, u32 n)
299 msg_set_word(m, 8, n);
302 static inline u32 msg_timestamp(struct tipc_msg *m)
304 return msg_word(m, 8);
307 static inline void msg_set_transp_seqno(struct tipc_msg *m, u32 n)
309 msg_set_word(m, 8, n);
312 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
314 msg_set_word(m, 9, n);
317 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
319 msg_set_namelower(m, n);
322 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
324 msg_set_word(m, 10, n);
327 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
329 return (struct tipc_msg *)msg_data(m);
332 static inline void msg_expand(struct tipc_msg *m, u32 destnode)
336 msg_set_hdr_sz(m, LONG_H_SIZE);
337 msg_set_orignode(m, msg_prevnode(m));
338 msg_set_destnode(m, destnode);
339 memset(&m->hdr[8], 0, 12);
345 TIPC internal message header format, version 2
347 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
348 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
349 w0:|vers |msg usr|hdr sz |n|resrv| packet size |
350 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
351 w1:|m typ|rsv=0| sequence gap | broadcast ack no |
352 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
353 w2:| link level ack no/bc_gap_from | seq no / bcast_gap_to |
354 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
356 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
357 w4:| next sent broadcast/fragm no | next sent pkt/ fragm msg no |
358 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
359 w5:| session no |rsv=0|r|berid|link prio|netpl|p|
360 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
361 w6:| originating node |
362 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
363 w7:| destination node |
364 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
365 w8:| transport sequence number |
366 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
367 w9:| msg count / bcast tag | link tolerance |
368 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
370 / User Specific Data /
372 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
374 NB: CONN_MANAGER use data message format. LINK_CONFIG has own format.
381 #define BCAST_PROTOCOL 5
382 #define MSG_BUNDLER 6
383 #define LINK_PROTOCOL 7
384 #define CONN_MANAGER 8
385 #define ROUTE_DISTRIBUTOR 9
386 #define CHANGEOVER_PROTOCOL 10
387 #define NAME_DISTRIBUTOR 11
388 #define MSG_FRAGMENTER 12
389 #define LINK_CONFIG 13
390 #define INT_H_SIZE 40
391 #define DSC_H_SIZE 40
394 * Connection management protocol messages
398 #define CONN_PROBE_REPLY 1
402 * Name distributor messages
405 #define PUBLICATION 0
413 static inline u32 msg_seq_gap(struct tipc_msg *m)
415 return msg_bits(m, 1, 16, 0xff);
418 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
420 msg_set_bits(m, 1, 16, 0xff, n);
423 static inline u32 msg_req_links(struct tipc_msg *m)
425 return msg_bits(m, 1, 16, 0xfff);
428 static inline void msg_set_req_links(struct tipc_msg *m, u32 n)
430 msg_set_bits(m, 1, 16, 0xfff, n);
438 static inline u32 msg_dest_domain(struct tipc_msg *m)
440 return msg_word(m, 2);
443 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
445 msg_set_word(m, 2, n);
448 static inline u32 msg_bcgap_after(struct tipc_msg *m)
450 return msg_bits(m, 2, 16, 0xffff);
453 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
455 msg_set_bits(m, 2, 16, 0xffff, n);
458 static inline u32 msg_bcgap_to(struct tipc_msg *m)
460 return msg_bits(m, 2, 0, 0xffff);
463 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
465 msg_set_bits(m, 2, 0, 0xffff, n);
473 static inline u32 msg_last_bcast(struct tipc_msg *m)
475 return msg_bits(m, 4, 16, 0xffff);
478 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
480 msg_set_bits(m, 4, 16, 0xffff, n);
484 static inline u32 msg_fragm_no(struct tipc_msg *m)
486 return msg_bits(m, 4, 16, 0xffff);
489 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
491 msg_set_bits(m, 4, 16, 0xffff, n);
495 static inline u32 msg_next_sent(struct tipc_msg *m)
497 return msg_bits(m, 4, 0, 0xffff);
500 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
502 msg_set_bits(m, 4, 0, 0xffff, n);
506 static inline u32 msg_long_msgno(struct tipc_msg *m)
508 return msg_bits(m, 4, 0, 0xffff);
511 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
513 msg_set_bits(m, 4, 0, 0xffff, n);
516 static inline u32 msg_bc_netid(struct tipc_msg *m)
518 return msg_word(m, 4);
521 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
523 msg_set_word(m, 4, id);
526 static inline u32 msg_link_selector(struct tipc_msg *m)
528 return msg_bits(m, 4, 0, 1);
531 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
533 msg_set_bits(m, 4, 0, 1, (n & 1));
540 static inline u32 msg_session(struct tipc_msg *m)
542 return msg_bits(m, 5, 16, 0xffff);
545 static inline void msg_set_session(struct tipc_msg *m, u32 n)
547 msg_set_bits(m, 5, 16, 0xffff, n);
550 static inline u32 msg_probe(struct tipc_msg *m)
552 return msg_bits(m, 5, 0, 1);
555 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
557 msg_set_bits(m, 5, 0, 1, (val & 1));
560 static inline char msg_net_plane(struct tipc_msg *m)
562 return msg_bits(m, 5, 1, 7) + 'A';
565 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
567 msg_set_bits(m, 5, 1, 7, (n - 'A'));
570 static inline u32 msg_linkprio(struct tipc_msg *m)
572 return msg_bits(m, 5, 4, 0x1f);
575 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
577 msg_set_bits(m, 5, 4, 0x1f, n);
580 static inline u32 msg_bearer_id(struct tipc_msg *m)
582 return msg_bits(m, 5, 9, 0x7);
585 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
587 msg_set_bits(m, 5, 9, 0x7, n);
590 static inline u32 msg_redundant_link(struct tipc_msg *m)
592 return msg_bits(m, 5, 12, 0x1);
595 static inline void msg_set_redundant_link(struct tipc_msg *m)
597 msg_set_bits(m, 5, 12, 0x1, 1);
600 static inline void msg_clear_redundant_link(struct tipc_msg *m)
602 msg_set_bits(m, 5, 12, 0x1, 0);
610 static inline u32 msg_msgcnt(struct tipc_msg *m)
612 return msg_bits(m, 9, 16, 0xffff);
615 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
617 msg_set_bits(m, 9, 16, 0xffff, n);
620 static inline u32 msg_bcast_tag(struct tipc_msg *m)
622 return msg_bits(m, 9, 16, 0xffff);
625 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
627 msg_set_bits(m, 9, 16, 0xffff, n);
630 static inline u32 msg_max_pkt(struct tipc_msg *m)
632 return (msg_bits(m, 9, 16, 0xffff) * 4);
635 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
637 msg_set_bits(m, 9, 16, 0xffff, (n / 4));
640 static inline u32 msg_link_tolerance(struct tipc_msg *m)
642 return msg_bits(m, 9, 0, 0xffff);
645 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
647 msg_set_bits(m, 9, 0, 0xffff, n);
651 * Routing table message data
655 static inline u32 msg_remote_node(struct tipc_msg *m)
657 return msg_word(m, msg_hdr_sz(m)/4);
660 static inline void msg_set_remote_node(struct tipc_msg *m, u32 a)
662 msg_set_word(m, msg_hdr_sz(m)/4, a);
665 static inline int msg_dataoctet(struct tipc_msg *m, u32 pos)
667 return(msg_data(m)[pos + 4] != 0);
670 static inline void msg_set_dataoctet(struct tipc_msg *m, u32 pos)
672 msg_data(m)[pos + 4] = 1;
676 * Segmentation message types
679 #define FIRST_FRAGMENT 0
681 #define LAST_FRAGMENT 2
684 * Link management protocol message types
689 #define ACTIVATE_MSG 2
692 * Changeover tunnel message types
694 #define DUPLICATE_MSG 0
695 #define ORIGINAL_MSG 1
698 * Routing table message types
700 #define EXT_ROUTING_TABLE 0
701 #define LOCAL_ROUTING_TABLE 1
702 #define SLAVE_ROUTING_TABLE 2
703 #define ROUTE_ADDITION 3
704 #define ROUTE_REMOVAL 4
707 * Config protocol message types
710 #define DSC_REQ_MSG 0
711 #define DSC_RESP_MSG 1
713 static inline u32 msg_tot_importance(struct tipc_msg *m)
715 if (likely(msg_isdata(m))) {
716 if (likely(msg_orignode(m) == tipc_own_addr))
717 return msg_importance(m);
718 return msg_importance(m) + 4;
720 if ((msg_user(m) == MSG_FRAGMENTER) &&
721 (msg_type(m) == FIRST_FRAGMENT))
722 return msg_importance(msg_get_wrapped(m));
723 return msg_importance(m);
727 static inline void msg_init(struct tipc_msg *m, u32 user, u32 type,
728 u32 err, u32 hsize, u32 destnode)
732 msg_set_user(m, user);
733 msg_set_hdr_sz(m, hsize);
734 msg_set_size(m, hsize);
735 msg_set_prevnode(m, tipc_own_addr);
736 msg_set_type(m, type);
737 msg_set_errcode(m, err);
739 msg_set_orignode(m, tipc_own_addr);
740 msg_set_destnode(m, destnode);
745 * msg_calc_data_size - determine total data size for message
748 static inline int msg_calc_data_size(struct iovec const *msg_sect, u32 num_sect)
753 for (i = 0; i < num_sect; i++)
754 dsz += msg_sect[i].iov_len;
759 * msg_build - create message using specified header and data
761 * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
763 * Returns message data size or errno
766 static inline int msg_build(struct tipc_msg *hdr,
767 struct iovec const *msg_sect, u32 num_sect,
768 int max_size, int usrmem, struct sk_buff** buf)
770 int dsz, sz, hsz, pos, res, cnt;
772 dsz = msg_calc_data_size(msg_sect, num_sect);
773 if (unlikely(dsz > TIPC_MAX_USER_MSG_SIZE)) {
778 pos = hsz = msg_hdr_sz(hdr);
780 msg_set_size(hdr, sz);
781 if (unlikely(sz > max_size)) {
786 *buf = buf_acquire(sz);
789 memcpy((*buf)->data, (unchar *)hdr, hsz);
790 for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
792 res = !copy_from_user((*buf)->data + pos,
793 msg_sect[cnt].iov_base,
794 msg_sect[cnt].iov_len);
796 memcpy((*buf)->data + pos, msg_sect[cnt].iov_base,
797 msg_sect[cnt].iov_len);
798 pos += msg_sect[cnt].iov_len;
808 static inline void msg_set_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
810 memcpy(&((int *)m)[5], a, sizeof(*a));
813 static inline void msg_get_media_addr(struct tipc_msg *m, struct tipc_media_addr *a)
815 memcpy(a, &((int*)m)[5], sizeof(*a));