[apple/xnu.git] / bsd / kern / kern_subr.c

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1982, 1986, 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 * (c) UNIX System Laboratories, Inc.
 * All or some portions of this file are derived from material licensed
 * to the University of California by American Telephone and Telegraph
 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
 * the permission of UNIX System Laboratories, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)kern_subr.c	8.3 (Berkeley) 1/21/94
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/proc.h>
#include <sys/malloc.h>
#include <sys/queue.h>

#include <kdebug.h>

#include <sys/kdebug.h>
#define DBG_UIO_COPYOUT 16
#define DBG_UIO_COPYIN  17


int
uiomove(cp, n, uio)
	register caddr_t cp;
	register int n;
	register struct uio *uio;
{
	register struct iovec *iov;
	u_int cnt;
	int error = 0;

#if DIAGNOSTIC
	if (uio->uio_rw != UIO_READ && uio->uio_rw != UIO_WRITE)
		panic("uiomove: mode");
	if (uio->uio_segflg == UIO_USERSPACE && uio->uio_procp != current_proc())
		panic("uiomove proc");
#endif

	while (n > 0 && uio->uio_resid) {
		iov = uio->uio_iov;
		cnt = iov->iov_len;
		if (cnt == 0) {
			uio->uio_iov++;
			uio->uio_iovcnt--;
			continue;
		}
		if (cnt > n)
			cnt = n;
		switch (uio->uio_segflg) {

		case UIO_USERSPACE:
		case UIO_USERISPACE:
			if (uio->uio_rw == UIO_READ)
			  {
			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) | DBG_FUNC_START,
					 cp, iov->iov_base, cnt, 0,0);

				error = copyout(cp, iov->iov_base, cnt);

			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) | DBG_FUNC_END,
					 cp, iov->iov_base, cnt, 0,0);
			  }
			else
			  {
			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) | DBG_FUNC_START,
					 iov->iov_base, cp, cnt, 0,0);

			        error = copyin(iov->iov_base, cp, cnt);

			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) | DBG_FUNC_END,
					 iov->iov_base, cp, cnt, 0,0);
			  }
			if (error)
				return (error);
			break;

		case UIO_SYSSPACE:
			if (uio->uio_rw == UIO_READ)
				error = copywithin((caddr_t)cp, iov->iov_base,
						   cnt);
			else
				error = copywithin(iov->iov_base, (caddr_t)cp,
						   cnt);
			break;

		case UIO_PHYS_USERSPACE:
			if (uio->uio_rw == UIO_READ)
			  {
			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) | DBG_FUNC_START,
					 cp, iov->iov_base, cnt, 1,0);

				error = copyp2v(cp, iov->iov_base, cnt);


			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) | DBG_FUNC_END,
					 cp, iov->iov_base, cnt, 1,0);
			  }
			else
			  {
			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) | DBG_FUNC_START,
					 iov->iov_base, cp, cnt, 1,0);

				panic("copyv2p not implemented yet\n");

			        KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) | DBG_FUNC_END,
					 iov->iov_base, cp, cnt, 1,0);
			  }
			if (error)
				return (error);
			break;
		}
		iov->iov_base += cnt;
		iov->iov_len -= cnt;
		uio->uio_resid -= cnt;
		uio->uio_offset += cnt;
		cp += cnt;
		n -= cnt;
	}
	return (error);
}

/*
 * Give next character to user as result of read.
 */
int
ureadc(c, uio)
	register int c;
	register struct uio *uio;
{
	register struct iovec *iov;

	if (uio->uio_resid <= 0)
		panic("ureadc: non-positive resid");
again:
	if (uio->uio_iovcnt == 0)
		panic("ureadc: non-positive iovcnt");
	iov = uio->uio_iov;
	if (iov->iov_len <= 0) {
		uio->uio_iovcnt--;
		uio->uio_iov++;
		goto again;
	}
	switch (uio->uio_segflg) {

	case UIO_USERSPACE:
		if (subyte(iov->iov_base, c) < 0)
			return (EFAULT);
		break;

	case UIO_SYSSPACE:
		*iov->iov_base = c;
		break;

	case UIO_USERISPACE:
		if (suibyte(iov->iov_base, c) < 0)
			return (EFAULT);
		break;
	}
	iov->iov_base++;
	iov->iov_len--;
	uio->uio_resid--;
	uio->uio_offset++;
	return (0);
}

#if defined(vax) || defined(ppc)
/* unused except by ct.c, other oddities XXX */
/*
 * Get next character written in by user from uio.
 */
uwritec(uio)
	struct uio *uio;
{
	register struct iovec *iov;
	register int c;

	if (uio->uio_resid <= 0)
		return (-1);
again:
	if (uio->uio_iovcnt <= 0)
		panic("uwritec: non-positive iovcnt");
	iov = uio->uio_iov;
	if (iov->iov_len == 0) {
		uio->uio_iov++;
		if (--uio->uio_iovcnt == 0)
			return (-1);
		goto again;
	}
	switch (uio->uio_segflg) {

	case UIO_USERSPACE:
		c = fubyte(iov->iov_base);
		break;

	case UIO_SYSSPACE:
		c = *iov->iov_base & 0377;
		break;

	case UIO_USERISPACE:
		c = fuibyte(iov->iov_base);
		break;

	default:
		c = 0;	/* avoid uninitialized variable warning */
		panic("uwritec: bogus uio_segflg");
		break;
	}
	if (c < 0)
		return (-1);
	iov->iov_base++;
	iov->iov_len--;
	uio->uio_resid--;
	uio->uio_offset++;
	return (c);
}
#endif /* vax || ppc */

/*
 * General routine to allocate a hash table.
 */
void *
hashinit(elements, type, hashmask)
	int elements, type;
	u_long *hashmask;
{
	long hashsize;
	LIST_HEAD(generic, generic) *hashtbl;
	int i;

	if (elements <= 0)
		panic("hashinit: bad cnt");
	for (hashsize = 1; hashsize <= elements; hashsize <<= 1)
		continue;
	hashsize >>= 1;
	MALLOC(hashtbl, struct generic *, 
			(u_long)hashsize * sizeof(*hashtbl), type, M_WAITOK);
	bzero(hashtbl, (u_long)hashsize * sizeof(*hashtbl));
	for (i = 0; i < hashsize; i++)
		LIST_INIT(&hashtbl[i]);
	*hashmask = hashsize - 1;
	return (hashtbl);
}
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
de355530 A	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
1c79356b	11	*
de355530 A	12	* This Original Code and all software distributed under the License are
de355530 A	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
1c79356b A	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
1c79356b A	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
de355530 A	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
1c79356b A	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
	23	/*
	24	* Copyright (c) 1982, 1986, 1991, 1993
	25	* The Regents of the University of California. All rights reserved.
	26	* (c) UNIX System Laboratories, Inc.
	27	* All or some portions of this file are derived from material licensed
	28	* to the University of California by American Telephone and Telegraph
	29	* Co. or Unix System Laboratories, Inc. and are reproduced herein with
	30	* the permission of UNIX System Laboratories, Inc.
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright
	38	* notice, this list of conditions and the following disclaimer in the
	39	* documentation and/or other materials provided with the distribution.
	40	* 3. All advertising materials mentioning features or use of this software
	41	* must display the following acknowledgement:
	42	* This product includes software developed by the University of
	43	* California, Berkeley and its contributors.
	44	* 4. Neither the name of the University nor the names of its contributors
	45	* may be used to endorse or promote products derived from this software
	46	* without specific prior written permission.
	47	*
	48	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	49	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	50	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	51	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	52	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	53	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	54	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	55	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	56	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	57	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	58	* SUCH DAMAGE.
	59	*
	60	* @(#)kern_subr.c 8.3 (Berkeley) 1/21/94
	61	*/
	62
	63	#include <sys/param.h>
	64	#include <sys/systm.h>
	65	#include <sys/proc.h>
	66	#include <sys/malloc.h>
	67	#include <sys/queue.h>
	68
	69	#include <kdebug.h>
	70
	71	#include <sys/kdebug.h>
	72	#define DBG_UIO_COPYOUT 16
	73	#define DBG_UIO_COPYIN 17
	74
de355530	75
1c79356b A	76	int
	77	uiomove(cp, n, uio)
	78	register caddr_t cp;
	79	register int n;
	80	register struct uio *uio;
	81	{
	82	register struct iovec *iov;
	83	u_int cnt;
	84	int error = 0;
	85
	86	#if DIAGNOSTIC
	87	if (uio->uio_rw != UIO_READ && uio->uio_rw != UIO_WRITE)
	88	panic("uiomove: mode");
	89	if (uio->uio_segflg == UIO_USERSPACE && uio->uio_procp != current_proc())
	90	panic("uiomove proc");
	91	#endif
	92
	93	while (n > 0 && uio->uio_resid) {
	94	iov = uio->uio_iov;
	95	cnt = iov->iov_len;
	96	if (cnt == 0) {
	97	uio->uio_iov++;
	98	uio->uio_iovcnt--;
	99	continue;
	100	}
	101	if (cnt > n)
	102	cnt = n;
	103	switch (uio->uio_segflg) {
	104
	105	case UIO_USERSPACE:
	106	case UIO_USERISPACE:
	107	if (uio->uio_rw == UIO_READ)
	108	{
	109	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) \| DBG_FUNC_START,
de355530	110	cp, iov->iov_base, cnt, 0,0);
1c79356b	111
de355530	112	error = copyout(cp, iov->iov_base, cnt);
1c79356b A	113
1c79356b A	114	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) \| DBG_FUNC_END,
de355530	115	cp, iov->iov_base, cnt, 0,0);
1c79356b A	116	}
	117	else
	118	{
	119	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) \| DBG_FUNC_START,
de355530	120	iov->iov_base, cp, cnt, 0,0);
1c79356b	121
de355530	122	error = copyin(iov->iov_base, cp, cnt);
1c79356b A	123
1c79356b A	124	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) \| DBG_FUNC_END,
de355530	125	iov->iov_base, cp, cnt, 0,0);
1c79356b A	126	}
	127	if (error)
	128	return (error);
	129	break;
	130
	131	case UIO_SYSSPACE:
	132	if (uio->uio_rw == UIO_READ)
	133	error = copywithin((caddr_t)cp, iov->iov_base,
	134	cnt);
	135	else
	136	error = copywithin(iov->iov_base, (caddr_t)cp,
	137	cnt);
	138	break;
9bccf70c	139
1c79356b A	140	case UIO_PHYS_USERSPACE:
	141	if (uio->uio_rw == UIO_READ)
	142	{
	143	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) \| DBG_FUNC_START,
	144	cp, iov->iov_base, cnt, 1,0);
	145
de355530 A	146	error = copyp2v(cp, iov->iov_base, cnt);
de355530 A	147
1c79356b A	148
	149	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYOUT)) \| DBG_FUNC_END,
	150	cp, iov->iov_base, cnt, 1,0);
	151	}
	152	else
	153	{
	154	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) \| DBG_FUNC_START,
	155	iov->iov_base, cp, cnt, 1,0);
	156
de355530	157	panic("copyv2p not implemented yet\n");
1c79356b A	158
	159	KERNEL_DEBUG((FSDBG_CODE(DBG_FSRW, DBG_UIO_COPYIN)) \| DBG_FUNC_END,
	160	iov->iov_base, cp, cnt, 1,0);
	161	}
	162	if (error)
	163	return (error);
	164	break;
1c79356b A	165	}
	166	iov->iov_base += cnt;
	167	iov->iov_len -= cnt;
	168	uio->uio_resid -= cnt;
	169	uio->uio_offset += cnt;
	170	cp += cnt;
	171	n -= cnt;
	172	}
	173	return (error);
	174	}
	175
	176	/*
	177	* Give next character to user as result of read.
	178	*/
	179	int
	180	ureadc(c, uio)
	181	register int c;
	182	register struct uio *uio;
	183	{
	184	register struct iovec *iov;
	185
	186	if (uio->uio_resid <= 0)
	187	panic("ureadc: non-positive resid");
	188	again:
	189	if (uio->uio_iovcnt == 0)
	190	panic("ureadc: non-positive iovcnt");
	191	iov = uio->uio_iov;
	192	if (iov->iov_len <= 0) {
	193	uio->uio_iovcnt--;
	194	uio->uio_iov++;
	195	goto again;
	196	}
	197	switch (uio->uio_segflg) {
	198
	199	case UIO_USERSPACE:
	200	if (subyte(iov->iov_base, c) < 0)
	201	return (EFAULT);
	202	break;
	203
	204	case UIO_SYSSPACE:
	205	*iov->iov_base = c;
	206	break;
	207
	208	case UIO_USERISPACE:
	209	if (suibyte(iov->iov_base, c) < 0)
	210	return (EFAULT);
	211	break;
	212	}
	213	iov->iov_base++;
	214	iov->iov_len--;
	215	uio->uio_resid--;
	216	uio->uio_offset++;
	217	return (0);
	218	}
	219
	220	#if defined(vax) \|\| defined(ppc)
	221	/* unused except by ct.c, other oddities XXX */
	222	/*
	223	* Get next character written in by user from uio.
	224	*/
	225	uwritec(uio)
	226	struct uio *uio;
	227	{
	228	register struct iovec *iov;
229	register int c;
230
231	if (uio->uio_resid <= 0)
232	return (-1);
233	again:
234	if (uio->uio_iovcnt <= 0)
235	panic("uwritec: non-positive iovcnt");
236	iov = uio->uio_iov;
237	if (iov->iov_len == 0) {
238	uio->uio_iov++;
239	if (--uio->uio_iovcnt == 0)
240	return (-1);
241	goto again;
242	}
243	switch (uio->uio_segflg) {
244
245	case UIO_USERSPACE:
246	c = fubyte(iov->iov_base);
247	break;
248
249	case UIO_SYSSPACE:
250	c = *iov->iov_base & 0377;
251	break;
252
253	case UIO_USERISPACE:
254	c = fuibyte(iov->iov_base);
255	break;
256
257	default:
258	c = 0; /* avoid uninitialized variable warning */
259	panic("uwritec: bogus uio_segflg");
260	break;
261	}
262	if (c < 0)
263	return (-1);
264	iov->iov_base++;
265	iov->iov_len--;
266	uio->uio_resid--;
267	uio->uio_offset++;
268	return (c);
269	}
270	#endif /* vax \|\| ppc */
271
272	/*
273	* General routine to allocate a hash table.
274	*/
275	void *
276	hashinit(elements, type, hashmask)
277	int elements, type;
278	u_long *hashmask;
279	{
280	long hashsize;
281	LIST_HEAD(generic, generic) *hashtbl;
282	int i;
283
284	if (elements <= 0)
285	panic("hashinit: bad cnt");
286	for (hashsize = 1; hashsize <= elements; hashsize <<= 1)
287	continue;
288	hashsize >>= 1;
289	MALLOC(hashtbl, struct generic *,
290	(u_long)hashsize * sizeof(*hashtbl), type, M_WAITOK);
291	bzero(hashtbl, (u_long)hashsize * sizeof(*hashtbl));
292	for (i = 0; i < hashsize; i++)
293	LIST_INIT(&hashtbl[i]);
294	*hashmask = hashsize - 1;
295	return (hashtbl);
296	}