xref: /dragonfly/sys/sys/procctl.h (revision 6ca88057)
1 /*
2  * Copyright (c) 2014 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef _SYS_PROCCTL_H_
36 #define _SYS_PROCCTL_H_
37 
38 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
39 #include <sys/lock.h>
40 #endif
41 
42 typedef enum idtype {
43 	/*
44 	 * These names were mostly lifted from Solaris source code and
45 	 * still use Solaris style naming to avoid breaking any
46 	 * OpenSolaris code which has been ported to FreeBSD.  There
47 	 * is no clear FreeBSD counterpart for all of the names, but
48 	 * some have a clear correspondence to FreeBSD entities.
49 	 *
50 	 * The numerical values are kept synchronized with the Solaris
51 	 * values.
52 	 */
53 	P_PID,			/* A process identifier. */
54 	P_PPID,			/* A parent process identifier.	*/
55 	P_PGID,			/* A process group identifier. */
56 	P_SID,			/* A session identifier. */
57 	P_CID,			/* A scheduling class identifier. */
58 	P_UID,			/* A user identifier. */
59 	P_GID,			/* A group identifier. */
60 	P_ALL,			/* All processes. */
61 	P_LWPID,		/* An LWP identifier. */
62 	P_TASKID,		/* A task identifier. */
63 	P_PROJID,		/* A project identifier. */
64 	P_POOLID,		/* A pool identifier. */
65 	P_JAILID,		/* A zone identifier. */
66 	P_CTID,			/* A (process) contract identifier. */
67 	P_CPUID,		/* CPU identifier. */
68 	P_PSETID		/* Processor set identifier. */
69 } idtype_t;			/* The type of id_t we are using. */
70 
71 struct reaper_status {
72 	uint32_t	flags;
73 	uint32_t	refs;
74 	long		reserved1[15];
75 	pid_t		pid_head;
76 	int		reserved2[15];
77 };
78 
79 union reaper_info {
80 	struct reaper_status	status;
81 };
82 
83 #define _PROCCTL_PRESENT
84 
85 #define PROC_REAP_ACQUIRE	0x0001
86 #define PROC_REAP_RELEASE	0x0002
87 #define PROC_REAP_STATUS	0x0003
88 
89 #define REAPER_STAT_OWNED	0x00000001
90 #define REAPER_STAT_REALINIT	0x00000002
91 
92 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
93 
94 struct proc;
95 
96 struct sysreaper {
97 	struct lock	lock;		/* thread or topo access */
98 	struct sysreaper *parent;	/* upward topology only */
99 	struct proc	*p;		/* who the reaper is */
100 	uint32_t	flags;		/* control flags */
101 	u_int		refs;		/* shared structure refs */
102 };
103 
104 #endif
105 
106 #if !defined(_KERNEL)
107 
108 int procctl(idtype_t idtype, id_t id, int cmd, void *arg);
109 
110 #endif
111 
112 #endif
113