sys/net80211/ieee80211_alq.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2011 Adrian Chadd, Xenion Lty Ltd
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #include <sys/cdefs.h>
  29 #ifdef __FreeBSD__
  30 __FBSDID("$FreeBSD$");
  31 #endif
  32
  33 /*
  34  * net80211 fast-logging support, primarily for debugging.
  35  *
  36  * This implements a single debugging queue which includes
  37  * per-device enumeration where needed.
  38  */
  39
  40 #include "opt_wlan.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/mbuf.h>
  45 #include <sys/malloc.h>
  46 #include <sys/endian.h>
  47 #include <sys/kernel.h>
  48 #include <sys/sysctl.h>
  49 #include <sys/pcpu.h>
  50 #include <sys/proc.h>
  51 #include <sys/ucred.h>
  52 #include <sys/alq.h>
  53
  54 #include <sys/socket.h>
  55
  56 #include <net/if.h>
  57 #include <net/if_var.h>
  58 #include <net/if_media.h>
  59 #include <net/ethernet.h>
  60
  61 #include <net80211/ieee80211_var.h>
  62 #include <net80211/ieee80211_freebsd.h>
  63 #include <net80211/ieee80211_alq.h>
  64
  65 static struct alq *ieee80211_alq;
  66 static int ieee80211_alq_lost;
  67 static int ieee80211_alq_logged;
  68 static char ieee80211_alq_logfile[MAXPATHLEN] = "/tmp/net80211.log";
  69 static unsigned int ieee80211_alq_qsize = 64*1024;
  70
  71 static int
  72 ieee80211_alq_setlogging(int enable)
  73 {
  74         int error;
  75
  76         if (enable) {
  77                 if (ieee80211_alq)
  78                         alq_close(ieee80211_alq);
  79
  80                 error = alq_open(&ieee80211_alq,
  81                     ieee80211_alq_logfile,
  82                     curthread->td_ucred,
  83                     ALQ_DEFAULT_CMODE,
  84                     ieee80211_alq_qsize, 0);
  85                 ieee80211_alq_lost = 0;
  86                 ieee80211_alq_logged = 0;
  87                 printf("net80211: logging to %s enabled; "
  88                     "struct size %d bytes\n",
  89                     ieee80211_alq_logfile,
  90                     (int) sizeof(struct ieee80211_alq_rec));
  91         } else {
  92                 if (ieee80211_alq)
  93                         alq_close(ieee80211_alq);
  94                 ieee80211_alq = NULL;
  95                 printf("net80211: logging disabled\n");
  96                 error = 0;
  97         }
  98         return (error);
  99 }
 100
 101 static int
 102 sysctl_ieee80211_alq_log(SYSCTL_HANDLER_ARGS)
 103 {
 104         int error, enable;
 105
 106         enable = (ieee80211_alq != NULL);
 107         error = sysctl_handle_int(oidp, &enable, 0, req);
 108         if (error || !req->newptr)
 109                 return (error);
 110         else
 111                 return (ieee80211_alq_setlogging(enable));
 112 }
 113
 114 SYSCTL_PROC(_net_wlan, OID_AUTO, alq, CTLTYPE_INT|CTLFLAG_RW,
 115         0, 0, sysctl_ieee80211_alq_log, "I", "Enable net80211 alq logging");
 116 SYSCTL_INT(_net_wlan, OID_AUTO, alq_size, CTLFLAG_RW,
 117         &ieee80211_alq_qsize, 0, "In-memory log size (bytes)");
 118 SYSCTL_INT(_net_wlan, OID_AUTO, alq_lost, CTLFLAG_RW,
 119         &ieee80211_alq_lost, 0, "Debugging operations not logged");
 120 SYSCTL_INT(_net_wlan, OID_AUTO, alq_logged, CTLFLAG_RW,
 121         &ieee80211_alq_logged, 0, "Debugging operations logged");
 122
 123 static struct ale *
 124 ieee80211_alq_get(size_t len)
 125 {
 126         struct ale *ale;
 127
 128         ale = alq_getn(ieee80211_alq, len + sizeof(struct ieee80211_alq_rec),
 129             ALQ_NOWAIT);
 130         if (!ale)
 131                 ieee80211_alq_lost++;
 132         else
 133                 ieee80211_alq_logged++;
 134         return ale;
 135 }
 136
 137 int
 138 ieee80211_alq_log(struct ieee80211com *ic, struct ieee80211vap *vap,
 139     uint32_t op, uint32_t flags, uint16_t srcid, const uint8_t *src,
 140     size_t len)
 141 {
 142         struct ale *ale;
 143         struct ieee80211_alq_rec *r;
 144         char *dst;
 145
 146         /* Don't log if we're disabled */
 147         if (ieee80211_alq == NULL)
 148                 return (0);
 149
 150         if (len > IEEE80211_ALQ_MAX_PAYLOAD)
 151                 return (ENOMEM);
 152
 153         ale = ieee80211_alq_get(len);
 154         if (! ale)
 155                 return (ENOMEM);
 156
 157         r = (struct ieee80211_alq_rec *) ale->ae_data;
 158         dst = ((char *) r) + sizeof(struct ieee80211_alq_rec);
 159         r->r_timestamp = htobe64(ticks);
 160         if (vap != NULL) {
 161                 r->r_wlan = htobe16(vap->iv_ifp->if_dunit);
 162         } else {
 163                 r->r_wlan = 0xffff;
 164         }
 165         r->r_src = htobe16(srcid);
 166         r->r_flags = htobe32(flags);
 167         r->r_op = htobe32(op);
 168         r->r_len = htobe32(len + sizeof(struct ieee80211_alq_rec));
 169         r->r_threadid = htobe32((uint32_t) curthread->td_tid);
 170
 171         if (src != NULL)
 172                 memcpy(dst, src, len);
 173
 174         alq_post(ieee80211_alq, ale);
 175
 176         return (0);
 177 }