sys/ofed/include/rdma/ib_addr.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
   3  *
   4  * Copyright (c) 2005 Voltaire Inc.  All rights reserved.
   5  * Copyright (c) 2005 Intel Corporation.  All rights reserved.
   6  *
   7  * This software is available to you under a choice of one of two
   8  * licenses.  You may choose to be licensed under the terms of the GNU
   9  * General Public License (GPL) Version 2, available from the file
  10  * COPYING in the main directory of this source tree, or the
  11  * OpenIB.org BSD license below:
  12  *
  13  *     Redistribution and use in source and binary forms, with or
  14  *     without modification, are permitted provided that the following
  15  *     conditions are met:
  16  *
  17  *      - Redistributions of source code must retain the above
  18  *        copyright notice, this list of conditions and the following
  19  *        disclaimer.
  20  *
  21  *      - Redistributions in binary form must reproduce the above
  22  *        copyright notice, this list of conditions and the following
  23  *        disclaimer in the documentation and/or other materials
  24  *        provided with the distribution.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  27  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  28  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  29  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  30  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  31  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  32  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  33  * SOFTWARE.
  34  */
  35
  36 #if !defined(IB_ADDR_H)
  37 #define IB_ADDR_H
  38
  39 #include <linux/in.h>
  40 #include <linux/in6.h>
  41 #include <linux/if_arp.h>
  42 #include <linux/netdevice.h>
  43 #include <linux/inetdevice.h>
  44 #include <linux/socket.h>
  45 #include <linux/if_vlan.h>
  46 #include <net/ipv6.h>
  47 #include <net/if_inet6.h>
  48 #include <net/ip.h>
  49 #include <rdma/ib_verbs.h>
  50 #include <rdma/ib_pack.h>
  51 #include <net/ipv6.h>
  52
  53 struct rdma_addr_client {
  54         atomic_t refcount;
  55         struct completion comp;
  56 };
  57
  58 /**
  59  * rdma_addr_register_client - Register an address client.
  60  */
  61 void rdma_addr_register_client(struct rdma_addr_client *client);
  62
  63 /**
  64  * rdma_addr_unregister_client - Deregister an address client.
  65  * @client: Client object to deregister.
  66  */
  67 void rdma_addr_unregister_client(struct rdma_addr_client *client);
  68
  69 /**
  70  * struct rdma_dev_addr - Contains resolved RDMA hardware addresses
  71  * @src_dev_addr:       Source MAC address.
  72  * @dst_dev_addr:       Destination MAC address.
  73  * @broadcast:          Broadcast address of the device.
  74  * @dev_type:           The interface hardware type of the device.
  75  * @bound_dev_if:       An optional device interface index.
  76  * @transport:          The transport type used.
  77  * @net:                Network namespace containing the bound_dev_if net_dev.
  78  */
  79 struct vnet;
  80 struct rdma_dev_addr {
  81         unsigned char src_dev_addr[MAX_ADDR_LEN];
  82         unsigned char dst_dev_addr[MAX_ADDR_LEN];
  83         unsigned char broadcast[MAX_ADDR_LEN];
  84         unsigned short dev_type;
  85         int bound_dev_if;
  86         enum rdma_transport_type transport;
  87         struct vnet *net;
  88         enum rdma_network_type network;
  89         int hoplimit;
  90 };
  91
  92 /**
  93  * rdma_translate_ip - Translate a local IP address to an RDMA hardware
  94  *   address.
  95  *
  96  * The dev_addr->net field must be initialized.
  97  */
  98 int rdma_translate_ip(const struct sockaddr *addr,
  99                       struct rdma_dev_addr *dev_addr, u16 *vlan_id);
 100
 101 /**
 102  * rdma_resolve_ip - Resolve source and destination IP addresses to
 103  *   RDMA hardware addresses.
 104  * @client: Address client associated with request.
 105  * @src_addr: An optional source address to use in the resolution.  If a
 106  *   source address is not provided, a usable address will be returned via
 107  *   the callback.
 108  * @dst_addr: The destination address to resolve.
 109  * @addr: A reference to a data location that will receive the resolved
 110  *   addresses.  The data location must remain valid until the callback has
 111  *   been invoked. The net field of the addr struct must be valid.
 112  * @timeout_ms: Amount of time to wait for the address resolution to complete.
 113  * @callback: Call invoked once address resolution has completed, timed out,
 114  *   or been canceled.  A status of 0 indicates success.
 115  * @context: User-specified context associated with the call.
 116  */
 117 int rdma_resolve_ip(struct rdma_addr_client *client,
 118                     struct sockaddr *src_addr, struct sockaddr *dst_addr,
 119                     struct rdma_dev_addr *addr, int timeout_ms,
 120                     void (*callback)(int status, struct sockaddr *src_addr,
 121                                      struct rdma_dev_addr *addr, void *context),
 122                     void *context);
 123
 124 int rdma_resolve_ip_route(struct sockaddr *src_addr,
 125                           const struct sockaddr *dst_addr,
 126                           struct rdma_dev_addr *addr);
 127
 128 void rdma_addr_cancel(struct rdma_dev_addr *addr);
 129
 130 int rdma_copy_addr(struct rdma_dev_addr *dev_addr, struct net_device *dev,
 131               const unsigned char *dst_dev_addr);
 132
 133 int rdma_addr_size(struct sockaddr *addr);
 134
 135 int rdma_addr_find_smac_by_sgid(union ib_gid *sgid, u8 *smac, u16 *vlan_id);
 136 int rdma_addr_find_l2_eth_by_grh(const union ib_gid *sgid,
 137                                  const union ib_gid *dgid,
 138                                  u8 *smac, u16 *vlan_id, int *if_index,
 139                                  int *hoplimit);
 140
 141 static inline u16 ib_addr_get_pkey(struct rdma_dev_addr *dev_addr)
 142 {
 143         return ((u16)dev_addr->broadcast[8] << 8) | (u16)dev_addr->broadcast[9];
 144 }
 145
 146 static inline void ib_addr_set_pkey(struct rdma_dev_addr *dev_addr, u16 pkey)
 147 {
 148         dev_addr->broadcast[8] = pkey >> 8;
 149         dev_addr->broadcast[9] = (unsigned char) pkey;
 150 }
 151
 152 static inline void ib_addr_get_mgid(struct rdma_dev_addr *dev_addr,
 153                                     union ib_gid *gid)
 154 {
 155         memcpy(gid, dev_addr->broadcast + 4, sizeof *gid);
 156 }
 157
 158 static inline int rdma_addr_gid_offset(struct rdma_dev_addr *dev_addr)
 159 {
 160         return dev_addr->dev_type == ARPHRD_INFINIBAND ? 4 : 0;
 161 }
 162
 163 static inline u16 rdma_vlan_dev_vlan_id(const struct net_device *dev)
 164 {
 165         uint16_t tag;
 166
 167         if (VLAN_TAG(__DECONST(struct ifnet *, dev), &tag) != 0)
 168                 return 0xffff;
 169         return tag;
 170 }
 171
 172 static inline int rdma_ip2gid(const struct sockaddr *addr, union ib_gid *gid)
 173 {
 174         switch (addr->sa_family) {
 175         case AF_INET:
 176                 ipv6_addr_set_v4mapped(((const struct sockaddr_in *)
 177                                         addr)->sin_addr.s_addr,
 178                                        (struct in6_addr *)gid);
 179                 break;
 180         case AF_INET6:
 181                 memcpy(gid->raw, &((const struct sockaddr_in6 *)addr)->sin6_addr, 16);
 182                 /* make sure scope ID gets zeroed inside GID */
 183                 if (IN6_IS_SCOPE_LINKLOCAL((struct in6_addr *)gid->raw) ||
 184                     IN6_IS_ADDR_MC_INTFACELOCAL((struct in6_addr *)gid->raw)) {
 185                         gid->raw[2] = 0;
 186                         gid->raw[3] = 0;
 187                 }
 188                 break;
 189         default:
 190                 return -EINVAL;
 191         }
 192         return 0;
 193 }
 194
 195 /* Important - sockaddr should be a union of sockaddr_in and sockaddr_in6 */
 196 static inline void rdma_gid2ip(struct sockaddr *out, const union ib_gid *gid)
 197 {
 198         if (ipv6_addr_v4mapped((const struct in6_addr *)gid)) {
 199                 struct sockaddr_in *out_in = (struct sockaddr_in *)out;
 200                 memset(out_in, 0, sizeof(*out_in));
 201                 out_in->sin_len = sizeof(*out_in);
 202                 out_in->sin_family = AF_INET;
 203                 memcpy(&out_in->sin_addr.s_addr, gid->raw + 12, 4);
 204         } else {
 205                 struct sockaddr_in6 *out_in = (struct sockaddr_in6 *)out;
 206                 memset(out_in, 0, sizeof(*out_in));
 207                 out_in->sin6_len = sizeof(*out_in);
 208                 out_in->sin6_family = AF_INET6;
 209                 memcpy(&out_in->sin6_addr.s6_addr, gid->raw, 16);
 210         }
 211 }
 212
 213 static inline void iboe_addr_get_sgid(struct rdma_dev_addr *dev_addr,
 214                                       union ib_gid *gid)
 215 {
 216         struct net_device *dev;
 217         struct ifaddr *ifa;
 218
 219         dev = dev_get_by_index(&init_net, dev_addr->bound_dev_if);
 220         if (dev) {
 221                 TAILQ_FOREACH(ifa, &dev->if_addrhead, ifa_link) {
 222                         if (ifa->ifa_addr == NULL ||
 223                             ifa->ifa_addr->sa_family != AF_INET)
 224                                 continue;
 225                         ipv6_addr_set_v4mapped(((struct sockaddr_in *)
 226                                                ifa->ifa_addr)->sin_addr.s_addr,
 227                                                (struct in6_addr *)gid);
 228                         break;
 229                 }
 230                 dev_put(dev);
 231         }
 232 }
 233
 234 static inline void rdma_addr_get_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
 235 {
 236         if (dev_addr->transport == RDMA_TRANSPORT_IB &&
 237             dev_addr->dev_type != ARPHRD_INFINIBAND)
 238                 iboe_addr_get_sgid(dev_addr, gid);
 239         else
 240                 memcpy(gid, dev_addr->src_dev_addr +
 241                        rdma_addr_gid_offset(dev_addr), sizeof *gid);
 242 }
 243
 244 static inline void rdma_addr_set_sgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
 245 {
 246         memcpy(dev_addr->src_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
 247 }
 248
 249 static inline void rdma_addr_get_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
 250 {
 251         memcpy(gid, dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), sizeof *gid);
 252 }
 253
 254 static inline void rdma_addr_set_dgid(struct rdma_dev_addr *dev_addr, union ib_gid *gid)
 255 {
 256         memcpy(dev_addr->dst_dev_addr + rdma_addr_gid_offset(dev_addr), gid, sizeof *gid);
 257 }
 258
 259 static inline enum ib_mtu iboe_get_mtu(int mtu)
 260 {
 261         /*
 262          * reduce IB headers from effective IBoE MTU. 28 stands for
 263          * atomic header which is the biggest possible header after BTH
 264          */
 265         mtu = mtu - IB_GRH_BYTES - IB_BTH_BYTES - 28;
 266
 267         if (mtu >= ib_mtu_enum_to_int(IB_MTU_4096))
 268                 return IB_MTU_4096;
 269         else if (mtu >= ib_mtu_enum_to_int(IB_MTU_2048))
 270                 return IB_MTU_2048;
 271         else if (mtu >= ib_mtu_enum_to_int(IB_MTU_1024))
 272                 return IB_MTU_1024;
 273         else if (mtu >= ib_mtu_enum_to_int(IB_MTU_512))
 274                 return IB_MTU_512;
 275         else if (mtu >= ib_mtu_enum_to_int(IB_MTU_256))
 276                 return IB_MTU_256;
 277         else
 278                 return 0;
 279 }
 280
 281 static inline int iboe_get_rate(struct net_device *dev)
 282 {
 283         uint64_t baudrate = dev->if_baudrate;
 284 #ifdef if_baudrate_pf
 285         int exp;
 286         for (exp = dev->if_baudrate_pf; exp > 0; exp--)
 287                 baudrate *= 10;
 288 #endif
 289         if (baudrate >= IF_Gbps(40))
 290                 return IB_RATE_40_GBPS;
 291         else if (baudrate >= IF_Gbps(30))
 292                 return IB_RATE_30_GBPS;
 293         else if (baudrate >= IF_Gbps(20))
 294                 return IB_RATE_20_GBPS;
 295         else if (baudrate >= IF_Gbps(10))
 296                 return IB_RATE_10_GBPS;
 297         else
 298                 return IB_RATE_PORT_CURRENT;
 299 }
 300
 301 static inline int rdma_link_local_addr(struct in6_addr *addr)
 302 {
 303         if (addr->s6_addr32[0] == htonl(0xfe800000) &&
 304             addr->s6_addr32[1] == 0)
 305                 return 1;
 306
 307         return 0;
 308 }
 309
 310 static inline void rdma_get_ll_mac(struct in6_addr *addr, u8 *mac)
 311 {
 312         memcpy(mac, &addr->s6_addr[8], 3);
 313         memcpy(mac + 3, &addr->s6_addr[13], 3);
 314         mac[0] ^= 2;
 315 }
 316
 317 static inline int rdma_is_multicast_addr(struct in6_addr *addr)
 318 {
 319         return addr->s6_addr[0] == 0xff;
 320 }
 321
 322 static inline void rdma_get_mcast_mac(struct in6_addr *addr, u8 *mac)
 323 {
 324         int i;
 325
 326         mac[0] = 0x33;
 327         mac[1] = 0x33;
 328         for (i = 2; i < 6; ++i)
 329                 mac[i] = addr->s6_addr[i + 10];
 330 }
 331
 332 static inline u16 rdma_get_vlan_id(union ib_gid *dgid)
 333 {
 334         u16 vid;
 335
 336         vid = dgid->raw[11] << 8 | dgid->raw[12];
 337         return vid < 0x1000 ? vid : 0xffff;
 338 }
 339
 340 static inline struct net_device *rdma_vlan_dev_real_dev(const struct net_device *dev)
 341 {
 342         return VLAN_TRUNKDEV(__DECONST(struct ifnet *, dev));
 343 }
 344
 345 #endif /* IB_ADDR_H */