xref: /freebsd/bin/ps/ps.h (revision cd768a840644ad55029ce9c3d41fc52b5045e0cc)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
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  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/queue.h>
33 
34 #define	UNLIMITED	0	/* unlimited terminal width */
35 enum type { UNSPEC, /* For output routines that don't care and aliases. */
36 	    CHAR, UCHAR, SHORT, USHORT, INT, UINT, LONG, ULONG, KPTR, PGTOK };
37 
38 typedef struct kinfo_str {
39 	STAILQ_ENTRY(kinfo_str) ks_next;
40 	char *ks_str;	/* formatted string */
41 } KINFO_STR;
42 
43 typedef struct kinfo {
44 	struct kinfo_proc *ki_p;	/* kinfo_proc structure */
45 	const char *ki_args;	/* exec args */
46 	const char *ki_env;	/* environment */
47 	int ki_valid;		/* 1 => uarea stuff valid */
48 	double	 ki_pcpu;	/* calculated in main() */
49 	segsz_t	 ki_memsize;	/* calculated in main() */
50 	union {
51 		int level;	/* used in decendant_sort() */
52 		char *prefix;	/* calculated in decendant_sort() */
53 	} ki_d;
54 	STAILQ_HEAD(, kinfo_str) ki_ks;
55 } KINFO;
56 
57 /* Keywords/variables to be printed. */
58 typedef struct varent {
59 	STAILQ_ENTRY(varent)	 next_ve;
60 	const char		*header;
61 	const struct var	*var;
62 	u_int			 width;
63 #define VE_KEEP		(1 << 0)
64 	uint16_t		flags;
65 } VARENT;
66 STAILQ_HEAD(velisthead, varent);
67 
68 struct var;
69 typedef struct var VAR;
70 /* Structure representing one available keyword. */
71 struct var {
72 	const char *name;	/* name(s) of variable */
73 	union {
74 		/* Valid field depends on RESOLVED_ALIAS' presence. */
75 		const char	*aliased; /* keyword this one is an alias to */
76 		const VAR	*final_kw; /* final aliased keyword */
77 	};
78 	const char *header;	/* default header */
79 	const char *field;	/* xo field name */
80 #define COMM		0x01	/* needs exec arguments and environment (XXX) */
81 #define LJUST		0x02	/* left adjust on output (trailing blanks) */
82 #define USER		0x04	/* needs user structure */
83 #define INF127		0x10	/* values >127 displayed as 127 */
84 #define NOINHERIT	0x1000	/* Don't inherit flags from aliased keyword. */
85 #define RESOLVING_ALIAS	0x10000	/* Used transiently to resolve aliases. */
86 #define RESOLVED_ALIAS	0x20000	/* Mark that an alias has been resolved. */
87 	u_int	flag;
88 	/* output routine */
89 	char	*(*oproc)(struct kinfo *, struct varent *);
90 	/*
91 	 * The following (optional) elements are hooks for passing information
92 	 * to the generic output routine pvar (which prints simple elements
93 	 * from the well known kinfo_proc structure).
94 	 */
95 	size_t	off;		/* offset in structure */
96 	enum	type type;	/* type of element */
97 	const char *fmt;	/* printf format (depends on output routine) */
98 };
99 
100 #include "extern.h"
101