net/tipc/msg.h

   1 /*
   2  * net/tipc/msg.h: Include file for TIPC message header routines
   3  *
   4  * Copyright (c) 2000-2007, 2014-2017 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 <linux/tipc.h>
  41 #include "core.h"
  42
  43 /*
  44  * Constants and routines used to read and write TIPC payload message headers
  45  *
  46  * Note: Some items are also used with TIPC internal message headers
  47  */
  48 #define TIPC_VERSION              2
  49 struct plist;
  50
  51 /*
  52  * Payload message users are defined in TIPC's public API:
  53  * - TIPC_LOW_IMPORTANCE
  54  * - TIPC_MEDIUM_IMPORTANCE
  55  * - TIPC_HIGH_IMPORTANCE
  56  * - TIPC_CRITICAL_IMPORTANCE
  57  */
  58 #define TIPC_SYSTEM_IMPORTANCE  4
  59
  60
  61 /*
  62  * Payload message types
  63  */
  64 #define TIPC_CONN_MSG           0
  65 #define TIPC_MCAST_MSG          1
  66 #define TIPC_NAMED_MSG          2
  67 #define TIPC_DIRECT_MSG         3
  68 #define TIPC_GRP_MEMBER_EVT     4
  69 #define TIPC_GRP_BCAST_MSG      5
  70 #define TIPC_GRP_MCAST_MSG      6
  71 #define TIPC_GRP_UCAST_MSG      7
  72
  73 /*
  74  * Internal message users
  75  */
  76 #define  BCAST_PROTOCOL       5
  77 #define  MSG_BUNDLER          6
  78 #define  LINK_PROTOCOL        7
  79 #define  CONN_MANAGER         8
  80 #define  GROUP_PROTOCOL       9
  81 #define  TUNNEL_PROTOCOL      10
  82 #define  NAME_DISTRIBUTOR     11
  83 #define  MSG_FRAGMENTER       12
  84 #define  LINK_CONFIG          13
  85 #define  SOCK_WAKEUP          14       /* pseudo user */
  86 #define  TOP_SRV              15       /* pseudo user */
  87
  88 /*
  89  * Message header sizes
  90  */
  91 #define SHORT_H_SIZE              24    /* In-cluster basic payload message */
  92 #define BASIC_H_SIZE              32    /* Basic payload message */
  93 #define NAMED_H_SIZE              40    /* Named payload message */
  94 #define MCAST_H_SIZE              44    /* Multicast payload message */
  95 #define GROUP_H_SIZE              44    /* Group payload message */
  96 #define INT_H_SIZE                40    /* Internal messages */
  97 #define MIN_H_SIZE                24    /* Smallest legal TIPC header size */
  98 #define MAX_H_SIZE                60    /* Largest possible TIPC header size */
  99
 100 #define MAX_MSG_SIZE (MAX_H_SIZE + TIPC_MAX_USER_MSG_SIZE)
 101 #define FB_MTU                  3744
 102 #define TIPC_MEDIA_INFO_OFFSET  5
 103
 104 struct tipc_skb_cb {
 105         u32 bytes_read;
 106         u32 orig_member;
 107         struct sk_buff *tail;
 108         unsigned long nxt_retr;
 109         bool validated;
 110         u16 chain_imp;
 111         u16 ackers;
 112 };
 113
 114 #define TIPC_SKB_CB(__skb) ((struct tipc_skb_cb *)&((__skb)->cb[0]))
 115
 116 struct tipc_msg {
 117         __be32 hdr[15];
 118 };
 119
 120 /* struct tipc_gap_ack - TIPC Gap ACK block
 121  * @ack: seqno of the last consecutive packet in link deferdq
 122  * @gap: number of gap packets since the last ack
 123  *
 124  * E.g:
 125  *       link deferdq: 1 2 3 4      10 11      13 14 15       20
 126  * --> Gap ACK blocks:      <4, 5>,   <11, 1>,      <15, 4>, <20, 0>
 127  */
 128 struct tipc_gap_ack {
 129         __be16 ack;
 130         __be16 gap;
 131 };
 132
 133 /* struct tipc_gap_ack_blks
 134  * @len: actual length of the record
 135  * @gack_cnt: number of Gap ACK blocks in the record
 136  * @gacks: array of Gap ACK blocks
 137  */
 138 struct tipc_gap_ack_blks {
 139         __be16 len;
 140         u8 gack_cnt;
 141         u8 reserved;
 142         struct tipc_gap_ack gacks[];
 143 };
 144
 145 #define tipc_gap_ack_blks_sz(n) (sizeof(struct tipc_gap_ack_blks) + \
 146                                  sizeof(struct tipc_gap_ack) * (n))
 147
 148 #define MAX_GAP_ACK_BLKS        32
 149 #define MAX_GAP_ACK_BLKS_SZ     tipc_gap_ack_blks_sz(MAX_GAP_ACK_BLKS)
 150
 151 static inline struct tipc_msg *buf_msg(struct sk_buff *skb)
 152 {
 153         return (struct tipc_msg *)skb->data;
 154 }
 155
 156 static inline u32 msg_word(struct tipc_msg *m, u32 pos)
 157 {
 158         return ntohl(m->hdr[pos]);
 159 }
 160
 161 static inline void msg_set_word(struct tipc_msg *m, u32 w, u32 val)
 162 {
 163         m->hdr[w] = htonl(val);
 164 }
 165
 166 static inline u32 msg_bits(struct tipc_msg *m, u32 w, u32 pos, u32 mask)
 167 {
 168         return (msg_word(m, w) >> pos) & mask;
 169 }
 170
 171 static inline void msg_set_bits(struct tipc_msg *m, u32 w,
 172                                 u32 pos, u32 mask, u32 val)
 173 {
 174         val = (val & mask) << pos;
 175         mask = mask << pos;
 176         m->hdr[w] &= ~htonl(mask);
 177         m->hdr[w] |= htonl(val);
 178 }
 179
 180 static inline void msg_swap_words(struct tipc_msg *msg, u32 a, u32 b)
 181 {
 182         u32 temp = msg->hdr[a];
 183
 184         msg->hdr[a] = msg->hdr[b];
 185         msg->hdr[b] = temp;
 186 }
 187
 188 /*
 189  * Word 0
 190  */
 191 static inline u32 msg_version(struct tipc_msg *m)
 192 {
 193         return msg_bits(m, 0, 29, 7);
 194 }
 195
 196 static inline void msg_set_version(struct tipc_msg *m)
 197 {
 198         msg_set_bits(m, 0, 29, 7, TIPC_VERSION);
 199 }
 200
 201 static inline u32 msg_user(struct tipc_msg *m)
 202 {
 203         return msg_bits(m, 0, 25, 0xf);
 204 }
 205
 206 static inline u32 msg_isdata(struct tipc_msg *m)
 207 {
 208         return msg_user(m) <= TIPC_CRITICAL_IMPORTANCE;
 209 }
 210
 211 static inline void msg_set_user(struct tipc_msg *m, u32 n)
 212 {
 213         msg_set_bits(m, 0, 25, 0xf, n);
 214 }
 215
 216 static inline u32 msg_hdr_sz(struct tipc_msg *m)
 217 {
 218         return msg_bits(m, 0, 21, 0xf) << 2;
 219 }
 220
 221 static inline void msg_set_hdr_sz(struct tipc_msg *m, u32 n)
 222 {
 223         msg_set_bits(m, 0, 21, 0xf, n>>2);
 224 }
 225
 226 static inline u32 msg_size(struct tipc_msg *m)
 227 {
 228         return msg_bits(m, 0, 0, 0x1ffff);
 229 }
 230
 231 static inline u32 msg_blocks(struct tipc_msg *m)
 232 {
 233         return (msg_size(m) / 1024) + 1;
 234 }
 235
 236 static inline u32 msg_data_sz(struct tipc_msg *m)
 237 {
 238         return msg_size(m) - msg_hdr_sz(m);
 239 }
 240
 241 static inline int msg_non_seq(struct tipc_msg *m)
 242 {
 243         return msg_bits(m, 0, 20, 1);
 244 }
 245
 246 static inline void msg_set_non_seq(struct tipc_msg *m, u32 n)
 247 {
 248         msg_set_bits(m, 0, 20, 1, n);
 249 }
 250
 251 static inline int msg_is_syn(struct tipc_msg *m)
 252 {
 253         return msg_bits(m, 0, 17, 1);
 254 }
 255
 256 static inline void msg_set_syn(struct tipc_msg *m, u32 d)
 257 {
 258         msg_set_bits(m, 0, 17, 1, d);
 259 }
 260
 261 static inline int msg_dest_droppable(struct tipc_msg *m)
 262 {
 263         return msg_bits(m, 0, 19, 1);
 264 }
 265
 266 static inline void msg_set_dest_droppable(struct tipc_msg *m, u32 d)
 267 {
 268         msg_set_bits(m, 0, 19, 1, d);
 269 }
 270
 271 static inline int msg_is_keepalive(struct tipc_msg *m)
 272 {
 273         return msg_bits(m, 0, 19, 1);
 274 }
 275
 276 static inline void msg_set_is_keepalive(struct tipc_msg *m, u32 d)
 277 {
 278         msg_set_bits(m, 0, 19, 1, d);
 279 }
 280
 281 static inline int msg_src_droppable(struct tipc_msg *m)
 282 {
 283         return msg_bits(m, 0, 18, 1);
 284 }
 285
 286 static inline void msg_set_src_droppable(struct tipc_msg *m, u32 d)
 287 {
 288         msg_set_bits(m, 0, 18, 1, d);
 289 }
 290
 291 static inline bool msg_is_rcast(struct tipc_msg *m)
 292 {
 293         return msg_bits(m, 0, 18, 0x1);
 294 }
 295
 296 static inline void msg_set_is_rcast(struct tipc_msg *m, bool d)
 297 {
 298         msg_set_bits(m, 0, 18, 0x1, d);
 299 }
 300
 301 static inline void msg_set_size(struct tipc_msg *m, u32 sz)
 302 {
 303         m->hdr[0] = htonl((msg_word(m, 0) & ~0x1ffff) | sz);
 304 }
 305
 306 static inline unchar *msg_data(struct tipc_msg *m)
 307 {
 308         return ((unchar *)m) + msg_hdr_sz(m);
 309 }
 310
 311 static inline struct tipc_msg *msg_inner_hdr(struct tipc_msg *m)
 312 {
 313         return (struct tipc_msg *)msg_data(m);
 314 }
 315
 316 /*
 317  * Word 1
 318  */
 319 static inline u32 msg_type(struct tipc_msg *m)
 320 {
 321         return msg_bits(m, 1, 29, 0x7);
 322 }
 323
 324 static inline void msg_set_type(struct tipc_msg *m, u32 n)
 325 {
 326         msg_set_bits(m, 1, 29, 0x7, n);
 327 }
 328
 329 static inline int msg_in_group(struct tipc_msg *m)
 330 {
 331         int mtyp = msg_type(m);
 332
 333         return mtyp >= TIPC_GRP_MEMBER_EVT && mtyp <= TIPC_GRP_UCAST_MSG;
 334 }
 335
 336 static inline bool msg_is_grp_evt(struct tipc_msg *m)
 337 {
 338         return msg_type(m) == TIPC_GRP_MEMBER_EVT;
 339 }
 340
 341 static inline u32 msg_named(struct tipc_msg *m)
 342 {
 343         return msg_type(m) == TIPC_NAMED_MSG;
 344 }
 345
 346 static inline u32 msg_mcast(struct tipc_msg *m)
 347 {
 348         int mtyp = msg_type(m);
 349
 350         return ((mtyp == TIPC_MCAST_MSG) || (mtyp == TIPC_GRP_BCAST_MSG) ||
 351                 (mtyp == TIPC_GRP_MCAST_MSG));
 352 }
 353
 354 static inline u32 msg_connected(struct tipc_msg *m)
 355 {
 356         return msg_type(m) == TIPC_CONN_MSG;
 357 }
 358
 359 static inline u32 msg_errcode(struct tipc_msg *m)
 360 {
 361         return msg_bits(m, 1, 25, 0xf);
 362 }
 363
 364 static inline void msg_set_errcode(struct tipc_msg *m, u32 err)
 365 {
 366         msg_set_bits(m, 1, 25, 0xf, err);
 367 }
 368
 369 static inline u32 msg_reroute_cnt(struct tipc_msg *m)
 370 {
 371         return msg_bits(m, 1, 21, 0xf);
 372 }
 373
 374 static inline void msg_incr_reroute_cnt(struct tipc_msg *m)
 375 {
 376         msg_set_bits(m, 1, 21, 0xf, msg_reroute_cnt(m) + 1);
 377 }
 378
 379 static inline void msg_reset_reroute_cnt(struct tipc_msg *m)
 380 {
 381         msg_set_bits(m, 1, 21, 0xf, 0);
 382 }
 383
 384 static inline u32 msg_lookup_scope(struct tipc_msg *m)
 385 {
 386         return msg_bits(m, 1, 19, 0x3);
 387 }
 388
 389 static inline void msg_set_lookup_scope(struct tipc_msg *m, u32 n)
 390 {
 391         msg_set_bits(m, 1, 19, 0x3, n);
 392 }
 393
 394 static inline u16 msg_bcast_ack(struct tipc_msg *m)
 395 {
 396         return msg_bits(m, 1, 0, 0xffff);
 397 }
 398
 399 static inline void msg_set_bcast_ack(struct tipc_msg *m, u16 n)
 400 {
 401         msg_set_bits(m, 1, 0, 0xffff, n);
 402 }
 403
 404 /* Note: reusing bits in word 1 for ACTIVATE_MSG only, to re-synch
 405  * link peer session number
 406  */
 407 static inline bool msg_dest_session_valid(struct tipc_msg *m)
 408 {
 409         return msg_bits(m, 1, 16, 0x1);
 410 }
 411
 412 static inline void msg_set_dest_session_valid(struct tipc_msg *m, bool valid)
 413 {
 414         msg_set_bits(m, 1, 16, 0x1, valid);
 415 }
 416
 417 static inline u16 msg_dest_session(struct tipc_msg *m)
 418 {
 419         return msg_bits(m, 1, 0, 0xffff);
 420 }
 421
 422 static inline void msg_set_dest_session(struct tipc_msg *m, u16 n)
 423 {
 424         msg_set_bits(m, 1, 0, 0xffff, n);
 425 }
 426
 427 /*
 428  * Word 2
 429  */
 430 static inline u16 msg_ack(struct tipc_msg *m)
 431 {
 432         return msg_bits(m, 2, 16, 0xffff);
 433 }
 434
 435 static inline void msg_set_ack(struct tipc_msg *m, u16 n)
 436 {
 437         msg_set_bits(m, 2, 16, 0xffff, n);
 438 }
 439
 440 static inline u16 msg_seqno(struct tipc_msg *m)
 441 {
 442         return msg_bits(m, 2, 0, 0xffff);
 443 }
 444
 445 static inline void msg_set_seqno(struct tipc_msg *m, u16 n)
 446 {
 447         msg_set_bits(m, 2, 0, 0xffff, n);
 448 }
 449
 450 /*
 451  * Words 3-10
 452  */
 453 static inline u32 msg_importance(struct tipc_msg *m)
 454 {
 455         int usr = msg_user(m);
 456
 457         if (likely((usr <= TIPC_CRITICAL_IMPORTANCE) && !msg_errcode(m)))
 458                 return usr;
 459         if ((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER))
 460                 return msg_bits(m, 9, 0, 0x7);
 461         return TIPC_SYSTEM_IMPORTANCE;
 462 }
 463
 464 static inline void msg_set_importance(struct tipc_msg *m, u32 i)
 465 {
 466         int usr = msg_user(m);
 467
 468         if (likely((usr == MSG_FRAGMENTER) || (usr == MSG_BUNDLER)))
 469                 msg_set_bits(m, 9, 0, 0x7, i);
 470         else if (i < TIPC_SYSTEM_IMPORTANCE)
 471                 msg_set_user(m, i);
 472         else
 473                 pr_warn("Trying to set illegal importance in message\n");
 474 }
 475
 476 static inline u32 msg_prevnode(struct tipc_msg *m)
 477 {
 478         return msg_word(m, 3);
 479 }
 480
 481 static inline void msg_set_prevnode(struct tipc_msg *m, u32 a)
 482 {
 483         msg_set_word(m, 3, a);
 484 }
 485
 486 static inline u32 msg_origport(struct tipc_msg *m)
 487 {
 488         if (msg_user(m) == MSG_FRAGMENTER)
 489                 m = msg_inner_hdr(m);
 490         return msg_word(m, 4);
 491 }
 492
 493 static inline void msg_set_origport(struct tipc_msg *m, u32 p)
 494 {
 495         msg_set_word(m, 4, p);
 496 }
 497
 498 static inline u32 msg_destport(struct tipc_msg *m)
 499 {
 500         return msg_word(m, 5);
 501 }
 502
 503 static inline void msg_set_destport(struct tipc_msg *m, u32 p)
 504 {
 505         msg_set_word(m, 5, p);
 506 }
 507
 508 static inline u32 msg_mc_netid(struct tipc_msg *m)
 509 {
 510         return msg_word(m, 5);
 511 }
 512
 513 static inline void msg_set_mc_netid(struct tipc_msg *m, u32 p)
 514 {
 515         msg_set_word(m, 5, p);
 516 }
 517
 518 static inline int msg_short(struct tipc_msg *m)
 519 {
 520         return msg_hdr_sz(m) == SHORT_H_SIZE;
 521 }
 522
 523 static inline u32 msg_orignode(struct tipc_msg *m)
 524 {
 525         if (likely(msg_short(m)))
 526                 return msg_prevnode(m);
 527         return msg_word(m, 6);
 528 }
 529
 530 static inline void msg_set_orignode(struct tipc_msg *m, u32 a)
 531 {
 532         msg_set_word(m, 6, a);
 533 }
 534
 535 static inline u32 msg_destnode(struct tipc_msg *m)
 536 {
 537         return msg_word(m, 7);
 538 }
 539
 540 static inline void msg_set_destnode(struct tipc_msg *m, u32 a)
 541 {
 542         msg_set_word(m, 7, a);
 543 }
 544
 545 static inline u32 msg_nametype(struct tipc_msg *m)
 546 {
 547         return msg_word(m, 8);
 548 }
 549
 550 static inline void msg_set_nametype(struct tipc_msg *m, u32 n)
 551 {
 552         msg_set_word(m, 8, n);
 553 }
 554
 555 static inline u32 msg_nameinst(struct tipc_msg *m)
 556 {
 557         return msg_word(m, 9);
 558 }
 559
 560 static inline u32 msg_namelower(struct tipc_msg *m)
 561 {
 562         return msg_nameinst(m);
 563 }
 564
 565 static inline void msg_set_namelower(struct tipc_msg *m, u32 n)
 566 {
 567         msg_set_word(m, 9, n);
 568 }
 569
 570 static inline void msg_set_nameinst(struct tipc_msg *m, u32 n)
 571 {
 572         msg_set_namelower(m, n);
 573 }
 574
 575 static inline u32 msg_nameupper(struct tipc_msg *m)
 576 {
 577         return msg_word(m, 10);
 578 }
 579
 580 static inline void msg_set_nameupper(struct tipc_msg *m, u32 n)
 581 {
 582         msg_set_word(m, 10, n);
 583 }
 584
 585 /*
 586  * Constants and routines used to read and write TIPC internal message headers
 587  */
 588
 589 /*
 590  *  Connection management protocol message types
 591  */
 592 #define CONN_PROBE        0
 593 #define CONN_PROBE_REPLY  1
 594 #define CONN_ACK          2
 595
 596 /*
 597  * Name distributor message types
 598  */
 599 #define PUBLICATION       0
 600 #define WITHDRAWAL        1
 601
 602 /*
 603  * Segmentation message types
 604  */
 605 #define FIRST_FRAGMENT          0
 606 #define FRAGMENT                1
 607 #define LAST_FRAGMENT           2
 608
 609 /*
 610  * Link management protocol message types
 611  */
 612 #define STATE_MSG               0
 613 #define RESET_MSG               1
 614 #define ACTIVATE_MSG            2
 615
 616 /*
 617  * Changeover tunnel message types
 618  */
 619 #define SYNCH_MSG               0
 620 #define FAILOVER_MSG            1
 621
 622 /*
 623  * Config protocol message types
 624  */
 625 #define DSC_REQ_MSG             0
 626 #define DSC_RESP_MSG            1
 627 #define DSC_TRIAL_MSG           2
 628 #define DSC_TRIAL_FAIL_MSG      3
 629
 630 /*
 631  * Group protocol message types
 632  */
 633 #define GRP_JOIN_MSG         0
 634 #define GRP_LEAVE_MSG        1
 635 #define GRP_ADV_MSG          2
 636 #define GRP_ACK_MSG          3
 637 #define GRP_RECLAIM_MSG      4
 638 #define GRP_REMIT_MSG        5
 639
 640 /*
 641  * Word 1
 642  */
 643 static inline u32 msg_seq_gap(struct tipc_msg *m)
 644 {
 645         return msg_bits(m, 1, 16, 0x1fff);
 646 }
 647
 648 static inline void msg_set_seq_gap(struct tipc_msg *m, u32 n)
 649 {
 650         msg_set_bits(m, 1, 16, 0x1fff, n);
 651 }
 652
 653 static inline u32 msg_node_sig(struct tipc_msg *m)
 654 {
 655         return msg_bits(m, 1, 0, 0xffff);
 656 }
 657
 658 static inline void msg_set_node_sig(struct tipc_msg *m, u32 n)
 659 {
 660         msg_set_bits(m, 1, 0, 0xffff, n);
 661 }
 662
 663 static inline u32 msg_node_capabilities(struct tipc_msg *m)
 664 {
 665         return msg_bits(m, 1, 15, 0x1fff);
 666 }
 667
 668 static inline void msg_set_node_capabilities(struct tipc_msg *m, u32 n)
 669 {
 670         msg_set_bits(m, 1, 15, 0x1fff, n);
 671 }
 672
 673 /*
 674  * Word 2
 675  */
 676 static inline u32 msg_dest_domain(struct tipc_msg *m)
 677 {
 678         return msg_word(m, 2);
 679 }
 680
 681 static inline void msg_set_dest_domain(struct tipc_msg *m, u32 n)
 682 {
 683         msg_set_word(m, 2, n);
 684 }
 685
 686 static inline u32 msg_bcgap_after(struct tipc_msg *m)
 687 {
 688         return msg_bits(m, 2, 16, 0xffff);
 689 }
 690
 691 static inline void msg_set_bcgap_after(struct tipc_msg *m, u32 n)
 692 {
 693         msg_set_bits(m, 2, 16, 0xffff, n);
 694 }
 695
 696 static inline u32 msg_bcgap_to(struct tipc_msg *m)
 697 {
 698         return msg_bits(m, 2, 0, 0xffff);
 699 }
 700
 701 static inline void msg_set_bcgap_to(struct tipc_msg *m, u32 n)
 702 {
 703         msg_set_bits(m, 2, 0, 0xffff, n);
 704 }
 705
 706 /*
 707  * Word 4
 708  */
 709 static inline u32 msg_last_bcast(struct tipc_msg *m)
 710 {
 711         return msg_bits(m, 4, 16, 0xffff);
 712 }
 713
 714 static inline u32 msg_bc_snd_nxt(struct tipc_msg *m)
 715 {
 716         return msg_last_bcast(m) + 1;
 717 }
 718
 719 static inline void msg_set_last_bcast(struct tipc_msg *m, u32 n)
 720 {
 721         msg_set_bits(m, 4, 16, 0xffff, n);
 722 }
 723
 724 static inline u32 msg_nof_fragms(struct tipc_msg *m)
 725 {
 726         return msg_bits(m, 4, 0, 0xffff);
 727 }
 728
 729 static inline void msg_set_nof_fragms(struct tipc_msg *m, u32 n)
 730 {
 731         msg_set_bits(m, 4, 0, 0xffff, n);
 732 }
 733
 734 static inline u32 msg_fragm_no(struct tipc_msg *m)
 735 {
 736         return msg_bits(m, 4, 16, 0xffff);
 737 }
 738
 739 static inline void msg_set_fragm_no(struct tipc_msg *m, u32 n)
 740 {
 741         msg_set_bits(m, 4, 16, 0xffff, n);
 742 }
 743
 744 static inline u16 msg_next_sent(struct tipc_msg *m)
 745 {
 746         return msg_bits(m, 4, 0, 0xffff);
 747 }
 748
 749 static inline void msg_set_next_sent(struct tipc_msg *m, u16 n)
 750 {
 751         msg_set_bits(m, 4, 0, 0xffff, n);
 752 }
 753
 754 static inline void msg_set_long_msgno(struct tipc_msg *m, u32 n)
 755 {
 756         msg_set_bits(m, 4, 0, 0xffff, n);
 757 }
 758
 759 static inline u32 msg_bc_netid(struct tipc_msg *m)
 760 {
 761         return msg_word(m, 4);
 762 }
 763
 764 static inline void msg_set_bc_netid(struct tipc_msg *m, u32 id)
 765 {
 766         msg_set_word(m, 4, id);
 767 }
 768
 769 static inline u32 msg_link_selector(struct tipc_msg *m)
 770 {
 771         if (msg_user(m) == MSG_FRAGMENTER)
 772                 m = (void *)msg_data(m);
 773         return msg_bits(m, 4, 0, 1);
 774 }
 775
 776 /*
 777  * Word 5
 778  */
 779 static inline u16 msg_session(struct tipc_msg *m)
 780 {
 781         return msg_bits(m, 5, 16, 0xffff);
 782 }
 783
 784 static inline void msg_set_session(struct tipc_msg *m, u16 n)
 785 {
 786         msg_set_bits(m, 5, 16, 0xffff, n);
 787 }
 788
 789 static inline u32 msg_probe(struct tipc_msg *m)
 790 {
 791         return msg_bits(m, 5, 0, 1);
 792 }
 793
 794 static inline void msg_set_probe(struct tipc_msg *m, u32 val)
 795 {
 796         msg_set_bits(m, 5, 0, 1, val);
 797 }
 798
 799 static inline char msg_net_plane(struct tipc_msg *m)
 800 {
 801         return msg_bits(m, 5, 1, 7) + 'A';
 802 }
 803
 804 static inline void msg_set_net_plane(struct tipc_msg *m, char n)
 805 {
 806         msg_set_bits(m, 5, 1, 7, (n - 'A'));
 807 }
 808
 809 static inline u32 msg_linkprio(struct tipc_msg *m)
 810 {
 811         return msg_bits(m, 5, 4, 0x1f);
 812 }
 813
 814 static inline void msg_set_linkprio(struct tipc_msg *m, u32 n)
 815 {
 816         msg_set_bits(m, 5, 4, 0x1f, n);
 817 }
 818
 819 static inline u32 msg_bearer_id(struct tipc_msg *m)
 820 {
 821         return msg_bits(m, 5, 9, 0x7);
 822 }
 823
 824 static inline void msg_set_bearer_id(struct tipc_msg *m, u32 n)
 825 {
 826         msg_set_bits(m, 5, 9, 0x7, n);
 827 }
 828
 829 static inline u32 msg_redundant_link(struct tipc_msg *m)
 830 {
 831         return msg_bits(m, 5, 12, 0x1);
 832 }
 833
 834 static inline void msg_set_redundant_link(struct tipc_msg *m, u32 r)
 835 {
 836         msg_set_bits(m, 5, 12, 0x1, r);
 837 }
 838
 839 static inline u32 msg_peer_stopping(struct tipc_msg *m)
 840 {
 841         return msg_bits(m, 5, 13, 0x1);
 842 }
 843
 844 static inline void msg_set_peer_stopping(struct tipc_msg *m, u32 s)
 845 {
 846         msg_set_bits(m, 5, 13, 0x1, s);
 847 }
 848
 849 static inline bool msg_bc_ack_invalid(struct tipc_msg *m)
 850 {
 851         switch (msg_user(m)) {
 852         case BCAST_PROTOCOL:
 853         case NAME_DISTRIBUTOR:
 854         case LINK_PROTOCOL:
 855                 return msg_bits(m, 5, 14, 0x1);
 856         default:
 857                 return false;
 858         }
 859 }
 860
 861 static inline void msg_set_bc_ack_invalid(struct tipc_msg *m, bool invalid)
 862 {
 863         msg_set_bits(m, 5, 14, 0x1, invalid);
 864 }
 865
 866 static inline char *msg_media_addr(struct tipc_msg *m)
 867 {
 868         return (char *)&m->hdr[TIPC_MEDIA_INFO_OFFSET];
 869 }
 870
 871 static inline u32 msg_bc_gap(struct tipc_msg *m)
 872 {
 873         return msg_bits(m, 8, 0, 0x3ff);
 874 }
 875
 876 static inline void msg_set_bc_gap(struct tipc_msg *m, u32 n)
 877 {
 878         msg_set_bits(m, 8, 0, 0x3ff, n);
 879 }
 880
 881 /*
 882  * Word 9
 883  */
 884 static inline u16 msg_msgcnt(struct tipc_msg *m)
 885 {
 886         return msg_bits(m, 9, 16, 0xffff);
 887 }
 888
 889 static inline void msg_set_msgcnt(struct tipc_msg *m, u16 n)
 890 {
 891         msg_set_bits(m, 9, 16, 0xffff, n);
 892 }
 893
 894 static inline u16 msg_syncpt(struct tipc_msg *m)
 895 {
 896         return msg_bits(m, 9, 16, 0xffff);
 897 }
 898
 899 static inline void msg_set_syncpt(struct tipc_msg *m, u16 n)
 900 {
 901         msg_set_bits(m, 9, 16, 0xffff, n);
 902 }
 903
 904 static inline u32 msg_conn_ack(struct tipc_msg *m)
 905 {
 906         return msg_bits(m, 9, 16, 0xffff);
 907 }
 908
 909 static inline void msg_set_conn_ack(struct tipc_msg *m, u32 n)
 910 {
 911         msg_set_bits(m, 9, 16, 0xffff, n);
 912 }
 913
 914 static inline u16 msg_adv_win(struct tipc_msg *m)
 915 {
 916         return msg_bits(m, 9, 0, 0xffff);
 917 }
 918
 919 static inline void msg_set_adv_win(struct tipc_msg *m, u16 n)
 920 {
 921         msg_set_bits(m, 9, 0, 0xffff, n);
 922 }
 923
 924 static inline u32 msg_max_pkt(struct tipc_msg *m)
 925 {
 926         return msg_bits(m, 9, 16, 0xffff) * 4;
 927 }
 928
 929 static inline void msg_set_max_pkt(struct tipc_msg *m, u32 n)
 930 {
 931         msg_set_bits(m, 9, 16, 0xffff, (n / 4));
 932 }
 933
 934 static inline u32 msg_link_tolerance(struct tipc_msg *m)
 935 {
 936         return msg_bits(m, 9, 0, 0xffff);
 937 }
 938
 939 static inline void msg_set_link_tolerance(struct tipc_msg *m, u32 n)
 940 {
 941         msg_set_bits(m, 9, 0, 0xffff, n);
 942 }
 943
 944 static inline u16 msg_grp_bc_syncpt(struct tipc_msg *m)
 945 {
 946         return msg_bits(m, 9, 16, 0xffff);
 947 }
 948
 949 static inline void msg_set_grp_bc_syncpt(struct tipc_msg *m, u16 n)
 950 {
 951         msg_set_bits(m, 9, 16, 0xffff, n);
 952 }
 953
 954 static inline u16 msg_grp_bc_acked(struct tipc_msg *m)
 955 {
 956         return msg_bits(m, 9, 16, 0xffff);
 957 }
 958
 959 static inline void msg_set_grp_bc_acked(struct tipc_msg *m, u16 n)
 960 {
 961         msg_set_bits(m, 9, 16, 0xffff, n);
 962 }
 963
 964 static inline u16 msg_grp_remitted(struct tipc_msg *m)
 965 {
 966         return msg_bits(m, 9, 16, 0xffff);
 967 }
 968
 969 static inline void msg_set_grp_remitted(struct tipc_msg *m, u16 n)
 970 {
 971         msg_set_bits(m, 9, 16, 0xffff, n);
 972 }
 973
 974 /* Word 10
 975  */
 976 static inline u16 msg_grp_evt(struct tipc_msg *m)
 977 {
 978         return msg_bits(m, 10, 0, 0x3);
 979 }
 980
 981 static inline void msg_set_grp_evt(struct tipc_msg *m, int n)
 982 {
 983         msg_set_bits(m, 10, 0, 0x3, n);
 984 }
 985
 986 static inline u16 msg_grp_bc_ack_req(struct tipc_msg *m)
 987 {
 988         return msg_bits(m, 10, 0, 0x1);
 989 }
 990
 991 static inline void msg_set_grp_bc_ack_req(struct tipc_msg *m, bool n)
 992 {
 993         msg_set_bits(m, 10, 0, 0x1, n);
 994 }
 995
 996 static inline u16 msg_grp_bc_seqno(struct tipc_msg *m)
 997 {
 998         return msg_bits(m, 10, 16, 0xffff);
 999 }
1000
1001 static inline void msg_set_grp_bc_seqno(struct tipc_msg *m, u32 n)
1002 {
1003         msg_set_bits(m, 10, 16, 0xffff, n);
1004 }
1005
1006 static inline bool msg_peer_link_is_up(struct tipc_msg *m)
1007 {
1008         if (likely(msg_user(m) != LINK_PROTOCOL))
1009                 return true;
1010         if (msg_type(m) == STATE_MSG)
1011                 return true;
1012         return false;
1013 }
1014
1015 static inline bool msg_peer_node_is_up(struct tipc_msg *m)
1016 {
1017         if (msg_peer_link_is_up(m))
1018                 return true;
1019         return msg_redundant_link(m);
1020 }
1021
1022 static inline bool msg_is_reset(struct tipc_msg *hdr)
1023 {
1024         return (msg_user(hdr) == LINK_PROTOCOL) && (msg_type(hdr) == RESET_MSG);
1025 }
1026
1027 static inline u32 msg_sugg_node_addr(struct tipc_msg *m)
1028 {
1029         return msg_word(m, 14);
1030 }
1031
1032 static inline void msg_set_sugg_node_addr(struct tipc_msg *m, u32 n)
1033 {
1034         msg_set_word(m, 14, n);
1035 }
1036
1037 static inline void msg_set_node_id(struct tipc_msg *hdr, u8 *id)
1038 {
1039         memcpy(msg_data(hdr), id, 16);
1040 }
1041
1042 static inline u8 *msg_node_id(struct tipc_msg *hdr)
1043 {
1044         return (u8 *)msg_data(hdr);
1045 }
1046
1047 struct sk_buff *tipc_buf_acquire(u32 size, gfp_t gfp);
1048 bool tipc_msg_validate(struct sk_buff **_skb);
1049 bool tipc_msg_reverse(u32 own_addr, struct sk_buff **skb, int err);
1050 void tipc_skb_reject(struct net *net, int err, struct sk_buff *skb,
1051                      struct sk_buff_head *xmitq);
1052 void tipc_msg_init(u32 own_addr, struct tipc_msg *m, u32 user, u32 type,
1053                    u32 hsize, u32 destnode);
1054 struct sk_buff *tipc_msg_create(uint user, uint type, uint hdr_sz,
1055                                 uint data_sz, u32 dnode, u32 onode,
1056                                 u32 dport, u32 oport, int errcode);
1057 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf);
1058 bool tipc_msg_bundle(struct sk_buff *skb, struct tipc_msg *msg, u32 mtu);
1059 bool tipc_msg_make_bundle(struct sk_buff **skb, struct tipc_msg *msg,
1060                           u32 mtu, u32 dnode);
1061 bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos);
1062 int tipc_msg_fragment(struct sk_buff *skb, const struct tipc_msg *hdr,
1063                       int pktmax, struct sk_buff_head *frags);
1064 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
1065                    int offset, int dsz, int mtu, struct sk_buff_head *list);
1066 bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb, int *err);
1067 bool tipc_msg_assemble(struct sk_buff_head *list);
1068 bool tipc_msg_reassemble(struct sk_buff_head *list, struct sk_buff_head *rcvq);
1069 bool tipc_msg_pskb_copy(u32 dst, struct sk_buff_head *msg,
1070                         struct sk_buff_head *cpy);
1071 void __tipc_skb_queue_sorted(struct sk_buff_head *list, u16 seqno,
1072                              struct sk_buff *skb);
1073 bool tipc_msg_skb_clone(struct sk_buff_head *msg, struct sk_buff_head *cpy);
1074
1075 static inline u16 buf_seqno(struct sk_buff *skb)
1076 {
1077         return msg_seqno(buf_msg(skb));
1078 }
1079
1080 static inline int buf_roundup_len(struct sk_buff *skb)
1081 {
1082         return (skb->len / 1024 + 1) * 1024;
1083 }
1084
1085 /* tipc_skb_peek(): peek and reserve first buffer in list
1086  * @list: list to be peeked in
1087  * Returns pointer to first buffer in list, if any
1088  */
1089 static inline struct sk_buff *tipc_skb_peek(struct sk_buff_head *list,
1090                                             spinlock_t *lock)
1091 {
1092         struct sk_buff *skb;
1093
1094         spin_lock_bh(lock);
1095         skb = skb_peek(list);
1096         if (skb)
1097                 skb_get(skb);
1098         spin_unlock_bh(lock);
1099         return skb;
1100 }
1101
1102 /* tipc_skb_peek_port(): find a destination port, ignoring all destinations
1103  *                       up to and including 'filter'.
1104  * Note: ignoring previously tried destinations minimizes the risk of
1105  *       contention on the socket lock
1106  * @list: list to be peeked in
1107  * @filter: last destination to be ignored from search
1108  * Returns a destination port number, of applicable.
1109  */
1110 static inline u32 tipc_skb_peek_port(struct sk_buff_head *list, u32 filter)
1111 {
1112         struct sk_buff *skb;
1113         u32 dport = 0;
1114         bool ignore = true;
1115
1116         spin_lock_bh(&list->lock);
1117         skb_queue_walk(list, skb) {
1118                 dport = msg_destport(buf_msg(skb));
1119                 if (!filter || skb_queue_is_last(list, skb))
1120                         break;
1121                 if (dport == filter)
1122                         ignore = false;
1123                 else if (!ignore)
1124                         break;
1125         }
1126         spin_unlock_bh(&list->lock);
1127         return dport;
1128 }
1129
1130 /* tipc_skb_dequeue(): unlink first buffer with dest 'dport' from list
1131  * @list: list to be unlinked from
1132  * @dport: selection criteria for buffer to unlink
1133  */
1134 static inline struct sk_buff *tipc_skb_dequeue(struct sk_buff_head *list,
1135                                                u32 dport)
1136 {
1137         struct sk_buff *_skb, *tmp, *skb = NULL;
1138
1139         spin_lock_bh(&list->lock);
1140         skb_queue_walk_safe(list, _skb, tmp) {
1141                 if (msg_destport(buf_msg(_skb)) == dport) {
1142                         __skb_unlink(_skb, list);
1143                         skb = _skb;
1144                         break;
1145                 }
1146         }
1147         spin_unlock_bh(&list->lock);
1148         return skb;
1149 }
1150
1151 /* tipc_skb_queue_splice_tail - append an skb list to lock protected list
1152  * @list: the new list to append. Not lock protected
1153  * @head: target list. Lock protected.
1154  */
1155 static inline void tipc_skb_queue_splice_tail(struct sk_buff_head *list,
1156                                               struct sk_buff_head *head)
1157 {
1158         spin_lock_bh(&head->lock);
1159         skb_queue_splice_tail(list, head);
1160         spin_unlock_bh(&head->lock);
1161 }
1162
1163 /* tipc_skb_queue_splice_tail_init - merge two lock protected skb lists
1164  * @list: the new list to add. Lock protected. Will be reinitialized
1165  * @head: target list. Lock protected.
1166  */
1167 static inline void tipc_skb_queue_splice_tail_init(struct sk_buff_head *list,
1168                                                    struct sk_buff_head *head)
1169 {
1170         struct sk_buff_head tmp;
1171
1172         __skb_queue_head_init(&tmp);
1173
1174         spin_lock_bh(&list->lock);
1175         skb_queue_splice_tail_init(list, &tmp);
1176         spin_unlock_bh(&list->lock);
1177         tipc_skb_queue_splice_tail(&tmp, head);
1178 }
1179
1180 /* __tipc_skb_dequeue() - dequeue the head skb according to expected seqno
1181  * @list: list to be dequeued from
1182  * @seqno: seqno of the expected msg
1183  *
1184  * returns skb dequeued from the list if its seqno is less than or equal to
1185  * the expected one, otherwise the skb is still hold
1186  *
1187  * Note: must be used with appropriate locks held only
1188  */
1189 static inline struct sk_buff *__tipc_skb_dequeue(struct sk_buff_head *list,
1190                                                  u16 seqno)
1191 {
1192         struct sk_buff *skb = skb_peek(list);
1193
1194         if (skb && less_eq(buf_seqno(skb), seqno)) {
1195                 __skb_unlink(skb, list);
1196                 return skb;
1197         }
1198         return NULL;
1199 }
1200
1201 #endif