]> git.karo-electronics.de Git - linux-beck.git/blob - net/tipc/msg.h
1a52f7cf3cd3664a1b515d99657129e0df772b18
[linux-beck.git] / net / tipc / msg.h
1 /*
2  * net/tipc/msg.h: Include file for TIPC message header routines
3  *
4  * Copyright (c) 2000-2007, 2014, Ericsson AB
5  * Copyright (c) 2005-2008, 2010-2011, Wind River Systems
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
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.
19  *
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.
23  *
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.
35  */
36
37 #ifndef _TIPC_MSG_H
38 #define _TIPC_MSG_H
39
40 #include "bearer.h"
41
42 /*
43  * Constants and routines used to read and write TIPC payload message headers
44  *
45  * Note: Some items are also used with TIPC internal message headers
46  */
47 #define TIPC_VERSION              2
48
49 /*
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
55  */
56
57 /*
58  * Payload message types
59  */
60 #define TIPC_CONN_MSG           0
61 #define TIPC_MCAST_MSG          1
62 #define TIPC_NAMED_MSG          2
63 #define TIPC_DIRECT_MSG         3
64
65 /*
66  * Message header sizes
67  */
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 */
75
76 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
77
78 #define TIPC_MEDIA_ADDR_OFFSET  5
79
80 struct tipc_msg {
81         __be32 hdr[15];
82 };
83
84 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
85 {
86         return ntohl(m->hdr[pos]);
87 }
88
89 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
90 {
91         m->hdr[w] = htonl(val);
92 }
93
94 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
95 {
96         return (msg_word(m, w) >> pos) & mask;
97 }
98
99 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
100                                 u32 pos, u32 mask, u32 val)
101 {
102         val = (val & mask) << pos;
103         mask = mask << pos;
104         m->hdr[w] &= ~htonl(mask);
105         m->hdr[w] |= htonl(val);
106 }
107
108 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
109 {
110         u32 temp = msg->hdr[a];
111
112         msg->hdr[a] = msg->hdr[b];
113         msg->hdr[b] = temp;
114 }
115
116 /*
117  * Word 0
118  */
119 static inline u32 msg_version(struct tipc_msg *m)
120 {
121         return msg_bits(m, 0, 29, 7);
122 }
123
124 static inline void msg_set_version(struct tipc_msg *m)
125 {
126         msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
127 }
128
129 static inline u32 msg_user(struct tipc_msg *m)
130 {
131         return msg_bits(m, 0, 25, 0xf);
132 }
133
134 static inline u32 msg_isdata(struct tipc_msg *m)
135 {
136         return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
137 }
138
139 static inline void msg_set_user(struct tipc_msg *m, u32 n)
140 {
141         msg_set_bits(m, 0, 25, 0xf, n);
142 }
143
144 static inline u32 msg_importance(struct tipc_msg *m)
145 {
146         return msg_bits(m, 0, 25, 0xf);
147 }
148
149 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
150 {
151         msg_set_user(m, i);
152 }
153
154 static inline u32 msg_hdr_sz(struct tipc_msg *m)
155 {
156         return msg_bits(m, 0, 21, 0xf) << 2;
157 }
158
159 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
160 {
161         msg_set_bits(m, 0, 21, 0xf, n>>2);
162 }
163
164 static inline u32 msg_size(struct tipc_msg *m)
165 {
166         return msg_bits(m, 0, 0, 0x1ffff);
167 }
168
169 static inline u32 msg_data_sz(struct tipc_msg *m)
170 {
171         return msg_size(m) - msg_hdr_sz(m);
172 }
173
174 static inline int msg_non_seq(struct tipc_msg *m)
175 {
176         return msg_bits(m, 0, 20, 1);
177 }
178
179 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
180 {
181         msg_set_bits(m, 0, 20, 1, n);
182 }
183
184 static inline int msg_dest_droppable(struct tipc_msg *m)
185 {
186         return msg_bits(m, 0, 19, 1);
187 }
188
189 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
190 {
191         msg_set_bits(m, 0, 19, 1, d);
192 }
193
194 static inline int msg_src_droppable(struct tipc_msg *m)
195 {
196         return msg_bits(m, 0, 18, 1);
197 }
198
199 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
200 {
201         msg_set_bits(m, 0, 18, 1, d);
202 }
203
204 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
205 {
206         m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
207 }
208
209
210 /*
211  * Word 1
212  */
213 static inline u32 msg_type(struct tipc_msg *m)
214 {
215         return msg_bits(m, 1, 29, 0x7);
216 }
217
218 static inline void msg_set_type(struct tipc_msg *m, u32 n)
219 {
220         msg_set_bits(m, 1, 29, 0x7, n);
221 }
222
223 static inline u32 msg_named(struct tipc_msg *m)
224 {
225         return msg_type(m) == TIPC_NAMED_MSG;
226 }
227
228 static inline u32 msg_mcast(struct tipc_msg *m)
229 {
230         return msg_type(m) == TIPC_MCAST_MSG;
231 }
232
233 static inline u32 msg_connected(struct tipc_msg *m)
234 {
235         return msg_type(m) == TIPC_CONN_MSG;
236 }
237
238 static inline u32 msg_errcode(struct tipc_msg *m)
239 {
240         return msg_bits(m, 1, 25, 0xf);
241 }
242
243 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
244 {
245         msg_set_bits(m, 1, 25, 0xf, err);
246 }
247
248 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
249 {
250         return msg_bits(m, 1, 21, 0xf);
251 }
252
253 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
254 {
255         msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
256 }
257
258 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
259 {
260         msg_set_bits(m, 1, 21, 0xf, 0);
261 }
262
263 static inline u32 msg_lookup_scope(struct tipc_msg *m)
264 {
265         return msg_bits(m, 1, 19, 0x3);
266 }
267
268 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
269 {
270         msg_set_bits(m, 1, 19, 0x3, n);
271 }
272
273 static inline u32 msg_bcast_ack(struct tipc_msg *m)
274 {
275         return msg_bits(m, 1, 0, 0xffff);
276 }
277
278 static inline void msg_set_bcast_ack(struct tipc_msg *m, u32 n)
279 {
280         msg_set_bits(m, 1, 0, 0xffff, n);
281 }
282
283
284 /*
285  * Word 2
286  */
287 static inline u32 msg_ack(struct tipc_msg *m)
288 {
289         return msg_bits(m, 2, 16, 0xffff);
290 }
291
292 static inline void msg_set_ack(struct tipc_msg *m, u32 n)
293 {
294         msg_set_bits(m, 2, 16, 0xffff, n);
295 }
296
297 static inline u32 msg_seqno(struct tipc_msg *m)
298 {
299         return msg_bits(m, 2, 0, 0xffff);
300 }
301
302 static inline void msg_set_seqno(struct tipc_msg *m, u32 n)
303 {
304         msg_set_bits(m, 2, 0, 0xffff, n);
305 }
306
307 /*
308  * Words 3-10
309  */
310 static inline u32 msg_prevnode(struct tipc_msg *m)
311 {
312         return msg_word(m, 3);
313 }
314
315 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
316 {
317         msg_set_word(m, 3, a);
318 }
319
320 static inline u32 msg_origport(struct tipc_msg *m)
321 {
322         return msg_word(m, 4);
323 }
324
325 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
326 {
327         msg_set_word(m, 4, p);
328 }
329
330 static inline u32 msg_destport(struct tipc_msg *m)
331 {
332         return msg_word(m, 5);
333 }
334
335 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
336 {
337         msg_set_word(m, 5, p);
338 }
339
340 static inline u32 msg_mc_netid(struct tipc_msg *m)
341 {
342         return msg_word(m, 5);
343 }
344
345 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
346 {
347         msg_set_word(m, 5, p);
348 }
349
350 static inline int msg_short(struct tipc_msg *m)
351 {
352         return msg_hdr_sz(m) == SHORT_H_SIZE;
353 }
354
355 static inline u32 msg_orignode(struct tipc_msg *m)
356 {
357         if (likely(msg_short(m)))
358                 return msg_prevnode(m);
359         return msg_word(m, 6);
360 }
361
362 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
363 {
364         msg_set_word(m, 6, a);
365 }
366
367 static inline u32 msg_destnode(struct tipc_msg *m)
368 {
369         return msg_word(m, 7);
370 }
371
372 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
373 {
374         msg_set_word(m, 7, a);
375 }
376
377 static inline u32 msg_nametype(struct tipc_msg *m)
378 {
379         return msg_word(m, 8);
380 }
381
382 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
383 {
384         msg_set_word(m, 8, n);
385 }
386
387 static inline u32 msg_nameinst(struct tipc_msg *m)
388 {
389         return msg_word(m, 9);
390 }
391
392 static inline u32 msg_namelower(struct tipc_msg *m)
393 {
394         return msg_nameinst(m);
395 }
396
397 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
398 {
399         msg_set_word(m, 9, n);
400 }
401
402 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
403 {
404         msg_set_namelower(m, n);
405 }
406
407 static inline u32 msg_nameupper(struct tipc_msg *m)
408 {
409         return msg_word(m, 10);
410 }
411
412 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
413 {
414         msg_set_word(m, 10, n);
415 }
416
417 static inline unchar *msg_data(struct tipc_msg *m)
418 {
419         return ((unchar *)m) + msg_hdr_sz(m);
420 }
421
422 static inline struct tipc_msg *msg_get_wrapped(struct tipc_msg *m)
423 {
424         return (struct tipc_msg *)msg_data(m);
425 }
426
427 /*
428  * Constants and routines used to read and write TIPC internal message headers
429  */
430
431 /*
432  * Internal message users
433  */
434 #define  BCAST_PROTOCOL       5
435 #define  MSG_BUNDLER          6
436 #define  LINK_PROTOCOL        7
437 #define  CONN_MANAGER         8
438 #define  ROUTE_DISTRIBUTOR    9         /* obsoleted */
439 #define  CHANGEOVER_PROTOCOL  10
440 #define  NAME_DISTRIBUTOR     11
441 #define  MSG_FRAGMENTER       12
442 #define  LINK_CONFIG          13
443 #define  SOCK_WAKEUP          14       /* pseudo user */
444
445 /*
446  *  Connection management protocol message types
447  */
448 #define CONN_PROBE        0
449 #define CONN_PROBE_REPLY  1
450 #define CONN_ACK          2
451
452 /*
453  * Name distributor message types
454  */
455 #define PUBLICATION       0
456 #define WITHDRAWAL        1
457
458 /*
459  * Segmentation message types
460  */
461 #define FIRST_FRAGMENT          0
462 #define FRAGMENT                1
463 #define LAST_FRAGMENT           2
464
465 /*
466  * Link management protocol message types
467  */
468 #define STATE_MSG               0
469 #define RESET_MSG               1
470 #define ACTIVATE_MSG            2
471
472 /*
473  * Changeover tunnel message types
474  */
475 #define DUPLICATE_MSG           0
476 #define ORIGINAL_MSG            1
477
478 /*
479  * Config protocol message types
480  */
481 #define DSC_REQ_MSG             0
482 #define DSC_RESP_MSG            1
483
484
485 /*
486  * Word 1
487  */
488 static inline u32 msg_seq_gap(struct tipc_msg *m)
489 {
490         return msg_bits(m, 1, 16, 0x1fff);
491 }
492
493 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
494 {
495         msg_set_bits(m, 1, 16, 0x1fff, n);
496 }
497
498 static inline u32 msg_node_sig(struct tipc_msg *m)
499 {
500         return msg_bits(m, 1, 0, 0xffff);
501 }
502
503 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
504 {
505         msg_set_bits(m, 1, 0, 0xffff, n);
506 }
507
508
509 /*
510  * Word 2
511  */
512 static inline u32 msg_dest_domain(struct tipc_msg *m)
513 {
514         return msg_word(m, 2);
515 }
516
517 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
518 {
519         msg_set_word(m, 2, n);
520 }
521
522 static inline u32 msg_bcgap_after(struct tipc_msg *m)
523 {
524         return msg_bits(m, 2, 16, 0xffff);
525 }
526
527 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
528 {
529         msg_set_bits(m, 2, 16, 0xffff, n);
530 }
531
532 static inline u32 msg_bcgap_to(struct tipc_msg *m)
533 {
534         return msg_bits(m, 2, 0, 0xffff);
535 }
536
537 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
538 {
539         msg_set_bits(m, 2, 0, 0xffff, n);
540 }
541
542
543 /*
544  * Word 4
545  */
546 static inline u32 msg_last_bcast(struct tipc_msg *m)
547 {
548         return msg_bits(m, 4, 16, 0xffff);
549 }
550
551 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
552 {
553         msg_set_bits(m, 4, 16, 0xffff, n);
554 }
555
556 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
557 {
558         msg_set_bits(m, 4, 16, 0xffff, n);
559 }
560
561
562 static inline u32 msg_next_sent(struct tipc_msg *m)
563 {
564         return msg_bits(m, 4, 0, 0xffff);
565 }
566
567 static inline void msg_set_next_sent(struct tipc_msg *m, u32 n)
568 {
569         msg_set_bits(m, 4, 0, 0xffff, n);
570 }
571
572 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
573 {
574         msg_set_bits(m, 4, 0, 0xffff, n);
575 }
576
577 static inline u32 msg_bc_netid(struct tipc_msg *m)
578 {
579         return msg_word(m, 4);
580 }
581
582 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
583 {
584         msg_set_word(m, 4, id);
585 }
586
587 static inline u32 msg_link_selector(struct tipc_msg *m)
588 {
589         return msg_bits(m, 4, 0, 1);
590 }
591
592 static inline void msg_set_link_selector(struct tipc_msg *m, u32 n)
593 {
594         msg_set_bits(m, 4, 0, 1, n);
595 }
596
597 /*
598  * Word 5
599  */
600 static inline u32 msg_session(struct tipc_msg *m)
601 {
602         return msg_bits(m, 5, 16, 0xffff);
603 }
604
605 static inline void msg_set_session(struct tipc_msg *m, u32 n)
606 {
607         msg_set_bits(m, 5, 16, 0xffff, n);
608 }
609
610 static inline u32 msg_probe(struct tipc_msg *m)
611 {
612         return msg_bits(m, 5, 0, 1);
613 }
614
615 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
616 {
617         msg_set_bits(m, 5, 0, 1, val);
618 }
619
620 static inline char msg_net_plane(struct tipc_msg *m)
621 {
622         return msg_bits(m, 5, 1, 7) + 'A';
623 }
624
625 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
626 {
627         msg_set_bits(m, 5, 1, 7, (n - 'A'));
628 }
629
630 static inline u32 msg_linkprio(struct tipc_msg *m)
631 {
632         return msg_bits(m, 5, 4, 0x1f);
633 }
634
635 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
636 {
637         msg_set_bits(m, 5, 4, 0x1f, n);
638 }
639
640 static inline u32 msg_bearer_id(struct tipc_msg *m)
641 {
642         return msg_bits(m, 5, 9, 0x7);
643 }
644
645 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
646 {
647         msg_set_bits(m, 5, 9, 0x7, n);
648 }
649
650 static inline u32 msg_redundant_link(struct tipc_msg *m)
651 {
652         return msg_bits(m, 5, 12, 0x1);
653 }
654
655 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
656 {
657         msg_set_bits(m, 5, 12, 0x1, r);
658 }
659
660 static inline char *msg_media_addr(struct tipc_msg *m)
661 {
662         return (char *)&m->hdr[TIPC_MEDIA_ADDR_OFFSET];
663 }
664
665 /*
666  * Word 9
667  */
668 static inline u32 msg_msgcnt(struct tipc_msg *m)
669 {
670         return msg_bits(m, 9, 16, 0xffff);
671 }
672
673 static inline void msg_set_msgcnt(struct tipc_msg *m, u32 n)
674 {
675         msg_set_bits(m, 9, 16, 0xffff, n);
676 }
677
678 static inline u32 msg_bcast_tag(struct tipc_msg *m)
679 {
680         return msg_bits(m, 9, 16, 0xffff);
681 }
682
683 static inline void msg_set_bcast_tag(struct tipc_msg *m, u32 n)
684 {
685         msg_set_bits(m, 9, 16, 0xffff, n);
686 }
687
688 static inline u32 msg_max_pkt(struct tipc_msg *m)
689 {
690         return msg_bits(m, 9, 16, 0xffff) * 4;
691 }
692
693 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
694 {
695         msg_set_bits(m, 9, 16, 0xffff, (n / 4));
696 }
697
698 static inline u32 msg_link_tolerance(struct tipc_msg *m)
699 {
700         return msg_bits(m, 9, 0, 0xffff);
701 }
702
703 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
704 {
705         msg_set_bits(m, 9, 0, 0xffff, n);
706 }
707
708 static inline u32 tipc_msg_tot_importance(struct tipc_msg *m)
709 {
710         if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
711                 return msg_importance(msg_get_wrapped(m));
712         return msg_importance(m);
713 }
714
715 static inline u32 msg_tot_origport(struct tipc_msg *m)
716 {
717         if ((msg_user(m) == MSG_FRAGMENTER) && (msg_type(m) == FIRST_FRAGMENT))
718                 return msg_origport(msg_get_wrapped(m));
719         return msg_origport(m);
720 }
721
722 bool tipc_msg_reverse(struct sk_buff *buf, u32 *dnode, int err);
723
724 int tipc_msg_eval(struct sk_buff *buf, u32 *dnode);
725
726 void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type, u32 hsize,
727                    u32 destnode);
728
729 struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
730                                 uint data_sz, u32 dnode, u32 onode,
731                                 u32 dport, u32 oport, int errcode);
732
733 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
734
735 bool tipc_msg_bundle(struct sk_buff_head *list, struct sk_buff *skb, u32 mtu);
736
737 bool tipc_msg_make_bundle(struct sk_buff_head *list, struct sk_buff *skb,
738                           u32 mtu, u32 dnode);
739
740 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m, int offset,
741                    int dsz, int mtu, struct sk_buff_head *list);
742
743 struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list);
744
745 #endif