xref: /illumos-gate/usr/src/uts/common/sys/ts.h (revision 6a0b1217)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 * Copyright 2019 Joyent, Inc.
 */

/*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T	*/
/*	  All Rights Reserved	*/


#ifndef _SYS_TS_H
#define	_SYS_TS_H

#include <sys/types.h>
#include <sys/thread.h>
#include <sys/cpucaps.h>

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * time-sharing dispatcher parameter table entry
 */
typedef struct tsdpent {
	pri_t	ts_globpri;	/* global (class independent) priority */
	int	ts_quantum;	/* time quantum given to procs at this level */
	pri_t	ts_tqexp;	/* ts_umdpri assigned when proc at this level */
				/*   exceeds its time quantum */
	pri_t	ts_slpret;	/* ts_umdpri assigned when proc at this level */
				/*  returns to user mode after sleeping */
	short	ts_maxwait;	/* bumped to ts_lwait if more than ts_maxwait */
				/*  secs elapse before receiving full quantum */
	short	ts_lwait;	/* ts_umdpri assigned if ts_dispwait exceeds  */
				/*  ts_maxwait */
} tsdpent_t;

#ifdef _KERNEL
/*
 * time-sharing class specific thread structure
 */
typedef struct tsproc {
	int	ts_timeleft;	/* time remaining in procs quantum	*/
	uint_t	ts_dispwait;	/* wall clock seconds since start	*/
				/* of quantum (not reset upon preempt)	*/
	pri_t	ts_cpupri;	/* system controlled component of ts_umdpri */
	pri_t	ts_uprilim;	/* user priority limit			*/
	pri_t	ts_upri;	/* user priority			*/
	pri_t	ts_umdpri;	/* user mode priority within ts class	*/
	pri_t	ts_scpri;	/* remembered priority, for schedctl	*/
	char	ts_nice;	/* nice value for compatibility		*/
	char	ts_boost;	/* interactive priority offset		*/
	uchar_t	ts_flags;	/* flags defined below			*/
	kthread_t *ts_tp;	/* pointer to thread			*/
	struct tsproc *ts_next;	/* link to next tsproc on list		*/
	struct tsproc *ts_prev;	/* link to previous tsproc on list	*/
	caps_sc_t ts_caps;	/* CPU caps specific data		*/
} tsproc_t;

/* flags */
#define	TSBACKQ		0x02	/* thread goes to back of dispq if preempted */
#define	TSIA		0x04	/* thread is interactive		*/
#define	TSIASET		0x08	/* interactive thread is "on"		*/
#define	TSIANICED	0x10	/* interactive thread has been niced	*/
#define	TSRESTORE	0x20	/* thread was not preempted, due to schedctl */
				/* restore priority from ts_scpri	*/

#endif /* _KERNEL */

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_TS_H */