common/sys/proc.h

b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * CDDL HEADER START
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross *
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * The contents of this file are subject to the terms of the
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * Common Development and Distribution License (the "License").
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * You may not use this file except in compliance with the License.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross *
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * or http://www.opensolaris.org/os/licensing.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * See the License for the specific language governing permissions
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * and limitations under the License.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross *
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * When distributing Covered Code, include this CDDL HEADER in each
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * If applicable, add the following below this CDDL HEADER, with the
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * fields enclosed by brackets "[]" replaced with your own identifying
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * information: Portions Copyright [yyyy] [name of copyright owner]
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross *
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * CDDL HEADER END
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * Copyright (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*  Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*    All Rights Reserved   */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#ifndef _SYS_PROC_H
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define _SYS_PROC_H
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/time.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/thread.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/cred.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/debug.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/signal.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/list.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/avl.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#include <sys/refstr.h>
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#ifdef  __cplusplus
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossextern "C" {
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#endif
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossstruct pool;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossstruct task;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossstruct zone;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * One structure allocated per active process.  It contains all
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * data needed about the process while the process may be swapped
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * out.  Other per-process data (user.h) is also inside the proc structure.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * Lightweight-process data (lwp.h) and the kernel stack may be swapped out.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rosstypedef struct  proc {
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct  cred    *p_cred;    /* process credentials */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct  pid     *p_pidp;    /* process ID info */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct  pid     *p_pgidp;   /* process group ID info */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    /*
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross     * Per process lwp and kernel thread stuff
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross     */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct zone *p_zone;    /* zone in which process lives */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    int do_not_use[10];
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    int p_user[10];     /* (see sys/user.h) */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross} proc_t;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define PROC_T              /* headers relying on proc_t are OK */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/* process ID info */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossstruct pid {
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    unsigned int pid_prinactive :1;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    unsigned int pid_pgorphaned :1;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    unsigned int pid_padding :6;    /* used to be pid_ref, now an int */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    unsigned int pid_prslot :24;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    pid_t pid_id;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct proc *pid_pglink;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct proc *pid_pgtail;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    struct pid *pid_link;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    uint_t pid_ref;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross};
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define p_pgrp p_pgidp->pid_id
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define p_pid  p_pidp->pid_id
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define p_slot p_pidp->pid_prslot
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define p_detached p_pgidp->pid_pgorphaned
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define PID_HOLD(pidp)  ASSERT(MUTEX_HELD(&pidlock)); \
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross            ++(pidp)->pid_ref;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define PID_RELE(pidp)  ASSERT(MUTEX_HELD(&pidlock)); \
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross            (pidp)->pid_ref > 1 ? \
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross                --(pidp)->pid_ref : pid_rele(pidp);
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * Structure containing persistent process lock.  The structure and
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * macro allow "mutex_enter(&p->p_lock)" to continue working.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossstruct plock {
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross    kmutex_t pl_lock;
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross};
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#define p_lock  p_lockp->pl_lock
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossextern proc_t p0;       /* process 0 */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossextern struct plock p0lock; /* p0's plock */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossextern struct pid pid0;     /* p0's pid */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross/*
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * This is normally in sunddi.h but
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross * I didn't want to drag that in here.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross */
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rosspid_t
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Rossddi_get_pid(void);
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#ifdef  __cplusplus
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross}
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#endif
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross#endif  /* _SYS_PROC_H */