xref: /freebsd/bin/ps/ps.h (revision 4b9d605768acabc460aa6dcfe8a1f8db35b16794)
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 { CHAR, UCHAR, SHORT, USHORT, INT, UINT, LONG, ULONG, KPTR, PGTOK };
36 
37 typedef struct kinfo_str {
38 	STAILQ_ENTRY(kinfo_str) ks_next;
39 	char *ks_str;	/* formatted string */
40 } KINFO_STR;
41 
42 typedef struct kinfo {
43 	struct kinfo_proc *ki_p;	/* kinfo_proc structure */
44 	const char *ki_args;	/* exec args */
45 	const char *ki_env;	/* environment */
46 	int ki_valid;		/* 1 => uarea stuff valid */
47 	double	 ki_pcpu;	/* calculated in main() */
48 	segsz_t	 ki_memsize;	/* calculated in main() */
49 	union {
50 		int level;	/* used in decendant_sort() */
51 		char *prefix;	/* calculated in decendant_sort() */
52 	} ki_d;
53 	STAILQ_HEAD(, kinfo_str) ki_ks;
54 } KINFO;
55 
56 /* Variables. */
57 typedef struct varent {
58 	STAILQ_ENTRY(varent) next_ve;
59 	const char *header;
60 	struct var *var;
61 } VARENT;
62 
63 typedef struct var {
64 	const char *name;	/* name(s) of variable */
65 	const char *header;	/* default header */
66 	const char *alias;	/* aliases */
67 	const char *field;	/* xo field name */
68 #define	COMM	0x01		/* needs exec arguments and environment (XXX) */
69 #define	LJUST	0x02		/* left adjust on output (trailing blanks) */
70 #define	USER	0x04		/* needs user structure */
71 #define	INF127	0x10		/* values >127 displayed as 127 */
72 	u_int	flag;
73 				/* output routine */
74 	char 	*(*oproc)(struct kinfo *, struct varent *);
75 	/*
76 	 * The following (optional) elements are hooks for passing information
77 	 * to the generic output routine pvar (which prints simple elements
78 	 * from the well known kinfo_proc structure).
79 	 */
80 	size_t	off;		/* offset in structure */
81 	enum	type type;	/* type of element */
82 	const char *fmt;	/* printf format */
83 
84 	short	width;		/* calculated width */
85 } VAR;
86 
87 #include "extern.h"
88