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