Home | History | Annotate | Line # | Download | only in pud
pud.c revision 1.3
      1 /*	$NetBSD: pud.c,v 1.3 2007/11/21 18:10:48 pooka Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2007  Antti Kantee.  All Rights Reserved.
      5  *
      6  * Development of this software was supported by the
      7  * Research Foundation of Helsinki University of Technology
      8  *
      9  * Redistribution and use in source and binary forms, with or without
     10  * modification, are permitted provided that the following conditions
     11  * are met:
     12  * 1. Redistributions of source code must retain the above copyright
     13  *    notice, this list of conditions and the following disclaimer.
     14  * 2. Redistributions in binary form must reproduce the above copyright
     15  *    notice, this list of conditions and the following disclaimer in the
     16  *    documentation and/or other materials provided with the distribution.
     17  *
     18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
     19  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     21  * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     28  * SUCH DAMAGE.
     29  */
     30 
     31 #include <sys/cdefs.h>
     32 __KERNEL_RCSID(0, "$NetBSD: pud.c,v 1.3 2007/11/21 18:10:48 pooka Exp $");
     33 
     34 #include <sys/param.h>
     35 #include <sys/conf.h>
     36 #include <sys/kmem.h>
     37 #include <sys/poll.h>
     38 #include <sys/queue.h>
     39 
     40 #include <dev/pud/pud_sys.h>
     41 #include <dev/putter/putter_sys.h>
     42 
     43 void	pudattach(void);
     44 
     45 static int	pud_putter_getout(void *, size_t, int, uint8_t **,
     46 				  size_t *, void **);
     47 static void	pud_putter_releaseout(void *, void *, int);
     48 static int	pud_putter_dispatch(void *, struct putter_hdr *);
     49 static size_t	pud_putter_waitcount(void *);
     50 static int	pud_putter_close(void *);
     51 
     52 struct putter_ops pud_putter = {
     53 	.pop_getout	= pud_putter_getout,
     54 	.pop_releaseout	= pud_putter_releaseout,
     55 	.pop_waitcount	= pud_putter_waitcount,
     56 	.pop_dispatch	= pud_putter_dispatch,
     57 	.pop_close	= pud_putter_close,
     58 };
     59 
     60 extern struct bdevsw pud_bdevsw;
     61 extern struct cdevsw pud_cdevsw;
     62 
     63 kmutex_t pud_mtx;
     64 static LIST_HEAD(, pud_dev) pudlist = LIST_HEAD_INITIALIZER(pudlist);
     65 
     66 static uint64_t
     67 nextreq(struct pud_dev *pd)
     68 {
     69 	uint64_t rv;
     70 
     71 	mutex_enter(&pd->pd_mtx);
     72 	rv = pd->pd_nextreq++;
     73 	mutex_exit(&pd->pd_mtx);
     74 
     75 	return rv;
     76 }
     77 
     78 static int
     79 pud_putter_getout(void *this, size_t maxsize, int nonblock,
     80 	uint8_t **data, size_t *dlen, void **cookie)
     81 {
     82 	struct pud_dev *pd = this;
     83 	struct pud_touser *putp;
     84 	int error = 0;
     85 
     86 	mutex_enter(&pd->pd_mtx);
     87 	for (;;) {
     88 		if (TAILQ_EMPTY(&pd->pd_waitq_req)) {
     89 			if (nonblock) {
     90 				error = EWOULDBLOCK;
     91 				break;
     92 			}
     93 
     94 			error = cv_wait_sig(&pd->pd_waitq_req_cv, &pd->pd_mtx);
     95 			if (error)
     96 				break;
     97 			else
     98 				continue;
     99 		}
    100 
    101 		putp = TAILQ_FIRST(&pd->pd_waitq_req);
    102 		TAILQ_REMOVE(&pd->pd_waitq_req, putp, pt_entries);
    103 		KASSERT(error == 0);
    104 		break;
    105 	}
    106 	mutex_exit(&pd->pd_mtx);
    107 
    108 	if (error == 0) {
    109 		*data = (uint8_t *)putp->pt_pdr;
    110 		*dlen = putp->pt_pdr->pdr_pth.pth_framelen;
    111 		*cookie = putp;
    112 	}
    113 
    114 	return error;
    115 }
    116 
    117 static void
    118 pud_putter_releaseout(void *this, void *cookie, int status)
    119 {
    120 	struct pud_dev *pd = this;
    121 	struct pud_touser *putp = cookie;
    122 
    123 	mutex_enter(&pd->pd_mtx);
    124 	TAILQ_INSERT_TAIL(&pd->pd_waitq_resp, putp, pt_entries);
    125 	mutex_exit(&pd->pd_mtx);
    126 
    127 }
    128 
    129 static size_t
    130 pud_putter_waitcount(void *this)
    131 {
    132 	struct pud_dev *pd = this;
    133 	size_t rv;
    134 
    135 	mutex_enter(&pd->pd_mtx);
    136 	rv = pd->pd_waitcount;
    137 	mutex_exit(&pd->pd_mtx);
    138 
    139 	return rv;
    140 }
    141 
    142 static int
    143 pudop_dev(struct pud_dev *pd, struct pud_req *pdr)
    144 {
    145 	struct putter_hdr *pth = (void *)pdr;
    146 	struct pud_touser *putp;
    147 
    148 	mutex_enter(&pd->pd_mtx);
    149 	TAILQ_FOREACH(putp, &pd->pd_waitq_resp, pt_entries)
    150 		if (putp->pt_pdr->pdr_reqid == pdr->pdr_reqid)
    151 			break;
    152 	if (putp == NULL) {
    153 		mutex_exit(&pd->pd_mtx);
    154 		return EINVAL;
    155 	}
    156 	TAILQ_REMOVE(&pd->pd_waitq_resp, putp, pt_entries);
    157 	mutex_exit(&pd->pd_mtx);
    158 
    159 	if (pth->pth_framelen > putp->pt_pdr->pdr_len) {
    160 		return EINVAL;
    161 	}
    162 	memcpy(putp->pt_pdr, pth, pth->pth_framelen);
    163 	cv_signal(&putp->pt_cv);
    164 
    165 	return 0;
    166 }
    167 
    168 /*
    169  * Register our major number.  Always register char device functions,
    170  * register block devices optionally.
    171  *
    172  * XXX: no way to configure "any major you like" currently.
    173  */
    174 static int
    175 pudconf_reg(struct pud_dev *pd, struct pud_conf_reg *pcr)
    176 {
    177 	struct bdevsw *bsw;
    178 	int cmajor, bmajor, error;
    179 
    180 	cmajor = major(pcr->pm_regdev);
    181 	if (pcr->pm_flags & PUD_CONFFLAG_BDEV) {
    182 		bsw = &pud_bdevsw;
    183 		bmajor = cmajor;
    184 	} else {
    185 		bsw = NULL;
    186 		bmajor = -1;
    187 	}
    188 
    189 	pcr->pm_devname[PUD_DEVNAME_MAX] = '\0';
    190         error = devsw_attach(pcr->pm_devname, bsw, &bmajor,
    191 	    &pud_cdevsw, &cmajor);
    192 	if (error == 0)
    193 		pd->pd_dev = pcr->pm_regdev;
    194 
    195 	return error;
    196 }
    197 
    198 static int
    199 pudop_conf(struct pud_dev *pd, struct pud_req *pdr)
    200 {
    201 	int rv;
    202 
    203 	switch (pdr->pdr_reqtype) {
    204 	case PUD_CONF_REG:
    205 		rv = pudconf_reg(pd, (struct pud_conf_reg *)pdr);
    206 		break;
    207 	case PUD_CONF_DEREG:
    208 		/* unimplemented */
    209 		rv = 0;
    210 		break;
    211 	case PUD_CONF_IOCTL:
    212 		/* unimplemented */
    213 		rv = 0;
    214 		break;
    215 	default:
    216 		rv = EINVAL;
    217 		break;
    218 	}
    219 
    220 	return rv;
    221 }
    222 
    223 static int
    224 pud_putter_dispatch(void *this, struct putter_hdr *pth)
    225 {
    226 	struct pud_dev *pd = this;
    227 	struct pud_req *pdr = (void *)pth;
    228 	int rv;
    229 
    230 	if (pdr->pdr_pth.pth_framelen < sizeof(struct pud_req))
    231 		return EINVAL;
    232 
    233 	switch (pdr->pdr_reqclass) {
    234 	case PUD_REQ_CDEV:
    235 	case PUD_REQ_BDEV:
    236 		rv = pudop_dev(pd, pdr);
    237 		break;
    238 	case PUD_REQ_CONF:
    239 		rv = pudop_conf(pd, pdr);
    240 		break;
    241 	default:
    242 		rv = EINVAL;
    243 		break;
    244 	}
    245 
    246 	return rv;
    247 }
    248 
    249 /* Device server severed the umbilical cord */
    250 static int
    251 pud_putter_close(void *this)
    252 {
    253 	struct pud_dev *pd = this;
    254 	struct pud_touser *putp;
    255 
    256 	mutex_enter(&pud_mtx);
    257 	LIST_REMOVE(pd, pd_entries);
    258 	mutex_exit(&pud_mtx);
    259 
    260 	mutex_enter(&pd->pd_mtx);
    261 	while ((putp = TAILQ_FIRST(&pd->pd_waitq_req)) != NULL) {
    262 		putp->pt_pdr->pdr_rv = ENXIO;
    263 		cv_signal(&putp->pt_cv);
    264 		TAILQ_REMOVE(&pd->pd_waitq_req, putp, pt_entries);
    265 	}
    266 
    267 	while ((putp = TAILQ_FIRST(&pd->pd_waitq_resp)) != NULL) {
    268 		putp->pt_pdr->pdr_rv = ENXIO;
    269 		cv_signal(&putp->pt_cv);
    270 		TAILQ_REMOVE(&pd->pd_waitq_resp, putp, pt_entries);
    271 	}
    272 	if (pd->pd_waitcount)
    273 		cv_wait(&pd->pd_draincv, &pd->pd_mtx);
    274 	KASSERT(pd->pd_waitcount == 0);
    275 
    276 	mutex_exit(&pd->pd_mtx);
    277 
    278 	if (pd->pd_dev)
    279 		devsw_detach(&pud_bdevsw /* XXX */, &pud_cdevsw);
    280 
    281 	putter_detach(pd->pd_pi);
    282 	kmem_free(pd, sizeof(struct pud_dev));
    283 
    284 	return 0;
    285 }
    286 
    287 struct pud_dev *
    288 pud_dev2pud(dev_t dev)
    289 {
    290 	struct pud_dev *pd;
    291 
    292 	mutex_enter(&pud_mtx);
    293 	LIST_FOREACH(pd, &pudlist, pd_entries)
    294 		if (major(pd->pd_dev) == major(dev))
    295 			break;
    296 	mutex_exit(&pud_mtx);
    297 
    298 	return pd;
    299 }
    300 
    301 /* Toss request to the device server and wait for result */
    302 int
    303 pud_request(dev_t dev, void *data, size_t dlen, int class, int type)
    304 {
    305 	struct pud_touser put;
    306 	struct pud_req *pdr = data;
    307 	struct pud_dev *pd;
    308 
    309 	pd = pud_dev2pud(dev);
    310 	if (pd == NULL)
    311 		return ENXIO;
    312 
    313 	pdr->pdr_dev = dev;
    314 	pdr->pdr_len = pdr->pdr_pth.pth_framelen = dlen;
    315 	pdr->pdr_reqid = nextreq(pd);
    316 
    317 	pdr->pdr_reqclass = class;
    318 	pdr->pdr_reqtype = type;
    319 
    320 	put.pt_pdr = pdr;
    321 	cv_init(&put.pt_cv, "pudresp");
    322 
    323 	mutex_enter(&pd->pd_mtx);
    324 	pd->pd_waitcount++;
    325 
    326 	TAILQ_INSERT_TAIL(&pd->pd_waitq_req, &put, pt_entries);
    327 	putter_notify(pd->pd_pi);
    328 	cv_broadcast(&pd->pd_waitq_req_cv);
    329 	cv_wait(&put.pt_cv, &pd->pd_mtx);
    330 
    331 	if (--pd->pd_waitcount == 0)
    332 		cv_signal(&pd->pd_draincv);
    333 	mutex_exit(&pd->pd_mtx);
    334 
    335 	return pdr->pdr_rv;
    336 }
    337 
    338 /* Called from putter based on minor dev number */
    339 int
    340 pud_config(int fd, int flags, int fmt)
    341 {
    342 	struct pud_dev *pd;
    343 
    344 	pd = kmem_zalloc(sizeof(struct pud_dev), KM_SLEEP);
    345 	pd->pd_pi = putter_attach(curlwp->l_proc->p_pid, fd, pd, &pud_putter);
    346 	if (pd->pd_pi == NULL) {
    347 		kmem_free(pd, sizeof(struct pud_dev));
    348 		return ENOENT; /* XXX */
    349 	}
    350 	pd->pd_dev = NODEV;
    351 
    352 	mutex_init(&pd->pd_mtx, MUTEX_DEFAULT, IPL_NONE);
    353 	TAILQ_INIT(&pd->pd_waitq_req);
    354 	TAILQ_INIT(&pd->pd_waitq_resp);
    355 	cv_init(&pd->pd_waitq_req_cv, "pudreq");
    356 	cv_init(&pd->pd_draincv, "pudrain");
    357 
    358 	mutex_enter(&pud_mtx);
    359 	LIST_INSERT_HEAD(&pudlist, pd, pd_entries);
    360 	mutex_exit(&pud_mtx);
    361 
    362 	return 0;
    363 }
    364 
    365 void
    366 pudattach()
    367 {
    368 	int error;
    369 
    370 	if ((error = putter_register(pud_config, PUTTER_MINOR_PUD)) != 0) {
    371 		printf("pudattach: can't register to putter: %d\n", error);
    372 		return;
    373 	}
    374 	mutex_init(&pud_mtx, MUTEX_DEFAULT, IPL_NONE);
    375 }
    376