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

/*
 * Copyright (c) 1997-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*-
 * Copyright (c) 1982, 1986, 1991, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * 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.
 *
 *	@(#)tty_tty.c	8.2 (Berkeley) 9/23/93
 */

/*
 * Indirect driver for controlling tty.
 */
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/conf.h>
#include <sys/ioctl.h>
#include <sys/proc_internal.h>
#include <sys/tty.h>
#include <sys/vnode_internal.h>
#include <sys/file_internal.h>
#include <sys/kauth.h>

/* Forward declarations for cdevsw[] entry */
/* XXX we should consider making these static */
int cttyopen(dev_t dev, int flag, int mode, proc_t p);
int cttyread(dev_t dev, struct uio *uio, int flag);
int cttywrite(dev_t dev, struct uio *uio, int flag);
int cttyioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, proc_t p);
int cttyselect(dev_t dev, int flag, void* wql, proc_t p);
static vnode_t cttyvp(proc_t p);

int
cttyopen(dev_t dev, int flag, __unused int mode, proc_t p)
{
	vnode_t ttyvp = cttyvp(p);
	struct vfs_context context;
	int error;

	if (ttyvp == NULL)
		return (ENXIO);

	context.vc_thread = current_thread();
	context.vc_ucred = kauth_cred_proc_ref(p);

	/*
	 * A little hack--this device, used by many processes,
	 * happens to do an open on another device, which can 
	 * cause unhappiness if the second-level open blocks indefinitely 
	 * (as could be the case if the master side has hung up).  Since
	 * we know that this driver doesn't care about the serializing
	 * opens and closes, we can drop the lock.
	 */
	devsw_unlock(dev, S_IFCHR);
	error = VNOP_OPEN(ttyvp, flag, &context);
	devsw_lock(dev, S_IFCHR);

	vnode_put(ttyvp);
	kauth_cred_unref(&context.vc_ucred);

	return (error);
}

int
cttyread(__unused dev_t dev, struct uio *uio, int flag)
{
	vnode_t ttyvp = cttyvp(current_proc());
	struct vfs_context context;
	int error;

	if (ttyvp == NULL)
		return (EIO);

	context.vc_thread = current_thread();
	context.vc_ucred = NOCRED;

	error = VNOP_READ(ttyvp, uio, flag, &context);
	vnode_put(ttyvp);

	return (error);
}

int
cttywrite(__unused dev_t dev, struct uio *uio, int flag)
{
	vnode_t ttyvp = cttyvp(current_proc());
	struct vfs_context context;
	int error;

	if (ttyvp == NULL)
		return (EIO);

	context.vc_thread = current_thread();
	context.vc_ucred = NOCRED;

	error = VNOP_WRITE(ttyvp, uio, flag, &context);
	vnode_put(ttyvp);

	return (error);
}

int
cttyioctl(__unused dev_t dev, u_long cmd, caddr_t addr, int flag, proc_t p)
{
	vnode_t ttyvp = cttyvp(current_proc());
	struct vfs_context context;
	struct session *sessp;
	int error = 0;

	if (ttyvp == NULL)
		return (EIO);
	if (cmd == TIOCSCTTY)  { /* don't allow controlling tty to be set    */
		error = EINVAL; /* to controlling tty -- infinite recursion */
		goto out;
	}
	if (cmd == TIOCNOTTY) {
		sessp = proc_session(p);
		if (!SESS_LEADER(p, sessp)) {
			OSBitAndAtomic(~((uint32_t)P_CONTROLT), &p->p_flag);
			if (sessp != SESSION_NULL)
				session_rele(sessp);
			error = 0;
			goto out;
		} else {
			if (sessp != SESSION_NULL)
				session_rele(sessp);
			error = EINVAL;
			goto out;
		}
	}
	context.vc_thread = current_thread();
	context.vc_ucred = NOCRED;

	error = VNOP_IOCTL(ttyvp, cmd, addr, flag, &context);
out:
	vnode_put(ttyvp);
	return (error);
}

int
cttyselect(__unused dev_t dev, int flag, void* wql, __unused proc_t p)
{
	vnode_t ttyvp = cttyvp(current_proc());
	struct vfs_context context;
	int error;

	context.vc_thread = current_thread();
	context.vc_ucred = NOCRED;

	if (ttyvp == NULL)
		return (1);	/* try operation to get EOF/failure */
	error = VNOP_SELECT(ttyvp, flag, FREAD|FWRITE, wql, &context);
	vnode_put(ttyvp);
	return (error);
}

/* This returns vnode with ioref */
static vnode_t
cttyvp(proc_t p)
{
	vnode_t vp;
	int vid;
	struct session *sessp;

	sessp = proc_session(p);

	session_lock(sessp);
	vp = (p->p_flag & P_CONTROLT ? sessp->s_ttyvp : NULLVP);
	vid = sessp->s_ttyvid;	
	session_unlock(sessp);

	session_rele(sessp);

	if (vp != NULLVP) {
		/* cannot get an IO reference, return NULLVP */
		if (vnode_getwithvid(vp, vid) != 0)
			vp = NULLVP;
	}
	return(vp);
}
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 1997-2006 Apple Computer, Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
8f6c56a5	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b	27	*/
1c79356b A	28	/*-
	29	* Copyright (c) 1982, 1986, 1991, 1993
	30	* The Regents of the University of California. All rights reserved.
	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	* @(#)tty_tty.c 8.2 (Berkeley) 9/23/93
	61	*/
	62
	63	/*
	64	* Indirect driver for controlling tty.
	65	*/
	66	#include <sys/param.h>
	67	#include <sys/systm.h>
	68	#include <sys/conf.h>
	69	#include <sys/ioctl.h>
91447636	70	#include <sys/proc_internal.h>
1c79356b	71	#include <sys/tty.h>
91447636 A	72	#include <sys/vnode_internal.h>
91447636 A	73	#include <sys/file_internal.h>
2d21ac55	74	#include <sys/kauth.h>
91447636 A	75
	76	/* Forward declarations for cdevsw[] entry */
	77	/* XXX we should consider making these static */
2d21ac55	78	int cttyopen(dev_t dev, int flag, int mode, proc_t p);
91447636 A	79	int cttyread(dev_t dev, struct uio *uio, int flag);
91447636 A	80	int cttywrite(dev_t dev, struct uio *uio, int flag);
2d21ac55 A	81	int cttyioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, proc_t p);
	82	int cttyselect(dev_t dev, int flag, void* wql, proc_t p);
	83	static vnode_t cttyvp(proc_t p);
1c79356b	84
1c79356b	85	int
6d2010ae	86	cttyopen(dev_t dev, int flag, __unused int mode, proc_t p)
1c79356b	87	{
2d21ac55	88	vnode_t ttyvp = cttyvp(p);
91447636	89	struct vfs_context context;
1c79356b A	90	int error;
	91
	92	if (ttyvp == NULL)
	93	return (ENXIO);
1c79356b	94
2d21ac55	95	context.vc_thread = current_thread();
0c530ab8	96	context.vc_ucred = kauth_cred_proc_ref(p);
2d21ac55	97
6d2010ae A	98	/*
	99	* A little hack--this device, used by many processes,
	100	* happens to do an open on another device, which can
	101	* cause unhappiness if the second-level open blocks indefinitely
	102	* (as could be the case if the master side has hung up). Since
	103	* we know that this driver doesn't care about the serializing
	104	* opens and closes, we can drop the lock.
	105	*/
	106	devsw_unlock(dev, S_IFCHR);
91447636	107	error = VNOP_OPEN(ttyvp, flag, &context);
6d2010ae A	108	devsw_lock(dev, S_IFCHR);
6d2010ae A	109
2d21ac55	110	vnode_put(ttyvp);
0c530ab8	111	kauth_cred_unref(&context.vc_ucred);
91447636	112
1c79356b A	113	return (error);
	114	}
	115
1c79356b	116	int
91447636	117	cttyread(__unused dev_t dev, struct uio *uio, int flag)
1c79356b	118	{
2d21ac55	119	vnode_t ttyvp = cttyvp(current_proc());
91447636	120	struct vfs_context context;
1c79356b A	121	int error;
	122
	123	if (ttyvp == NULL)
	124	return (EIO);
91447636	125
2d21ac55	126	context.vc_thread = current_thread();
91447636 A	127	context.vc_ucred = NOCRED;
	128
	129	error = VNOP_READ(ttyvp, uio, flag, &context);
2d21ac55	130	vnode_put(ttyvp);
91447636	131
1c79356b A	132	return (error);
	133	}
	134
1c79356b	135	int
91447636	136	cttywrite(__unused dev_t dev, struct uio *uio, int flag)
1c79356b	137	{
2d21ac55	138	vnode_t ttyvp = cttyvp(current_proc());
91447636	139	struct vfs_context context;
1c79356b A	140	int error;
	141
	142	if (ttyvp == NULL)
	143	return (EIO);
91447636	144
2d21ac55	145	context.vc_thread = current_thread();
91447636 A	146	context.vc_ucred = NOCRED;
	147
	148	error = VNOP_WRITE(ttyvp, uio, flag, &context);
2d21ac55	149	vnode_put(ttyvp);
91447636	150
1c79356b A	151	return (error);
	152	}
	153
1c79356b	154	int
2d21ac55	155	cttyioctl(__unused dev_t dev, u_long cmd, caddr_t addr, int flag, proc_t p)
1c79356b	156	{
2d21ac55	157	vnode_t ttyvp = cttyvp(current_proc());
91447636	158	struct vfs_context context;
2d21ac55 A	159	struct session *sessp;
2d21ac55 A	160	int error = 0;
1c79356b A	161
	162	if (ttyvp == NULL)
	163	return (EIO);
2d21ac55 A	164	if (cmd == TIOCSCTTY) { /* don't allow controlling tty to be set */
	165	error = EINVAL; /* to controlling tty -- infinite recursion */
	166	goto out;
	167	}
1c79356b	168	if (cmd == TIOCNOTTY) {
2d21ac55 A	169	sessp = proc_session(p);
2d21ac55 A	170	if (!SESS_LEADER(p, sessp)) {
b0d623f7	171	OSBitAndAtomic(~((uint32_t)P_CONTROLT), &p->p_flag);
2d21ac55 A	172	if (sessp != SESSION_NULL)
	173	session_rele(sessp);
	174	error = 0;
	175	goto out;
	176	} else {
	177	if (sessp != SESSION_NULL)
	178	session_rele(sessp);
	179	error = EINVAL;
	180	goto out;
	181	}
1c79356b	182	}
2d21ac55	183	context.vc_thread = current_thread();
91447636 A	184	context.vc_ucred = NOCRED;
91447636 A	185
2d21ac55 A	186	error = VNOP_IOCTL(ttyvp, cmd, addr, flag, &context);
	187	out:
	188	vnode_put(ttyvp);
	189	return (error);
1c79356b A	190	}
1c79356b A	191
1c79356b	192	int
2d21ac55	193	cttyselect(__unused dev_t dev, int flag, void* wql, __unused proc_t p)
1c79356b	194	{
2d21ac55	195	vnode_t ttyvp = cttyvp(current_proc());
91447636	196	struct vfs_context context;
2d21ac55	197	int error;
91447636	198
2d21ac55	199	context.vc_thread = current_thread();
91447636	200	context.vc_ucred = NOCRED;
1c79356b A	201
	202	if (ttyvp == NULL)
	203	return (1); /* try operation to get EOF/failure */
2d21ac55 A	204	error = VNOP_SELECT(ttyvp, flag, FREAD\|FWRITE, wql, &context);
	205	vnode_put(ttyvp);
	206	return (error);
1c79356b A	207	}
1c79356b A	208
2d21ac55 A	209	/* This returns vnode with ioref */
	210	static vnode_t
	211	cttyvp(proc_t p)
1c79356b	212	{
2d21ac55 A	213	vnode_t vp;
	214	int vid;
	215	struct session *sessp;
1c79356b	216
2d21ac55	217	sessp = proc_session(p);
1c79356b	218
2d21ac55 A	219	session_lock(sessp);
	220	vp = (p->p_flag & P_CONTROLT ? sessp->s_ttyvp : NULLVP);
	221	vid = sessp->s_ttyvid;
	222	session_unlock(sessp);
	223
	224	session_rele(sessp);
	225
	226	if (vp != NULLVP) {
	227	/* cannot get an IO reference, return NULLVP */
	228	if (vnode_getwithvid(vp, vid) != 0)
	229	vp = NULLVP;
	230	}
	231	return(vp);
	232	}
1c79356b	233