xref: /illumos-gate/usr/src/contrib/ast/src/lib/libast/include/proc.h (revision b30d193948be5a7794d7ae3ba0ed9c2f72c88e0f)
1 /***********************************************************************
2 *                                                                      *
3 *               This software is part of the ast package               *
4 *          Copyright (c) 1985-2011 AT&T Intellectual Property          *
5 *                      and is licensed under the                       *
6 *                 Eclipse Public License, Version 1.0                  *
7 *                    by AT&T Intellectual Property                     *
8 *                                                                      *
9 *                A copy of the License is available at                 *
10 *          http://www.eclipse.org/org/documents/epl-v10.html           *
11 *         (with md5 checksum b35adb5213ca9657e911e9befb180842)         *
12 *                                                                      *
13 *              Information and Software Systems Research               *
14 *                            AT&T Research                             *
15 *                           Florham Park NJ                            *
16 *                                                                      *
17 *                 Glenn Fowler <gsf@research.att.com>                  *
18 *                  David Korn <dgk@research.att.com>                   *
19 *                   Phong Vo <kpv@research.att.com>                    *
20 *                                                                      *
21 ***********************************************************************/
22 #pragma prototyped
23 
24 /*
25  * process library interface
26  */
27 
28 #ifndef _PROC_H
29 #define _PROC_H
30 
31 #include <ast.h>
32 
33 #define PROC_ARGMOD	(1<<0)	/* argv[-1],argv[0] can be modified	*/
34 #define PROC_BACKGROUND	(1<<1)	/* shell background (&) setup		*/
35 #define PROC_CHECK	(1<<17)	/* check that command exists		*/
36 #define PROC_CLEANUP	(1<<2)	/* close parent redirect fds on error	*/
37 #define PROC_DAEMON	(1<<3)	/* daemon setup				*/
38 #define PROC_ENVCLEAR	(1<<4)	/* clear environment			*/
39 #define PROC_FOREGROUND	(1<<14)	/* system(3) setup			*/
40 #define PROC_GID	(1<<5)	/* setgid(getgid())			*/
41 #define PROC_IGNORE	(1<<6)	/* ignore parent pipe errors		*/
42 #define PROC_IGNOREPATH	(1<<16)	/* procrun() intercept to ignore path	*/
43 #define PROC_ORPHAN	(1<<18)	/* create orphaned process		*/
44 #define PROC_OVERLAY	(1<<7)	/* overlay current process if possible	*/
45 #define PROC_PARANOID	(1<<8)	/* restrict everything			*/
46 #define PROC_PRIVELEGED	(1<<9)	/* setuid(0), setgid(getegid())		*/
47 #define PROC_READ	(1<<10)	/* proc pipe fd 1 returned		*/
48 #define PROC_SESSION	(1<<11)	/* session leader			*/
49 #define PROC_UID	(1<<12)	/* setuid(getuid())			*/
50 #define PROC_WRITE	(1<<13)	/* proc pipe fd 0 returned		*/
51 #define PROC_ZOMBIE	(1<<15)	/* proc may leave a zombie behind	*/
52 
53 #define PROC_ARG_BIT	14	/* bits per op arg			*/
54 #define PROC_OP_BIT	4	/* bits per op				*/
55 
56 #define PROC_ARG_NULL	((1<<PROC_ARG_BIT)-1)
57 
58 #define PROC_fd_dup	0x4
59 #define PROC_FD_CHILD	0x1
60 #define PROC_FD_PARENT	0x2
61 
62 #define PROC_sig_dfl	0x8
63 #define PROC_sig_ign	0x9
64 
65 #define PROC_sys_pgrp	0xa
66 #define PROC_sys_umask	0xb
67 
68 #define PROC_fd_ctty	0xc
69 
70 #define PROC_op1(o,a)	(((o)<<(2*PROC_ARG_BIT))|((a)&((PROC_ARG_NULL<<PROC_ARG_BIT)|PROC_ARG_NULL)))
71 #define PROC_op2(o,a,b)	(((o)<<(2*PROC_ARG_BIT))|(((b)&PROC_ARG_NULL)<<PROC_ARG_BIT)|((a)&PROC_ARG_NULL))
72 
73 #define PROC_FD_CLOSE(p,f)	PROC_op2(PROC_fd_dup|(f),p,PROC_ARG_NULL)
74 #define PROC_FD_CTTY(f)		PROC_op1(PROC_fd_ctty,f)
75 #define PROC_FD_DUP(p,c,f)	PROC_op2(PROC_fd_dup|(f),p,c)
76 #define PROC_SIG_DFL(s)		PROC_op1(PROC_sig_dfl,s,0)
77 #define PROC_SIG_IGN(s)		PROC_op1(PROC_sig_ign,s,0)
78 #define PROC_SYS_PGRP(g)	PROC_op1(PROC_sys_pgrp,g)
79 #define PROC_SYS_UMASK(m)	PROC_op1(PROC_sys_umask,m,0)
80 
81 #define PROC_OP(x)	(((x)>>(2*PROC_ARG_BIT))&((1<<PROC_OP_BIT)-1))
82 #define PROC_ARG(x,n)	((n)?(((x)>>(((n)-1)*PROC_ARG_BIT))&PROC_ARG_NULL):(((x)&~((1<<(2*PROC_ARG_BIT))-1))==~((1<<(2*PROC_ARG_BIT))-1))?(-1):((x)&~((1<<(2*PROC_ARG_BIT))-1)))
83 
84 typedef struct
85 {
86 	pid_t	pid;			/* process id			*/
87 	pid_t	pgrp;			/* process group id		*/
88 	int	rfd;			/* read fd if applicable	*/
89 	int	wfd;			/* write fd if applicable	*/
90 
91 #ifdef _PROC_PRIVATE_
92 _PROC_PRIVATE_
93 #endif
94 
95 } Proc_t;
96 
97 #if _BLD_ast && defined(__EXPORT__)
98 #define extern		__EXPORT__
99 #endif
100 
101 extern int	procclose(Proc_t*);
102 extern int	procfree(Proc_t*);
103 extern Proc_t*	procopen(const char*, char**, char**, long*, int);
104 extern int	procrun(const char*, char**, int);
105 
106 #undef	extern
107 
108 #endif
109