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