ff7245aeaad1b10ee8c8b625128a0716064228ee
[util-vserver.git] / 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 /** \file vserver.h
21  *  \brief The public interface of the the libvserver library.
22  */
23
24 #ifndef H_VSERVER_SYSCALL_H
25 #define H_VSERVER_SYSCALL_H
26
27 #include <stdint.h>
28 #include <stdlib.h>
29 #include <stdbool.h>
30 #include <sys/types.h>
31 #include <sched.h>
32 #include <netinet/in.h>
33
34 #ifndef IS_DOXYGEN
35 #if defined(__GNUC__)
36 #  define VC_ATTR_UNUSED                __attribute__((__unused__))
37 #  define VC_ATTR_NORETURN              __attribute__((__noreturn__))
38 #  define VC_ATTR_CONST                 __attribute__((__const__))
39 #  define VC_ATTR_DEPRECATED            __attribute__((__deprecated__))
40 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
41 #    define VC_ATTR_NONNULL(ARGS)       __attribute__((__nonnull__ ARGS))
42 #    define VC_ATTR_ALWAYSINLINE        __attribute__((__always_inline__))
43 #  else
44 #    define VC_ATTR_NONNULL(ARGS)
45 #    define VC_ATTR_ALWAYSINLINE
46 #  endif
47 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
48 #    define VC_ATTR_PURE                __attribute__((__pure__))
49 #  else
50 #    define VC_ATTR_PURE
51 #  endif
52 #else
53 #  define VC_ATTR_NONNULL(ARGS)
54 #  define VC_ATTR_UNUSED
55 #  define VC_ATTR_NORETURN
56 #  define VC_ATTR_ALWAYSINLINE
57 #  define VC_ATTR_DEPRECATED
58 #  define VC_ATTR_PURE
59 #  define VC_ATTR_CONST
60 #endif
61 #endif  // IS_DOXYGEN
62
63 /** the value which is returned in error-case (no ctx found) */
64 #define VC_NOCTX                ((xid_t)(-1))
65 #define VC_NOXID                ((xid_t)(-1))
66 /** the value which means a random (the next free) ctx */
67 #define VC_DYNAMIC_XID          ((xid_t)(-1))
68 /** the value which means the current ctx */
69 #define VC_SAMECTX              ((xid_t)(-2))
70
71 #define VC_NONID                ((nid_t)(-1))
72 #define VC_DYNAMIC_NID          ((nid_t)(-1))
73
74 #define VC_LIM_INFINITY         (~0ULL)
75 #define VC_LIM_KEEP             (~1ULL)
76
77 #define VC_CDLIM_UNSET          (0U)
78 #define VC_CDLIM_INFINITY       (~0U)
79 #define VC_CDLIM_KEEP           (~1U)
80   
81 #ifndef S_CTX_INFO_LOCK
82 #  define S_CTX_INFO_LOCK       1
83 #endif
84
85 #ifndef S_CTX_INFO_SCHED
86 #  define S_CTX_INFO_SCHED      2
87 #endif
88
89 #ifndef S_CTX_INFO_NPROC
90 #  define S_CTX_INFO_NPROC      4
91 #endif
92
93 #ifndef S_CTX_INFO_PRIVATE
94 #  define S_CTX_INFO_PRIVATE    8
95 #endif
96
97 #ifndef S_CTX_INFO_INIT
98 #  define S_CTX_INFO_INIT       16
99 #endif
100
101 #ifndef S_CTX_INFO_HIDEINFO
102 #  define S_CTX_INFO_HIDEINFO   32
103 #endif
104
105 #ifndef S_CTX_INFO_ULIMIT
106 #  define S_CTX_INFO_ULIMIT     64
107 #endif
108
109 #ifndef S_CTX_INFO_NAMESPACE
110 #  define S_CTX_INFO_NAMESPACE  128
111 #endif
112
113 #define VC_CAP_CHOWN                     0
114 #define VC_CAP_DAC_OVERRIDE              1
115 #define VC_CAP_DAC_READ_SEARCH           2
116 #define VC_CAP_FOWNER                    3
117 #define VC_CAP_FSETID                    4
118 #define VC_CAP_KILL                      5
119 #define VC_CAP_SETGID                    6
120 #define VC_CAP_SETUID                    7
121 #define VC_CAP_SETPCAP                   8
122 #define VC_CAP_LINUX_IMMUTABLE           9
123 #define VC_CAP_NET_BIND_SERVICE         10
124 #define VC_CAP_NET_BROADCAST            11
125 #define VC_CAP_NET_ADMIN                12
126 #define VC_CAP_NET_RAW                  13
127 #define VC_CAP_IPC_LOCK                 14
128 #define VC_CAP_IPC_OWNER                15
129 #define VC_CAP_SYS_MODULE               16
130 #define VC_CAP_SYS_RAWIO                17
131 #define VC_CAP_SYS_CHROOT               18
132 #define VC_CAP_SYS_PTRACE               19
133 #define VC_CAP_SYS_PACCT                20
134 #define VC_CAP_SYS_ADMIN                21
135 #define VC_CAP_SYS_BOOT                 22
136 #define VC_CAP_SYS_NICE                 23
137 #define VC_CAP_SYS_RESOURCE             24
138 #define VC_CAP_SYS_TIME                 25
139 #define VC_CAP_SYS_TTY_CONFIG           26
140 #define VC_CAP_MKNOD                    27
141 #define VC_CAP_LEASE                    28
142 #define VC_CAP_AUDIT_WRITE              29
143 #define VC_CAP_AUDIT_CONTROL            30
144
145 #define VC_IMMUTABLE_FILE_FL            0x0000010lu
146 #define VC_IMMUTABLE_LINK_FL            0x0008000lu
147 #define VC_IMMUTABLE_ALL                (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
148
149 #define VC_IATTR_XID                    0x01000000u
150
151 #define VC_IATTR_ADMIN                  0x00000001u
152 #define VC_IATTR_WATCH                  0x00000002u
153 #define VC_IATTR_HIDE                   0x00000004u
154 #define VC_IATTR_FLAGS                  0x00000007u
155
156 #define VC_IATTR_BARRIER                0x00010000u
157 #define VC_IATTR_IUNLINK                0x00020000u
158 #define VC_IATTR_IMMUTABLE              0x00040000u
159
160
161 // the flags
162 #define VC_VXF_INFO_LOCK                0x00000001ull
163 #define VC_VXF_INFO_NPROC               0x00000004ull
164 #define VC_VXF_INFO_PRIVATE             0x00000008ull
165 #define VC_VXF_INFO_INIT                0x00000010ull
166
167 #define VC_VXF_INFO_HIDEINFO            0x00000020ull
168 #define VC_VXF_INFO_ULIMIT              0x00000040ull
169 #define VC_VXF_INFO_NAMESPACE           0x00000080ull
170
171 #define VC_VXF_SCHED_HARD               0x00000100ull
172 #define VC_VXF_SCHED_PRIO               0x00000200ull
173 #define VC_VXF_SCHED_PAUSE              0x00000400ull
174
175 #define VC_VXF_VIRT_MEM                 0x00010000ull
176 #define VC_VXF_VIRT_UPTIME              0x00020000ull
177 #define VC_VXF_VIRT_CPU                 0x00040000ull
178 #define VC_VXF_VIRT_LOAD                0x00080000ull
179 #define VC_VXF_VIRT_TIME                0x00100000ull
180
181 #define VC_VXF_HIDE_MOUNT               0x01000000ull
182 #define VC_VXF_HIDE_NETIF               0x02000000ull
183 #define VC_VXF_HIDE_VINFO               0x04000000ull
184
185 #define VC_VXF_STATE_SETUP              (1ULL<<32)
186 #define VC_VXF_STATE_INIT               (1ULL<<33)
187 #define VC_VXF_STATE_ADMIN              (1ULL<<34)
188
189 #define VC_VXF_SC_HELPER                (1ULL<<36)
190 #define VC_VXF_REBOOT_KILL              (1ULL<<37)
191 #define VC_VXF_PERSISTENT               (1ULL<<38)
192
193 #define VC_VXF_FORK_RSS                 (1ULL<<48)
194 #define VC_VXF_PROLIFIC                 (1ULL<<49)
195
196 #define VC_VXF_IGNEG_NICE               (1ULL<<52)
197
198
199 // the ccapabilities
200 #define VC_VXC_SET_UTSNAME              0x00000001ull
201 #define VC_VXC_SET_RLIMIT               0x00000002ull
202
203 #define VC_VXC_RAW_ICMP                 0x00000100ull
204 #define VC_VXC_SYSLOG                   0x00001000ull
205
206 #define VC_VXC_SECURE_MOUNT             0x00010000ull
207 #define VC_VXC_SECURE_REMOUNT           0x00020000ull
208 #define VC_VXC_BINARY_MOUNT             0x00040000ull
209
210 #define VC_VXC_QUOTA_CTL                0x00100000ull
211 #define VC_VXC_ADMIN_MAPPER             0x00200000ull
212 #define VC_VXC_ADMIN_CLOOP              0x00400000ull
213
214
215 // the scheduler flags
216 #define VC_VXSM_FILL_RATE               0x0001
217 #define VC_VXSM_INTERVAL                0x0002
218 #define VC_VXSM_FILL_RATE2              0x0004
219 #define VC_VXSM_INTERVAL2               0x0008
220 #define VC_VXSM_TOKENS                  0x0010
221 #define VC_VXSM_TOKENS_MIN              0x0020
222 #define VC_VXSM_TOKENS_MAX              0x0040
223 #define VC_VXSM_PRIO_BIAS               0x0100
224 #define VC_VXSM_CPU_ID                  0x1000
225 #define VC_VXSM_BUCKET_ID               0x2000
226
227 #define VC_VXSM_IDLE_TIME               0x0200
228 #define VC_VXSM_FORCE                   0x0400
229 #define VC_VXSM_MSEC                    0x4000
230
231 #define VC_VXSM_V3_MASK                 0x0173
232
233
234 // the network flags
235 #define VC_NXF_INFO_LOCK                0x00000001ull
236 #define VC_NXF_INFO_PRIVATE             0x00000008ull
237
238 #define VC_NXF_SINGLE_IP                0x00000100ull
239 #define VC_NXF_LBACK_REMAP              0x00000200ull
240
241 #define VC_NXF_HIDE_NETIF               0x02000000ull
242 #define VC_NXF_HIDE_LBACK               0x04000000ull
243
244 #define VC_NXF_STATE_SETUP              (1ULL<<32)
245 #define VC_NXF_STATE_ADMIN              (1ULL<<34)
246
247 #define VC_NXF_SC_HELPER                (1ULL<<36)
248 #define VC_NXF_PERSISTENT               (1ULL<<38)
249
250
251 // the vserver specific limits
252 #define VC_VLIMIT_NSOCK                 16
253 #define VC_VLIMIT_OPENFD                17
254 #define VC_VLIMIT_ANON                  18
255 #define VC_VLIMIT_SHMEM                 19
256 #define VC_VLIMIT_SEMARY                20
257 #define VC_VLIMIT_NSEMS                 21
258 #define VC_VLIMIT_DENTRY                22
259 #define VC_VLIMIT_MAPPED                23
260
261
262 // the VCI bit values
263 #define VC_VCI_NO_DYNAMIC               (1 << 0)
264 #define VC_VCI_SPACES                   (1 << 10)
265 #define VC_VCI_NETV2                    (1 << 11)
266
267
268 // the device mapping flags
269 #define VC_DATTR_CREATE                 0x00000001
270 #define VC_DATTR_OPEN                   0x00000002
271
272 #define VC_DATTR_REMAP                  0x00000010
273
274
275 // the process context migration flags
276 #define VC_VXM_SET_INIT                 0x00000001
277 #define VC_VXM_SET_REAPER               0x00000002
278
279
280 // the network address flags
281 #define VC_NXA_TYPE_IPV4                0x0001
282 #define VC_NXA_TYPE_IPV6                0x0002
283
284 #define VC_NXA_TYPE_NONE                0x0000
285 #define VC_NXA_TYPE_ANY                 0x00FF
286
287 #define VC_NXA_TYPE_ADDR                0x0010
288 #define VC_NXA_TYPE_MASK                0x0020
289 #define VC_NXA_TYPE_RANGE               0x0040
290
291 #define VC_NXA_MOD_BCAST                0x0100
292 #define VC_NXA_MOD_LBACK                0x0200
293
294
295 #ifndef CLONE_NEWNS
296 #  define CLONE_NEWNS                   0x00020000
297 #endif
298 #ifndef CLONE_NEWUTS
299 #  define CLONE_NEWUTS                  0x04000000
300 #endif
301 #ifndef CLONE_NEWIPC
302 #  define CLONE_NEWIPC                  0x08000000
303 #endif
304
305
306
307 #define VC_BAD_PERSONALITY              ((uint_least32_t)(-1))
308
309
310 /** \defgroup  syscalls Syscall wrappers
311  *  Functions which are calling the vserver syscall directly. */
312
313 /** \defgroup  helper   Helper functions
314  *  Functions which are doing general helper tasks like parameter parsing. */
315
316 /** \typedef  an_unsigned_integer_type  xid_t
317  *  The identifier of a context. */
318
319 #ifdef IS_DOXYGEN
320 typedef an_unsigned_integer_type        xid_t;
321 typedef an_unsigned_integer_type        nid_t;
322 #endif
323
324 #ifdef __cplusplus
325 extern "C" {
326 #endif
327
328     /** \brief   The generic vserver syscall
329      *  \ingroup syscalls
330      *
331      *  This function executes the generic vserver syscall. It uses the
332      *  correct syscallnumber (which may differ between the different
333      *  architectures).
334      *
335      *  \param   cmd  the command to be executed
336      *  \param   xid  the xid on which the cmd shall be applied
337      *  \param   data additional arguments; depends on \c cmd
338      *  \returns depends on \c cmd; usually, -1 stands for an error
339      */
340   int           vc_syscall(uint32_t cmd, xid_t xid, void *data);
341
342     /** \brief   Returns the version of the current kernel API.
343      *  \ingroup syscalls
344      *  \returns The versionnumber of the kernel API
345      */
346   int           vc_get_version();
347
348     /** \brief   Returns the kernel configuration bits
349      *  \ingroup syscalls
350      *  \returns The kernel configuration bits
351      */
352   int           vc_get_vci();
353
354     /** \brief   Moves current process into a context
355      *  \ingroup syscalls
356      *
357      *  Puts current process into context \a ctx, removes the capabilities
358      *  given in \a remove_cap and sets \a flags.
359      *
360      *  \param ctx         The new context; special values for are
361      *  - VC_SAMECTX      which means the current context (just for changing caps and flags)
362      *  - VC_DYNAMIC_XID  which means the next free context; this value can be used by
363      *                    ordinary users also
364      *  \param remove_cap  The linux capabilities which will be \b removed.
365      *  \param flags       Special flags which will be set.
366      *
367      *  \returns  The new context-id, or VC_NOCTX on errors; \c errno
368      *            will be set appropriately
369      *
370      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
371   xid_t         vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
372
373   struct vc_ip_mask_pair {
374       uint32_t  ip;
375       uint32_t  mask;
376   };
377
378     /** \brief  Sets the ipv4root information.
379      *  \ingroup syscalls
380      *  \pre    \a nb < NB_IPV4ROOT && \a ips != 0 */
381   int           vc_set_ipv4root(uint32_t  bcast, size_t nb,
382                         struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
383
384     /** \brief  Returns the value of NB_IPV4ROOT.
385      *  \ingroup helper
386      *
387      *  This function returns the value of NB_IPV4ROOT which was used when the
388      *  library was built, but \b not the value which is used by the currently
389      *  running kernel. */
390   size_t        vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
391
392     /* process context */
393   /** \brief    Flags of process-contexts
394    */
395   struct  vc_ctx_flags {
396       /** \brief Mask of set context flags */
397       uint_least64_t    flagword;
398       /** \brief Mask of set and unset context flags when used by set
399        *         operations, or modifiable flags when used by get
400        *         operations */
401       uint_least64_t    mask;
402   };
403
404     /** \brief   Creates a context without starting it.
405      *  \ingroup syscalls
406      *
407      *  This functions initializes a new context. When already in a freshly
408      *  created context, this old context will be discarded.
409      *
410      *  \param xid  The new context; special values are:
411      *  - VC_DYNAMIC_XID which means to create a dynamic context
412      *
413      *  \returns the xid of the created context, or VC_NOCTX on errors. \c errno
414      *           will be set appropriately. */
415   xid_t         vc_ctx_create(xid_t xid, struct vc_ctx_flags *flags);
416
417     /** \brief   Moves the current process into the specified context.
418      *  \ingroup syscalls
419      *
420      *  \param   xid    The new context
421      *  \param   flags  The flags, see VC_VXM_*
422      *  \returns 0 on success, -1 on errors */
423   int           vc_ctx_migrate(xid_t xid, uint_least64_t flags);
424
425     /** \brief   Statistics about a context */
426   struct vc_ctx_stat {
427       uint_least32_t    usecnt; ///< number of uses
428       uint_least32_t    tasks;  ///< number of tasks
429   };
430
431     /** \brief   Get some statistics about a context.
432      *  \ingroup syscalls
433      *
434      *  \param   xid   The context to get stats about
435      *  \param   stat  Where to store the result
436      *
437      *  \returns 0 on success, -1 on errors. */
438   int           vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
439
440     /** \brief   Contains further statistics about a context. */
441   struct vc_virt_stat {
442       uint_least64_t    offset;
443       uint_least64_t    uptime;
444       uint_least32_t    nr_threads;
445       uint_least32_t    nr_running;
446       uint_least32_t    nr_uninterruptible;
447       uint_least32_t    nr_onhold;
448       uint_least32_t    nr_forks;
449       uint_least32_t    load[3];
450   };
451
452     /** \brief   Get more statistics about a context.
453      *  \ingroup syscalls
454      *
455      *  \param xid   The context to get stats about
456      *  \param stat  Where to store the result
457      *
458      *  \returns 0 on success, -1 on errors. */
459   int           vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
460
461   /** \brief    Sends a signal to a context/pid
462    *  \ingroup  syscalls
463    *
464    *  Special values for \a pid are:
465    *  - -1   which means every process in ctx except the init-process
466    *  -  0   which means every process in ctx inclusive the init-process */
467   int           vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
468  
469   int           vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *)       VC_ATTR_NONNULL((2));
470   int           vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *)  VC_ATTR_NONNULL((2));
471
472   /** \brief    Capabilities of process-contexts */
473   struct  vc_ctx_caps {
474       /** \brief  Mask of set common system capabilities */
475       uint_least64_t    bcaps;
476       /** \brief Mask of set and unset common system capabilities when used by
477        *         set operations, or the modifiable capabilities when used by
478        *         get operations */
479       uint_least64_t    bmask;
480       /** \brief Mask of set process context capabilities */
481       uint_least64_t    ccaps;
482       /** \brief Mask of set and unset process context capabilities when used
483        *         by set operations, or the modifiable capabilities when used
484        *         by get operations */
485       uint_least64_t    cmask;
486   };
487
488   int           vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
489   int           vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
490
491   struct vc_vx_info {
492       xid_t     xid;
493       pid_t     initpid;
494   };
495
496   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
497   
498     /** \brief   Returns the context of the given process.
499      *  \ingroup syscalls
500      *
501      *  \param  pid  the process-id whose xid shall be determined;
502      *               pid==0 means the current process.
503      *  \returns     the xid of process \c pid or -1 on errors
504      */
505   xid_t         vc_get_task_xid(pid_t pid);
506
507   /** \brief   Waits for the end of a context
508    *  \ingroup syscalls
509    */
510   int           vc_wait_exit(xid_t xid);
511   
512     /* rlimit related functions */
513   
514     /** \brief  The type which is used for a single limit value.
515      *
516      *  Special values are
517      *  - VC_LIM_INFINITY ... which is the infinite value
518      *  - VC_LIM_KEEP     ... which is used to mark values which shall not be
519      *                        modified by the vc_set_rlimit() operation.
520      *
521      *  Else, the interpretation of the value depends on the corresponding
522      *  resource; it might be bytes, pages, seconds or litres of beer. */
523   typedef uint_least64_t        vc_limit_t;
524
525     /** \brief  Masks describing the supported limits. */
526   struct  vc_rlimit_mask {
527       uint_least32_t    min;    ///< masks the resources supporting a minimum limit
528       uint_least32_t    soft;   ///< masks the resources supporting a soft limit
529       uint_least32_t    hard;   ///< masks the resources supporting a hard limit
530   };
531
532     /** \brief  Returns the limits supported by the kernel */
533   int           vc_get_rlimit_mask(xid_t xid,
534                            struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
535
536     /** \brief  The limits of a resources.
537      *
538      *  This is a triple consisting of a minimum, soft and hardlimit. */
539   struct vc_rlimit {
540       vc_limit_t        min;    ///< the guaranted minimum of a resources
541       vc_limit_t        soft;   ///< the softlimit of a resource
542       vc_limit_t        hard;   ///< the absolute hardlimit of a resource
543   };
544
545     /** \brief   Returns the limits of \a resource.
546      *  \ingroup syscalls
547      *
548      *  \param  xid       The id of the context
549      *  \param  resource  The resource which will be queried
550      *  \param  lim       The result which will be filled with the limits
551      *
552      *  \returns 0 on success, and -1 on errors. */
553   int           vc_get_rlimit(xid_t xid, int resource,
554                       struct vc_rlimit       /*@out@*/ *lim) VC_ATTR_NONNULL((3));
555     /** \brief   Sets the limits of \a resource.
556      *  \ingroup syscalls
557      *
558      *  \param  xid       The id of the context
559      *  \param  resource  The resource which will be queried
560      *  \param  lim       The new limits
561      *
562      *  \returns 0 on success, and -1 on errors. */
563   int           vc_set_rlimit(xid_t xid, int resource,
564                       struct vc_rlimit const /*@in@*/  *lim) VC_ATTR_NONNULL((3));
565
566     /** \brief Statistics for a resource limit. */
567   struct  vc_rlimit_stat {
568       uint_least32_t    hits;    ///< number of hits on the limit
569       vc_limit_t        value;   ///< current value
570       vc_limit_t        minimum; ///< minimum value observed
571       vc_limit_t        maximum; ///< maximum value observed
572   };
573
574     /** \brief   Returns the current stats of \a resource.
575      *  \ingroup syscalls
576      *
577      *  \param  xid       The id of the context
578      *  \param  resource  The resource which will be queried
579      *  \param  stat      The result which will be filled with the stats
580      *
581      *  \returns 0 on success, and -1 on errors. */
582   int           vc_rlimit_stat(xid_t xid, int resource,
583                        struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
584
585     /** \brief   Resets the minimum and maximum observed values of all resources.
586      *  \ingroup syscalls
587      *
588      *  \param xid      The id of the context
589      *
590      *  \returns 0 on success, and -1 on errors. */
591   int           vc_reset_minmax(xid_t xid);
592
593     /** \brief   Parses a string describing a limit
594      *  \ingroup helper
595      *
596      *  This function parses \a str and interprets special words like \p "inf"
597      *  or suffixes. Valid suffixes are
598      *  - \p k ... 1000
599      *  - \p m ... 1000000
600      *  - \p K ... 1024
601      *  - \p M ... 1048576
602      *
603      *  \param str  The string which shall be parsed
604      *  \param res  Will be filled with the interpreted value; in errorcase,
605      *              this value is undefined.
606      *
607      *  \returns \a true, iff the string \a str could be parsed. \a res will
608      *  be filled with the interpreted value in this case. 
609      *
610      *  \pre \a str!=0 && \a res!=0
611      */
612   bool          vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res)      VC_ATTR_NONNULL((1,2));
613
614
615     /* network context */
616   struct vc_nx_info {
617       nid_t     nid;
618   };
619
620   nid_t         vc_get_task_nid(pid_t pid);
621   int           vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
622
623   struct vc_net_addr {
624       uint16_t                  vna_type;
625       uint16_t                  vna_flags;
626       uint16_t                  vna_prefix;
627       uint16_t                  vna_parent;
628       union {
629         struct {
630           struct in_addr        ip;
631           struct in_addr        mask;
632         } ipv4;
633         struct {
634           struct in6_addr       ip;
635           struct in6_addr       mask;
636         } ipv6;
637       } u;
638 #define vna_v4_ip       u.ipv4.ip
639 #define vna_v4_mask     u.ipv4.mask
640 #define vna_v6_ip       u.ipv6.ip
641 #define vna_v6_mask     u.ipv6.mask
642   };
643
644   struct vc_net_flags {
645       uint_least64_t    flagword;
646       uint_least64_t    mask;
647   };
648
649   nid_t         vc_net_create(nid_t nid);
650   int           vc_net_migrate(nid_t nid);
651
652   int           vc_net_add(nid_t nid, struct vc_net_addr const *info);
653   int           vc_net_remove(nid_t nid, struct vc_net_addr const *info);
654
655   int           vc_get_nflags(nid_t, struct vc_net_flags *);
656   int           vc_set_nflags(nid_t, struct vc_net_flags const *);
657
658   struct vc_net_caps {
659       uint_least64_t    ncaps;
660       uint_least64_t    cmask;
661   };
662
663   int           vc_get_ncaps(nid_t, struct vc_net_caps *);
664   int           vc_set_ncaps(nid_t, struct vc_net_caps const *);
665
666
667     /* iattr related functions */
668
669   int           vc_set_iattr(char const *filename, xid_t xid,
670                              uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
671
672   int           vc_fset_iattr(int fd, xid_t xid,
673                               uint_least32_t flags, uint_least32_t mask);
674
675     /** \brief   Returns information about attributes and assigned context of a file.
676      *  \ingroup syscalls
677      *
678      *  This function returns the VC_IATTR_XXX flags and about the assigned
679      *  context of a file. To request an information, the appropriate bit in
680      *  \c mask must be set and the corresponding parameter (\a xid or \a
681      *  flags) must not be NULL.
682      *
683      *  E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
684      *  set in \a mask, and \a xid must point to valid memory.
685      *
686      *  Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
687      *  \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
688      *
689      *  \param filename  The name of the file whose attributes shall be determined.
690
691      *  \param xid       When non-zero and the VC_IATTR_XID bit is set in \a mask,
692      *                   the assigned context of \a filename will be stored there.
693      *  \param flags     When non-zero, a bitmask of current attributes will be
694      *                   stored there. These attributes must be requested explicitly
695      *                   by setting the appropriate bit in \a mask
696      *  \param mask      Points to a bitmask which tells which attributes shall be
697      *                   determined. On return, it will masquerade the attributes
698      *                   which were determined.
699      *
700      *  \pre  mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
701   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
702                              uint_least32_t * /*@null@*/ flags,
703                              uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
704
705   int           vc_fget_iattr(int fd, xid_t * /*@null@*/ xid,
706                               uint_least32_t * /*@null@*/ flags,
707                               uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((4));
708   
709   /** \brief   Returns the context of \c filename
710    *  \ingroup syscalls
711    *
712    *  This function calls vc_get_iattr() with appropriate arguments to
713    *  determine the context of \c filename. In error-case or when no context
714    *  is assigned, \c VC_NOCTX will be returned. To differ between both cases,
715    *  \c errno must be examined.
716    *
717    *  \b WARNING: this function can modify \c errno although no error happened.
718    *
719    *  \param   filename  The file to check
720    *  \returns The assigned context, or VC_NOCTX when an error occured or no
721    *           such assignment exists. \c errno will be 0 in the latter case */
722   xid_t         vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
723
724
725     /* vhi related functions */
726   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
727                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
728                  vcVHI_DOMAINNAME }             vc_uts_type;
729   
730   int           vc_set_vhi_name(xid_t xid, vc_uts_type type,
731                                 char const *val, size_t len) VC_ATTR_NONNULL((3));
732   int           vc_get_vhi_name(xid_t xid, vc_uts_type type,
733                                 char *val, size_t len)       VC_ATTR_NONNULL((3));
734
735     /* namespace related functions */
736   int           vc_enter_namespace(xid_t xid, uint_least64_t mask);
737   int           vc_set_namespace(xid_t xid, uint_least64_t mask);
738   int           vc_cleanup_namespace();
739   uint_least64_t vc_get_space_mask();
740
741
742     /* disk limit related things */
743   struct vc_ctx_dlimit {
744       uint_least32_t    space_used;
745       uint_least32_t    space_total;
746       uint_least32_t    inodes_used;
747       uint_least32_t    inodes_total;
748       uint_least32_t    reserved;
749   };
750   
751
752   /** Add a disk limit to a file system. */
753   int           vc_add_dlimit(char const *filename, xid_t xid,
754                               uint_least32_t flags) VC_ATTR_NONNULL((1));
755   /** Remove a disk limit from a file system. */
756   int           vc_rem_dlimit(char const *filename, xid_t xid,
757                               uint_least32_t flags) VC_ATTR_NONNULL((1));
758
759   /** Set a disk limit. */
760   int           vc_set_dlimit(char const *filename, xid_t xid,
761                               uint_least32_t flags,
762                               struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
763   /** Get a disk limit. */
764   int           vc_get_dlimit(char const *filename, xid_t xid,
765                               uint_least32_t flags,
766                               struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
767
768     /* scheduler related syscalls */
769   struct vc_set_sched {
770       uint_least32_t    set_mask;
771       int_least32_t     fill_rate;
772       int_least32_t     interval;
773       int_least32_t     fill_rate2;
774       int_least32_t     interval2;
775       int_least32_t     tokens;
776       int_least32_t     tokens_min;
777       int_least32_t     tokens_max;
778       int_least32_t     priority_bias;
779       int_least32_t     cpu_id;
780       int_least32_t     bucket_id;
781   };
782
783   int           vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
784   int           vc_get_sched(xid_t xid, struct vc_set_sched *) VC_ATTR_NONNULL((2));
785
786   struct vc_sched_info {
787       int_least32_t     cpu_id;
788       int_least32_t     bucket_id;
789       uint_least64_t    user_msec;
790       uint_least64_t    sys_msec;
791       uint_least64_t    hold_msec;
792       uint_least32_t    token_usec;
793       int_least32_t     vavavoom;
794   };
795
796   int           vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
797
798     /* misc. syscalls */
799   int           vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
800
801
802   /** \brief    Information about parsing errors
803    *  \ingroup  helper
804    */
805   struct vc_err_listparser {
806       char const        *ptr;           ///< Pointer to the first character of an erroneous string
807       size_t            len;            ///< Length of the erroneous string
808   };
809
810   /** \brief   Converts a single string into bcapability
811    *  \ingroup helper
812    *
813    *  \param   str   The string to be parsed;
814    *                 both "CAP_xxx" and "xxx" will be accepted
815    *  \param   len   The length of the string, or \c 0 for automatic detection
816    *
817    *  \returns 0 on error; a bitmask on success
818    *  \pre     \a str != 0
819    */
820   uint_least64_t        vc_text2bcap(char const *str, size_t len);
821
822   /** \brief   Converts the lowest bit of a bcapability or the entire value
823    *           (when possible) to a textual representation
824    *  \ingroup helper
825    *
826    *  \param   val  The string to be converted; on success, the detected bit(s)
827    *                will be unset, in errorcase only the lowest set bit
828    *
829    *  \returns A textual representation of \a val resp. of its lowest set bit;
830    *           or \c NULL in errorcase.
831    *  \pre     \a val!=0
832    *  \post    \a *val<sub>old</sub> \c != 0  \c <-->
833    *               \a *val<sub>old</sub> > \a *val<sub>new</sub>
834    *  \post    \a *val<sub>old</sub> \c == 0  \c --->  \a result == 0
835    */
836   char const *  vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
837
838   /** \brief   Converts a string into a bcapability-bitmask
839    *  \ingroup helper
840    *
841    *  Syntax of \a str: \verbinclude list2xxx.syntax
842    *
843    *  When the \c `~' prefix is used, the bits will be unset and a `~' after
844    *  another `~' will cancel both ones. The \c `^' prefix specifies a
845    *  bitnumber instead of a bitmask.
846    *
847    *  "literal name" is everything which will be accepted by the
848    *  vc_text2bcap() function. The special values for \c NAME will be
849    *  recognized case insensitively
850    *
851    *  \param  str   The string to be parsed
852    *  \param  len   The length of the string, or \c 0 for automatic detection
853    *  \param  err   Pointer to a structure for error-information, or \c NULL.
854    *  \param  cap   Pointer to a vc_ctx_caps structure holding the results;
855    *                only the \a bcaps and \a bmask fields will be changed and
856    *                already set values will not be honored. When an error
857    *                occured, \a cap will have the value of all processed valid
858    *                \c BCAP parts.
859    *
860    *  \returns 0 on success, -1 on error. In error case, \a err will hold
861    *           position and length of the first not understood BCAP part
862    *  \pre     \a str != 0 && \a cap != 0;
863    *           \a cap->bcaps and \a cap->bmask must be initialized
864    */
865   int                   vc_list2bcap(char const *str, size_t len,
866                                      struct vc_err_listparser *err,
867                                      struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
868
869   uint_least64_t        vc_text2ccap(char const *, size_t len);
870   char const *          vc_loccap2text(uint_least64_t *);
871   int                   vc_list2ccap(char const *, size_t len,
872                                      struct vc_err_listparser *err,
873                                      struct vc_ctx_caps *);
874
875   int                   vc_list2cflag(char const *, size_t len,
876                                      struct vc_err_listparser *err,
877                                      struct vc_ctx_flags *flags);
878   uint_least64_t        vc_text2cflag(char const *, size_t len);
879   char const *          vc_locflag2text(uint_least64_t *);
880   
881   uint_least32_t        vc_list2cflag_compat(char const *, size_t len,
882                                             struct vc_err_listparser *err);
883   uint_least32_t        vc_text2cflag_compat(char const *, size_t len);
884   char const *          vc_hicflag2text_compat(uint_least32_t);
885
886   int                   vc_text2cap(char const *);
887   char const *          vc_cap2text(unsigned int);
888
889   
890   int                   vc_list2nflag(char const *, size_t len,
891                                      struct vc_err_listparser *err,
892                                      struct vc_net_flags *flags);
893   uint_least64_t        vc_text2nflag(char const *, size_t len);
894   char const *          vc_lonflag2text(uint_least64_t *);
895
896   uint_least64_t        vc_text2ncap(char const *, size_t len);
897   char const *          vc_loncap2text(uint_least64_t *);
898   int                   vc_list2ncap(char const *, size_t len,
899                                      struct vc_err_listparser *err,
900                                      struct vc_net_caps *);
901
902   uint_least64_t                vc_get_insecurebcaps() VC_ATTR_CONST;
903   inline static uint_least64_t  vc_get_insecureccaps() {
904     return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
905   }
906   
907   inline static int     vc_setfilecontext(char const *filename, xid_t xid) {
908     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
909   }
910
911
912   uint_least32_t        vc_text2personalityflag(char const *str,
913                                                 size_t len) VC_ATTR_NONNULL((1));
914
915   char const *          vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
916   
917   int                   vc_list2personalityflag(char const /*@in@*/ *,
918                                                 size_t len,
919                                                 uint_least32_t /*@out@*/ *personality,
920                                                 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
921
922   uint_least32_t        vc_str2personalitytype(char const /*@in@*/*,
923                                                size_t len) VC_ATTR_NONNULL((1));
924
925     
926   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
927                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
928                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI,
929                  vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
930                  vcFEATURE_VNET, vcFEATURE_VSTAT }
931     vcFeatureSet;
932
933   bool          vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
934   bool          vc_isSupportedString(char const *);
935
936   
937   typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
938                  vcTYPE_STATIC, vcTYPE_DYNAMIC }
939     vcXidType;
940   
941   vcXidType     vc_getXIDType(xid_t xid) VC_ATTR_CONST;
942
943     /** Returns true iff \a xid is a dynamic xid */
944   bool          vc_is_dynamic_xid(xid_t xid);
945
946
947   /* The management part */
948
949 #define VC_LIMIT_VSERVER_NAME_LEN       1024
950   
951   typedef enum { vcCFG_NONE, vcCFG_AUTO,
952                  vcCFG_LEGACY,
953                  vcCFG_RECENT_SHORT,
954                  vcCFG_RECENT_FULL }            vcCfgStyle;
955
956
957   /** Maps an xid given at '--xid' options to an xid_t */
958   xid_t         vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
959   /** Maps a  nid given at '--nid' options to a  nid_t */
960   nid_t         vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
961
962   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
963   
964   /** Resolves the name of the vserver. The result will be allocated and must
965       be freed by the caller. */
966   char *        vc_getVserverName(char const *id, vcCfgStyle style);
967
968   /** Returns the path of the vserver configuration directory. When the given
969    *  vserver does not exist, or when it does not have such a directory, NULL
970    *  will be returned. Else, the result will be allocated and must be freed
971    *  by the caller. */
972   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
973
974   /** Returns the path of the configuration directory for the given
975    *  application. The result will be allocated and must be freed by the
976    *  caller. */
977   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
978
979   /** Returns the path to the vserver root-directory. The result will be
980    *  allocated and must be freed by the caller. */
981   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
982
983   /** Returns the ctx of the given vserver. When vserver is not running and
984    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
985    *  'honor_static' is true and a static assignment exists, those value will
986    *  be returned. Else, the result will be VC_NOCTX.
987    *
988    *  When 'is_running' is not null, the status of the vserver will be
989    *  assigned to this variable. */
990   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
991                                  bool honor_static, bool /*@null@*/ *is_running);
992
993   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
994       be used as the directory holding the mapping-links; when NULL, the
995       default value will be assumed.  The result will be allocated and must be
996       freed by the caller. */
997   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
998                                    /*@null@*/char const *revdir);
999
1000   int           vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
1001                                       char const *rhs, vcCfgStyle rhs_style);
1002  
1003 #define vcSKEL_INTERFACES       1u
1004 #define vcSKEL_PKGMGMT          2u
1005 #define vcSKEL_FILESYSTEM       4u
1006
1007   /** Create a basic configuration skeleton for a vserver plus toplevel
1008    *  directories for pkgmanagemt and filesystem (when requested). */
1009   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
1010
1011
1012 #ifdef __cplusplus
1013 }
1014 #endif
1015
1016 #undef VC_ATTR_PURE
1017 #undef VC_ATTR_ALWAYSINLINE
1018 #undef VC_ATTR_NORETURN
1019 #undef VC_ATTR_UNUSED
1020 #undef VC_ATTR_NONNULL
1021
1022 #endif