added URL which describes context-creation
[util-vserver.git] / util-vserver / lib / vserver.h
1 /* $Id$
2
3 *  Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
4 *   
5 *  This program is free software; you can redistribute it and/or modify
6 *  it under the terms of the GNU General Public License as published by
7 *  the Free Software Foundation; either version 2, or (at your option)
8 *  any later version.
9 *   
10 *  This program is distributed in the hope that it will be useful,
11 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 *  GNU General Public License for more details.
14 *   
15 *  You should have received a copy of the GNU General Public License
16 *  along with this program; if not, write to the Free Software
17 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20 #ifndef H_VSERVER_SYSCALL_H
21 #define H_VSERVER_SYSCALL_H
22
23 #include <stdint.h>
24 #include <stdlib.h>
25 #include <stdbool.h>
26 #include <sys/types.h>
27
28 /** the value which is returned in error-case (no ctx found) */
29 #define VC_NOCTX                ((xid_t)(-1))
30 /** the value which means a random (the next free) ctx */
31 #define VC_RANDCTX              ((xid_t)(-1))
32 /** the value which means the current ctx */
33 #define VC_SAMECTX              ((xid_t)(-2))
34
35 #define VC_LIM_INFINITY         (~0ULL)
36 #define VC_LIM_KEEP             (~1ULL)
37
38   
39 #ifndef S_CTX_INFO_LOCK
40 #  define S_CTX_INFO_LOCK       1
41 #endif
42
43 #ifndef S_CTX_INFO_SCHED
44 #  define S_CTX_INFO_SCHED      2
45 #endif
46
47 #ifndef S_CTX_INFO_NPROC
48 #  define S_CTX_INFO_NPROC      4
49 #endif
50
51 #ifndef S_CTX_INFO_PRIVATE
52 #  define S_CTX_INFO_PRIVATE    8
53 #endif
54
55 #ifndef S_CTX_INFO_INIT
56 #  define S_CTX_INFO_INIT       16
57 #endif
58
59 #ifndef S_CTX_INFO_HIDEINFO
60 #  define S_CTX_INFO_HIDEINFO   32
61 #endif
62
63 #ifndef S_CTX_INFO_ULIMIT
64 #  define S_CTX_INFO_ULIMIT     64
65 #endif
66
67 #define VC_CAP_CHOWN                     0
68 #define VC_CAP_DAC_OVERRIDE              1
69 #define VC_CAP_DAC_READ_SEARCH           2
70 #define VC_CAP_FOWNER                    3
71 #define VC_CAP_FSETID                    4
72 #define VC_CAP_KILL                      5
73 #define VC_CAP_SETGID                    6
74 #define VC_CAP_SETUID                    7
75 #define VC_CAP_SETPCAP                   8
76 #define VC_CAP_LINUX_IMMUTABLE           9
77 #define VC_CAP_NET_BIND_SERVICE         10
78 #define VC_CAP_NET_BROADCAST            11
79 #define VC_CAP_NET_ADMIN                12
80 #define VC_CAP_NET_RAW                  13
81 #define VC_CAP_IPC_LOCK                 14
82 #define VC_CAP_IPC_OWNER                15
83 #define VC_CAP_SYS_MODULE               16
84 #define VC_CAP_SYS_RAWIO                17
85 #define VC_CAP_SYS_CHROOT               18
86 #define VC_CAP_SYS_PTRACE               19
87 #define VC_CAP_SYS_PACCT                20
88 #define VC_CAP_SYS_ADMIN                21
89 #define VC_CAP_SYS_BOOT                 22
90 #define VC_CAP_SYS_NICE                 23
91 #define VC_CAP_SYS_RESOURCE             24
92 #define VC_CAP_SYS_TIME                 25
93 #define VC_CAP_SYS_TTY_CONFIG           26
94 #define VC_CAP_MKNOD                    27
95 #define VC_CAP_LEASE                    28
96 #define VC_CAP_QUOTACTL                 29
97
98
99 #ifdef __cplusplus
100 extern "C" {
101 #endif
102
103   struct vc_ip_mask_pair {
104     uint32_t    ip;
105     uint32_t    mask;
106   };
107
108     /** Returns version of the given API-category */
109   int   vc_get_version(int category);
110   
111     /** Puts current process into context <ctx>, removes the given caps and
112      *  sets flags.
113      *  Special values for ctx are
114      *  - VC_SAMECTX  which means the current context (just for changing caps and flags)
115      *  - VC_RANDCTX  which means the next free context; this value can be used by
116      *                ordinary users also
117      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
118   int   vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
119
120     /** Sets the ipv4root information.
121      *  \precondition: nb<16 */
122   int   vc_set_ipv4root(uint32_t  bcast, size_t nb, struct vc_ip_mask_pair const *ips);
123   
124   /* rlimit related functions */
125   typedef uint64_t      vc_limit_t;
126   
127   
128   struct vc_rlimit {
129       vc_limit_t min;
130       vc_limit_t soft;
131       vc_limit_t hard;      
132   };
133
134   struct  vc_rlimit_mask {
135       uint32_t min;
136       uint32_t soft;
137       uint32_t hard;
138   };
139
140   int   vc_get_rlimit(xid_t ctx, int resource, struct vc_rlimit *lim);
141   int   vc_set_rlimit(xid_t ctx, int resource, struct vc_rlimit const *lim);
142   int   vc_get_rlimit_mask(xid_t ctx, struct vc_rlimit_mask *lim);
143
144
145   /** sends a signal to a context/pid
146       Special values for pid are:
147       * -1   which means every process in ctx except the init-process
148       *  0   which means every process in ctx inclusive the init-process */
149   int   vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
150
151
152     /** Returns the context of the given process. pid==0 means the current process. */
153   xid_t vc_X_getctx(pid_t pid);
154
155     /** Returns the pid of the 'init' process */
156   pid_t vc_X_getinitpid(pid_t pid);
157
158
159   int           vc_text2cap(char const *);
160   char const *  vc_cap2text(int);
161
162   
163   /* The management part */
164
165 #define VC_LIMIT_VSERVER_NAME_LEN       1024
166   
167   typedef enum { vcCFG_NONE, vcCFG_AUTO,
168                  vcCFG_LEGACY,
169                  vcCFG_RECENT_SHORT,
170                  vcCFG_RECENT_FULL }            vcCfgStyle;
171
172   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
173   
174   /** Resolves the name of the vserver. The result will be allocated and must
175       be freed by the caller. */
176   char *        vc_getVserverName(char const *id, vcCfgStyle style);
177
178   char *        vc_getVserverVdir(char const *id, vcCfgStyle style);
179
180   /** Returns the ctx of the given vserver. When vserver is not running and
181    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
182    *  'honor_static' is true and a static assignment exists, those value will
183    *  be returned. Else, the result will be VC_NOCTX.
184    *
185    *  When 'is_running' is not null, the status of the vserver will be
186    *  assigned to this variable. */
187   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
188                                  bool honor_static, bool /*@null@*/ *is_running);
189
190   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
191       be used as the directory holding the mapping-links; when NULL, the
192       default value will be assumed.  The result will be allocated and must be
193       freed by the caller. */
194   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
195                                    /*@null@*/char const *revdir);
196   
197 #ifdef __cplusplus
198 }
199 #endif
200
201 #endif