xref: /freebsd/sys/dev/sound/sndstat.c (revision 2aa16666e2fa5c98be8d330cd0c32c9dc3801ba7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
5  * Copyright (c) 2001 Cameron Grant <cg@FreeBSD.org>
6  * Copyright (c) 2020 The FreeBSD Foundation
7  * All rights reserved.
8  * Copyright (c) 2024-2025 The FreeBSD Foundation
9  *
10  * Portions of this software were developed by Christos Margiolis
11  * <christos@FreeBSD.org> under sponsorship from the FreeBSD Foundation.
12  *
13  * Portions of this software were developed by Ka Ho Ng
14  * under sponsorship from the FreeBSD Foundation.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  */
37 
38 #ifdef HAVE_KERNEL_OPTION_HEADERS
39 #include "opt_snd.h"
40 #endif
41 
42 #include <sys/param.h>
43 #include <sys/dnv.h>
44 #include <sys/lock.h>
45 #include <sys/malloc.h>
46 #include <sys/nv.h>
47 #include <sys/sndstat.h>
48 #include <sys/sx.h>
49 
50 #include <dev/sound/pcm/sound.h>
51 #include <dev/sound/sndstat.h>
52 
53 #include "feeder_if.h"
54 
55 static d_open_t sndstat_open;
56 static void sndstat_close(void *);
57 static d_read_t sndstat_read;
58 static d_write_t sndstat_write;
59 static d_ioctl_t sndstat_ioctl;
60 
61 static struct cdevsw sndstat_cdevsw = {
62 	.d_version =	D_VERSION,
63 	.d_open =	sndstat_open,
64 	.d_read =	sndstat_read,
65 	.d_write =	sndstat_write,
66 	.d_ioctl =	sndstat_ioctl,
67 	.d_name =	"sndstat",
68 	.d_flags =	D_TRACKCLOSE,
69 };
70 
71 struct sndstat_entry {
72 	TAILQ_ENTRY(sndstat_entry) link;
73 	device_t dev;
74 	char *str;
75 	enum sndstat_type type;
76 	int unit;
77 };
78 
79 struct sndstat_userdev {
80 	TAILQ_ENTRY(sndstat_userdev) link;
81 	char *provider;
82 	char *nameunit;
83 	char *devnode;
84 	char *desc;
85 	unsigned int pchan;
86 	unsigned int rchan;
87 	struct {
88 		uint32_t min_rate;
89 		uint32_t max_rate;
90 		uint32_t formats;
91 		uint32_t min_chn;
92 		uint32_t max_chn;
93 	} info_play, info_rec;
94 	nvlist_t *provider_nvl;
95 };
96 
97 struct sndstat_file {
98 	TAILQ_ENTRY(sndstat_file) entry;
99 	struct sbuf sbuf;
100 	struct sx lock;
101 	void *devs_nvlbuf;	/* (l) */
102 	size_t devs_nbytes;	/* (l) */
103 	TAILQ_HEAD(, sndstat_userdev) userdev_list;	/* (l) */
104 	int out_offset;
105   	int in_offset;
106 	int fflags;
107 };
108 
109 static struct sx sndstat_lock;
110 static struct cdev *sndstat_dev;
111 
112 #define	SNDSTAT_LOCK() sx_xlock(&sndstat_lock)
113 #define	SNDSTAT_UNLOCK() sx_xunlock(&sndstat_lock)
114 
115 static TAILQ_HEAD(, sndstat_entry) sndstat_devlist = TAILQ_HEAD_INITIALIZER(sndstat_devlist);
116 static TAILQ_HEAD(, sndstat_file) sndstat_filelist = TAILQ_HEAD_INITIALIZER(sndstat_filelist);
117 
118 int snd_verbose = 0;
119 
120 static int sndstat_prepare(struct sndstat_file *);
121 static struct sndstat_userdev *
122 sndstat_line2userdev(struct sndstat_file *, const char *, int);
123 
124 static int
sysctl_hw_sndverbose(SYSCTL_HANDLER_ARGS)125 sysctl_hw_sndverbose(SYSCTL_HANDLER_ARGS)
126 {
127 	int error, verbose;
128 
129 	verbose = snd_verbose;
130 	error = sysctl_handle_int(oidp, &verbose, 0, req);
131 	if (error == 0 && req->newptr != NULL) {
132 		if (verbose < 0 || verbose > 4)
133 			error = EINVAL;
134 		else
135 			snd_verbose = verbose;
136 	}
137 	return (error);
138 }
139 SYSCTL_PROC(_hw_snd, OID_AUTO, verbose,
140     CTLTYPE_INT | CTLFLAG_RWTUN | CTLFLAG_MPSAFE, 0, sizeof(int),
141     sysctl_hw_sndverbose, "I",
142     "verbosity level");
143 
144 static int
sndstat_open(struct cdev * i_dev,int flags,int mode,struct thread * td)145 sndstat_open(struct cdev *i_dev, int flags, int mode, struct thread *td)
146 {
147 	struct sndstat_file *pf;
148 
149 	pf = malloc(sizeof(*pf), M_DEVBUF, M_WAITOK | M_ZERO);
150 
151 	sbuf_new(&pf->sbuf, NULL, 4096, SBUF_AUTOEXTEND);
152 
153 	pf->fflags = flags;
154 	TAILQ_INIT(&pf->userdev_list);
155 	sx_init(&pf->lock, "sndstat_file");
156 
157 	SNDSTAT_LOCK();
158 	TAILQ_INSERT_TAIL(&sndstat_filelist, pf, entry);
159 	SNDSTAT_UNLOCK();
160 
161 	devfs_set_cdevpriv(pf, &sndstat_close);
162 
163 	return (0);
164 }
165 
166 /*
167  * Should only be called either when:
168  * * Closing
169  * * pf->lock held
170  */
171 static void
sndstat_remove_all_userdevs(struct sndstat_file * pf)172 sndstat_remove_all_userdevs(struct sndstat_file *pf)
173 {
174 	struct sndstat_userdev *ud;
175 
176 	KASSERT(
177 	    sx_xlocked(&pf->lock), ("%s: Called without pf->lock", __func__));
178 	while ((ud = TAILQ_FIRST(&pf->userdev_list)) != NULL) {
179 		TAILQ_REMOVE(&pf->userdev_list, ud, link);
180 		free(ud->provider, M_DEVBUF);
181 		free(ud->desc, M_DEVBUF);
182 		free(ud->devnode, M_DEVBUF);
183 		free(ud->nameunit, M_DEVBUF);
184 		nvlist_destroy(ud->provider_nvl);
185 		free(ud, M_DEVBUF);
186 	}
187 }
188 
189 static void
sndstat_close(void * sndstat_file)190 sndstat_close(void *sndstat_file)
191 {
192 	struct sndstat_file *pf = (struct sndstat_file *)sndstat_file;
193 
194 	SNDSTAT_LOCK();
195 	sbuf_delete(&pf->sbuf);
196 	TAILQ_REMOVE(&sndstat_filelist, pf, entry);
197 	SNDSTAT_UNLOCK();
198 
199 	free(pf->devs_nvlbuf, M_NVLIST);
200 	sx_xlock(&pf->lock);
201 	sndstat_remove_all_userdevs(pf);
202 	sx_xunlock(&pf->lock);
203 	sx_destroy(&pf->lock);
204 
205 	free(pf, M_DEVBUF);
206 }
207 
208 static int
sndstat_read(struct cdev * i_dev,struct uio * buf,int flag)209 sndstat_read(struct cdev *i_dev, struct uio *buf, int flag)
210 {
211 	struct sndstat_file *pf;
212 	int err;
213 	int len;
214 
215 	err = devfs_get_cdevpriv((void **)&pf);
216 	if (err != 0)
217 		return (err);
218 
219 	/* skip zero-length reads */
220 	if (buf->uio_resid == 0)
221 		return (0);
222 
223 	SNDSTAT_LOCK();
224 	if (pf->out_offset != 0) {
225 		/* don't allow both reading and writing */
226 		err = EINVAL;
227 		goto done;
228 	} else if (pf->in_offset == 0) {
229 		err = sndstat_prepare(pf);
230 		if (err <= 0) {
231 			err = ENOMEM;
232 			goto done;
233 		}
234 	}
235 	len = sbuf_len(&pf->sbuf) - pf->in_offset;
236 	if (len > buf->uio_resid)
237 		len = buf->uio_resid;
238 	if (len > 0)
239 		err = uiomove(sbuf_data(&pf->sbuf) + pf->in_offset, len, buf);
240 	pf->in_offset += len;
241 done:
242 	SNDSTAT_UNLOCK();
243 	return (err);
244 }
245 
246 static int
sndstat_write(struct cdev * i_dev,struct uio * buf,int flag)247 sndstat_write(struct cdev *i_dev, struct uio *buf, int flag)
248 {
249 	struct sndstat_file *pf;
250 	uint8_t temp[64];
251 	int err;
252 	int len;
253 
254 	err = devfs_get_cdevpriv((void **)&pf);
255 	if (err != 0)
256 		return (err);
257 
258 	/* skip zero-length writes */
259 	if (buf->uio_resid == 0)
260 		return (0);
261 
262 	/* don't allow writing more than 64Kbytes */
263 	if (buf->uio_resid > 65536)
264 		return (ENOMEM);
265 
266 	SNDSTAT_LOCK();
267 	if (pf->in_offset != 0) {
268 		/* don't allow both reading and writing */
269 		err = EINVAL;
270 	} else {
271 		/* only remember the last write - allows for updates */
272 		sx_xlock(&pf->lock);
273 		sndstat_remove_all_userdevs(pf);
274 		sx_xunlock(&pf->lock);
275 
276 		while (1) {
277 			len = sizeof(temp);
278 			if (len > buf->uio_resid)
279 				len = buf->uio_resid;
280 			if (len > 0) {
281 				err = uiomove(temp, len, buf);
282 				if (err)
283 					break;
284 			} else {
285 				break;
286 			}
287 			if (sbuf_bcat(&pf->sbuf, temp, len) < 0) {
288 				err = ENOMEM;
289 				break;
290 			}
291 		}
292 		sbuf_finish(&pf->sbuf);
293 
294 		if (err == 0) {
295 			char *line, *str;
296 
297 			str = sbuf_data(&pf->sbuf);
298 			while ((line = strsep(&str, "\n")) != NULL) {
299 				struct sndstat_userdev *ud;
300 
301 				ud = sndstat_line2userdev(pf, line, strlen(line));
302 				if (ud == NULL)
303 					continue;
304 
305 				sx_xlock(&pf->lock);
306 				TAILQ_INSERT_TAIL(&pf->userdev_list, ud, link);
307 				sx_xunlock(&pf->lock);
308 			}
309 
310 			pf->out_offset = sbuf_len(&pf->sbuf);
311 		} else
312 			pf->out_offset = 0;
313 
314 		sbuf_clear(&pf->sbuf);
315 	}
316 	SNDSTAT_UNLOCK();
317 	return (err);
318 }
319 
320 static void
sndstat_get_caps(struct snddev_info * d,int dir,uint32_t * min_rate,uint32_t * max_rate,uint32_t * fmts,uint32_t * minchn,uint32_t * maxchn)321 sndstat_get_caps(struct snddev_info *d, int dir, uint32_t *min_rate,
322     uint32_t *max_rate, uint32_t *fmts, uint32_t *minchn, uint32_t *maxchn)
323 {
324 	struct pcm_channel *c;
325 	struct pcmchan_caps *caps;
326 	int i;
327 
328 	*fmts = 0;
329 	*min_rate = UINT32_MAX;
330 	*max_rate = 0;
331 	*minchn = UINT32_MAX;
332 	*maxchn = 0;
333 
334 	CHN_FOREACH(c, d, channels.pcm) {
335 		if (c->direction != dir)
336 			continue;
337 		CHN_LOCK(c);
338 		caps = chn_getcaps(c);
339 		for (i = 0; caps->fmtlist[i]; i++) {
340 			*fmts |= AFMT_ENCODING(caps->fmtlist[i]);
341 			*minchn = min(AFMT_CHANNEL(caps->fmtlist[i]), *minchn);
342 			*maxchn = max(AFMT_CHANNEL(caps->fmtlist[i]), *maxchn);
343 		}
344 		if ((c->flags & CHN_F_EXCLUSIVE) ||
345 		    (pcm_getflags(d->dev) & SD_F_BITPERFECT)) {
346 			*min_rate = min(*min_rate, caps->minspeed);
347 			*max_rate = max(*max_rate, caps->maxspeed);
348 		} else {
349 			*min_rate = min(*min_rate, feeder_rate_min);
350 			*max_rate = max(*max_rate, feeder_rate_max);
351 		}
352 		CHN_UNLOCK(c);
353 	}
354 	if (*min_rate == UINT32_MAX)
355 		*min_rate = 0;
356 	if (*minchn == UINT32_MAX)
357 		*minchn = 0;
358 }
359 
360 static nvlist_t *
sndstat_create_diinfo_nv(uint32_t min_rate,uint32_t max_rate,uint32_t formats,uint32_t min_chn,uint32_t max_chn)361 sndstat_create_diinfo_nv(uint32_t min_rate, uint32_t max_rate, uint32_t formats,
362 	    uint32_t min_chn, uint32_t max_chn)
363 {
364 	nvlist_t *nv;
365 
366 	nv = nvlist_create(0);
367 	if (nv == NULL)
368 		return (NULL);
369 	nvlist_add_number(nv, SNDST_DSPS_INFO_MIN_RATE, min_rate);
370 	nvlist_add_number(nv, SNDST_DSPS_INFO_MAX_RATE, max_rate);
371 	nvlist_add_number(nv, SNDST_DSPS_INFO_FORMATS, formats);
372 	nvlist_add_number(nv, SNDST_DSPS_INFO_MIN_CHN, min_chn);
373 	nvlist_add_number(nv, SNDST_DSPS_INFO_MAX_CHN, max_chn);
374 	return (nv);
375 }
376 
377 static int
sndstat_build_sound4_nvlist(struct snddev_info * d,nvlist_t ** dip)378 sndstat_build_sound4_nvlist(struct snddev_info *d, nvlist_t **dip)
379 {
380 	struct pcm_channel *c;
381 	struct pcm_feeder *f;
382 	struct sbuf sb;
383 	uint32_t maxrate, minrate, fmts, minchn, maxchn, caps;
384 	nvlist_t *di = NULL, *sound4di = NULL, *diinfo = NULL, *cdi = NULL;
385 	int err, nchan;
386 	char buf[AFMTSTR_LEN];
387 
388 	di = nvlist_create(0);
389 	if (di == NULL) {
390 		err = ENOMEM;
391 		goto done;
392 	}
393 	sound4di = nvlist_create(0);
394 	if (sound4di == NULL) {
395 		err = ENOMEM;
396 		goto done;
397 	}
398 
399 	nvlist_add_bool(di, SNDST_DSPS_FROM_USER, false);
400 	nvlist_add_stringf(di, SNDST_DSPS_NAMEUNIT, "%s",
401 			device_get_nameunit(d->dev));
402 	nvlist_add_stringf(di, SNDST_DSPS_DEVNODE, "dsp%d",
403 			device_get_unit(d->dev));
404 	nvlist_add_string(
405 			di, SNDST_DSPS_DESC, device_get_desc(d->dev));
406 
407 	PCM_ACQUIRE_QUICK(d);
408 	nvlist_add_number(di, SNDST_DSPS_PCHAN, d->playcount);
409 	nvlist_add_number(di, SNDST_DSPS_RCHAN, d->reccount);
410 	if (d->playcount > 0) {
411 		sndstat_get_caps(d, PCMDIR_PLAY, &minrate, &maxrate, &fmts,
412 		    &minchn, &maxchn);
413 		nvlist_add_number(di, "pminrate", minrate);
414 		nvlist_add_number(di, "pmaxrate", maxrate);
415 		nvlist_add_number(di, "pfmts", fmts);
416 		diinfo = sndstat_create_diinfo_nv(minrate, maxrate, fmts,
417 		    minchn, maxchn);
418 		if (diinfo == NULL)
419 			nvlist_set_error(di, ENOMEM);
420 		else
421 			nvlist_move_nvlist(di, SNDST_DSPS_INFO_PLAY, diinfo);
422 	}
423 	if (d->reccount > 0) {
424 		sndstat_get_caps(d, PCMDIR_REC, &minrate, &maxrate, &fmts,
425 		    &minchn, &maxchn);
426 		nvlist_add_number(di, "rminrate", minrate);
427 		nvlist_add_number(di, "rmaxrate", maxrate);
428 		nvlist_add_number(di, "rfmts", fmts);
429 		diinfo = sndstat_create_diinfo_nv(minrate, maxrate, fmts,
430 		    minchn, maxchn);
431 		if (diinfo == NULL)
432 			nvlist_set_error(di, ENOMEM);
433 		else
434 			nvlist_move_nvlist(di, SNDST_DSPS_INFO_REC, diinfo);
435 	}
436 
437 	nvlist_add_number(sound4di, SNDST_DSPS_SOUND4_UNIT,
438 			device_get_unit(d->dev)); // XXX: I want signed integer here
439 	nvlist_add_string(sound4di, SNDST_DSPS_SOUND4_STATUS, d->status);
440 	nvlist_add_bool(
441 	    sound4di, SNDST_DSPS_SOUND4_BITPERFECT, d->flags & SD_F_BITPERFECT);
442 	nvlist_add_bool(sound4di, SNDST_DSPS_SOUND4_PVCHAN,
443 	    d->flags & SD_F_PVCHANS);
444 	nvlist_add_number(sound4di, SNDST_DSPS_SOUND4_PVCHANRATE,
445 	    d->pvchanrate);
446 	nvlist_add_number(sound4di, SNDST_DSPS_SOUND4_PVCHANFORMAT,
447 	    d->pvchanformat);
448 	nvlist_add_bool(sound4di, SNDST_DSPS_SOUND4_RVCHAN,
449 	    d->flags & SD_F_RVCHANS);
450 	nvlist_add_number(sound4di, SNDST_DSPS_SOUND4_RVCHANRATE,
451 	    d->rvchanrate);
452 	nvlist_add_number(sound4di, SNDST_DSPS_SOUND4_RVCHANFORMAT,
453 	    d->rvchanformat);
454 
455 	nchan = 0;
456 	CHN_FOREACH(c, d, channels.pcm) {
457 		sbuf_new(&sb, NULL, 4096, SBUF_AUTOEXTEND);
458 		cdi = nvlist_create(0);
459 		if (cdi == NULL) {
460 			sbuf_delete(&sb);
461 			PCM_RELEASE_QUICK(d);
462 			err = ENOMEM;
463 			goto done;
464 		}
465 
466 		CHN_LOCK(c);
467 
468 		caps = PCM_CAP_REALTIME | PCM_CAP_MMAP | PCM_CAP_TRIGGER |
469 		    ((c->flags & CHN_F_VIRTUAL) ? PCM_CAP_VIRTUAL : 0) |
470 		    ((c->direction == PCMDIR_PLAY) ? PCM_CAP_OUTPUT : PCM_CAP_INPUT);
471 
472 		nvlist_add_string(cdi, SNDST_DSPS_SOUND4_CHAN_NAME, c->name);
473 		nvlist_add_string(cdi, SNDST_DSPS_SOUND4_CHAN_PARENTCHAN,
474 		    c->parentchannel != NULL ? c->parentchannel->name : "");
475 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_UNIT, nchan++);
476 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_CAPS, caps);
477 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_LATENCY,
478 		    c->latency);
479 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_RATE, c->speed);
480 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_FORMAT,
481 		    c->format);
482 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_PID, c->pid);
483 		nvlist_add_string(cdi, SNDST_DSPS_SOUND4_CHAN_COMM, c->comm);
484 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_INTR,
485 		    c->interrupts);
486 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_FEEDCNT,
487 		    c->feedcount);
488 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_XRUNS, c->xruns);
489 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_LEFTVOL,
490 		    CHN_GETVOLUME(c, SND_VOL_C_PCM, SND_CHN_T_FL));
491 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_RIGHTVOL,
492 		    CHN_GETVOLUME(c, SND_VOL_C_PCM, SND_CHN_T_FR));
493 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_FORMAT,
494 		    c->bufhard->fmt);
495 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_RATE,
496 		    c->bufhard->spd);
497 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_SIZE,
498 		    c->bufhard->bufsize);
499 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_BLKSZ,
500 		    c->bufhard->blksz);
501 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_BLKCNT,
502 		    c->bufhard->blkcnt);
503 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_FREE,
504 		    sndbuf_getfree(c->bufhard));
505 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_HWBUF_READY,
506 		    sndbuf_getready(c->bufhard));
507 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_FORMAT,
508 		    c->bufsoft->fmt);
509 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_RATE,
510 		    c->bufsoft->spd);
511 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_SIZE,
512 		    c->bufsoft->bufsize);
513 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_BLKSZ,
514 		    c->bufsoft->blksz);
515 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_BLKCNT,
516 		    c->bufsoft->blkcnt);
517 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_FREE,
518 		    sndbuf_getfree(c->bufsoft));
519 		nvlist_add_number(cdi, SNDST_DSPS_SOUND4_CHAN_SWBUF_READY,
520 		    sndbuf_getready(c->bufsoft));
521 
522 		if (c->parentchannel != NULL) {
523 			sbuf_printf(&sb, "[%s", (c->direction == PCMDIR_REC) ?
524 			    c->parentchannel->name : "userland");
525 		} else {
526 			sbuf_printf(&sb, "[%s", (c->direction == PCMDIR_REC) ?
527 			    "hardware" :
528 			    ((d->flags & SD_F_PVCHANS) ? "vchans" : "userland"));
529 		}
530 		sbuf_printf(&sb, " -> ");
531 		f = c->feeder;
532 		while (f->source != NULL)
533 			f = f->source;
534 		while (f != NULL) {
535 			sbuf_printf(&sb, "%s", f->class->name);
536 			if (f->class->type == FEEDER_FORMAT) {
537 				snd_afmt2str(f->desc.in, buf, sizeof(buf));
538 				sbuf_printf(&sb, "(%s -> ", buf);
539 				snd_afmt2str(f->desc.out, buf, sizeof(buf));
540 				sbuf_printf(&sb, "%s)", buf);
541 			} else if (f->class->type == FEEDER_MATRIX) {
542 				sbuf_printf(&sb, "(%d.%dch -> %d.%dch)",
543 				    AFMT_CHANNEL(f->desc.in) -
544 				    AFMT_EXTCHANNEL(f->desc.in),
545 				    AFMT_EXTCHANNEL(f->desc.in),
546 				    AFMT_CHANNEL(f->desc.out) -
547 				    AFMT_EXTCHANNEL(f->desc.out),
548 				    AFMT_EXTCHANNEL(f->desc.out));
549 			} else if (f->class->type == FEEDER_RATE) {
550 				sbuf_printf(&sb, "(%d -> %d)",
551 				    FEEDER_GET(f, FEEDRATE_SRC),
552 				    FEEDER_GET(f, FEEDRATE_DST));
553 			} else {
554 				snd_afmt2str(f->desc.out, buf, sizeof(buf));
555 				sbuf_printf(&sb, "(%s)", buf);
556 			}
557 			sbuf_printf(&sb, " -> ");
558 			f = f->parent;
559 		}
560 		if (c->parentchannel != NULL) {
561 			sbuf_printf(&sb, "%s]", (c->direction == PCMDIR_REC) ?
562 			    "userland" : c->parentchannel->name);
563 		} else {
564 			sbuf_printf(&sb, "%s]", (c->direction == PCMDIR_REC) ?
565 			    ((d->flags & SD_F_RVCHANS) ? "vchans" : "userland") :
566 			    "hardware");
567 		}
568 
569 		CHN_UNLOCK(c);
570 
571 		sbuf_finish(&sb);
572 		nvlist_add_string(cdi, SNDST_DSPS_SOUND4_CHAN_FEEDERCHAIN,
573 		    sbuf_data(&sb));
574 		sbuf_delete(&sb);
575 
576 		nvlist_append_nvlist_array(sound4di,
577 		    SNDST_DSPS_SOUND4_CHAN_INFO, cdi);
578 		nvlist_destroy(cdi);
579 		err = nvlist_error(sound4di);
580 		if (err) {
581 			PCM_RELEASE_QUICK(d);
582 			goto done;
583 		}
584 	}
585 	nvlist_move_nvlist(di, SNDST_DSPS_PROVIDER_INFO, sound4di);
586 	sound4di = NULL;
587 
588 	PCM_RELEASE_QUICK(d);
589 	nvlist_add_string(di, SNDST_DSPS_PROVIDER, SNDST_DSPS_SOUND4_PROVIDER);
590 
591 	err = nvlist_error(di);
592 	if (err)
593 		goto done;
594 
595 	*dip = di;
596 
597 done:
598 	if (err) {
599 		nvlist_destroy(sound4di);
600 		nvlist_destroy(di);
601 	}
602 	return (err);
603 }
604 
605 static int
sndstat_build_userland_nvlist(struct sndstat_userdev * ud,nvlist_t ** dip)606 sndstat_build_userland_nvlist(struct sndstat_userdev *ud, nvlist_t **dip)
607 {
608 	nvlist_t *di, *diinfo;
609 	int err;
610 
611 	di = nvlist_create(0);
612 	if (di == NULL) {
613 		err = ENOMEM;
614 		goto done;
615 	}
616 
617 	nvlist_add_bool(di, SNDST_DSPS_FROM_USER, true);
618 	nvlist_add_number(di, SNDST_DSPS_PCHAN, ud->pchan);
619 	nvlist_add_number(di, SNDST_DSPS_RCHAN, ud->rchan);
620 	nvlist_add_string(di, SNDST_DSPS_NAMEUNIT, ud->nameunit);
621 	nvlist_add_string(
622 			di, SNDST_DSPS_DEVNODE, ud->devnode);
623 	nvlist_add_string(di, SNDST_DSPS_DESC, ud->desc);
624 	if (ud->pchan != 0) {
625 		nvlist_add_number(di, "pminrate",
626 		    ud->info_play.min_rate);
627 		nvlist_add_number(di, "pmaxrate",
628 		    ud->info_play.max_rate);
629 		nvlist_add_number(di, "pfmts",
630 		    ud->info_play.formats);
631 		diinfo = sndstat_create_diinfo_nv(ud->info_play.min_rate,
632 		    ud->info_play.max_rate, ud->info_play.formats,
633 		    ud->info_play.min_chn, ud->info_play.max_chn);
634 		if (diinfo == NULL)
635 			nvlist_set_error(di, ENOMEM);
636 		else
637 			nvlist_move_nvlist(di, SNDST_DSPS_INFO_PLAY, diinfo);
638 	}
639 	if (ud->rchan != 0) {
640 		nvlist_add_number(di, "rminrate",
641 		    ud->info_rec.min_rate);
642 		nvlist_add_number(di, "rmaxrate",
643 		    ud->info_rec.max_rate);
644 		nvlist_add_number(di, "rfmts",
645 		    ud->info_rec.formats);
646 		diinfo = sndstat_create_diinfo_nv(ud->info_rec.min_rate,
647 		    ud->info_rec.max_rate, ud->info_rec.formats,
648 		    ud->info_rec.min_chn, ud->info_rec.max_chn);
649 		if (diinfo == NULL)
650 			nvlist_set_error(di, ENOMEM);
651 		else
652 			nvlist_move_nvlist(di, SNDST_DSPS_INFO_REC, diinfo);
653 	}
654 	nvlist_add_string(di, SNDST_DSPS_PROVIDER,
655 	    (ud->provider != NULL) ? ud->provider : "");
656 	if (ud->provider_nvl != NULL)
657 		nvlist_add_nvlist(
658 		    di, SNDST_DSPS_PROVIDER_INFO, ud->provider_nvl);
659 
660 	err = nvlist_error(di);
661 	if (err)
662 		goto done;
663 
664 	*dip = di;
665 
666 done:
667 	if (err)
668 		nvlist_destroy(di);
669 	return (err);
670 }
671 
672 /*
673  * Should only be called with the following locks held:
674  * * sndstat_lock
675  */
676 static int
sndstat_create_devs_nvlist(nvlist_t ** nvlp)677 sndstat_create_devs_nvlist(nvlist_t **nvlp)
678 {
679 	int err;
680 	nvlist_t *nvl;
681 	struct sndstat_entry *ent;
682 	struct sndstat_file *pf;
683 
684 	nvl = nvlist_create(0);
685 	if (nvl == NULL)
686 		return (ENOMEM);
687 
688 	TAILQ_FOREACH(ent, &sndstat_devlist, link) {
689 		if (ent->type == SNDST_TYPE_PCM) {
690 			struct snddev_info *d;
691 			nvlist_t *di;
692 
693 			d = device_get_softc(ent->dev);
694 			if (!PCM_REGISTERED(d))
695 				continue;
696 
697 			err = sndstat_build_sound4_nvlist(d, &di);
698 			if (err)
699 				goto done;
700 
701 			nvlist_append_nvlist_array(nvl, SNDST_DSPS, di);
702 			nvlist_destroy(di);
703 			err = nvlist_error(nvl);
704 			if (err)
705 				goto done;
706 		} else if (ent->type == SNDST_TYPE_MIDI) {
707 			/* TODO */
708 		}
709 	}
710 
711 	TAILQ_FOREACH(pf, &sndstat_filelist, entry) {
712 		struct sndstat_userdev *ud;
713 
714 		sx_xlock(&pf->lock);
715 
716 		TAILQ_FOREACH(ud, &pf->userdev_list, link) {
717 			nvlist_t *di;
718 
719 			err = sndstat_build_userland_nvlist(ud, &di);
720 			if (err != 0) {
721 				sx_xunlock(&pf->lock);
722 				goto done;
723 			}
724 			nvlist_append_nvlist_array(nvl, SNDST_DSPS, di);
725 			nvlist_destroy(di);
726 
727 			err = nvlist_error(nvl);
728 			if (err != 0) {
729 				sx_xunlock(&pf->lock);
730 				goto done;
731 			}
732 		}
733 
734 		sx_xunlock(&pf->lock);
735 	}
736 
737 	*nvlp = nvl;
738 
739 done:
740 	if (err != 0)
741 		nvlist_destroy(nvl);
742 	return (err);
743 }
744 
745 static int
sndstat_refresh_devs(struct sndstat_file * pf)746 sndstat_refresh_devs(struct sndstat_file *pf)
747 {
748 	sx_xlock(&pf->lock);
749 	free(pf->devs_nvlbuf, M_NVLIST);
750 	pf->devs_nvlbuf = NULL;
751 	pf->devs_nbytes = 0;
752 	sx_unlock(&pf->lock);
753 
754 	return (0);
755 }
756 
757 static int
sndstat_get_devs(struct sndstat_file * pf,void * arg_buf,size_t * arg_nbytes)758 sndstat_get_devs(struct sndstat_file *pf, void *arg_buf, size_t *arg_nbytes)
759 {
760 	int err;
761 
762 	SNDSTAT_LOCK();
763 	sx_xlock(&pf->lock);
764 
765 	if (pf->devs_nvlbuf == NULL) {
766 		nvlist_t *nvl;
767 		void *nvlbuf;
768 		size_t nbytes;
769 		int err;
770 
771 		sx_xunlock(&pf->lock);
772 
773 		err = sndstat_create_devs_nvlist(&nvl);
774 		if (err) {
775 			SNDSTAT_UNLOCK();
776 			return (err);
777 		}
778 
779 		sx_xlock(&pf->lock);
780 
781 		nvlbuf = nvlist_pack(nvl, &nbytes);
782 		err = nvlist_error(nvl);
783 		nvlist_destroy(nvl);
784 		if (nvlbuf == NULL || err != 0) {
785 			SNDSTAT_UNLOCK();
786 			sx_xunlock(&pf->lock);
787 			if (err == 0)
788 				return (ENOMEM);
789 			return (err);
790 		}
791 
792 		free(pf->devs_nvlbuf, M_NVLIST);
793 		pf->devs_nvlbuf = nvlbuf;
794 		pf->devs_nbytes = nbytes;
795 	}
796 
797 	SNDSTAT_UNLOCK();
798 
799 	if (*arg_nbytes == 0) {
800 		*arg_nbytes = pf->devs_nbytes;
801 		err = 0;
802 		goto done;
803 	}
804 	if (*arg_nbytes < pf->devs_nbytes) {
805 		*arg_nbytes = 0;
806 		err = 0;
807 		goto done;
808 	}
809 
810 	err = copyout(pf->devs_nvlbuf, arg_buf, pf->devs_nbytes);
811 	if (err)
812 		goto done;
813 
814 	*arg_nbytes = pf->devs_nbytes;
815 
816 	free(pf->devs_nvlbuf, M_NVLIST);
817 	pf->devs_nvlbuf = NULL;
818 	pf->devs_nbytes = 0;
819 
820 done:
821 	sx_unlock(&pf->lock);
822 	return (err);
823 }
824 
825 static int
sndstat_unpack_user_nvlbuf(const void * unvlbuf,size_t nbytes,nvlist_t ** nvl)826 sndstat_unpack_user_nvlbuf(const void *unvlbuf, size_t nbytes, nvlist_t **nvl)
827 {
828 	void *nvlbuf;
829 	int err;
830 
831 	nvlbuf = malloc(nbytes, M_DEVBUF, M_WAITOK);
832 	err = copyin(unvlbuf, nvlbuf, nbytes);
833 	if (err != 0) {
834 		free(nvlbuf, M_DEVBUF);
835 		return (err);
836 	}
837 	*nvl = nvlist_unpack(nvlbuf, nbytes, 0);
838 	free(nvlbuf, M_DEVBUF);
839 	if (*nvl == NULL) {
840 		return (EINVAL);
841 	}
842 
843 	return (0);
844 }
845 
846 static bool
sndstat_diinfo_is_sane(const nvlist_t * diinfo)847 sndstat_diinfo_is_sane(const nvlist_t *diinfo)
848 {
849 	if (!(nvlist_exists_number(diinfo, SNDST_DSPS_INFO_MIN_RATE) &&
850 	    nvlist_exists_number(diinfo, SNDST_DSPS_INFO_MAX_RATE) &&
851 	    nvlist_exists_number(diinfo, SNDST_DSPS_INFO_FORMATS) &&
852 	    nvlist_exists_number(diinfo, SNDST_DSPS_INFO_MIN_CHN) &&
853 	    nvlist_exists_number(diinfo, SNDST_DSPS_INFO_MAX_CHN)))
854 		return (false);
855 	return (true);
856 }
857 
858 static bool
sndstat_dsp_nvlist_is_sane(const nvlist_t * nvlist)859 sndstat_dsp_nvlist_is_sane(const nvlist_t *nvlist)
860 {
861 	if (!(nvlist_exists_string(nvlist, SNDST_DSPS_DEVNODE) &&
862 	    nvlist_exists_string(nvlist, SNDST_DSPS_DESC) &&
863 	    nvlist_exists_number(nvlist, SNDST_DSPS_PCHAN) &&
864 	    nvlist_exists_number(nvlist, SNDST_DSPS_RCHAN)))
865 		return (false);
866 
867 	if (nvlist_get_number(nvlist, SNDST_DSPS_PCHAN) > 0) {
868 		if (nvlist_exists_nvlist(nvlist, SNDST_DSPS_INFO_PLAY)) {
869 			if (!sndstat_diinfo_is_sane(nvlist_get_nvlist(nvlist,
870 			    SNDST_DSPS_INFO_PLAY)))
871 				return (false);
872 		} else if (!(nvlist_exists_number(nvlist, "pminrate") &&
873 		    nvlist_exists_number(nvlist, "pmaxrate") &&
874 		    nvlist_exists_number(nvlist, "pfmts")))
875 			return (false);
876 	}
877 
878 	if (nvlist_get_number(nvlist, SNDST_DSPS_RCHAN) > 0) {
879 		if (nvlist_exists_nvlist(nvlist, SNDST_DSPS_INFO_REC)) {
880 			if (!sndstat_diinfo_is_sane(nvlist_get_nvlist(nvlist,
881 			    SNDST_DSPS_INFO_REC)))
882 				return (false);
883 		} else if (!(nvlist_exists_number(nvlist, "rminrate") &&
884 		    nvlist_exists_number(nvlist, "rmaxrate") &&
885 		    nvlist_exists_number(nvlist, "rfmts")))
886 			return (false);
887 	}
888 
889 	return (true);
890 
891 }
892 
893 static void
sndstat_get_diinfo_nv(const nvlist_t * nv,uint32_t * min_rate,uint32_t * max_rate,uint32_t * formats,uint32_t * min_chn,uint32_t * max_chn)894 sndstat_get_diinfo_nv(const nvlist_t *nv, uint32_t *min_rate,
895 	    uint32_t *max_rate, uint32_t *formats, uint32_t *min_chn,
896 	    uint32_t *max_chn)
897 {
898 	*min_rate = nvlist_get_number(nv, SNDST_DSPS_INFO_MIN_RATE);
899 	*max_rate = nvlist_get_number(nv, SNDST_DSPS_INFO_MAX_RATE);
900 	*formats = nvlist_get_number(nv, SNDST_DSPS_INFO_FORMATS);
901 	*min_chn = nvlist_get_number(nv, SNDST_DSPS_INFO_MIN_CHN);
902 	*max_chn = nvlist_get_number(nv, SNDST_DSPS_INFO_MAX_CHN);
903 }
904 
905 static int
sndstat_dsp_unpack_nvlist(const nvlist_t * nvlist,struct sndstat_userdev * ud)906 sndstat_dsp_unpack_nvlist(const nvlist_t *nvlist, struct sndstat_userdev *ud)
907 {
908 	const char *nameunit, *devnode, *desc;
909 	unsigned int pchan, rchan;
910 	uint32_t pminrate = 0, pmaxrate = 0;
911 	uint32_t rminrate = 0, rmaxrate = 0;
912 	uint32_t pfmts = 0, rfmts = 0;
913 	uint32_t pminchn = 0, pmaxchn = 0;
914 	uint32_t rminchn = 0, rmaxchn = 0;
915 	nvlist_t *provider_nvl = NULL;
916 	const nvlist_t *diinfo;
917 	const char *provider;
918 
919 	devnode = nvlist_get_string(nvlist, SNDST_DSPS_DEVNODE);
920 	if (nvlist_exists_string(nvlist, SNDST_DSPS_NAMEUNIT))
921 		nameunit = nvlist_get_string(nvlist, SNDST_DSPS_NAMEUNIT);
922 	else
923 		nameunit = devnode;
924 	desc = nvlist_get_string(nvlist, SNDST_DSPS_DESC);
925 	pchan = nvlist_get_number(nvlist, SNDST_DSPS_PCHAN);
926 	rchan = nvlist_get_number(nvlist, SNDST_DSPS_RCHAN);
927 	if (pchan != 0) {
928 		if (nvlist_exists_nvlist(nvlist, SNDST_DSPS_INFO_PLAY)) {
929 			diinfo = nvlist_get_nvlist(nvlist,
930 			    SNDST_DSPS_INFO_PLAY);
931 			sndstat_get_diinfo_nv(diinfo, &pminrate, &pmaxrate,
932 			    &pfmts, &pminchn, &pmaxchn);
933 		} else {
934 			pminrate = nvlist_get_number(nvlist, "pminrate");
935 			pmaxrate = nvlist_get_number(nvlist, "pmaxrate");
936 			pfmts = nvlist_get_number(nvlist, "pfmts");
937 		}
938 	}
939 	if (rchan != 0) {
940 		if (nvlist_exists_nvlist(nvlist, SNDST_DSPS_INFO_REC)) {
941 			diinfo = nvlist_get_nvlist(nvlist,
942 			    SNDST_DSPS_INFO_REC);
943 			sndstat_get_diinfo_nv(diinfo, &rminrate, &rmaxrate,
944 			    &rfmts, &rminchn, &rmaxchn);
945 		} else {
946 			rminrate = nvlist_get_number(nvlist, "rminrate");
947 			rmaxrate = nvlist_get_number(nvlist, "rmaxrate");
948 			rfmts = nvlist_get_number(nvlist, "rfmts");
949 		}
950 	}
951 
952 	provider = dnvlist_get_string(nvlist, SNDST_DSPS_PROVIDER, "");
953 	if (provider[0] == '\0')
954 		provider = NULL;
955 
956 	if (provider != NULL &&
957 	    nvlist_exists_nvlist(nvlist, SNDST_DSPS_PROVIDER_INFO)) {
958 		provider_nvl = nvlist_clone(
959 		    nvlist_get_nvlist(nvlist, SNDST_DSPS_PROVIDER_INFO));
960 		if (provider_nvl == NULL)
961 			return (ENOMEM);
962 	}
963 
964 	ud->provider = (provider != NULL) ? strdup(provider, M_DEVBUF) : NULL;
965 	ud->devnode = strdup(devnode, M_DEVBUF);
966 	ud->nameunit = strdup(nameunit, M_DEVBUF);
967 	ud->desc = strdup(desc, M_DEVBUF);
968 	ud->pchan = pchan;
969 	ud->rchan = rchan;
970 	ud->info_play.min_rate = pminrate;
971 	ud->info_play.max_rate = pmaxrate;
972 	ud->info_play.formats = pfmts;
973 	ud->info_play.min_chn = pminchn;
974 	ud->info_play.max_chn = pmaxchn;
975 	ud->info_rec.min_rate = rminrate;
976 	ud->info_rec.max_rate = rmaxrate;
977 	ud->info_rec.formats = rfmts;
978 	ud->info_rec.min_chn = rminchn;
979 	ud->info_rec.max_chn = rmaxchn;
980 	ud->provider_nvl = provider_nvl;
981 	return (0);
982 }
983 
984 static int
sndstat_add_user_devs(struct sndstat_file * pf,void * nvlbuf,size_t nbytes)985 sndstat_add_user_devs(struct sndstat_file *pf, void *nvlbuf, size_t nbytes)
986 {
987 	int err;
988 	nvlist_t *nvl = NULL;
989 	const nvlist_t * const *dsps;
990 	size_t i, ndsps;
991 
992 	if ((pf->fflags & FWRITE) == 0) {
993 		err = EPERM;
994 		goto done;
995 	}
996 
997 	if (nbytes > SNDST_UNVLBUF_MAX) {
998 		err = ENOMEM;
999 		goto done;
1000 	}
1001 
1002 	err = sndstat_unpack_user_nvlbuf(nvlbuf, nbytes, &nvl);
1003 	if (err != 0)
1004 		goto done;
1005 
1006 	if (!nvlist_exists_nvlist_array(nvl, SNDST_DSPS)) {
1007 		err = EINVAL;
1008 		goto done;
1009 	}
1010 	dsps = nvlist_get_nvlist_array(nvl, SNDST_DSPS, &ndsps);
1011 	for (i = 0; i < ndsps; i++) {
1012 		if (!sndstat_dsp_nvlist_is_sane(dsps[i])) {
1013 			err = EINVAL;
1014 			goto done;
1015 		}
1016 	}
1017 	sx_xlock(&pf->lock);
1018 	for (i = 0; i < ndsps; i++) {
1019 		struct sndstat_userdev *ud =
1020 		    malloc(sizeof(*ud), M_DEVBUF, M_WAITOK);
1021 		err = sndstat_dsp_unpack_nvlist(dsps[i], ud);
1022 		if (err) {
1023 			sx_unlock(&pf->lock);
1024 			goto done;
1025 		}
1026 		TAILQ_INSERT_TAIL(&pf->userdev_list, ud, link);
1027 	}
1028 	sx_unlock(&pf->lock);
1029 
1030 done:
1031 	nvlist_destroy(nvl);
1032 	return (err);
1033 }
1034 
1035 static int
sndstat_flush_user_devs(struct sndstat_file * pf)1036 sndstat_flush_user_devs(struct sndstat_file *pf)
1037 {
1038 	if ((pf->fflags & FWRITE) == 0)
1039 		return (EPERM);
1040 
1041 	sx_xlock(&pf->lock);
1042 	sndstat_remove_all_userdevs(pf);
1043 	sx_xunlock(&pf->lock);
1044 
1045 	return (0);
1046 }
1047 
1048 static int
sndstat_ioctl(struct cdev * dev,u_long cmd,caddr_t data,int fflag,struct thread * td)1049 sndstat_ioctl(
1050     struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
1051 {
1052 	int err;
1053 	struct sndstat_file *pf;
1054 	struct sndstioc_nv_arg *arg;
1055 #ifdef COMPAT_FREEBSD32
1056 	struct sndstioc_nv_arg32 *arg32;
1057 	size_t nbytes;
1058 #endif
1059 
1060 	err = devfs_get_cdevpriv((void **)&pf);
1061 	if (err != 0)
1062 		return (err);
1063 
1064 	switch (cmd) {
1065 	case SNDSTIOC_GET_DEVS:
1066 		arg = (struct sndstioc_nv_arg *)data;
1067 		err = sndstat_get_devs(pf, arg->buf, &arg->nbytes);
1068 		break;
1069 #ifdef COMPAT_FREEBSD32
1070 	case SNDSTIOC_GET_DEVS32:
1071 		arg32 = (struct sndstioc_nv_arg32 *)data;
1072 		nbytes = arg32->nbytes;
1073 		err = sndstat_get_devs(pf, (void *)(uintptr_t)arg32->buf,
1074 		    &nbytes);
1075 		if (err == 0) {
1076 			KASSERT(nbytes < UINT_MAX, ("impossibly many bytes"));
1077 			arg32->nbytes = nbytes;
1078 		}
1079 		break;
1080 #endif
1081 	case SNDSTIOC_ADD_USER_DEVS:
1082 		arg = (struct sndstioc_nv_arg *)data;
1083 		err = sndstat_add_user_devs(pf, arg->buf, arg->nbytes);
1084 		break;
1085 #ifdef COMPAT_FREEBSD32
1086 	case SNDSTIOC_ADD_USER_DEVS32:
1087 		arg32 = (struct sndstioc_nv_arg32 *)data;
1088 		err = sndstat_add_user_devs(pf, (void *)(uintptr_t)arg32->buf,
1089 		    arg32->nbytes);
1090 		break;
1091 #endif
1092 	case SNDSTIOC_REFRESH_DEVS:
1093 		err = sndstat_refresh_devs(pf);
1094 		break;
1095 	case SNDSTIOC_FLUSH_USER_DEVS:
1096 		err = sndstat_flush_user_devs(pf);
1097 		break;
1098 	default:
1099 		err = ENODEV;
1100 	}
1101 
1102 	return (err);
1103 }
1104 
1105 static struct sndstat_userdev *
sndstat_line2userdev(struct sndstat_file * pf,const char * line,int n)1106 sndstat_line2userdev(struct sndstat_file *pf, const char *line, int n)
1107 {
1108 	struct sndstat_userdev *ud;
1109 	const char *e, *m;
1110 
1111 	ud = malloc(sizeof(*ud), M_DEVBUF, M_WAITOK|M_ZERO);
1112 
1113 	ud->provider = NULL;
1114 	ud->provider_nvl = NULL;
1115 	e = strchr(line, ':');
1116 	if (e == NULL)
1117 		goto fail;
1118 	ud->nameunit = strndup(line, e - line, M_DEVBUF);
1119 	ud->devnode = malloc(e - line + 1, M_DEVBUF, M_WAITOK | M_ZERO);
1120 	strlcat(ud->devnode, ud->nameunit, e - line + 1);
1121 	line = e + 1;
1122 
1123 	e = strchr(line, '<');
1124 	if (e == NULL)
1125 		goto fail;
1126 	line = e + 1;
1127 	e = strrchr(line, '>');
1128 	if (e == NULL)
1129 		goto fail;
1130 	ud->desc = strndup(line, e - line, M_DEVBUF);
1131 	line = e + 1;
1132 
1133 	e = strchr(line, '(');
1134 	if (e == NULL)
1135 		goto fail;
1136 	line = e + 1;
1137 	e = strrchr(line, ')');
1138 	if (e == NULL)
1139 		goto fail;
1140 	m = strstr(line, "play");
1141 	if (m != NULL && m < e)
1142 		ud->pchan = 1;
1143 	m = strstr(line, "rec");
1144 	if (m != NULL && m < e)
1145 		ud->rchan = 1;
1146 
1147 	return (ud);
1148 
1149 fail:
1150 	free(ud->nameunit, M_DEVBUF);
1151 	free(ud->devnode, M_DEVBUF);
1152 	free(ud->desc, M_DEVBUF);
1153 	free(ud, M_DEVBUF);
1154 	return (NULL);
1155 }
1156 
1157 /************************************************************************/
1158 
1159 void
sndstat_register(device_t dev,enum sndstat_type type,char * str)1160 sndstat_register(device_t dev, enum sndstat_type type, char *str)
1161 {
1162 	struct sndstat_entry *ent;
1163 	struct sndstat_entry *pre;
1164 	int unit;
1165 
1166 	unit = device_get_unit(dev);
1167 
1168 	ent = malloc(sizeof *ent, M_DEVBUF, M_WAITOK | M_ZERO);
1169 	ent->dev = dev;
1170 	ent->str = str;
1171 	ent->type = type;
1172 	ent->unit = unit;
1173 
1174 	SNDSTAT_LOCK();
1175 	/* sorted list insertion */
1176 	TAILQ_FOREACH(pre, &sndstat_devlist, link) {
1177 		if (pre->unit > unit)
1178 			break;
1179 		else if (pre->unit < unit)
1180 			continue;
1181 		if (pre->type > type)
1182 			break;
1183 		else if (pre->type < unit)
1184 			continue;
1185 	}
1186 	if (pre == NULL) {
1187 		TAILQ_INSERT_TAIL(&sndstat_devlist, ent, link);
1188 	} else {
1189 		TAILQ_INSERT_BEFORE(pre, ent, link);
1190 	}
1191 	SNDSTAT_UNLOCK();
1192 }
1193 
1194 int
sndstat_unregister(device_t dev)1195 sndstat_unregister(device_t dev)
1196 {
1197 	struct sndstat_entry *ent;
1198 	int error = ENXIO;
1199 
1200 	SNDSTAT_LOCK();
1201 	TAILQ_FOREACH(ent, &sndstat_devlist, link) {
1202 		if (ent->dev == dev) {
1203 			TAILQ_REMOVE(&sndstat_devlist, ent, link);
1204 			free(ent, M_DEVBUF);
1205 			error = 0;
1206 			break;
1207 		}
1208 	}
1209 	SNDSTAT_UNLOCK();
1210 
1211 	return (error);
1212 }
1213 
1214 /************************************************************************/
1215 
1216 static int
sndstat_prepare_pcm(struct sbuf * s,device_t dev,int verbose)1217 sndstat_prepare_pcm(struct sbuf *s, device_t dev, int verbose)
1218 {
1219 	struct snddev_info *d;
1220 	struct pcm_channel *c;
1221 	struct pcm_feeder *f;
1222 
1223 	d = device_get_softc(dev);
1224 	PCM_BUSYASSERT(d);
1225 
1226 	if (CHN_EMPTY(d, channels.pcm)) {
1227 		sbuf_printf(s, " (mixer only)");
1228 		return (0);
1229 	}
1230 
1231 	if (verbose < 1) {
1232 		sbuf_printf(s, " (%s%s%s",
1233 		    d->playcount ? "play" : "",
1234 		    (d->playcount && d->reccount) ? "/" : "",
1235 		    d->reccount ? "rec" : "");
1236 	} else {
1237 		sbuf_printf(s, " (%dp:%dv/%dr:%dv",
1238 		    d->playcount, d->pvchancount,
1239 		    d->reccount, d->rvchancount);
1240 	}
1241 	sbuf_printf(s, "%s)%s",
1242 	    ((d->playcount != 0 && d->reccount != 0) &&
1243 	    (d->flags & SD_F_SIMPLEX)) ? " simplex" : "",
1244 	    (device_get_unit(dev) == snd_unit) ? " default" : "");
1245 
1246 	if (verbose <= 1)
1247 		return (0);
1248 
1249 	sbuf_printf(s, "\n\t");
1250 	sbuf_printf(s, "snddev flags=0x%b", d->flags, SD_F_BITS);
1251 
1252 	CHN_FOREACH(c, d, channels.pcm) {
1253 		KASSERT(c->bufhard != NULL && c->bufsoft != NULL,
1254 		    ("hosed pcm channel setup"));
1255 
1256 		CHN_LOCK(c);
1257 
1258 		sbuf_printf(s, "\n\t");
1259 
1260 		sbuf_printf(s, "%s[%s]: ",
1261 		    (c->parentchannel != NULL) ?
1262 		    c->parentchannel->name : "", c->name);
1263 		sbuf_printf(s, "spd %d", c->speed);
1264 		if (c->speed != c->bufhard->spd)
1265 			sbuf_printf(s, "/%d", c->bufhard->spd);
1266 		sbuf_printf(s, ", fmt 0x%08x", c->format);
1267 		if (c->format != c->bufhard->fmt) {
1268 			sbuf_printf(s, "/0x%08x", c->bufhard->fmt);
1269 		}
1270 		sbuf_printf(s, ", flags 0x%08x, 0x%08x",
1271 		    c->flags, c->feederflags);
1272 		if (c->pid != -1) {
1273 			sbuf_printf(s, ", pid %d (%s)",
1274 			    c->pid, c->comm);
1275 		}
1276 		sbuf_printf(s, "\n\t");
1277 
1278 		sbuf_printf(s, "\tinterrupts %d, ", c->interrupts);
1279 
1280 		if (c->direction == PCMDIR_REC)	{
1281 			sbuf_printf(s,
1282 			    "overruns %d, feed %u, hfree %d, "
1283 			    "sfree %d\n\t\t[b:%d/%d/%d|bs:%d/%d/%d]",
1284 				c->xruns, c->feedcount,
1285 				sndbuf_getfree(c->bufhard),
1286 				sndbuf_getfree(c->bufsoft),
1287 				c->bufhard->bufsize,
1288 				c->bufhard->blksz,
1289 				c->bufhard->blkcnt,
1290 				c->bufsoft->bufsize,
1291 				c->bufsoft->blksz,
1292 				c->bufsoft->blkcnt);
1293 		} else {
1294 			sbuf_printf(s,
1295 			    "underruns %d, feed %u, ready %d "
1296 			    "\n\t\t[b:%d/%d/%d|bs:%d/%d/%d]",
1297 				c->xruns, c->feedcount,
1298 				sndbuf_getready(c->bufsoft),
1299 				c->bufhard->bufsize,
1300 				c->bufhard->blksz,
1301 				c->bufhard->blkcnt,
1302 				c->bufsoft->bufsize,
1303 				c->bufsoft->blksz,
1304 				c->bufsoft->blkcnt);
1305 		}
1306 		sbuf_printf(s, "\n\t");
1307 
1308 		sbuf_printf(s, "\tchannel flags=0x%b", c->flags, CHN_F_BITS);
1309 		sbuf_printf(s, "\n\t");
1310 
1311 		if (c->parentchannel != NULL) {
1312 			sbuf_printf(s, "\t{%s}", (c->direction == PCMDIR_REC) ?
1313 			    c->parentchannel->name : "userland");
1314 		} else {
1315 			sbuf_printf(s, "\t{%s}", (c->direction == PCMDIR_REC) ?
1316 			    "hardware" :
1317 			    ((d->flags & SD_F_PVCHANS) ? "vchans" : "userland"));
1318 		}
1319 		sbuf_printf(s, " -> ");
1320 		f = c->feeder;
1321 		while (f->source != NULL)
1322 			f = f->source;
1323 		while (f != NULL) {
1324 			sbuf_printf(s, "%s", f->class->name);
1325 			if (f->class->type == FEEDER_FORMAT) {
1326 				sbuf_printf(s, "(0x%08x -> 0x%08x)",
1327 				    f->desc.in, f->desc.out);
1328 			} else if (f->class->type == FEEDER_MATRIX) {
1329 				sbuf_printf(s, "(%d.%d -> %d.%d)",
1330 				    AFMT_CHANNEL(f->desc.in) -
1331 				    AFMT_EXTCHANNEL(f->desc.in),
1332 				    AFMT_EXTCHANNEL(f->desc.in),
1333 				    AFMT_CHANNEL(f->desc.out) -
1334 				    AFMT_EXTCHANNEL(f->desc.out),
1335 				    AFMT_EXTCHANNEL(f->desc.out));
1336 			} else if (f->class->type == FEEDER_RATE) {
1337 				sbuf_printf(s,
1338 				    "(0x%08x q:%d %d -> %d)",
1339 				    f->desc.out,
1340 				    FEEDER_GET(f, FEEDRATE_QUALITY),
1341 				    FEEDER_GET(f, FEEDRATE_SRC),
1342 				    FEEDER_GET(f, FEEDRATE_DST));
1343 			} else {
1344 				sbuf_printf(s, "(0x%08x)",
1345 				    f->desc.out);
1346 			}
1347 			sbuf_printf(s, " -> ");
1348 			f = f->parent;
1349 		}
1350 		if (c->parentchannel != NULL) {
1351 			sbuf_printf(s, "{%s}", (c->direction == PCMDIR_REC) ?
1352 			    "userland" : c->parentchannel->name);
1353 		} else {
1354 			sbuf_printf(s, "{%s}", (c->direction == PCMDIR_REC) ?
1355 			    ((d->flags & SD_F_RVCHANS) ? "vchans" : "userland") :
1356 			    "hardware");
1357 		}
1358 
1359 		CHN_UNLOCK(c);
1360 	}
1361 
1362 	return (0);
1363 }
1364 
1365 static int
sndstat_prepare(struct sndstat_file * pf_self)1366 sndstat_prepare(struct sndstat_file *pf_self)
1367 {
1368 	struct sbuf *s = &pf_self->sbuf;
1369 	struct sndstat_entry *ent;
1370 	struct snddev_info *d;
1371 	struct sndstat_file *pf;
1372     	int k;
1373 
1374 	/* make sure buffer is reset */
1375 	sbuf_clear(s);
1376 
1377 	if (snd_verbose > 0)
1378 		sbuf_printf(s, "FreeBSD Audio Driver\n");
1379 
1380 	/* generate list of installed devices */
1381 	k = 0;
1382 	TAILQ_FOREACH(ent, &sndstat_devlist, link) {
1383 		if (ent->type == SNDST_TYPE_PCM) {
1384 			d = device_get_softc(ent->dev);
1385 			if (!PCM_REGISTERED(d))
1386 				continue;
1387 			if (!k++)
1388 				sbuf_printf(s, "Installed devices:\n");
1389 			sbuf_printf(s, "%s:", device_get_nameunit(ent->dev));
1390 			sbuf_printf(s, " <%s>", device_get_desc(ent->dev));
1391 			if (snd_verbose > 0)
1392 				sbuf_printf(s, " %s", ent->str);
1393 			/* XXX Need Giant magic entry ??? */
1394 			PCM_ACQUIRE_QUICK(d);
1395 			sndstat_prepare_pcm(s, ent->dev, snd_verbose);
1396 			PCM_RELEASE_QUICK(d);
1397 			sbuf_printf(s, "\n");
1398 		} else if (ent->type == SNDST_TYPE_MIDI) {
1399 			/* TODO */
1400 		}
1401 	}
1402 	if (k == 0)
1403 		sbuf_printf(s, "No devices installed.\n");
1404 
1405 	/* append any input from userspace */
1406 	k = 0;
1407 	TAILQ_FOREACH(pf, &sndstat_filelist, entry) {
1408 		struct sndstat_userdev *ud;
1409 
1410 		if (pf == pf_self)
1411 			continue;
1412 		sx_xlock(&pf->lock);
1413 		if (TAILQ_EMPTY(&pf->userdev_list)) {
1414 			sx_unlock(&pf->lock);
1415 			continue;
1416 		}
1417 		if (!k++)
1418 			sbuf_printf(s, "Installed devices from userspace:\n");
1419 		TAILQ_FOREACH(ud, &pf->userdev_list, link) {
1420 			const char *caps = (ud->pchan && ud->rchan) ?
1421 			    "play/rec" :
1422 			    (ud->pchan ? "play" : (ud->rchan ? "rec" : ""));
1423 			sbuf_printf(s, "%s: <%s>", ud->nameunit, ud->desc);
1424 			sbuf_printf(s, " (%s)", caps);
1425 			sbuf_printf(s, "\n");
1426 		}
1427 		sx_unlock(&pf->lock);
1428 	}
1429 	if (k == 0)
1430 		sbuf_printf(s, "No devices installed from userspace.\n");
1431 
1432 	sbuf_finish(s);
1433     	return (sbuf_len(s));
1434 }
1435 
1436 static void
sndstat_sysinit(void * p)1437 sndstat_sysinit(void *p)
1438 {
1439 	sx_init(&sndstat_lock, "sndstat lock");
1440 	sndstat_dev = make_dev(&sndstat_cdevsw, 0, UID_ROOT, GID_WHEEL, 0644,
1441 	    "sndstat");
1442 }
1443 SYSINIT(sndstat_sysinit, SI_SUB_DRIVERS, SI_ORDER_FIRST, sndstat_sysinit, NULL);
1444 
1445 static void
sndstat_sysuninit(void * p)1446 sndstat_sysuninit(void *p)
1447 {
1448 	if (sndstat_dev != NULL) {
1449 		/* destroy_dev() will wait for all references to go away */
1450 		destroy_dev(sndstat_dev);
1451 	}
1452 	sx_destroy(&sndstat_lock);
1453 }
1454 SYSUNINIT(sndstat_sysuninit, SI_SUB_DRIVERS, SI_ORDER_FIRST, sndstat_sysuninit, NULL);
1455