/*
 * 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 2008 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

/*
 * The enclosed is a private interface between system libraries and
 * the kernel.  It should not be used in any other way.  It may be
 * changed without notice in a minor release of Solaris.
 */

#ifndef _SYS_SCHEDCTL_H
#define _SYS_SCHEDCTL_H

#ifdef  __cplusplus
extern "C" {
#endif

#if !defined(_ASM)

#include <sys/types.h>
#include <sys/processor.h>

/*
 * This "public" portion of the sc_shared data is used by libsched/libc.
 */
typedef struct sc_public {
        volatile short  sc_nopreempt;
        volatile short  sc_yield;
} sc_public_t;

/*
 * The private portion of the sc_shared data is for
 * use by user-level threading support code in libc.
 * Java has a contract to look at sc_state and sc_cpu (PSARC/2005/351).
 */
typedef struct sc_shared {
        volatile ushort_t sc_state;     /* current LWP state */
        volatile char   sc_sigblock;    /* all signals blocked */
        volatile uchar_t sc_flgs;       /* set only by curthread; see below */
        volatile processorid_t sc_cpu;  /* last CPU on which LWP ran */
        volatile char   sc_cid;         /* scheduling class id */
        volatile char   sc_cpri;        /* class priority, -128..127 */
        volatile uchar_t sc_priority;   /* dispatch priority, 0..255 */
        char            sc_pad;
        sc_public_t     sc_preemptctl;  /* preemption control data */
} sc_shared_t;

/* sc_flgs */
#define SC_PARK_FLG     0x01    /* calling lwp_park() */
#define SC_CANCEL_FLG   0x02    /* cancel pending and not disabled */
#define SC_EINTR_FLG    0x04    /* EINTR returned due to SC_CANCEL_FLG */

/*
 * Possible state settings.  These are same as the kernel thread states
 * except there is no zombie state.
 */
#define SC_FREE         0x00
#define SC_SLEEP        0x01
#define SC_RUN          0x02
#define SC_ONPROC       0x04
#define SC_STOPPED      0x10
#define SC_WAIT         0x20

/* preemption control settings */
#define SC_MAX_TICKS    2               /* max time preemption can be blocked */

#ifdef  _KERNEL
caddr_t schedctl(void);
void    schedctl_init(void);
void    schedctl_lwp_cleanup(kthread_t *);
void    schedctl_proc_cleanup(void);
int     schedctl_get_nopreempt(kthread_t *);
void    schedctl_set_nopreempt(kthread_t *, short);
void    schedctl_set_yield(kthread_t *, short);
void    schedctl_set_cidpri(kthread_t *);
int     schedctl_sigblock(kthread_t *);
void    schedctl_finish_sigblock(kthread_t *);
int     schedctl_cancel_pending(void);
void    schedctl_cancel_eintr(void);
int     schedctl_is_park(void);
void    schedctl_set_park(void);
void    schedctl_unpark(void);
#endif  /* _KERNEL */

#endif  /* !defined(_ASM) */

#ifdef  __cplusplus
}
#endif

#endif  /* _SYS_SCHEDCTL_H */