import source from 4.82
[external/lsof.git] / proto.h
1 /*
2  * proto.h - common function prototypes for lsof
3  */
4
5
6 /*
7  * Copyright 1994 Purdue Research Foundation, West Lafayette, Indiana
8  * 47907.  All rights reserved.
9  *
10  * Written by Victor A. Abell
11  *
12  * This software is not subject to any license of the American Telephone
13  * and Telegraph Company or the Regents of the University of California.
14  *
15  * Permission is granted to anyone to use this software for any purpose on
16  * any computer system, and to alter it and redistribute it freely, subject
17  * to the following restrictions:
18  *
19  * 1. Neither the authors nor Purdue University are responsible for any
20  *    consequences of the use of this software.
21  *
22  * 2. The origin of this software must not be misrepresented, either by
23  *    explicit claim or by omission.  Credit to the authors and Purdue
24  *    University must appear in documentation and sources.
25  *
26  * 3. Altered versions must be plainly marked as such, and must not be
27  *    misrepresented as being the original software.
28  *
29  * 4. This notice may not be removed or altered.
30  */
31
32
33 /*
34  * $Id: proto.h,v 1.34 2008/10/21 16:21:41 abe Exp $
35  */
36
37
38 #if     !defined(PROTO_H)
39 #define PROTO_H 1
40
41
42 /*
43  * The _PROTOTYPE macro provides strict ANSI C prototypes if __STDC__
44  * is defined, and old-style K&R prototypes otherwise.
45  *
46  * (With thanks to Andy Tanenbaum)
47  */
48
49 # if    defined(__STDC__)
50 #define _PROTOTYPE(function, params)    function params
51 # else  /* !defined(__STDC__) */
52 #define _PROTOTYPE(function, params)    function()
53 # endif /* defined(__STDC__) */
54
55
56 /*
57  * The following define keeps gcc>=2.7 from complaining about the failure
58  * of the Exit() function to return.
59  *
60  * Paul Eggert supplied it.
61  */
62
63 # if    defined(__GNUC__) && !(__GNUC__<2 || (__GNUC__==2 && __GNUC_MINOR__<7))
64 #define exiting __attribute__((__noreturn__))
65 # else  /* !gcc || gcc<2.7 */
66 #define exiting
67 # endif /* gcc && gcc>=2.7 */
68
69
70 _PROTOTYPE(extern void add_nma,(char *cp, int len));
71 _PROTOTYPE(extern void alloc_lfile,(char *nm, int num));
72 _PROTOTYPE(extern void alloc_lproc,(int pid, int pgid, int ppid, UID_ARG uid, char *cmd, int pss, int sf));
73 _PROTOTYPE(extern void build_IPstates,(void));
74 _PROTOTYPE(extern void childx,(void));
75 _PROTOTYPE(extern int ck_fd_status,(char *nm, int num));
76 _PROTOTYPE(extern int ck_file_arg,(int i, int ac, char *av[], int fv, int rs, struct stat *sbp));
77 _PROTOTYPE(extern void ckkv,(char *d, char *er, char *ev, char *ea));
78 _PROTOTYPE(extern void clr_devtab,(void));
79 _PROTOTYPE(extern int compdev,(COMP_P *a1, COMP_P *a2));
80 _PROTOTYPE(extern int comppid,(COMP_P *a1, COMP_P *a2));
81
82 # if    defined(WILLDROPGID)
83 _PROTOTYPE(extern void dropgid,(void));
84 # endif /* defined(WILLDROPGID) */
85
86 _PROTOTYPE(extern char *endnm,(size_t *sz));
87 _PROTOTYPE(extern int enter_cmd_rx,(char *x));
88 _PROTOTYPE(extern void enter_dev_ch,(char *m));
89 _PROTOTYPE(extern int enter_dir,(char *d, int descend));
90 _PROTOTYPE(extern int enter_fd,(char *f));
91 _PROTOTYPE(extern int enter_network_address,(char *na));
92 _PROTOTYPE(extern int enter_id,(enum IDType ty, char *p));
93 _PROTOTYPE(extern void enter_IPstate,(char *ty, char *nm, int nr));
94 _PROTOTYPE(extern void enter_nm,(char *m));
95
96 # if    defined(HASTCPUDPSTATE)
97 _PROTOTYPE(extern int enter_state_spec,(char *ss));
98 # endif /* defined(HASTCPUDPSTATE) */
99
100 _PROTOTYPE(extern int enter_str_lst,(char *opt, char *s, struct str_lst **lp,
101                                      int *incl, int *excl));
102 _PROTOTYPE(extern int enter_uid,(char *us));
103 _PROTOTYPE(extern void ent_inaddr,(unsigned char *la, int lp, unsigned char *fa, int fp, int af));
104 _PROTOTYPE(extern int examine_lproc,(void));
105 _PROTOTYPE(extern void Exit,(int xv)) exiting;
106 _PROTOTYPE(extern void find_ch_ino,(void));
107 _PROTOTYPE(extern void free_lproc,(struct lproc *lp));
108 _PROTOTYPE(extern void gather_proc_info,(void));
109 _PROTOTYPE(extern char *gethostnm,(unsigned char *ia, int af));
110
111 # if    !defined(GET_MAX_FD)
112 /*
113  * This is not strictly a prototype, but GET_MAX_FD is the name of the
114  * function that, in lieu of getdtablesize(), returns the maximum file
115  * descriptor plus one (or file descriptor count).  GET_MAX_FD may be
116  * defined in the dialect's machine.h.  If it is not, the following
117  * selects getdtablesize().
118  */
119
120 #define GET_MAX_FD      getdtablesize
121 # endif /* !defined(GET_MAX_FD) */
122
123 _PROTOTYPE(extern int hashbyname,(char *nm, int mod));
124 _PROTOTYPE(extern void hashSfile,(void));
125 _PROTOTYPE(extern void initialize,(void));
126 _PROTOTYPE(extern int is_cmd_excl,(char *cmd, short *pss, short *sf));
127 _PROTOTYPE(extern int is_nw_addr,(unsigned char *ia, int p, int af));
128 _PROTOTYPE(extern int is_proc_excl,(int pid, int pgid, UID_ARG uid, short *pss, short *sf));
129 _PROTOTYPE(extern int is_readable,(char *path, int msg));
130 _PROTOTYPE(extern int kread,(KA_T addr, char *buf, READLEN_T len));
131 _PROTOTYPE(extern void link_lfile,(void));
132 _PROTOTYPE(extern struct l_dev *lkupdev,(dev_t *dev,dev_t *rdev,int i,int r));
133 _PROTOTYPE(extern int main,(int argc, char *argv[]));
134 _PROTOTYPE(extern int lstatsafely,(char *path, struct stat *buf));
135 _PROTOTYPE(extern char *mkstrcpy,(char *src, MALLOC_S *rlp));
136 _PROTOTYPE(extern char *mkstrcat,(char *s1, int l1, char *s2, int l2, char *s3, int l3, MALLOC_S *clp));
137 _PROTOTYPE(extern int printdevname,(dev_t *dev, dev_t *rdev, int f, int nty));
138 _PROTOTYPE(extern void print_file,(void));
139 _PROTOTYPE(extern void print_init,(void));
140 _PROTOTYPE(extern void printname,(int nl));
141 _PROTOTYPE(extern char *print_kptr,(KA_T kp, char *buf, size_t bufl));
142 _PROTOTYPE(extern int print_proc,(void));
143 _PROTOTYPE(extern void printrawaddr,(struct sockaddr *sa));
144 _PROTOTYPE(extern void print_tcptpi,(int nl));
145 _PROTOTYPE(extern char *printuid,(UID_ARG uid, int *ty));
146 _PROTOTYPE(extern void printunkaf,(int fam, int ty));
147 _PROTOTYPE(extern char *printsockty,(int ty));
148 _PROTOTYPE(extern void process_file,(KA_T fp));
149 _PROTOTYPE(extern void process_node,(KA_T f));
150 _PROTOTYPE(extern char *Readlink,(char *arg));
151 _PROTOTYPE(extern void readdev,(int skip));
152 _PROTOTYPE(extern struct mounts *readmnt,(void));
153 _PROTOTYPE(extern void rereaddev,(void));
154 _PROTOTYPE(extern int safestrlen,(char *sp, int flags));
155 _PROTOTYPE(extern void safestrprtn,(char *sp, int len, FILE *fs, int flags));
156 _PROTOTYPE(extern void safestrprt,(char *sp, FILE *fs, int flags));
157 _PROTOTYPE(extern int statsafely,(char *path, struct stat *buf));
158 _PROTOTYPE(extern void stkdir,(char *p));
159 _PROTOTYPE(extern void usage,(int xv, int fh, int version));
160 _PROTOTYPE(extern int util_strftime,(char *fmtr, int fmtl, char *fmt));
161 _PROTOTYPE(extern int vfy_dev,(struct l_dev *dp));
162 _PROTOTYPE(extern char *x2dev,(char *s, dev_t *d));
163
164 # if    defined(HASBLKDEV)
165 _PROTOTYPE(extern void find_bl_ino,(void));
166 _PROTOTYPE(extern struct l_dev *lkupbdev,(dev_t *dev,dev_t *rdev,int i,int r));
167 _PROTOTYPE(extern int printbdevname,(dev_t *dev, dev_t *rdev, int f));
168 # endif /* defined(HASBLKDEV) */
169
170 # if    defined(HASCDRNODE)
171 _PROTOTYPE(extern int readcdrnode,(KA_T ca, struct cdrnode *c));
172 # endif /* defined(HASCDRNODE) */
173
174 # if    defined(HASDCACHE)
175 _PROTOTYPE(extern void alloc_dcache,(void));
176 _PROTOTYPE(extern void crc,(char *b, int l, unsigned *s));
177 _PROTOTYPE(extern void crdbld,(void));
178 _PROTOTYPE(extern int ctrl_dcache,(char *p));
179 _PROTOTYPE(extern int dcpath,(int rw, int npw));
180 _PROTOTYPE(extern int open_dcache,(int m, int r, struct stat *sb));
181 _PROTOTYPE(extern int read_dcache,(void));
182 _PROTOTYPE(extern int wr2DCfd,(char *b, unsigned *c));
183 _PROTOTYPE(extern void write_dcache,(void));
184 # endif /* defined(HASDCACHE) */
185
186 # if    defined(HASFIFONODE)
187 _PROTOTYPE(extern int readfifonode,(KA_T fa, struct fifonode *f));
188 # endif /* defined(HASFIFONODE) */
189
190 # if    defined(HASFSTRUCT)
191 _PROTOTYPE(extern char *print_fflags,(long ffg, long pof));
192 # endif /* defined(HASFSTRUCT) */
193
194 # if    defined(HASGNODE)
195 _PROTOTYPE(extern int readgnode,(KA_T ga, struct gnode *g));
196 # endif /* defined(HASGNODE) */
197
198 # if    defined(HASKQUEUE)
199 _PROTOTYPE(extern void process_kqueue,(KA_T ka));
200 # endif /* defined(HASKQUEUE) */
201
202 # if    defined(HASHSNODE)
203 _PROTOTYPE(extern int readhsnode,(KA_T ha, struct hsnode *h));
204 # endif /* defined(HASHSNODE) */
205
206 # if    defined(HASINODE)
207 _PROTOTYPE(extern int readinode,(KA_T ia, struct inode *i));
208 # endif /* defined(HASINODE) */
209
210 # if    defined(HASNCACHE)
211 _PROTOTYPE(extern void ncache_load,(void));
212 _PROTOTYPE(extern char *ncache_lookup,(char *buf, int blen, int *fp));
213 # endif /* defined(HASNCACHE) */
214
215 # if    defined(HASNLIST)
216 _PROTOTYPE(extern void build_Nl,(struct drive_Nl *d));
217 _PROTOTYPE(extern int get_Nl_value,(char *nn, struct drive_Nl *d, KA_T *v));
218 # endif /* defined(HASNLIST) */
219
220 # if    defined(HASPIPENODE)
221 _PROTOTYPE(extern int readpipenode,(KA_T pa, struct pipenode *p));
222 # endif /* defined(HASPIPENODE) */
223
224 # if    defined(HASPRINTDEV)
225 _PROTOTYPE(extern char *HASPRINTDEV,(struct lfile *lf, dev_t *dev));
226 # endif /* defined(HASPRINTDEV) */
227
228 # if    defined(HASPRINTINO)
229 _PROTOTYPE(extern char *HASPRINTINO,(struct lfile *lf));
230 # endif /* defined(HASPRINTINO) */
231
232 # if    defined(HASPRINTNM)
233 _PROTOTYPE(extern void HASPRINTNM,(struct lfile *lf));
234 # endif /* defined(HASPRINTNM) */
235
236 # if    defined(HASPRINTOFF)
237 _PROTOTYPE(extern char *HASPRINTOFF,(struct lfile *lf, int ty));
238 # endif /* defined(HASPRINTOFF) */
239
240 # if    defined(HASPRINTSZ)
241 _PROTOTYPE(extern char *HASPRINTSZ,(struct lfile *lf));
242 # endif /* defined(HASPRINTSZ) */
243
244 # if    defined(HASPRIVNMCACHE)
245 _PROTOTYPE(extern int HASPRIVNMCACHE,(struct lfile *lf));
246 # endif /* defined(HASPRIVNMCACHE) */
247
248 # if    !defined(HASPRIVPRIPP)
249 _PROTOTYPE(extern void printiproto,(int p));
250 # endif /* !defined(HASPRIVPRIPP) */
251
252 # if    defined(HASRNODE)
253 _PROTOTYPE(extern int readrnode,(KA_T ra, struct rnode *r));
254 # endif /* defined(HASRNODE) */
255
256 # if    defined(HASSPECDEVD)
257 _PROTOTYPE(extern void HASSPECDEVD,(char *p, struct stat *s));
258 # endif /* defined(HASSPECDEVD) */
259
260 # if    defined(HASSNODE)
261 _PROTOTYPE(extern int readsnode,(KA_T sa, struct snode *s));
262 # endif /* defined(HASSNODE) */
263
264 # if    defined(HASSTREAMS)
265 _PROTOTYPE(extern int readstdata,(KA_T addr, struct stdata *buf));
266 _PROTOTYPE(extern int readsthead,(KA_T addr, struct queue *buf));
267 _PROTOTYPE(extern int readstidnm,(KA_T addr, char *buf, READLEN_T len));
268 _PROTOTYPE(extern int readstmin,(KA_T addr, struct module_info *buf));
269 _PROTOTYPE(extern int readstqinit,(KA_T addr, struct qinit *buf));
270 # endif /* defined(HASSTREAMS) */
271
272 # if    defined(HASTMPNODE)
273 _PROTOTYPE(extern int readtnode,(KA_T ta, struct tmpnode *t));
274 # endif /* defined(HASTMPNODE) */
275
276 # if    defined(HASVNODE)
277 _PROTOTYPE(extern int readvnode,(KA_T va, struct vnode *v));
278 # endif /* defined(HASVNODE) */
279
280 # if    defined(USE_LIB_SNPF)
281 _PROTOTYPE(extern int snpf,(char *str, int len, char *fmt, ...));
282 # endif /* defined(USE_LIB_SNPF) */
283
284 # endif /* !defined(PROTO_H) */