2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2013 Chelsio Communications, Inc.
6 * Written by: Navdeep Parhar <np@FreeBSD.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 #include "opt_inet6.h"
36 #include <sys/param.h>
37 #include <sys/eventhandler.h>
39 #include <sys/types.h>
41 #include <sys/socket.h>
42 #include <sys/sockio.h>
45 #include <net/ethernet.h>
47 #include <net/if_clone.h>
48 #include <net/if_types.h>
50 #include "common/common.h"
51 #include "common/t4_msg.h"
52 #include "common/t4_regs.h"
59 * An interface cloner is registered during mod_load and it can be used to
60 * create or destroy the tracing ifnet for an adapter at any time. It is
61 * possible for the cloned interface to outlive the adapter (adapter disappears
62 * in t4_detach but the tracing ifnet may live till mod_unload when removal of
63 * the cloner finally destroys any remaining cloned interfaces). When tracing
64 * filters are active, this ifnet is also receiving data. There are potential
65 * bad races between ifnet create, ifnet destroy, ifnet rx, ifnet ioctl,
66 * cxgbe_detach/t4_detach, mod_unload.
68 * a) The driver selects an iq for tracing (sc->traceq) inside a synch op. The
69 * iq is destroyed inside a synch op too (and sc->traceq updated).
70 * b) The cloner looks for an adapter that matches the name of the ifnet it's
71 * been asked to create, starts a synch op on that adapter, and proceeds only
72 * if the adapter has a tracing iq.
73 * c) The cloned ifnet and the adapter are coupled to each other via
74 * ifp->if_softc and sc->ifp. These can be modified only with the global
75 * t4_trace_lock sx as well as the sc->ifp_lock mutex held. Holding either
76 * of these will prevent any change.
78 * The order in which all the locks involved should be acquired are:
81 * (begin synch op and let go of the above two)
86 static struct sx t4_trace_lock;
87 static const char *t4_cloner_name = "tXnex";
88 static struct if_clone *t4_cloner;
90 /* tracer ifnet routines. mostly no-ops. */
91 static void tracer_init(void *);
92 static int tracer_ioctl(struct ifnet *, unsigned long, caddr_t);
93 static int tracer_transmit(struct ifnet *, struct mbuf *);
94 static void tracer_qflush(struct ifnet *);
95 static int tracer_media_change(struct ifnet *);
96 static void tracer_media_status(struct ifnet *, struct ifmediareq *);
98 /* match name (request/response) */
101 int lock; /* set to 1 to returned sc locked. */
107 match_name(struct adapter *sc, void *arg)
109 struct match_rr *mrr = arg;
111 if (strcmp(device_get_nameunit(sc->dev), mrr->name) != 0)
114 KASSERT(mrr->sc == NULL, ("%s: multiple matches (%p, %p) for %s",
115 __func__, mrr->sc, sc, mrr->name));
119 mrr->rc = begin_synchronized_op(mrr->sc, NULL, 0, "t4clon");
125 t4_cloner_match(struct if_clone *ifc, const char *name)
128 if (strncmp(name, "t4nex", 5) != 0 &&
129 strncmp(name, "t5nex", 5) != 0 &&
130 strncmp(name, "t6nex", 5) != 0)
132 if (name[5] < '0' || name[5] > '9')
138 t4_cloner_create(struct if_clone *ifc, char *name, size_t len, caddr_t params)
144 const uint8_t lla[ETHER_ADDR_LEN] = {0, 0, 0, 0, 0, 0};
150 t4_iterate(match_name, &mrr);
156 KASSERT(sc != NULL, ("%s: name (%s) matched but softc is NULL",
158 ASSERT_SYNCHRONIZED_OP(sc);
160 sx_xlock(&t4_trace_lock);
162 if (sc->ifp != NULL) {
166 if (sc->traceq < 0) {
173 rc = ifc_alloc_unit(ifc, &unit);
177 ifp = if_alloc(IFT_ETHER);
179 ifc_free_unit(ifc, unit);
184 /* Note that if_xname is not <if_dname><if_dunit>. */
185 strlcpy(ifp->if_xname, name, sizeof(ifp->if_xname));
186 ifp->if_dname = t4_cloner_name;
187 ifp->if_dunit = unit;
188 ifp->if_init = tracer_init;
189 ifp->if_flags = IFF_SIMPLEX | IFF_DRV_RUNNING;
190 ifp->if_ioctl = tracer_ioctl;
191 ifp->if_transmit = tracer_transmit;
192 ifp->if_qflush = tracer_qflush;
193 ifp->if_capabilities = IFCAP_JUMBO_MTU | IFCAP_VLAN_MTU;
194 ifmedia_init(&sc->media, IFM_IMASK, tracer_media_change,
195 tracer_media_status);
196 ifmedia_add(&sc->media, IFM_ETHER | IFM_FDX | IFM_NONE, 0, NULL);
197 ifmedia_set(&sc->media, IFM_ETHER | IFM_FDX | IFM_NONE);
198 ether_ifattach(ifp, lla);
200 mtx_lock(&sc->ifp_lock);
203 mtx_unlock(&sc->ifp_lock);
205 sx_xunlock(&t4_trace_lock);
206 end_synchronized_op(sc, 0);
211 t4_cloner_destroy(struct if_clone *ifc, struct ifnet *ifp)
214 int unit = ifp->if_dunit;
216 sx_xlock(&t4_trace_lock);
219 mtx_lock(&sc->ifp_lock);
221 ifp->if_softc = NULL;
222 mtx_unlock(&sc->ifp_lock);
223 ifmedia_removeall(&sc->media);
227 ifc_free_unit(ifc, unit);
228 sx_xunlock(&t4_trace_lock);
237 sx_init(&t4_trace_lock, "T4/T5 tracer lock");
238 t4_cloner = if_clone_advanced(t4_cloner_name, 0, t4_cloner_match,
239 t4_cloner_create, t4_cloner_destroy);
243 t4_tracer_modunload()
246 if (t4_cloner != NULL) {
248 * The module is being unloaded so the nexus drivers have
249 * detached. The tracing interfaces can not outlive the nexus
250 * (ifp->if_softc is the nexus) and must have been destroyed
251 * already. XXX: but if_clone is opaque to us and we can't
252 * assert LIST_EMPTY(&t4_cloner->ifc_iflist) at this time.
254 if_clone_detach(t4_cloner);
256 sx_destroy(&t4_trace_lock);
260 t4_tracer_port_detach(struct adapter *sc)
263 sx_xlock(&t4_trace_lock);
264 if (sc->ifp != NULL) {
265 mtx_lock(&sc->ifp_lock);
266 sc->ifp->if_softc = NULL;
268 mtx_unlock(&sc->ifp_lock);
270 ifmedia_removeall(&sc->media);
271 sx_xunlock(&t4_trace_lock);
275 t4_get_tracer(struct adapter *sc, struct t4_tracer *t)
278 struct trace_params tp;
280 if (t->idx >= NTRACE) {
287 rc = begin_synchronized_op(sc, NULL, HOLD_LOCK | SLEEP_OK | INTR_OK,
292 for (i = t->idx; i < NTRACE; i++) {
293 if (isset(&sc->tracer_valid, t->idx)) {
294 t4_get_trace_filter(sc, &tp, i, &enabled);
296 t->enabled = enabled;
298 memcpy(&t->tp.data[0], &tp.data[0], sizeof(t->tp.data));
299 memcpy(&t->tp.mask[0], &tp.mask[0], sizeof(t->tp.mask));
300 t->tp.snap_len = tp.snap_len;
301 t->tp.min_len = tp.min_len;
302 t->tp.skip_ofst = tp.skip_ofst;
303 t->tp.skip_len = tp.skip_len;
304 t->tp.invert = tp.invert;
306 /* convert channel to port iff 0 <= port < 8. */
308 t->tp.port = sc->chan_map[tp.port];
309 else if (tp.port < 8)
310 t->tp.port = sc->chan_map[tp.port - 4] + 4;
312 t->tp.port = tp.port;
322 end_synchronized_op(sc, LOCK_HELD);
328 t4_set_tracer(struct adapter *sc, struct t4_tracer *t)
331 struct trace_params tp, *tpp;
333 if (t->idx >= NTRACE)
336 rc = begin_synchronized_op(sc, NULL, HOLD_LOCK | SLEEP_OK | INTR_OK,
342 * If no tracing filter is specified this time then check if the filter
343 * at the index is valid anyway because it was set previously. If so
344 * then this is a legitimate enable/disable operation.
347 if (isset(&sc->tracer_valid, t->idx))
354 if (t->tp.port > 19 || t->tp.snap_len > 9600 ||
355 t->tp.min_len > M_TFMINPKTSIZE || t->tp.skip_len > M_TFLENGTH ||
356 t->tp.skip_ofst > M_TFOFFSET) {
361 memcpy(&tp.data[0], &t->tp.data[0], sizeof(tp.data));
362 memcpy(&tp.mask[0], &t->tp.mask[0], sizeof(tp.mask));
363 tp.snap_len = t->tp.snap_len;
364 tp.min_len = t->tp.min_len;
365 tp.skip_ofst = t->tp.skip_ofst;
366 tp.skip_len = t->tp.skip_len;
367 tp.invert = !!t->tp.invert;
369 /* convert port to channel iff 0 <= port < 8. */
370 if (t->tp.port < 4) {
371 if (sc->port[t->tp.port] == NULL) {
375 tp.port = sc->port[t->tp.port]->tx_chan;
376 } else if (t->tp.port < 8) {
377 if (sc->port[t->tp.port - 4] == NULL) {
381 tp.port = sc->port[t->tp.port - 4]->tx_chan + 4;
386 rc = -t4_set_trace_filter(sc, tpp, t->idx, t->enabled);
389 setbit(&sc->tracer_valid, t->idx);
390 if (sc->tracer_enabled == 0) {
391 t4_set_reg_field(sc, A_MPS_TRC_CFG,
394 setbit(&sc->tracer_enabled, t->idx);
396 clrbit(&sc->tracer_enabled, t->idx);
397 if (sc->tracer_enabled == 0) {
398 t4_set_reg_field(sc, A_MPS_TRC_CFG,
404 end_synchronized_op(sc, LOCK_HELD);
410 t4_trace_pkt(struct sge_iq *iq, const struct rss_header *rss, struct mbuf *m)
412 struct adapter *sc = iq->adapter;
415 KASSERT(m != NULL, ("%s: no payload with opcode %02x", __func__,
418 mtx_lock(&sc->ifp_lock);
421 m_adj(m, sizeof(struct cpl_trace_pkt));
422 m->m_pkthdr.rcvif = ifp;
423 ETHER_BPF_MTAP(ifp, m);
425 mtx_unlock(&sc->ifp_lock);
432 t5_trace_pkt(struct sge_iq *iq, const struct rss_header *rss, struct mbuf *m)
434 struct adapter *sc = iq->adapter;
437 KASSERT(m != NULL, ("%s: no payload with opcode %02x", __func__,
440 mtx_lock(&sc->ifp_lock);
443 m_adj(m, sizeof(struct cpl_t5_trace_pkt));
444 m->m_pkthdr.rcvif = ifp;
445 ETHER_BPF_MTAP(ifp, m);
447 mtx_unlock(&sc->ifp_lock);
455 tracer_init(void *arg)
462 tracer_ioctl(struct ifnet *ifp, unsigned long cmd, caddr_t data)
466 struct ifreq *ifr = (struct ifreq *)data;
478 sx_xlock(&t4_trace_lock);
483 rc = ifmedia_ioctl(ifp, ifr, &sc->media, cmd);
484 sx_xunlock(&t4_trace_lock);
487 rc = ether_ioctl(ifp, cmd, data);
494 tracer_transmit(struct ifnet *ifp, struct mbuf *m)
502 tracer_qflush(struct ifnet *ifp)
509 tracer_media_change(struct ifnet *ifp)
516 tracer_media_status(struct ifnet *ifp, struct ifmediareq *ifmr)
519 ifmr->ifm_status = IFM_AVALID | IFM_ACTIVE;