net/tipc/msg.c

   1 /*
   2  * net/tipc/msg.c: TIPC message header routines
   3  *
   4  * Copyright (c) 2000-2006, 2014-2015, Ericsson AB
   5  * Copyright (c) 2005, 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 #include <net/sock.h>
  38 #include "core.h"
  39 #include "msg.h"
  40 #include "addr.h"
  41 #include "name_table.h"
  42
  43 #define MAX_FORWARD_SIZE 1024
  44
  45 static unsigned int align(unsigned int i)
  46 {
  47         return (i + 3) & ~3u;
  48 }
  49
  50 /**
  51  * tipc_buf_acquire - creates a TIPC message buffer
  52  * @size: message size (including TIPC header)
  53  *
  54  * Returns a new buffer with data pointers set to the specified size.
  55  *
  56  * NOTE: Headroom is reserved to allow prepending of a data link header.
  57  *       There may also be unrequested tailroom present at the buffer's end.
  58  */
  59 struct sk_buff *tipc_buf_acquire(u32 size)
  60 {
  61         struct sk_buff *skb;
  62         unsigned int buf_size = (BUF_HEADROOM + size + 3) & ~3u;
  63
  64         skb = alloc_skb_fclone(buf_size, GFP_ATOMIC);
  65         if (skb) {
  66                 skb_reserve(skb, BUF_HEADROOM);
  67                 skb_put(skb, size);
  68                 skb->next = NULL;
  69         }
  70         return skb;
  71 }
  72
  73 void tipc_msg_init(u32 own_node, struct tipc_msg *m, u32 user, u32 type,
  74                    u32 hsize, u32 dnode)
  75 {
  76         memset(m, 0, hsize);
  77         msg_set_version(m);
  78         msg_set_user(m, user);
  79         msg_set_hdr_sz(m, hsize);
  80         msg_set_size(m, hsize);
  81         msg_set_prevnode(m, own_node);
  82         msg_set_type(m, type);
  83         if (hsize > SHORT_H_SIZE) {
  84                 msg_set_orignode(m, own_node);
  85                 msg_set_destnode(m, dnode);
  86         }
  87 }
  88
  89 struct sk_buff *tipc_msg_create(uint user, uint type,
  90                                 uint hdr_sz, uint data_sz, u32 dnode,
  91                                 u32 onode, u32 dport, u32 oport, int errcode)
  92 {
  93         struct tipc_msg *msg;
  94         struct sk_buff *buf;
  95
  96         buf = tipc_buf_acquire(hdr_sz + data_sz);
  97         if (unlikely(!buf))
  98                 return NULL;
  99
 100         msg = buf_msg(buf);
 101         tipc_msg_init(onode, msg, user, type, hdr_sz, dnode);
 102         msg_set_size(msg, hdr_sz + data_sz);
 103         msg_set_origport(msg, oport);
 104         msg_set_destport(msg, dport);
 105         msg_set_errcode(msg, errcode);
 106         if (hdr_sz > SHORT_H_SIZE) {
 107                 msg_set_orignode(msg, onode);
 108                 msg_set_destnode(msg, dnode);
 109         }
 110         return buf;
 111 }
 112
 113 /* tipc_buf_append(): Append a buffer to the fragment list of another buffer
 114  * @*headbuf: in:  NULL for first frag, otherwise value returned from prev call
 115  *            out: set when successful non-complete reassembly, otherwise NULL
 116  * @*buf:     in:  the buffer to append. Always defined
 117  *            out: head buf after successful complete reassembly, otherwise NULL
 118  * Returns 1 when reassembly complete, otherwise 0
 119  */
 120 int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf)
 121 {
 122         struct sk_buff *head = *headbuf;
 123         struct sk_buff *frag = *buf;
 124         struct sk_buff *tail;
 125         struct tipc_msg *msg;
 126         u32 fragid;
 127         int delta;
 128         bool headstolen;
 129
 130         if (!frag)
 131                 goto err;
 132
 133         msg = buf_msg(frag);
 134         fragid = msg_type(msg);
 135         frag->next = NULL;
 136         skb_pull(frag, msg_hdr_sz(msg));
 137
 138         if (fragid == FIRST_FRAGMENT) {
 139                 if (unlikely(head))
 140                         goto err;
 141                 if (unlikely(skb_unclone(frag, GFP_ATOMIC)))
 142                         goto err;
 143                 head = *headbuf = frag;
 144                 skb_frag_list_init(head);
 145                 TIPC_SKB_CB(head)->tail = NULL;
 146                 *buf = NULL;
 147                 return 0;
 148         }
 149
 150         if (!head)
 151                 goto err;
 152
 153         if (skb_try_coalesce(head, frag, &headstolen, &delta)) {
 154                 kfree_skb_partial(frag, headstolen);
 155         } else {
 156                 tail = TIPC_SKB_CB(head)->tail;
 157                 if (!skb_has_frag_list(head))
 158                         skb_shinfo(head)->frag_list = frag;
 159                 else
 160                         tail->next = frag;
 161                 head->truesize += frag->truesize;
 162                 head->data_len += frag->len;
 163                 head->len += frag->len;
 164                 TIPC_SKB_CB(head)->tail = frag;
 165         }
 166
 167         if (fragid == LAST_FRAGMENT) {
 168                 *buf = head;
 169                 TIPC_SKB_CB(head)->tail = NULL;
 170                 *headbuf = NULL;
 171                 return 1;
 172         }
 173         *buf = NULL;
 174         return 0;
 175
 176 err:
 177         pr_warn_ratelimited("Unable to build fragment list\n");
 178         kfree_skb(*buf);
 179         kfree_skb(*headbuf);
 180         *buf = *headbuf = NULL;
 181         return 0;
 182 }
 183
 184 /* tipc_msg_validate - validate basic format of received message
 185  *
 186  * This routine ensures a TIPC message has an acceptable header, and at least
 187  * as much data as the header indicates it should.  The routine also ensures
 188  * that the entire message header is stored in the main fragment of the message
 189  * buffer, to simplify future access to message header fields.
 190  *
 191  * Note: Having extra info present in the message header or data areas is OK.
 192  * TIPC will ignore the excess, under the assumption that it is optional info
 193  * introduced by a later release of the protocol.
 194  */
 195 bool tipc_msg_validate(struct sk_buff *skb)
 196 {
 197         struct tipc_msg *msg;
 198         int msz, hsz;
 199
 200         if (unlikely(TIPC_SKB_CB(skb)->validated))
 201                 return true;
 202         if (unlikely(!pskb_may_pull(skb, MIN_H_SIZE)))
 203                 return false;
 204
 205         hsz = msg_hdr_sz(buf_msg(skb));
 206         if (unlikely(hsz < MIN_H_SIZE) || (hsz > MAX_H_SIZE))
 207                 return false;
 208         if (unlikely(!pskb_may_pull(skb, hsz)))
 209                 return false;
 210
 211         msg = buf_msg(skb);
 212         if (unlikely(msg_version(msg) != TIPC_VERSION))
 213                 return false;
 214
 215         msz = msg_size(msg);
 216         if (unlikely(msz < hsz))
 217                 return false;
 218         if (unlikely((msz - hsz) > TIPC_MAX_USER_MSG_SIZE))
 219                 return false;
 220         if (unlikely(skb->len < msz))
 221                 return false;
 222
 223         TIPC_SKB_CB(skb)->validated = true;
 224         return true;
 225 }
 226
 227 /**
 228  * tipc_msg_build - create buffer chain containing specified header and data
 229  * @mhdr: Message header, to be prepended to data
 230  * @m: User message
 231  * @dsz: Total length of user data
 232  * @pktmax: Max packet size that can be used
 233  * @list: Buffer or chain of buffers to be returned to caller
 234  *
 235  * Returns message data size or errno: -ENOMEM, -EFAULT
 236  */
 237 int tipc_msg_build(struct tipc_msg *mhdr, struct msghdr *m,
 238                    int offset, int dsz, int pktmax, struct sk_buff_head *list)
 239 {
 240         int mhsz = msg_hdr_sz(mhdr);
 241         int msz = mhsz + dsz;
 242         int pktno = 1;
 243         int pktsz;
 244         int pktrem = pktmax;
 245         int drem = dsz;
 246         struct tipc_msg pkthdr;
 247         struct sk_buff *skb;
 248         char *pktpos;
 249         int rc;
 250
 251         msg_set_size(mhdr, msz);
 252
 253         /* No fragmentation needed? */
 254         if (likely(msz <= pktmax)) {
 255                 skb = tipc_buf_acquire(msz);
 256                 if (unlikely(!skb))
 257                         return -ENOMEM;
 258                 skb_orphan(skb);
 259                 __skb_queue_tail(list, skb);
 260                 skb_copy_to_linear_data(skb, mhdr, mhsz);
 261                 pktpos = skb->data + mhsz;
 262                 if (copy_from_iter(pktpos, dsz, &m->msg_iter) == dsz)
 263                         return dsz;
 264                 rc = -EFAULT;
 265                 goto error;
 266         }
 267
 268         /* Prepare reusable fragment header */
 269         tipc_msg_init(msg_prevnode(mhdr), &pkthdr, MSG_FRAGMENTER,
 270                       FIRST_FRAGMENT, INT_H_SIZE, msg_destnode(mhdr));
 271         msg_set_size(&pkthdr, pktmax);
 272         msg_set_fragm_no(&pkthdr, pktno);
 273
 274         /* Prepare first fragment */
 275         skb = tipc_buf_acquire(pktmax);
 276         if (!skb)
 277                 return -ENOMEM;
 278         skb_orphan(skb);
 279         __skb_queue_tail(list, skb);
 280         pktpos = skb->data;
 281         skb_copy_to_linear_data(skb, &pkthdr, INT_H_SIZE);
 282         pktpos += INT_H_SIZE;
 283         pktrem -= INT_H_SIZE;
 284         skb_copy_to_linear_data_offset(skb, INT_H_SIZE, mhdr, mhsz);
 285         pktpos += mhsz;
 286         pktrem -= mhsz;
 287
 288         do {
 289                 if (drem < pktrem)
 290                         pktrem = drem;
 291
 292                 if (copy_from_iter(pktpos, pktrem, &m->msg_iter) != pktrem) {
 293                         rc = -EFAULT;
 294                         goto error;
 295                 }
 296                 drem -= pktrem;
 297
 298                 if (!drem)
 299                         break;
 300
 301                 /* Prepare new fragment: */
 302                 if (drem < (pktmax - INT_H_SIZE))
 303                         pktsz = drem + INT_H_SIZE;
 304                 else
 305                         pktsz = pktmax;
 306                 skb = tipc_buf_acquire(pktsz);
 307                 if (!skb) {
 308                         rc = -ENOMEM;
 309                         goto error;
 310                 }
 311                 skb_orphan(skb);
 312                 __skb_queue_tail(list, skb);
 313                 msg_set_type(&pkthdr, FRAGMENT);
 314                 msg_set_size(&pkthdr, pktsz);
 315                 msg_set_fragm_no(&pkthdr, ++pktno);
 316                 skb_copy_to_linear_data(skb, &pkthdr, INT_H_SIZE);
 317                 pktpos = skb->data + INT_H_SIZE;
 318                 pktrem = pktsz - INT_H_SIZE;
 319
 320         } while (1);
 321         msg_set_type(buf_msg(skb), LAST_FRAGMENT);
 322         return dsz;
 323 error:
 324         __skb_queue_purge(list);
 325         __skb_queue_head_init(list);
 326         return rc;
 327 }
 328
 329 /**
 330  * tipc_msg_bundle(): Append contents of a buffer to tail of an existing one
 331  * @list: the buffer chain of the existing buffer ("bundle")
 332  * @skb:  buffer to be appended
 333  * @mtu:  max allowable size for the bundle buffer
 334  * Consumes buffer if successful
 335  * Returns true if bundling could be performed, otherwise false
 336  */
 337 bool tipc_msg_bundle(struct sk_buff_head *list, struct sk_buff *skb, u32 mtu)
 338 {
 339         struct sk_buff *bskb = skb_peek_tail(list);
 340         struct tipc_msg *bmsg = buf_msg(bskb);
 341         struct tipc_msg *msg = buf_msg(skb);
 342         unsigned int bsz = msg_size(bmsg);
 343         unsigned int msz = msg_size(msg);
 344         u32 start = align(bsz);
 345         u32 max = mtu - INT_H_SIZE;
 346         u32 pad = start - bsz;
 347
 348         if (likely(msg_user(msg) == MSG_FRAGMENTER))
 349                 return false;
 350         if (unlikely(msg_user(msg) == CHANGEOVER_PROTOCOL))
 351                 return false;
 352         if (unlikely(msg_user(msg) == BCAST_PROTOCOL))
 353                 return false;
 354         if (likely(msg_user(bmsg) != MSG_BUNDLER))
 355                 return false;
 356         if (likely(!TIPC_SKB_CB(bskb)->bundling))
 357                 return false;
 358         if (unlikely(skb_tailroom(bskb) < (pad + msz)))
 359                 return false;
 360         if (unlikely(max < (start + msz)))
 361                 return false;
 362
 363         skb_put(bskb, pad + msz);
 364         skb_copy_to_linear_data_offset(bskb, start, skb->data, msz);
 365         msg_set_size(bmsg, start + msz);
 366         msg_set_msgcnt(bmsg, msg_msgcnt(bmsg) + 1);
 367         kfree_skb(skb);
 368         return true;
 369 }
 370
 371 /**
 372  *  tipc_msg_extract(): extract bundled inner packet from buffer
 373  *  @skb: linear outer buffer, to be extracted from.
 374  *  @iskb: extracted inner buffer, to be returned
 375  *  @pos: position of msg to be extracted. Returns with pointer of next msg
 376  *  Consumes outer buffer when last packet extracted
 377  *  Returns true when when there is an extracted buffer, otherwise false
 378  */
 379 bool tipc_msg_extract(struct sk_buff *skb, struct sk_buff **iskb, int *pos)
 380 {
 381         struct tipc_msg *msg = buf_msg(skb);
 382         int imsz;
 383         struct tipc_msg *imsg = (struct tipc_msg *)(msg_data(msg) + *pos);
 384
 385         /* Is there space left for shortest possible message? */
 386         if (*pos > (msg_data_sz(msg) - SHORT_H_SIZE))
 387                 goto none;
 388         imsz = msg_size(imsg);
 389
 390         /* Is there space left for current message ? */
 391         if ((*pos + imsz) > msg_data_sz(msg))
 392                 goto none;
 393         *iskb = tipc_buf_acquire(imsz);
 394         if (!*iskb)
 395                 goto none;
 396         skb_copy_to_linear_data(*iskb, imsg, imsz);
 397         *pos += align(imsz);
 398         return true;
 399 none:
 400         kfree_skb(skb);
 401         *iskb = NULL;
 402         return false;
 403 }
 404
 405 /**
 406  * tipc_msg_make_bundle(): Create bundle buf and append message to its tail
 407  * @list: the buffer chain
 408  * @skb: buffer to be appended and replaced
 409  * @mtu: max allowable size for the bundle buffer, inclusive header
 410  * @dnode: destination node for message. (Not always present in header)
 411  * Replaces buffer if successful
 412  * Returns true if success, otherwise false
 413  */
 414 bool tipc_msg_make_bundle(struct sk_buff_head *list,
 415                           struct sk_buff *skb, u32 mtu, u32 dnode)
 416 {
 417         struct sk_buff *bskb;
 418         struct tipc_msg *bmsg;
 419         struct tipc_msg *msg = buf_msg(skb);
 420         u32 msz = msg_size(msg);
 421         u32 max = mtu - INT_H_SIZE;
 422
 423         if (msg_user(msg) == MSG_FRAGMENTER)
 424                 return false;
 425         if (msg_user(msg) == CHANGEOVER_PROTOCOL)
 426                 return false;
 427         if (msg_user(msg) == BCAST_PROTOCOL)
 428                 return false;
 429         if (msz > (max / 2))
 430                 return false;
 431
 432         bskb = tipc_buf_acquire(max);
 433         if (!bskb)
 434                 return false;
 435
 436         skb_trim(bskb, INT_H_SIZE);
 437         bmsg = buf_msg(bskb);
 438         tipc_msg_init(msg_prevnode(msg), bmsg, MSG_BUNDLER, 0,
 439                       INT_H_SIZE, dnode);
 440         msg_set_seqno(bmsg, msg_seqno(msg));
 441         msg_set_ack(bmsg, msg_ack(msg));
 442         msg_set_bcast_ack(bmsg, msg_bcast_ack(msg));
 443         TIPC_SKB_CB(bskb)->bundling = true;
 444         __skb_queue_tail(list, bskb);
 445         return tipc_msg_bundle(list, skb, mtu);
 446 }
 447
 448 /**
 449  * tipc_msg_reverse(): swap source and destination addresses and add error code
 450  * @buf:  buffer containing message to be reversed
 451  * @dnode: return value: node where to send message after reversal
 452  * @err:  error code to be set in message
 453  * Consumes buffer if failure
 454  * Returns true if success, otherwise false
 455  */
 456 bool tipc_msg_reverse(u32 own_addr,  struct sk_buff *buf, u32 *dnode,
 457                       int err)
 458 {
 459         struct tipc_msg *msg = buf_msg(buf);
 460         uint imp = msg_importance(msg);
 461         struct tipc_msg ohdr;
 462         uint rdsz = min_t(uint, msg_data_sz(msg), MAX_FORWARD_SIZE);
 463
 464         if (skb_linearize(buf))
 465                 goto exit;
 466         if (msg_dest_droppable(msg))
 467                 goto exit;
 468         if (msg_errcode(msg))
 469                 goto exit;
 470
 471         memcpy(&ohdr, msg, msg_hdr_sz(msg));
 472         imp = min_t(uint, imp + 1, TIPC_CRITICAL_IMPORTANCE);
 473         if (msg_isdata(msg))
 474                 msg_set_importance(msg, imp);
 475         msg_set_errcode(msg, err);
 476         msg_set_origport(msg, msg_destport(&ohdr));
 477         msg_set_destport(msg, msg_origport(&ohdr));
 478         msg_set_prevnode(msg, own_addr);
 479         if (!msg_short(msg)) {
 480                 msg_set_orignode(msg, msg_destnode(&ohdr));
 481                 msg_set_destnode(msg, msg_orignode(&ohdr));
 482         }
 483         msg_set_size(msg, msg_hdr_sz(msg) + rdsz);
 484         skb_trim(buf, msg_size(msg));
 485         skb_orphan(buf);
 486         *dnode = msg_orignode(&ohdr);
 487         return true;
 488 exit:
 489         kfree_skb(buf);
 490         *dnode = 0;
 491         return false;
 492 }
 493
 494 /**
 495  * tipc_msg_lookup_dest(): try to find new destination for named message
 496  * @skb: the buffer containing the message.
 497  * @dnode: return value: next-hop node, if destination found
 498  * @err: return value: error code to use, if message to be rejected
 499  * Does not consume buffer
 500  * Returns true if a destination is found, false otherwise
 501  */
 502 bool tipc_msg_lookup_dest(struct net *net, struct sk_buff *skb,
 503                           u32 *dnode, int *err)
 504 {
 505         struct tipc_msg *msg = buf_msg(skb);
 506         u32 dport;
 507
 508         if (!msg_isdata(msg))
 509                 return false;
 510         if (!msg_named(msg))
 511                 return false;
 512         *err = -TIPC_ERR_NO_NAME;
 513         if (skb_linearize(skb))
 514                 return false;
 515         if (msg_reroute_cnt(msg) > 0)
 516                 return false;
 517         *dnode = addr_domain(net, msg_lookup_scope(msg));
 518         dport = tipc_nametbl_translate(net, msg_nametype(msg),
 519                                        msg_nameinst(msg), dnode);
 520         if (!dport)
 521                 return false;
 522         msg_incr_reroute_cnt(msg);
 523         msg_set_destnode(msg, *dnode);
 524         msg_set_destport(msg, dport);
 525         *err = TIPC_OK;
 526         return true;
 527 }
 528
 529 /* tipc_msg_reassemble() - clone a buffer chain of fragments and
 530  *                         reassemble the clones into one message
 531  */
 532 struct sk_buff *tipc_msg_reassemble(struct sk_buff_head *list)
 533 {
 534         struct sk_buff *skb;
 535         struct sk_buff *frag = NULL;
 536         struct sk_buff *head = NULL;
 537         int hdr_sz;
 538
 539         /* Copy header if single buffer */
 540         if (skb_queue_len(list) == 1) {
 541                 skb = skb_peek(list);
 542                 hdr_sz = skb_headroom(skb) + msg_hdr_sz(buf_msg(skb));
 543                 return __pskb_copy(skb, hdr_sz, GFP_ATOMIC);
 544         }
 545
 546         /* Clone all fragments and reassemble */
 547         skb_queue_walk(list, skb) {
 548                 frag = skb_clone(skb, GFP_ATOMIC);
 549                 if (!frag)
 550                         goto error;
 551                 frag->next = NULL;
 552                 if (tipc_buf_append(&head, &frag))
 553                         break;
 554                 if (!head)
 555                         goto error;
 556         }
 557         return frag;
 558 error:
 559         pr_warn("Failed do clone local mcast rcv buffer\n");
 560         kfree_skb(head);
 561         return NULL;
 562 }