1 /*-
2  * Copyright 2003 Eric Anholt
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * ERIC ANHOLT BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 
24 /** @file drm_sysctl.c
25  * Implementation of various sysctls for controlling DRM behavior and reporting
26  * debug information.
27  */
28 
29 #include "drmP.h"
30 #include "drm.h"
31 
32 #include <sys/sysctl.h>
33 
34 static int	   drm_name_info DRM_SYSCTL_HANDLER_ARGS;
35 static int	   drm_vm_info DRM_SYSCTL_HANDLER_ARGS;
36 static int	   drm_clients_info DRM_SYSCTL_HANDLER_ARGS;
37 static int	   drm_bufs_info DRM_SYSCTL_HANDLER_ARGS;
38 
39 struct drm_sysctl_list {
40 	const char *name;
41 	int	   (*f) DRM_SYSCTL_HANDLER_ARGS;
42 } drm_sysctl_list[] = {
43 	{"name",    drm_name_info},
44 	{"vm",	    drm_vm_info},
45 	{"clients", drm_clients_info},
46 	{"bufs",    drm_bufs_info},
47 };
48 #define DRM_SYSCTL_ENTRIES (sizeof(drm_sysctl_list)/sizeof(drm_sysctl_list[0]))
49 
50 struct drm_sysctl_info {
51 #if defined(__FreeBSD__)
52 	struct sysctl_ctx_list ctx;
53 	char		       name[2];
54 #elif   defined(__NetBSD__)
55 	const struct sysctlnode *dri, *dri_card, *dri_debug;
56 	const struct sysctlnode *dri_rest[DRM_SYSCTL_ENTRIES];
57 	char		       name[7];
58 	struct sysctllog       *log;
59 #endif
60 };
61 
62 int drm_sysctl_init(struct drm_device *dev)
63 {
64 	struct drm_sysctl_info *info;
65 #if defined(__FreeBSD__)
66 	struct sysctl_oid *oid;
67 	struct sysctl_oid *top, *drioid;
68 #endif
69 	int		  i;
70 
71 	info = malloc(sizeof *info, DRM_MEM_DRIVER, M_WAITOK | M_ZERO);
72 	if ( !info )
73 		return 1;
74 	dev->sysctl = info;
75 
76 #if defined(__FreeBSD__)
77 	/* Add the sysctl node for DRI if it doesn't already exist */
78 	drioid = SYSCTL_ADD_NODE( &info->ctx, &sysctl__hw_children, OID_AUTO, "dri", CTLFLAG_RW, NULL, "DRI Graphics");
79 	if (!drioid)
80 		return 1;
81 
82 	/* Find the next free slot under hw.dri */
83 	i = 0;
84 	SLIST_FOREACH(oid, SYSCTL_CHILDREN(drioid), oid_link) {
85 		if (i <= oid->oid_arg2)
86 			i = oid->oid_arg2 + 1;
87 	}
88 	if (i>9)
89 		return 1;
90 
91 	/* Add the hw.dri.x for our device */
92 	info->name[0] = '0' + i;
93 	info->name[1] = 0;
94 	top = SYSCTL_ADD_NODE( &info->ctx, SYSCTL_CHILDREN(drioid), OID_AUTO, info->name, CTLFLAG_RW, NULL, NULL);
95 	if (!top)
96 		return 1;
97 
98 	for (i = 0; i < DRM_SYSCTL_ENTRIES; i++) {
99 		oid = SYSCTL_ADD_OID(&info->ctx,
100 			SYSCTL_CHILDREN(top),
101 			OID_AUTO,
102 			drm_sysctl_list[i].name,
103 			CTLTYPE_INT | CTLFLAG_RD,
104 			dev,
105 			0,
106 			drm_sysctl_list[i].f,
107 			"A",
108 			NULL);
109 		if (!oid)
110 			return 1;
111 	}
112 	SYSCTL_ADD_INT(&info->ctx, SYSCTL_CHILDREN(top), OID_AUTO, "debug",
113 	    CTLFLAG_RW, &drm_debug_flag, sizeof(drm_debug_flag),
114 	    "Enable debugging output");
115 #elif   defined(__NetBSD__)
116 	sysctl_createv(&info->log, 0, NULL, &info->dri,
117 			CTLFLAG_READWRITE, CTLTYPE_NODE,
118 			"dri", SYSCTL_DESCR("DRI Graphics"), NULL, 0, NULL, 0,
119 			CTL_HW, CTL_CREATE);
120 	snprintf(info->name, 7, "card%d", minor(dev->kdev));
121 	sysctl_createv(&info->log, 0, NULL, &info->dri_card,
122 			CTLFLAG_READWRITE, CTLTYPE_NODE,
123 			info->name, NULL, NULL, 0, NULL, 0,
124 			CTL_HW, info->dri->sysctl_num, CTL_CREATE);
125 	for (i = 0; i < DRM_SYSCTL_ENTRIES; i++)
126 		sysctl_createv(&info->log, 0, NULL, &(info->dri_rest[i]),
127 				CTLFLAG_READONLY, CTLTYPE_STRING,
128 				drm_sysctl_list[i].name, NULL,
129 				drm_sysctl_list[i].f, 0, dev,
130 				sizeof(struct drm_device*),
131 				CTL_HW,
132 				info->dri->sysctl_num,
133 				info->dri_card->sysctl_num, CTL_CREATE);
134 	sysctl_createv(&info->log, 0, NULL, &info->dri_debug,
135 			CTLFLAG_READWRITE, CTLTYPE_INT,
136 			"debug", SYSCTL_DESCR("Enable debugging output"),
137 			NULL, 0,
138 			&drm_debug_flag, sizeof(drm_debug_flag),
139 			CTL_HW, info->dri->sysctl_num, CTL_CREATE);
140 #endif
141 
142 	return 0;
143 }
144 
145 int drm_sysctl_cleanup(struct drm_device *dev)
146 {
147 #if defined(__FreeBSD__)
148 	int error;
149 	error = sysctl_ctx_free( &dev->sysctl->ctx );
150 
151 	free(dev->sysctl, DRM_MEM_DRIVER);
152 	dev->sysctl = NULL;
153 
154 	return error;
155 #elif   defined(__NetBSD__)
156 	sysctl_teardown(&dev->sysctl->log);
157 
158 	free(dev->sysctl, DRM_MEM_DRIVER);
159 	dev->sysctl = NULL;
160 
161 	return 0;
162 #endif
163 }
164 
165 #ifdef __NetBSD__
166 #define SYSCTL_OUT(x, y, z) \
167 	(len+=z,(len<*oldlenp)?(strcat((char*)oldp, y),0):EOVERFLOW)
168 #endif
169 
170 #define DRM_SYSCTL_PRINT(fmt, arg...)				\
171 do {								\
172 	snprintf(buf, sizeof(buf), fmt, ##arg);			\
173 	retcode = SYSCTL_OUT(req, buf, strlen(buf));		\
174 	if (retcode)						\
175 		goto done;					\
176 } while (0)
177 
178 static int drm_name_info DRM_SYSCTL_HANDLER_ARGS
179 {
180 #if defined(__FreeBSD__)
181 	struct drm_device *dev = arg1;
182 #elif   defined(__NetBSD__)
183 	struct drm_device *dev = rnode->sysctl_data;
184 	int len = 0;
185 #endif
186 	char buf[128];
187 	int retcode;
188 	int hasunique = 0;
189 
190 #if defined(__FreeBSD__)
191 	DRM_SYSCTL_PRINT("%s 0x%x", dev->driver->name, dev2udev(dev->devnode));
192 #elif   defined(__NetBSD__)
193 	if (oldp == NULL)
194 		return EINVAL;
195 	*((char*)oldp) = '\0';
196 
197 	DRM_SYSCTL_PRINT("%s", dev->driver->name);
198 #endif
199 
200 	DRM_LOCK();
201 	if (dev->unique) {
202 		snprintf(buf, sizeof(buf), " %s", dev->unique);
203 		hasunique = 1;
204 	}
205 	DRM_UNLOCK();
206 
207 	if (hasunique)
208 		SYSCTL_OUT(req, buf, strlen(buf));
209 
210 	SYSCTL_OUT(req, "", 1);
211 
212 done:
213 	return retcode;
214 }
215 
216 static int drm_vm_info DRM_SYSCTL_HANDLER_ARGS
217 {
218 #if defined(__FreeBSD__)
219 	struct drm_device *dev = arg1;
220 #elif   defined(__NetBSD__)
221 	struct drm_device *dev = rnode->sysctl_data;
222 	int len = 0;
223 #endif
224 	drm_local_map_t *map, *tempmaps;
225 	const char   *types[] = { "FB", "REG", "SHM", "AGP", "SG", "GEM", "TTM" };
226 	const char *type, *yesno;
227 	int i, mapcount;
228 	char buf[128];
229 	int retcode;
230 
231 	/* We can't hold the lock while doing SYSCTL_OUTs, so allocate a
232 	 * temporary copy of all the map entries and then SYSCTL_OUT that.
233 	 */
234 	DRM_LOCK();
235 
236 	mapcount = 0;
237 	TAILQ_FOREACH(map, &dev->maplist, link)
238 		mapcount++;
239 
240 	tempmaps = malloc(sizeof(drm_local_map_t) * mapcount, DRM_MEM_DRIVER,
241 	    M_NOWAIT);
242 	if (tempmaps == NULL) {
243 		DRM_UNLOCK();
244 		return ENOMEM;
245 	}
246 
247 	i = 0;
248 	TAILQ_FOREACH(map, &dev->maplist, link)
249 		tempmaps[i++] = *map;
250 
251 	DRM_UNLOCK();
252 
253 	DRM_SYSCTL_PRINT("\nslot offset	        size       "
254 	    "type flags address            mtrr\n");
255 
256 	for (i = 0; i < mapcount; i++) {
257 		map = &tempmaps[i];
258 
259 		if (map->type > 4)
260 			type = "??";
261 		else
262 			type = types[map->type];
263 
264 		if (!map->mtrr)
265 			yesno = "no";
266 		else
267 			yesno = "yes";
268 
269 		DRM_SYSCTL_PRINT(
270 		    "%4d 0x%016lx 0x%08lx %4.4s  0x%02x 0x%016lx %s\n", i,
271 		    map->offset, map->size, type, map->flags,
272 		    (unsigned long)map->handle, yesno);
273 	}
274 	SYSCTL_OUT(req, "", 1);
275 
276 done:
277 	free(tempmaps, DRM_MEM_DRIVER);
278 	return retcode;
279 }
280 
281 static int drm_bufs_info DRM_SYSCTL_HANDLER_ARGS
282 {
283 #if defined(__FreeBSD__)
284 	struct drm_device *dev = arg1;
285 #elif   defined(__NetBSD__)
286 	struct drm_device *dev = rnode->sysctl_data;
287 	int len = 0;
288 #endif
289 	drm_device_dma_t *dma = dev->dma;
290 	drm_device_dma_t tempdma;
291 	int *templists;
292 	int i;
293 	char buf[128];
294 	int retcode;
295 
296 	/* We can't hold the locks around DRM_SYSCTL_PRINT, so make a temporary
297 	 * copy of the whole structure and the relevant data from buflist.
298 	 */
299 	DRM_LOCK();
300 	if (dma == NULL) {
301 		DRM_UNLOCK();
302 		return 0;
303 	}
304 	DRM_SPINLOCK(&dev->dma_lock);
305 	tempdma = *dma;
306 	templists = malloc(sizeof(int) * dma->buf_count, DRM_MEM_DRIVER,
307 	    M_NOWAIT);
308 	for (i = 0; i < dma->buf_count; i++)
309 		templists[i] = dma->buflist[i]->list;
310 	dma = &tempdma;
311 	DRM_SPINUNLOCK(&dev->dma_lock);
312 	DRM_UNLOCK();
313 
314 	DRM_SYSCTL_PRINT("\n o     size count  free	 segs pages    kB\n");
315 	for (i = 0; i <= DRM_MAX_ORDER; i++) {
316 		if (dma->bufs[i].buf_count)
317 			DRM_SYSCTL_PRINT("%2d %8d %5d %5d %5d %5d %5d\n",
318 				       i,
319 				       dma->bufs[i].buf_size,
320 				       dma->bufs[i].buf_count,
321 				       atomic_read(&dma->bufs[i]
322 						   .freelist.count),
323 				       dma->bufs[i].seg_count,
324 				       dma->bufs[i].seg_count
325 				       *(1 << dma->bufs[i].page_order),
326 				       (dma->bufs[i].seg_count
327 					* (1 << dma->bufs[i].page_order))
328 				       * PAGE_SIZE / 1024);
329 	}
330 	DRM_SYSCTL_PRINT("\n");
331 	for (i = 0; i < dma->buf_count; i++) {
332 		if (i && !(i%32)) DRM_SYSCTL_PRINT("\n");
333 		DRM_SYSCTL_PRINT(" %d", templists[i]);
334 	}
335 	DRM_SYSCTL_PRINT("\n");
336 
337 	SYSCTL_OUT(req, "", 1);
338 done:
339 	free(templists, DRM_MEM_DRIVER);
340 	return retcode;
341 }
342 
343 static int drm_clients_info DRM_SYSCTL_HANDLER_ARGS
344 {
345 #if defined(__FreeBSD__)
346 	struct drm_device *dev = arg1;
347 #elif   defined(__NetBSD__)
348 	struct drm_device *dev = rnode->sysctl_data;
349 	int len = 0;
350 #endif
351 	struct drm_file *priv, *tempprivs;
352 	char buf[128];
353 	int retcode;
354 	int privcount, i;
355 
356 	DRM_LOCK();
357 
358 	privcount = 0;
359 	TAILQ_FOREACH(priv, &dev->files, link)
360 		privcount++;
361 
362 	tempprivs = malloc(sizeof(struct drm_file) * privcount, DRM_MEM_DRIVER,
363 	    M_NOWAIT);
364 	if (tempprivs == NULL) {
365 		DRM_UNLOCK();
366 		return ENOMEM;
367 	}
368 	i = 0;
369 	TAILQ_FOREACH(priv, &dev->files, link)
370 		tempprivs[i++] = *priv;
371 
372 	DRM_UNLOCK();
373 
374 	DRM_SYSCTL_PRINT("\na dev	pid    uid	magic	  ioctls\n");
375 	for (i = 0; i < privcount; i++) {
376 		priv = &tempprivs[i];
377 		DRM_SYSCTL_PRINT("%c %3d %5d %5d %10u %10lu\n",
378 			       priv->authenticated ? 'y' : 'n',
379 			       priv->minor,
380 			       priv->pid,
381 			       priv->uid,
382 			       priv->magic,
383 			       priv->ioctl_count);
384 	}
385 
386 	SYSCTL_OUT(req, "", 1);
387 done:
388 	free(tempprivs, DRM_MEM_DRIVER);
389 	return retcode;
390 }
391