b67a30ac39cc35fc56367d5b25aeb545781ab1b3
[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_DYNAMIC_XID          ((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 #ifndef S_CTX_INFO_NAMESPACE
68 #  define S_CTX_INFO_NAMESPACE  128
69 #endif
70
71 #define VC_CAP_CHOWN                     0
72 #define VC_CAP_DAC_OVERRIDE              1
73 #define VC_CAP_DAC_READ_SEARCH           2
74 #define VC_CAP_FOWNER                    3
75 #define VC_CAP_FSETID                    4
76 #define VC_CAP_KILL                      5
77 #define VC_CAP_SETGID                    6
78 #define VC_CAP_SETUID                    7
79 #define VC_CAP_SETPCAP                   8
80 #define VC_CAP_LINUX_IMMUTABLE           9
81 #define VC_CAP_NET_BIND_SERVICE         10
82 #define VC_CAP_NET_BROADCAST            11
83 #define VC_CAP_NET_ADMIN                12
84 #define VC_CAP_NET_RAW                  13
85 #define VC_CAP_IPC_LOCK                 14
86 #define VC_CAP_IPC_OWNER                15
87 #define VC_CAP_SYS_MODULE               16
88 #define VC_CAP_SYS_RAWIO                17
89 #define VC_CAP_SYS_CHROOT               18
90 #define VC_CAP_SYS_PTRACE               19
91 #define VC_CAP_SYS_PACCT                20
92 #define VC_CAP_SYS_ADMIN                21
93 #define VC_CAP_SYS_BOOT                 22
94 #define VC_CAP_SYS_NICE                 23
95 #define VC_CAP_SYS_RESOURCE             24
96 #define VC_CAP_SYS_TIME                 25
97 #define VC_CAP_SYS_TTY_CONFIG           26
98 #define VC_CAP_MKNOD                    27
99 #define VC_CAP_LEASE                    28
100 #define VC_CAP_QUOTACTL                 29
101
102 #define VC_IMMUTABLE_FILE_FL            0x00000010l
103 #define VC_IMMUTABLE_LINK_FL            0x00008000l
104 #define VC_IMMUTABLE_ALL                (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
105
106 #define VC_IATTR_XID                    0x01000000
107
108 #define VC_IATTR_ADMIN                  0x00000001
109 #define VC_IATTR_WATCH                  0x00000002
110 #define VC_IATTR_HIDE                   0x00000004
111 #define VC_IATTR_FLAGS                  0x00000007
112
113 #define VC_IATTR_BARRIER                0x00010000
114 #define VC_IATTR_IUNLINK                0x00020000
115 #define VC_IATTR_IMMUTABLE              0x00040000
116
117 #ifdef __cplusplus
118 extern "C" {
119 #endif
120
121   struct vc_ip_mask_pair {
122     uint32_t    ip;
123     uint32_t    mask;
124   };
125
126     /** Returns the version of the current kernel API. */
127   int   vc_get_version();
128   
129     /** Puts current process into context <ctx>, removes the given caps and
130      *  sets flags.
131      *  Special values for ctx are
132      *  - VC_SAMECTX  which means the current context (just for changing caps and flags)
133      *  - VC_RANDCTX  which means the next free context; this value can be used by
134      *                ordinary users also
135      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
136   xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
137
138     /** Sets the ipv4root information.
139      *  \precondition: nb<16 */
140   int   vc_set_ipv4root(uint32_t  bcast, size_t nb, struct vc_ip_mask_pair const *ips);
141
142   xid_t vc_create_context(xid_t xid);
143   int   vc_migrate_context(xid_t xid);
144   
145   /* rlimit related functions */
146   typedef uint_least64_t        vc_limit_t;
147  
148   struct vc_rlimit {
149       vc_limit_t        min;
150       vc_limit_t        soft;
151       vc_limit_t        hard;
152   };
153
154   struct  vc_rlimit_mask {
155       uint_least32_t    min;
156       uint_least32_t    soft;
157       uint_least32_t    hard;
158   };
159
160   int   vc_get_rlimit(xid_t ctx, int resource, struct vc_rlimit *lim);
161   int   vc_set_rlimit(xid_t ctx, int resource, struct vc_rlimit const *lim);
162   int   vc_get_rlimit_mask(xid_t ctx, struct vc_rlimit_mask *lim);
163   bool  vc_parseLimit(char const *, vc_limit_t *);
164
165
166   /** sends a signal to a context/pid
167       Special values for pid are:
168       * -1   which means every process in ctx except the init-process
169       *  0   which means every process in ctx inclusive the init-process */
170   int   vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
171
172
173
174   int           vc_set_iattr(char const *filename, xid_t xid,
175                              uint_least32_t flags, uint_least32_t mask); 
176   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
177                              uint_least32_t * /*@null@*/ flags,
178                              uint_least32_t * /*@null@*/ mask);
179
180   struct vc_vx_info {
181       xid_t     xid;
182       pid_t     initpid;
183   };
184   
185     /** Returns the context of the given process. pid==0 means the current process. */
186   xid_t         vc_get_task_xid(pid_t pid);
187   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info);
188
189
190   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
191                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
192                  vcVHI_DOMAINNAME }             vc_uts_type;
193   
194   int           vc_set_vhi_name(xid_t xid, vc_uts_type type, char const *val, size_t len);
195   int           vc_get_vhi_name(xid_t xid, vc_uts_type type, char *val, size_t len);
196
197
198   int           vc_enter_namespace(xid_t xid);
199   int           vc_set_namespace();
200   int           vc_cleanup_namespace();
201
202   struct  vc_ctx_flags {
203       uint_least64_t    flagword;
204       uint_least64_t    mask;
205   };
206
207   int                   vc_get_flags(xid_t xid, struct vc_ctx_flags *);
208   int                   vc_set_flags(xid_t xid, struct vc_ctx_flags const *);
209
210   int                   vc_list2flag(char const *, size_t len,
211                                      char const **err_ptr, size_t *err_len,
212                                      uint_least64_t *flag,
213                                      uint_least64_t *mask);
214   uint_least64_t        vc_text2flag(char const *, size_t len);
215   char const *          vc_hiflag2text(uint_least64_t);
216   
217   uint_least32_t        vc_list2flag_compat(char const *, size_t len,
218                                             char const **err_ptr, size_t *err_len);
219   uint_least32_t        vc_text2flag_compat(char const *, size_t len);
220   char const *          vc_hiflag2text_compat(uint_least32_t);
221   
222   int           vc_text2cap(char const *);
223   char const *  vc_cap2text(unsigned int);
224
225   inline static uint_least32_t  vc_get_securecaps() {
226     return ( (1<<VC_CAP_LINUX_IMMUTABLE) | (1<<VC_CAP_NET_BROADCAST) |
227              (1<<VC_CAP_NET_ADMIN) | (1<<VC_CAP_NET_RAW) |
228              (1<<VC_CAP_IPC_LOCK) | (1<<VC_CAP_IPC_OWNER) |
229              (1<<VC_CAP_SYS_MODULE) | (1<<VC_CAP_SYS_RAWIO) |
230              (1<<VC_CAP_SYS_PACCT) | (1<<VC_CAP_SYS_ADMIN) |
231              (1<<VC_CAP_SYS_BOOT) | (1<<VC_CAP_SYS_NICE) |
232              (1<<VC_CAP_SYS_RESOURCE) | (1<<VC_CAP_SYS_TIME) |
233              (1<<VC_CAP_MKNOD) | (1<<VC_CAP_QUOTACTL) );
234   }
235
236   inline static int             vc_setfilecontext(char const *filename, xid_t xid) {
237     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
238   }
239   
240   inline static xid_t           vc_getfilecontext(char const *filename) {
241     xid_t       res;
242     if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
243     return res;
244   }
245
246
247   struct vc_set_sched {
248       int32_t   fill_rate;
249       int32_t   period;
250       int32_t   fill_level;
251       int32_t   bucket_size;
252   };
253
254   int           vc_set_sched(xid_t xid, struct vc_set_sched const *);
255   
256   
257   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
258                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
259                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI }
260     vcFeatureSet;
261
262   bool          vc_isSupported(vcFeatureSet);
263   bool          vc_isSupportedString(char const *);
264   
265   /* The management part */
266
267 #define VC_LIMIT_VSERVER_NAME_LEN       1024
268   
269   typedef enum { vcCFG_NONE, vcCFG_AUTO,
270                  vcCFG_LEGACY,
271                  vcCFG_RECENT_SHORT,
272                  vcCFG_RECENT_FULL }            vcCfgStyle;
273
274   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
275   
276   /** Resolves the name of the vserver. The result will be allocated and must
277       be freed by the caller. */
278   char *        vc_getVserverName(char const *id, vcCfgStyle style);
279
280   /** Returns the path of the vserver configuration directory. When the given
281    *  vserver does not exist, or when it does not have such a directory, NULL
282    *  will be returned. Else, the result will be allocated and must be freed
283    *  by the caller. */
284   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
285
286   /** Returns the path of the configuration directory for the given
287    *  application. The result will be allocated and must be freed by the
288    *  caller. */
289   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
290
291   /** Returns the path to the vserver root-directory. The result will be
292    *  allocated and must be freed by the caller. */
293   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
294
295   /** Returns the ctx of the given vserver. When vserver is not running and
296    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
297    *  'honor_static' is true and a static assignment exists, those value will
298    *  be returned. Else, the result will be VC_NOCTX.
299    *
300    *  When 'is_running' is not null, the status of the vserver will be
301    *  assigned to this variable. */
302   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
303                                  bool honor_static, bool /*@null@*/ *is_running);
304
305   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
306       be used as the directory holding the mapping-links; when NULL, the
307       default value will be assumed.  The result will be allocated and must be
308       freed by the caller. */
309   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
310                                    /*@null@*/char const *revdir);
311
312 #define vcSKEL_INTERFACES       1u
313 #define vcSKEL_PKGMGMT          2u
314 #define vcSKEL_FILESYSTEM       4u
315   
316   /** Create a basic configuration skeleton for a vserver plus toplevel
317    *  directories for pkgmanagemt and filesystem (when requested). */
318   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
319   
320 #ifdef __cplusplus
321 }
322 #endif
323
324 #endif