net/tipc/msg.c

   1 /*
   2  * net/tipc/msg.c: TIPC message header routines
   3  *
   4  * Copyright (c) 2000-2006, 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 "core.h"
  38 #include "msg.h"
  39
  40 u32 tipc_msg_tot_importance(struct tipc_msg *m)
  41 {
  42         if (likely(msg_isdata(m))) {
  43                 if (likely(msg_orignode(m) == tipc_own_addr))
  44                         return msg_importance(m);
  45                 return msg_importance(m) + 4;
  46         }
  47         if ((msg_user(m) == MSG_FRAGMENTER)  &&
  48             (msg_type(m) == FIRST_FRAGMENT))
  49                 return msg_importance(msg_get_wrapped(m));
  50         return msg_importance(m);
  51 }
  52
  53
  54 void tipc_msg_init(struct tipc_msg *m, u32 user, u32 type,
  55                             u32 hsize, u32 destnode)
  56 {
  57         memset(m, 0, hsize);
  58         msg_set_version(m);
  59         msg_set_user(m, user);
  60         msg_set_hdr_sz(m, hsize);
  61         msg_set_size(m, hsize);
  62         msg_set_prevnode(m, tipc_own_addr);
  63         msg_set_type(m, type);
  64         msg_set_orignode(m, tipc_own_addr);
  65         msg_set_destnode(m, destnode);
  66 }
  67
  68 /**
  69  * tipc_msg_build - create message using specified header and data
  70  *
  71  * Note: Caller must not hold any locks in case copy_from_user() is interrupted!
  72  *
  73  * Returns message data size or errno
  74  */
  75 int tipc_msg_build(struct tipc_msg *hdr, struct iovec const *msg_sect,
  76                    u32 num_sect, unsigned int total_len,
  77                             int max_size, int usrmem, struct sk_buff **buf)
  78 {
  79         int dsz, sz, hsz, pos, res, cnt;
  80
  81         dsz = total_len;
  82         pos = hsz = msg_hdr_sz(hdr);
  83         sz = hsz + dsz;
  84         msg_set_size(hdr, sz);
  85         if (unlikely(sz > max_size)) {
  86                 *buf = NULL;
  87                 return dsz;
  88         }
  89
  90         *buf = tipc_buf_acquire(sz);
  91         if (!(*buf))
  92                 return -ENOMEM;
  93         skb_copy_to_linear_data(*buf, hdr, hsz);
  94         for (res = 1, cnt = 0; res && (cnt < num_sect); cnt++) {
  95                 if (likely(usrmem))
  96                         res = !copy_from_user((*buf)->data + pos,
  97                                               msg_sect[cnt].iov_base,
  98                                               msg_sect[cnt].iov_len);
  99                 else
 100                         skb_copy_to_linear_data_offset(*buf, pos,
 101                                                        msg_sect[cnt].iov_base,
 102                                                        msg_sect[cnt].iov_len);
 103                 pos += msg_sect[cnt].iov_len;
 104         }
 105         if (likely(res))
 106                 return dsz;
 107
 108         kfree_skb(*buf);
 109         *buf = NULL;
 110         return -EFAULT;
 111 }
 112
 113 #ifdef CONFIG_TIPC_DEBUG
 114 void tipc_msg_dbg(struct print_buf *buf, struct tipc_msg *msg, const char *str)
 115 {
 116         u32 usr = msg_user(msg);
 117         tipc_printf(buf, KERN_DEBUG);
 118         tipc_printf(buf, str);
 119
 120         switch (usr) {
 121         case MSG_BUNDLER:
 122                 tipc_printf(buf, "BNDL::");
 123                 tipc_printf(buf, "MSGS(%u):", msg_msgcnt(msg));
 124                 break;
 125         case BCAST_PROTOCOL:
 126                 tipc_printf(buf, "BCASTP::");
 127                 break;
 128         case MSG_FRAGMENTER:
 129                 tipc_printf(buf, "FRAGM::");
 130                 switch (msg_type(msg)) {
 131                 case FIRST_FRAGMENT:
 132                         tipc_printf(buf, "FIRST:");
 133                         break;
 134                 case FRAGMENT:
 135                         tipc_printf(buf, "BODY:");
 136                         break;
 137                 case LAST_FRAGMENT:
 138                         tipc_printf(buf, "LAST:");
 139                         break;
 140                 default:
 141                         tipc_printf(buf, "UNKNOWN:%x", msg_type(msg));
 142
 143                 }
 144                 tipc_printf(buf, "NO(%u/%u):", msg_long_msgno(msg),
 145                             msg_fragm_no(msg));
 146                 break;
 147         case TIPC_LOW_IMPORTANCE:
 148         case TIPC_MEDIUM_IMPORTANCE:
 149         case TIPC_HIGH_IMPORTANCE:
 150         case TIPC_CRITICAL_IMPORTANCE:
 151                 tipc_printf(buf, "DAT%u:", msg_user(msg));
 152                 if (msg_short(msg)) {
 153                         tipc_printf(buf, "CON:");
 154                         break;
 155                 }
 156                 switch (msg_type(msg)) {
 157                 case TIPC_CONN_MSG:
 158                         tipc_printf(buf, "CON:");
 159                         break;
 160                 case TIPC_MCAST_MSG:
 161                         tipc_printf(buf, "MCST:");
 162                         break;
 163                 case TIPC_NAMED_MSG:
 164                         tipc_printf(buf, "NAM:");
 165                         break;
 166                 case TIPC_DIRECT_MSG:
 167                         tipc_printf(buf, "DIR:");
 168                         break;
 169                 default:
 170                         tipc_printf(buf, "UNKNOWN TYPE %u", msg_type(msg));
 171                 }
 172                 if (msg_reroute_cnt(msg))
 173                         tipc_printf(buf, "REROUTED(%u):",
 174                                     msg_reroute_cnt(msg));
 175                 break;
 176         case NAME_DISTRIBUTOR:
 177                 tipc_printf(buf, "NMD::");
 178                 switch (msg_type(msg)) {
 179                 case PUBLICATION:
 180                         tipc_printf(buf, "PUBL(%u):", (msg_size(msg) - msg_hdr_sz(msg)) / 20);  /* Items */
 181                         break;
 182                 case WITHDRAWAL:
 183                         tipc_printf(buf, "WDRW:");
 184                         break;
 185                 default:
 186                         tipc_printf(buf, "UNKNOWN:%x", msg_type(msg));
 187                 }
 188                 if (msg_reroute_cnt(msg))
 189                         tipc_printf(buf, "REROUTED(%u):",
 190                                     msg_reroute_cnt(msg));
 191                 break;
 192         case CONN_MANAGER:
 193                 tipc_printf(buf, "CONN_MNG:");
 194                 switch (msg_type(msg)) {
 195                 case CONN_PROBE:
 196                         tipc_printf(buf, "PROBE:");
 197                         break;
 198                 case CONN_PROBE_REPLY:
 199                         tipc_printf(buf, "PROBE_REPLY:");
 200                         break;
 201                 case CONN_ACK:
 202                         tipc_printf(buf, "CONN_ACK:");
 203                         tipc_printf(buf, "ACK(%u):", msg_msgcnt(msg));
 204                         break;
 205                 default:
 206                         tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
 207                 }
 208                 if (msg_reroute_cnt(msg))
 209                         tipc_printf(buf, "REROUTED(%u):", msg_reroute_cnt(msg));
 210                 break;
 211         case LINK_PROTOCOL:
 212                 switch (msg_type(msg)) {
 213                 case STATE_MSG:
 214                         tipc_printf(buf, "STATE:");
 215                         tipc_printf(buf, "%s:", msg_probe(msg) ? "PRB" : "");
 216                         tipc_printf(buf, "NXS(%u):", msg_next_sent(msg));
 217                         tipc_printf(buf, "GAP(%u):", msg_seq_gap(msg));
 218                         tipc_printf(buf, "LSTBC(%u):", msg_last_bcast(msg));
 219                         break;
 220                 case RESET_MSG:
 221                         tipc_printf(buf, "RESET:");
 222                         if (msg_size(msg) != msg_hdr_sz(msg))
 223                                 tipc_printf(buf, "BEAR:%s:", msg_data(msg));
 224                         break;
 225                 case ACTIVATE_MSG:
 226                         tipc_printf(buf, "ACTIVATE:");
 227                         break;
 228                 default:
 229                         tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
 230                 }
 231                 tipc_printf(buf, "PLANE(%c):", msg_net_plane(msg));
 232                 tipc_printf(buf, "SESS(%u):", msg_session(msg));
 233                 break;
 234         case CHANGEOVER_PROTOCOL:
 235                 tipc_printf(buf, "TUNL:");
 236                 switch (msg_type(msg)) {
 237                 case DUPLICATE_MSG:
 238                         tipc_printf(buf, "DUPL:");
 239                         break;
 240                 case ORIGINAL_MSG:
 241                         tipc_printf(buf, "ORIG:");
 242                         tipc_printf(buf, "EXP(%u)", msg_msgcnt(msg));
 243                         break;
 244                 default:
 245                         tipc_printf(buf, "UNKNOWN TYPE:%x", msg_type(msg));
 246                 }
 247                 break;
 248         case LINK_CONFIG:
 249                 tipc_printf(buf, "CFG:");
 250                 switch (msg_type(msg)) {
 251                 case DSC_REQ_MSG:
 252                         tipc_printf(buf, "DSC_REQ:");
 253                         break;
 254                 case DSC_RESP_MSG:
 255                         tipc_printf(buf, "DSC_RESP:");
 256                         break;
 257                 default:
 258                         tipc_printf(buf, "UNKNOWN TYPE:%x:", msg_type(msg));
 259                         break;
 260                 }
 261                 break;
 262         default:
 263                 tipc_printf(buf, "UNKNOWN USER:");
 264         }
 265
 266         switch (usr) {
 267         case CONN_MANAGER:
 268         case TIPC_LOW_IMPORTANCE:
 269         case TIPC_MEDIUM_IMPORTANCE:
 270         case TIPC_HIGH_IMPORTANCE:
 271         case TIPC_CRITICAL_IMPORTANCE:
 272                 switch (msg_errcode(msg)) {
 273                 case TIPC_OK:
 274                         break;
 275                 case TIPC_ERR_NO_NAME:
 276                         tipc_printf(buf, "NO_NAME:");
 277                         break;
 278                 case TIPC_ERR_NO_PORT:
 279                         tipc_printf(buf, "NO_PORT:");
 280                         break;
 281                 case TIPC_ERR_NO_NODE:
 282                         tipc_printf(buf, "NO_PROC:");
 283                         break;
 284                 case TIPC_ERR_OVERLOAD:
 285                         tipc_printf(buf, "OVERLOAD:");
 286                         break;
 287                 case TIPC_CONN_SHUTDOWN:
 288                         tipc_printf(buf, "SHUTDOWN:");
 289                         break;
 290                 default:
 291                         tipc_printf(buf, "UNKNOWN ERROR(%x):",
 292                                     msg_errcode(msg));
 293                 }
 294         default:
 295                 break;
 296         }
 297
 298         tipc_printf(buf, "HZ(%u):", msg_hdr_sz(msg));
 299         tipc_printf(buf, "SZ(%u):", msg_size(msg));
 300         tipc_printf(buf, "SQNO(%u):", msg_seqno(msg));
 301
 302         if (msg_non_seq(msg))
 303                 tipc_printf(buf, "NOSEQ:");
 304         else
 305                 tipc_printf(buf, "ACK(%u):", msg_ack(msg));
 306         tipc_printf(buf, "BACK(%u):", msg_bcast_ack(msg));
 307         tipc_printf(buf, "PRND(%x)", msg_prevnode(msg));
 308
 309         if (msg_isdata(msg)) {
 310                 if (msg_named(msg)) {
 311                         tipc_printf(buf, "NTYP(%u):", msg_nametype(msg));
 312                         tipc_printf(buf, "NINST(%u)", msg_nameinst(msg));
 313                 }
 314         }
 315
 316         if ((usr != LINK_PROTOCOL) && (usr != LINK_CONFIG) &&
 317             (usr != MSG_BUNDLER)) {
 318                 if (!msg_short(msg)) {
 319                         tipc_printf(buf, ":ORIG(%x:%u):",
 320                                     msg_orignode(msg), msg_origport(msg));
 321                         tipc_printf(buf, ":DEST(%x:%u):",
 322                                     msg_destnode(msg), msg_destport(msg));
 323                 } else {
 324                         tipc_printf(buf, ":OPRT(%u):", msg_origport(msg));
 325                         tipc_printf(buf, ":DPRT(%u):", msg_destport(msg));
 326                 }
 327         }
 328         if (msg_user(msg) == NAME_DISTRIBUTOR) {
 329                 tipc_printf(buf, ":ONOD(%x):", msg_orignode(msg));
 330                 tipc_printf(buf, ":DNOD(%x):", msg_destnode(msg));
 331         }
 332
 333         if (msg_user(msg) ==  LINK_CONFIG) {
 334                 struct tipc_media_addr orig;
 335
 336                 tipc_printf(buf, ":DDOM(%x):", msg_dest_domain(msg));
 337                 tipc_printf(buf, ":NETID(%u):", msg_bc_netid(msg));
 338                 memcpy(orig.value, msg_media_addr(msg), sizeof(orig.value));
 339                 orig.media_id = 0;
 340                 orig.broadcast = 0;
 341                 tipc_media_addr_printf(buf, &orig);
 342         }
 343         if (msg_user(msg) == BCAST_PROTOCOL) {
 344                 tipc_printf(buf, "BCNACK:AFTER(%u):", msg_bcgap_after(msg));
 345                 tipc_printf(buf, "TO(%u):", msg_bcgap_to(msg));
 346         }
 347         tipc_printf(buf, "\n");
 348         if ((usr == CHANGEOVER_PROTOCOL) && (msg_msgcnt(msg)))
 349                 tipc_msg_dbg(buf, msg_get_wrapped(msg), "      /");
 350         if ((usr == MSG_FRAGMENTER) && (msg_type(msg) == FIRST_FRAGMENT))
 351                 tipc_msg_dbg(buf, msg_get_wrapped(msg), "      /");
 352 }
 353 #endif