f3ad36efeb75238651ba26dc84b78d0df540c71f
[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 uint64_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       uint32_t min;
156       uint32_t soft;
157       uint32_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
164
165   /** sends a signal to a context/pid
166       Special values for pid are:
167       * -1   which means every process in ctx except the init-process
168       *  0   which means every process in ctx inclusive the init-process */
169   int   vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
170
171
172
173   int           vc_set_iattr(char const *filename, xid_t xid,  uint32_t flags, uint32_t mask); 
174   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
175                              uint32_t * /*@null@*/ flags, uint32_t * /*@null@*/ mask);
176
177   struct vc_vx_info {
178       xid_t     xid;
179       pid_t     initpid;
180   };
181   
182     /** Returns the context of the given process. pid==0 means the current process. */
183   xid_t         vc_get_task_xid(pid_t pid);
184   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info);
185
186
187   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
188                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
189                  vcVHI_DOMAINNAME }             vc_uts_type;
190   
191   int           vc_set_vhi_name(xid_t xid, vc_uts_type type, char const *val, size_t len);
192   int           vc_get_vhi_name(xid_t xid, vc_uts_type type, char *val, size_t len);
193
194
195   int           vc_enter_namespace(xid_t xid);
196   int           vc_set_namespace();
197   int           vc_cleanup_namespace();
198
199   struct  vc_ctx_flags {
200       uint64_t flagword;
201       uint64_t mask;
202   };
203
204   int           vc_get_flags(xid_t xid, struct vc_ctx_flags *);
205   int           vc_set_flags(xid_t xid, struct vc_ctx_flags const *);
206
207   uint32_t      vc_textlist2flag(char const *, size_t len,
208                                  char const **err_ptr, size_t *err_len);
209   uint32_t      vc_text2flag(char const *, size_t len);
210   char const *  vc_hiflag2text(unsigned int);
211   
212   int           vc_text2cap(char const *);
213   char const *  vc_cap2text(unsigned int);
214
215   inline static int     vc_get_securecaps() {
216     return ( (1<<VC_CAP_LINUX_IMMUTABLE) | (1<<VC_CAP_NET_BROADCAST) |
217              (1<<VC_CAP_NET_ADMIN) | (1<<VC_CAP_NET_RAW) |
218              (1<<VC_CAP_IPC_LOCK) | (1<<VC_CAP_IPC_OWNER) |
219              (1<<VC_CAP_SYS_MODULE) | (1<<VC_CAP_SYS_RAWIO) |
220              (1<<VC_CAP_SYS_PACCT) | (1<<VC_CAP_SYS_ADMIN) |
221              (1<<VC_CAP_SYS_BOOT) | (1<<VC_CAP_SYS_NICE) |
222              (1<<VC_CAP_SYS_RESOURCE) | (1<<VC_CAP_SYS_TIME) |
223              (1<<VC_CAP_MKNOD) | (1<<VC_CAP_QUOTACTL) );
224   }
225
226   inline static int             vc_setfilecontext(char const *filename, xid_t xid) {
227     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
228   }
229   
230   inline static xid_t           vc_getfilecontext(char const *filename) {
231     xid_t       res;
232     if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
233     return res;
234   }
235
236
237   struct vc_set_sched {
238       int32_t   fill_rate;
239       int32_t   period;
240       int32_t   fill_level;
241       int32_t   bucket_size;
242   };
243
244   int           vc_set_sched(xid_t xid, struct vc_set_sched const *);
245   
246   
247   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
248                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
249                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI }
250     vcFeatureSet;
251
252   bool          vc_isSupported(vcFeatureSet);
253   
254   /* The management part */
255
256 #define VC_LIMIT_VSERVER_NAME_LEN       1024
257   
258   typedef enum { vcCFG_NONE, vcCFG_AUTO,
259                  vcCFG_LEGACY,
260                  vcCFG_RECENT_SHORT,
261                  vcCFG_RECENT_FULL }            vcCfgStyle;
262
263   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
264   
265   /** Resolves the name of the vserver. The result will be allocated and must
266       be freed by the caller. */
267   char *        vc_getVserverName(char const *id, vcCfgStyle style);
268
269   /** Returns the path of the vserver configuration directory. When the given
270    *  vserver does not exist, or when it does not have such a directory, NULL
271    *  will be returned. Else, the result will be allocated and must be freed
272    *  by the caller. */
273   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
274
275   /** Returns the path of the configuration directory for the given
276    *  application. The result will be allocated and must be freed by the
277    *  caller. */
278   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
279
280   /** Returns the path to the vserver root-directory. The result will be
281    *  allocated and must be freed by the caller. */
282   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
283
284   /** Returns the ctx of the given vserver. When vserver is not running and
285    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
286    *  'honor_static' is true and a static assignment exists, those value will
287    *  be returned. Else, the result will be VC_NOCTX.
288    *
289    *  When 'is_running' is not null, the status of the vserver will be
290    *  assigned to this variable. */
291   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
292                                  bool honor_static, bool /*@null@*/ *is_running);
293
294   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
295       be used as the directory holding the mapping-links; when NULL, the
296       default value will be assumed.  The result will be allocated and must be
297       freed by the caller. */
298   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
299                                    /*@null@*/char const *revdir);
300
301 #define vcSKEL_INTERFACES       1u
302 #define vcSKEL_PKGMGMT          2u
303 #define vcSKEL_FILESYSTEM       4u
304   
305   /** Create a basic configuration skeleton for a vserver plus toplevel
306    *  directories for pkgmanagemt and filesystem (when requested). */
307   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
308   
309 #ifdef __cplusplus
310 }
311 #endif
312
313 #endif