sys/dev/cxgb/ulp/tom/cxgb_l2t.c

   1 /**************************************************************************
   2
   3 Copyright (c) 2007, Chelsio Inc.
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Neither the name of the Chelsio Corporation nor the names of its
  13     contributors may be used to endorse or promote products derived from
  14     this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  20 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 POSSIBILITY OF SUCH DAMAGE.
  27
  28 ***************************************************************************/
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/module.h>
  37 #include <sys/bus.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #if __FreeBSD_version > 700000
  41 #include <sys/rwlock.h>
  42 #endif
  43
  44 #include <sys/socket.h>
  45 #include <net/if.h>
  46 #include <net/ethernet.h>
  47 #include <net/if_vlan_var.h>
  48 #include <net/if_dl.h>
  49 #include <net/route.h>
  50 #include <netinet/in.h>
  51 #include <netinet/if_ether.h>
  52
  53 #include <cxgb_include.h>
  54 #include <ulp/tom/cxgb_l2t.h>
  55
  56 #define VLAN_NONE 0xfff
  57 #define SDL(s) ((struct sockaddr_dl *)s)
  58 #define RT_ENADDR(sa)  ((u_char *)LLADDR(SDL((sa))))
  59 #define rt_expire rt_rmx.rmx_expire
  60
  61 struct llinfo_arp {
  62         struct  callout la_timer;
  63         struct  rtentry *la_rt;
  64         struct  mbuf *la_hold;  /* last packet until resolved/timeout */
  65         u_short la_preempt;     /* countdown for pre-expiry arps */
  66         u_short la_asked;       /* # requests sent */
  67 };
  68
  69 /*
  70  * Module locking notes:  There is a RW lock protecting the L2 table as a
  71  * whole plus a spinlock per L2T entry.  Entry lookups and allocations happen
  72  * under the protection of the table lock, individual entry changes happen
  73  * while holding that entry's spinlock.  The table lock nests outside the
  74  * entry locks.  Allocations of new entries take the table lock as writers so
  75  * no other lookups can happen while allocating new entries.  Entry updates
  76  * take the table lock as readers so multiple entries can be updated in
  77  * parallel.  An L2T entry can be dropped by decrementing its reference count
  78  * and therefore can happen in parallel with entry allocation but no entry
  79  * can change state or increment its ref count during allocation as both of
  80  * these perform lookups.
  81  */
  82
  83 static inline unsigned int
  84 vlan_prio(const struct l2t_entry *e)
  85 {
  86         return e->vlan >> 13;
  87 }
  88
  89 static inline unsigned int
  90 arp_hash(u32 key, int ifindex, const struct l2t_data *d)
  91 {
  92         return jhash_2words(key, ifindex, 0) & (d->nentries - 1);
  93 }
  94
  95 static inline void
  96 neigh_replace(struct l2t_entry *e, struct llentry *neigh)
  97 {
  98         LLE_WLOCK(neigh);
  99         LLE_ADDREF(neigh);
 100         LLE_WUNLOCK(neigh);
 101
 102         if (e->neigh)
 103                 LLE_FREE(e->neigh);
 104         e->neigh = neigh;
 105 }
 106
 107 /*
 108  * Set up an L2T entry and send any packets waiting in the arp queue.  The
 109  * supplied mbuf is used for the CPL_L2T_WRITE_REQ.  Must be called with the
 110  * entry locked.
 111  */
 112 static int
 113 setup_l2e_send_pending(struct t3cdev *dev, struct mbuf *m,
 114     struct l2t_entry *e)
 115 {
 116         struct cpl_l2t_write_req *req;
 117
 118         if (!m) {
 119                 if ((m = m_gethdr(M_NOWAIT, MT_DATA)) == NULL)
 120                     return (ENOMEM);
 121         }
 122         /*
 123          * XXX MH_ALIGN
 124          */
 125         req = mtod(m, struct cpl_l2t_write_req *);
 126         m->m_pkthdr.len = m->m_len = sizeof(*req);
 127
 128         req->wr.wr_hi = htonl(V_WR_OP(FW_WROPCODE_FORWARD));
 129         OPCODE_TID(req) = htonl(MK_OPCODE_TID(CPL_L2T_WRITE_REQ, e->idx));
 130         req->params = htonl(V_L2T_W_IDX(e->idx) | V_L2T_W_IFF(e->smt_idx) |
 131                             V_L2T_W_VLAN(e->vlan & EVL_VLID_MASK) |
 132                             V_L2T_W_PRIO(vlan_prio(e)));
 133
 134         memcpy(req->dst_mac, e->dmac, sizeof(req->dst_mac));
 135         m_set_priority(m, CPL_PRIORITY_CONTROL);
 136         cxgb_ofld_send(dev, m);
 137         while (e->arpq_head) {
 138                 m = e->arpq_head;
 139                 e->arpq_head = m->m_next;
 140                 m->m_next = NULL;
 141                 cxgb_ofld_send(dev, m);
 142         }
 143         e->arpq_tail = NULL;
 144         e->state = L2T_STATE_VALID;
 145
 146         return 0;
 147 }
 148
 149 /*
 150  * Add a packet to the an L2T entry's queue of packets awaiting resolution.
 151  * Must be called with the entry's lock held.
 152  */
 153 static inline void
 154 arpq_enqueue(struct l2t_entry *e, struct mbuf *m)
 155 {
 156         m->m_next = NULL;
 157         if (e->arpq_head)
 158                 e->arpq_tail->m_next = m;
 159         else
 160                 e->arpq_head = m;
 161         e->arpq_tail = m;
 162 }
 163
 164 int
 165 t3_l2t_send_slow(struct t3cdev *dev, struct mbuf *m, struct l2t_entry *e)
 166 {
 167         struct llentry *lle =  e->neigh;
 168         struct sockaddr_in sin;
 169
 170         bzero(&sin, sizeof(struct sockaddr_in));
 171         sin.sin_family = AF_INET;
 172         sin.sin_len = sizeof(struct sockaddr_in);
 173         sin.sin_addr.s_addr = e->addr;
 174
 175         CTR2(KTR_CXGB, "send slow on rt=%p eaddr=0x%08x\n", rt, e->addr);
 176 again:
 177         switch (e->state) {
 178         case L2T_STATE_STALE:     /* entry is stale, kick off revalidation */
 179                 arpresolve(rt->rt_ifp, rt, NULL,
 180                      (struct sockaddr *)&sin, e->dmac, &lle);
 181                 mtx_lock(&e->lock);
 182                 if (e->state == L2T_STATE_STALE)
 183                         e->state = L2T_STATE_VALID;
 184                 mtx_unlock(&e->lock);
 185         case L2T_STATE_VALID:     /* fast-path, send the packet on */
 186                 return cxgb_ofld_send(dev, m);
 187         case L2T_STATE_RESOLVING:
 188                 mtx_lock(&e->lock);
 189                 if (e->state != L2T_STATE_RESOLVING) { // ARP already completed
 190                         mtx_unlock(&e->lock);
 191                         goto again;
 192                 }
 193                 arpq_enqueue(e, m);
 194                 mtx_unlock(&e->lock);
 195                 /*
 196                  * Only the first packet added to the arpq should kick off
 197                  * resolution.  However, because the m_gethdr below can fail,
 198                  * we allow each packet added to the arpq to retry resolution
 199                  * as a way of recovering from transient memory exhaustion.
 200                  * A better way would be to use a work request to retry L2T
 201                  * entries when there's no memory.
 202                  */
 203                 if (arpresolve(rt->rt_ifp, rt, NULL,
 204                      (struct sockaddr *)&sin, e->dmac, &lle) == 0) {
 205                         CTR6(KTR_CXGB, "mac=%x:%x:%x:%x:%x:%x\n",
 206                             e->dmac[0], e->dmac[1], e->dmac[2], e->dmac[3], e->dmac[4], e->dmac[5]);
 207
 208                         if ((m = m_gethdr(M_NOWAIT, MT_DATA)) == NULL)
 209                                 return (ENOMEM);
 210
 211                         mtx_lock(&e->lock);
 212                         if (e->arpq_head)
 213                                 setup_l2e_send_pending(dev, m, e);
 214                         else
 215                                 m_freem(m);
 216                         mtx_unlock(&e->lock);
 217                 }
 218         }
 219         return 0;
 220 }
 221
 222 void
 223 t3_l2t_send_event(struct t3cdev *dev, struct l2t_entry *e)
 224 {
 225         struct mbuf *m0;
 226         struct sockaddr_in sin;
 227         sin.sin_family = AF_INET;
 228         sin.sin_len = sizeof(struct sockaddr_in);
 229         sin.sin_addr.s_addr = e->addr;
 230         struct llentry *lle;
 231
 232         if ((m0 = m_gethdr(M_NOWAIT, MT_DATA)) == NULL)
 233                 return;
 234
 235         rt = e->neigh;
 236 again:
 237         switch (e->state) {
 238         case L2T_STATE_STALE:     /* entry is stale, kick off revalidation */
 239                 arpresolve(rt->rt_ifp, rt, NULL,
 240                      (struct sockaddr *)&sin, e->dmac, &lle);
 241                 mtx_lock(&e->lock);
 242                 if (e->state == L2T_STATE_STALE) {
 243                         e->state = L2T_STATE_VALID;
 244                 }
 245                 mtx_unlock(&e->lock);
 246                 return;
 247         case L2T_STATE_VALID:     /* fast-path, send the packet on */
 248                 return;
 249         case L2T_STATE_RESOLVING:
 250                 mtx_lock(&e->lock);
 251                 if (e->state != L2T_STATE_RESOLVING) { // ARP already completed
 252                         mtx_unlock(&e->lock);
 253                         goto again;
 254                 }
 255                 mtx_unlock(&e->lock);
 256
 257                 /*
 258                  * Only the first packet added to the arpq should kick off
 259                  * resolution.  However, because the alloc_skb below can fail,
 260                  * we allow each packet added to the arpq to retry resolution
 261                  * as a way of recovering from transient memory exhaustion.
 262                  * A better way would be to use a work request to retry L2T
 263                  * entries when there's no memory.
 264                  */
 265                 arpresolve(rt->rt_ifp, rt, NULL,
 266                     (struct sockaddr *)&sin, e->dmac, &lle);
 267
 268         }
 269         return;
 270 }
 271 /*
 272  * Allocate a free L2T entry.  Must be called with l2t_data.lock held.
 273  */
 274 static struct l2t_entry *
 275 alloc_l2e(struct l2t_data *d)
 276 {
 277         struct l2t_entry *end, *e, **p;
 278
 279         if (!atomic_load_acq_int(&d->nfree))
 280                 return NULL;
 281
 282         /* there's definitely a free entry */
 283         for (e = d->rover, end = &d->l2tab[d->nentries]; e != end; ++e)
 284                 if (atomic_load_acq_int(&e->refcnt) == 0)
 285                         goto found;
 286
 287         for (e = &d->l2tab[1]; atomic_load_acq_int(&e->refcnt); ++e) ;
 288 found:
 289         d->rover = e + 1;
 290         atomic_add_int(&d->nfree, -1);
 291
 292         /*
 293          * The entry we found may be an inactive entry that is
 294          * presently in the hash table.  We need to remove it.
 295          */
 296         if (e->state != L2T_STATE_UNUSED) {
 297                 int hash = arp_hash(e->addr, e->ifindex, d);
 298
 299                 for (p = &d->l2tab[hash].first; *p; p = &(*p)->next)
 300                         if (*p == e) {
 301                                 *p = e->next;
 302                                 break;
 303                         }
 304                 e->state = L2T_STATE_UNUSED;
 305         }
 306
 307         return e;
 308 }
 309
 310 /*
 311  * Called when an L2T entry has no more users.  The entry is left in the hash
 312  * table since it is likely to be reused but we also bump nfree to indicate
 313  * that the entry can be reallocated for a different neighbor.  We also drop
 314  * the existing neighbor reference in case the neighbor is going away and is
 315  * waiting on our reference.
 316  *
 317  * Because entries can be reallocated to other neighbors once their ref count
 318  * drops to 0 we need to take the entry's lock to avoid races with a new
 319  * incarnation.
 320  */
 321 void
 322 t3_l2e_free(struct l2t_data *d, struct l2t_entry *e)
 323 {
 324         struct llentry *lle;
 325
 326         mtx_lock(&e->lock);
 327         if (atomic_load_acq_int(&e->refcnt) == 0) {  /* hasn't been recycled */
 328                 lle = e->neigh;
 329                 e->neigh = NULL;
 330         }
 331
 332         mtx_unlock(&e->lock);
 333         atomic_add_int(&d->nfree, 1);
 334         if (lle)
 335                 LLE_FREE(lle);
 336 }
 337
 338
 339 /*
 340  * Update an L2T entry that was previously used for the same next hop as neigh.
 341  * Must be called with softirqs disabled.
 342  */
 343 static inline void
 344 reuse_entry(struct l2t_entry *e, struct llentry *neigh)
 345 {
 346
 347         mtx_lock(&e->lock);                /* avoid race with t3_l2t_free */
 348         if (neigh != e->neigh)
 349                 neigh_replace(e, neigh);
 350
 351         if (memcmp(e->dmac, RT_ENADDR(neigh->rt_gateway), sizeof(e->dmac)) ||
 352             (neigh->rt_expire > time_uptime))
 353                 e->state = L2T_STATE_RESOLVING;
 354         else if (la->la_hold == NULL)
 355                 e->state = L2T_STATE_VALID;
 356         else
 357                 e->state = L2T_STATE_STALE;
 358         mtx_unlock(&e->lock);
 359 }
 360
 361 struct l2t_entry *
 362 t3_l2t_get(struct t3cdev *dev, struct llentry *neigh, struct ifnet *ifp,
 363         struct sockaddr *sa)
 364 {
 365         struct l2t_entry *e;
 366         struct l2t_data *d = L2DATA(dev);
 367         u32 addr = ((struct sockaddr_in *)sa)->sin_addr.s_addr;
 368         int ifidx = ifp->if_index;
 369         int hash = arp_hash(addr, ifidx, d);
 370         unsigned int smt_idx = ((struct port_info *)ifp->if_softc)->port_id;
 371
 372         rw_wlock(&d->lock);
 373         for (e = d->l2tab[hash].first; e; e = e->next)
 374                 if (e->addr == addr && e->ifindex == ifidx &&
 375                     e->smt_idx == smt_idx) {
 376                         l2t_hold(d, e);
 377                         if (atomic_load_acq_int(&e->refcnt) == 1)
 378                                 reuse_entry(e, neigh);
 379                         goto done;
 380                 }
 381
 382         /* Need to allocate a new entry */
 383         e = alloc_l2e(d);
 384         if (e) {
 385                 mtx_lock(&e->lock);          /* avoid race with t3_l2t_free */
 386                 e->next = d->l2tab[hash].first;
 387                 d->l2tab[hash].first = e;
 388                 rw_wunlock(&d->lock);
 389
 390                 e->state = L2T_STATE_RESOLVING;
 391                 e->addr = addr;
 392                 e->ifindex = ifidx;
 393                 e->smt_idx = smt_idx;
 394                 atomic_store_rel_int(&e->refcnt, 1);
 395                 e->neigh = NULL;
 396
 397
 398                 neigh_replace(e, neigh);
 399 #ifdef notyet
 400                 /*
 401                  * XXX need to add accessor function for vlan tag
 402                  */
 403                 if (neigh->rt_ifp->if_vlantrunk)
 404                         e->vlan = VLAN_DEV_INFO(neigh->dev)->vlan_id;
 405                 else
 406 #endif
 407                         e->vlan = VLAN_NONE;
 408                 mtx_unlock(&e->lock);
 409
 410                 return (e);
 411         }
 412
 413 done:
 414         rw_wunlock(&d->lock);
 415         return e;
 416 }
 417
 418 /*
 419  * Called when address resolution fails for an L2T entry to handle packets
 420  * on the arpq head.  If a packet specifies a failure handler it is invoked,
 421  * otherwise the packets is sent to the TOE.
 422  *
 423  * XXX: maybe we should abandon the latter behavior and just require a failure
 424  * handler.
 425  */
 426 static void
 427 handle_failed_resolution(struct t3cdev *dev, struct mbuf *arpq)
 428 {
 429
 430         while (arpq) {
 431                 struct mbuf *m = arpq;
 432 #ifdef notyet
 433                 struct l2t_mbuf_cb *cb = L2T_MBUF_CB(m);
 434 #endif
 435                 arpq = m->m_next;
 436                 m->m_next = NULL;
 437 #ifdef notyet
 438                 if (cb->arp_failure_handler)
 439                         cb->arp_failure_handler(dev, m);
 440                 else
 441 #endif
 442                         cxgb_ofld_send(dev, m);
 443         }
 444
 445 }
 446
 447 void
 448 t3_l2t_update(struct t3cdev *dev, struct llentry *neigh,
 449     uint8_t *enaddr, struct sockaddr *sa)
 450 {
 451         struct l2t_entry *e;
 452         struct mbuf *arpq = NULL;
 453         struct l2t_data *d = L2DATA(dev);
 454         u32 addr = *(u32 *) &((struct sockaddr_in *)sa)->sin_addr;
 455         int hash = arp_hash(addr, ifidx, d);
 456         struct llinfo_arp *la;
 457
 458         rw_rlock(&d->lock);
 459         for (e = d->l2tab[hash].first; e; e = e->next)
 460                 if (e->addr == addr) {
 461                         mtx_lock(&e->lock);
 462                         goto found;
 463                 }
 464         rw_runlock(&d->lock);
 465         CTR1(KTR_CXGB, "t3_l2t_update: addr=0x%08x not found", addr);
 466         return;
 467
 468 found:
 469         printf("found 0x%08x\n", addr);
 470
 471         rw_runlock(&d->lock);
 472         memcpy(e->dmac, enaddr, ETHER_ADDR_LEN);
 473         printf("mac=%x:%x:%x:%x:%x:%x\n",
 474             e->dmac[0], e->dmac[1], e->dmac[2], e->dmac[3], e->dmac[4], e->dmac[5]);
 475
 476         if (atomic_load_acq_int(&e->refcnt)) {
 477                 if (neigh != e->neigh)
 478                         neigh_replace(e, neigh);
 479
 480                 la = (struct llinfo_arp *)neigh->rt_llinfo;
 481                 if (e->state == L2T_STATE_RESOLVING) {
 482
 483                         if (la->la_asked >= 5 /* arp_maxtries */) {
 484                                 arpq = e->arpq_head;
 485                                 e->arpq_head = e->arpq_tail = NULL;
 486                         } else
 487                                 setup_l2e_send_pending(dev, NULL, e);
 488                 } else {
 489                         e->state = L2T_STATE_VALID;
 490                         if (memcmp(e->dmac, RT_ENADDR(neigh->rt_gateway), 6))
 491                                 setup_l2e_send_pending(dev, NULL, e);
 492                 }
 493         }
 494         mtx_unlock(&e->lock);
 495
 496         if (arpq)
 497                 handle_failed_resolution(dev, arpq);
 498 }
 499
 500 struct l2t_data *
 501 t3_init_l2t(unsigned int l2t_capacity)
 502 {
 503         struct l2t_data *d;
 504         int i, size = sizeof(*d) + l2t_capacity * sizeof(struct l2t_entry);
 505
 506         d = cxgb_alloc_mem(size);
 507         if (!d)
 508                 return NULL;
 509
 510         d->nentries = l2t_capacity;
 511         d->rover = &d->l2tab[1];        /* entry 0 is not used */
 512         atomic_store_rel_int(&d->nfree, l2t_capacity - 1);
 513         rw_init(&d->lock, "L2T");
 514
 515         for (i = 0; i < l2t_capacity; ++i) {
 516                 d->l2tab[i].idx = i;
 517                 d->l2tab[i].state = L2T_STATE_UNUSED;
 518                 mtx_init(&d->l2tab[i].lock, "L2TAB", NULL, MTX_DEF);
 519                 atomic_store_rel_int(&d->l2tab[i].refcnt, 0);
 520         }
 521         return d;
 522 }
 523
 524 void
 525 t3_free_l2t(struct l2t_data *d)
 526 {
 527         int i;
 528
 529         rw_destroy(&d->lock);
 530         for (i = 0; i < d->nentries; ++i)
 531                 mtx_destroy(&d->l2tab[i].lock);
 532
 533         cxgb_free_mem(d);
 534 }