Add network capability RAW_ICMP.
[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 network capabilities
252 #define VC_NXC_RAW_ICMP                 0x00000100ull
253
254
255 // the vserver specific limits
256 #define VC_VLIMIT_NSOCK                 16
257 #define VC_VLIMIT_OPENFD                17
258 #define VC_VLIMIT_ANON                  18
259 #define VC_VLIMIT_SHMEM                 19
260 #define VC_VLIMIT_SEMARY                20
261 #define VC_VLIMIT_NSEMS                 21
262 #define VC_VLIMIT_DENTRY                22
263 #define VC_VLIMIT_MAPPED                23
264
265
266 // the VCI bit values
267 #define VC_VCI_NO_DYNAMIC               (1 << 0)
268 #define VC_VCI_SPACES                   (1 << 10)
269 #define VC_VCI_NETV2                    (1 << 11)
270
271
272 // the device mapping flags
273 #define VC_DATTR_CREATE                 0x00000001
274 #define VC_DATTR_OPEN                   0x00000002
275
276 #define VC_DATTR_REMAP                  0x00000010
277
278
279 // the process context migration flags
280 #define VC_VXM_SET_INIT                 0x00000001
281 #define VC_VXM_SET_REAPER               0x00000002
282
283
284 // the network address flags
285 #define VC_NXA_TYPE_IPV4                0x0001
286 #define VC_NXA_TYPE_IPV6                0x0002
287
288 #define VC_NXA_TYPE_NONE                0x0000
289 #define VC_NXA_TYPE_ANY                 0x00FF
290
291 #define VC_NXA_TYPE_ADDR                0x0010
292 #define VC_NXA_TYPE_MASK                0x0020
293 #define VC_NXA_TYPE_RANGE               0x0040
294
295 #define VC_NXA_MOD_BCAST                0x0100
296 #define VC_NXA_MOD_LBACK                0x0200
297
298
299 #ifndef CLONE_NEWNS
300 #  define CLONE_NEWNS                   0x00020000
301 #endif
302 #ifndef CLONE_NEWUTS
303 #  define CLONE_NEWUTS                  0x04000000
304 #endif
305 #ifndef CLONE_NEWIPC
306 #  define CLONE_NEWIPC                  0x08000000
307 #endif
308
309
310
311 #define VC_BAD_PERSONALITY              ((uint_least32_t)(-1))
312
313
314 /** \defgroup  syscalls Syscall wrappers
315  *  Functions which are calling the vserver syscall directly. */
316
317 /** \defgroup  helper   Helper functions
318  *  Functions which are doing general helper tasks like parameter parsing. */
319
320 /** \typedef  an_unsigned_integer_type  xid_t
321  *  The identifier of a context. */
322
323 #ifdef IS_DOXYGEN
324 typedef an_unsigned_integer_type        xid_t;
325 typedef an_unsigned_integer_type        nid_t;
326 #endif
327
328 #ifdef __cplusplus
329 extern "C" {
330 #endif
331
332     /** \brief   The generic vserver syscall
333      *  \ingroup syscalls
334      *
335      *  This function executes the generic vserver syscall. It uses the
336      *  correct syscallnumber (which may differ between the different
337      *  architectures).
338      *
339      *  \param   cmd  the command to be executed
340      *  \param   xid  the xid on which the cmd shall be applied
341      *  \param   data additional arguments; depends on \c cmd
342      *  \returns depends on \c cmd; usually, -1 stands for an error
343      */
344   int           vc_syscall(uint32_t cmd, xid_t xid, void *data);
345
346     /** \brief   Returns the version of the current kernel API.
347      *  \ingroup syscalls
348      *  \returns The versionnumber of the kernel API
349      */
350   int           vc_get_version();
351
352     /** \brief   Returns the kernel configuration bits
353      *  \ingroup syscalls
354      *  \returns The kernel configuration bits
355      */
356   int           vc_get_vci();
357
358     /** \brief   Moves current process into a context
359      *  \ingroup syscalls
360      *
361      *  Puts current process into context \a ctx, removes the capabilities
362      *  given in \a remove_cap and sets \a flags.
363      *
364      *  \param ctx         The new context; special values for are
365      *  - VC_SAMECTX      which means the current context (just for changing caps and flags)
366      *  - VC_DYNAMIC_XID  which means the next free context; this value can be used by
367      *                    ordinary users also
368      *  \param remove_cap  The linux capabilities which will be \b removed.
369      *  \param flags       Special flags which will be set.
370      *
371      *  \returns  The new context-id, or VC_NOCTX on errors; \c errno
372      *            will be set appropriately
373      *
374      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
375   xid_t         vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
376
377   struct vc_ip_mask_pair {
378       uint32_t  ip;
379       uint32_t  mask;
380   };
381
382     /** \brief  Sets the ipv4root information.
383      *  \ingroup syscalls
384      *  \pre    \a nb < NB_IPV4ROOT && \a ips != 0 */
385   int           vc_set_ipv4root(uint32_t  bcast, size_t nb,
386                         struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
387
388     /** \brief  Returns the value of NB_IPV4ROOT.
389      *  \ingroup helper
390      *
391      *  This function returns the value of NB_IPV4ROOT which was used when the
392      *  library was built, but \b not the value which is used by the currently
393      *  running kernel. */
394   size_t        vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
395
396     /* process context */
397   /** \brief    Flags of process-contexts
398    */
399   struct  vc_ctx_flags {
400       /** \brief Mask of set context flags */
401       uint_least64_t    flagword;
402       /** \brief Mask of set and unset context flags when used by set
403        *         operations, or modifiable flags when used by get
404        *         operations */
405       uint_least64_t    mask;
406   };
407
408     /** \brief   Creates a context without starting it.
409      *  \ingroup syscalls
410      *
411      *  This functions initializes a new context. When already in a freshly
412      *  created context, this old context will be discarded.
413      *
414      *  \param xid  The new context; special values are:
415      *  - VC_DYNAMIC_XID which means to create a dynamic context
416      *
417      *  \returns the xid of the created context, or VC_NOCTX on errors. \c errno
418      *           will be set appropriately. */
419   xid_t         vc_ctx_create(xid_t xid, struct vc_ctx_flags *flags);
420
421     /** \brief   Moves the current process into the specified context.
422      *  \ingroup syscalls
423      *
424      *  \param   xid    The new context
425      *  \param   flags  The flags, see VC_VXM_*
426      *  \returns 0 on success, -1 on errors */
427   int           vc_ctx_migrate(xid_t xid, uint_least64_t flags);
428
429     /** \brief   Statistics about a context */
430   struct vc_ctx_stat {
431       uint_least32_t    usecnt; ///< number of uses
432       uint_least32_t    tasks;  ///< number of tasks
433   };
434
435     /** \brief   Get some statistics about a context.
436      *  \ingroup syscalls
437      *
438      *  \param   xid   The context to get stats about
439      *  \param   stat  Where to store the result
440      *
441      *  \returns 0 on success, -1 on errors. */
442   int           vc_ctx_stat(xid_t xid, struct vc_ctx_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
443
444     /** \brief   Contains further statistics about a context. */
445   struct vc_virt_stat {
446       uint_least64_t    offset;
447       uint_least64_t    uptime;
448       uint_least32_t    nr_threads;
449       uint_least32_t    nr_running;
450       uint_least32_t    nr_uninterruptible;
451       uint_least32_t    nr_onhold;
452       uint_least32_t    nr_forks;
453       uint_least32_t    load[3];
454   };
455
456     /** \brief   Get more statistics about a context.
457      *  \ingroup syscalls
458      *
459      *  \param xid   The context to get stats about
460      *  \param stat  Where to store the result
461      *
462      *  \returns 0 on success, -1 on errors. */
463   int           vc_virt_stat(xid_t xid, struct vc_virt_stat /*@out@*/ *stat) VC_ATTR_NONNULL((2));
464
465   /** \brief    Sends a signal to a context/pid
466    *  \ingroup  syscalls
467    *
468    *  Special values for \a pid are:
469    *  - -1   which means every process in ctx except the init-process
470    *  -  0   which means every process in ctx inclusive the init-process */
471   int           vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
472  
473   int           vc_get_cflags(xid_t xid, struct vc_ctx_flags /*@out@*/ *)       VC_ATTR_NONNULL((2));
474   int           vc_set_cflags(xid_t xid, struct vc_ctx_flags /*@in@*/ const *)  VC_ATTR_NONNULL((2));
475
476   /** \brief    Capabilities of process-contexts */
477   struct  vc_ctx_caps {
478       /** \brief  Mask of set common system capabilities */
479       uint_least64_t    bcaps;
480       /** \brief Mask of set and unset common system capabilities when used by
481        *         set operations, or the modifiable capabilities when used by
482        *         get operations */
483       uint_least64_t    bmask;
484       /** \brief Mask of set process context capabilities */
485       uint_least64_t    ccaps;
486       /** \brief Mask of set and unset process context capabilities when used
487        *         by set operations, or the modifiable capabilities when used
488        *         by get operations */
489       uint_least64_t    cmask;
490   };
491
492   int           vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
493   int           vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
494
495   struct vc_vx_info {
496       xid_t     xid;
497       pid_t     initpid;
498   };
499
500   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
501   
502     /** \brief   Returns the context of the given process.
503      *  \ingroup syscalls
504      *
505      *  \param  pid  the process-id whose xid shall be determined;
506      *               pid==0 means the current process.
507      *  \returns     the xid of process \c pid or -1 on errors
508      */
509   xid_t         vc_get_task_xid(pid_t pid);
510
511   /** \brief   Waits for the end of a context
512    *  \ingroup syscalls
513    */
514   int           vc_wait_exit(xid_t xid);
515   
516     /* rlimit related functions */
517   
518     /** \brief  The type which is used for a single limit value.
519      *
520      *  Special values are
521      *  - VC_LIM_INFINITY ... which is the infinite value
522      *  - VC_LIM_KEEP     ... which is used to mark values which shall not be
523      *                        modified by the vc_set_rlimit() operation.
524      *
525      *  Else, the interpretation of the value depends on the corresponding
526      *  resource; it might be bytes, pages, seconds or litres of beer. */
527   typedef uint_least64_t        vc_limit_t;
528
529     /** \brief  Masks describing the supported limits. */
530   struct  vc_rlimit_mask {
531       uint_least32_t    min;    ///< masks the resources supporting a minimum limit
532       uint_least32_t    soft;   ///< masks the resources supporting a soft limit
533       uint_least32_t    hard;   ///< masks the resources supporting a hard limit
534   };
535
536     /** \brief  Returns the limits supported by the kernel */
537   int           vc_get_rlimit_mask(xid_t xid,
538                            struct vc_rlimit_mask /*@out@*/ *lim) VC_ATTR_NONNULL((2));
539
540     /** \brief  The limits of a resources.
541      *
542      *  This is a triple consisting of a minimum, soft and hardlimit. */
543   struct vc_rlimit {
544       vc_limit_t        min;    ///< the guaranted minimum of a resources
545       vc_limit_t        soft;   ///< the softlimit of a resource
546       vc_limit_t        hard;   ///< the absolute hardlimit of a resource
547   };
548
549     /** \brief   Returns the limits of \a resource.
550      *  \ingroup syscalls
551      *
552      *  \param  xid       The id of the context
553      *  \param  resource  The resource which will be queried
554      *  \param  lim       The result which will be filled with the limits
555      *
556      *  \returns 0 on success, and -1 on errors. */
557   int           vc_get_rlimit(xid_t xid, int resource,
558                       struct vc_rlimit       /*@out@*/ *lim) VC_ATTR_NONNULL((3));
559     /** \brief   Sets the limits of \a resource.
560      *  \ingroup syscalls
561      *
562      *  \param  xid       The id of the context
563      *  \param  resource  The resource which will be queried
564      *  \param  lim       The new limits
565      *
566      *  \returns 0 on success, and -1 on errors. */
567   int           vc_set_rlimit(xid_t xid, int resource,
568                       struct vc_rlimit const /*@in@*/  *lim) VC_ATTR_NONNULL((3));
569
570     /** \brief Statistics for a resource limit. */
571   struct  vc_rlimit_stat {
572       uint_least32_t    hits;    ///< number of hits on the limit
573       vc_limit_t        value;   ///< current value
574       vc_limit_t        minimum; ///< minimum value observed
575       vc_limit_t        maximum; ///< maximum value observed
576   };
577
578     /** \brief   Returns the current stats of \a resource.
579      *  \ingroup syscalls
580      *
581      *  \param  xid       The id of the context
582      *  \param  resource  The resource which will be queried
583      *  \param  stat      The result which will be filled with the stats
584      *
585      *  \returns 0 on success, and -1 on errors. */
586   int           vc_rlimit_stat(xid_t xid, int resource,
587                        struct vc_rlimit_stat /*@out@*/ *stat) VC_ATTR_NONNULL((3));
588
589     /** \brief   Resets the minimum and maximum observed values of all resources.
590      *  \ingroup syscalls
591      *
592      *  \param xid      The id of the context
593      *
594      *  \returns 0 on success, and -1 on errors. */
595   int           vc_reset_minmax(xid_t xid);
596
597     /** \brief   Parses a string describing a limit
598      *  \ingroup helper
599      *
600      *  This function parses \a str and interprets special words like \p "inf"
601      *  or suffixes. Valid suffixes are
602      *  - \p k ... 1000
603      *  - \p m ... 1000000
604      *  - \p K ... 1024
605      *  - \p M ... 1048576
606      *
607      *  \param str  The string which shall be parsed
608      *  \param res  Will be filled with the interpreted value; in errorcase,
609      *              this value is undefined.
610      *
611      *  \returns \a true, iff the string \a str could be parsed. \a res will
612      *  be filled with the interpreted value in this case. 
613      *
614      *  \pre \a str!=0 && \a res!=0
615      */
616   bool          vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res)      VC_ATTR_NONNULL((1,2));
617
618
619     /* network context */
620   struct vc_nx_info {
621       nid_t     nid;
622   };
623
624   nid_t         vc_get_task_nid(pid_t pid);
625   int           vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
626
627   struct vc_net_addr {
628       uint16_t                  vna_type;
629       uint16_t                  vna_flags;
630       uint16_t                  vna_prefix;
631       uint16_t                  vna_parent;
632       union {
633         struct {
634           struct in_addr        ip;
635           struct in_addr        mask;
636         } ipv4;
637         struct {
638           struct in6_addr       ip;
639           struct in6_addr       mask;
640         } ipv6;
641       } u;
642 #define vna_v4_ip       u.ipv4.ip
643 #define vna_v4_mask     u.ipv4.mask
644 #define vna_v6_ip       u.ipv6.ip
645 #define vna_v6_mask     u.ipv6.mask
646   };
647
648   struct vc_net_flags {
649       uint_least64_t    flagword;
650       uint_least64_t    mask;
651   };
652
653   nid_t         vc_net_create(nid_t nid);
654   int           vc_net_migrate(nid_t nid);
655
656   int           vc_net_add(nid_t nid, struct vc_net_addr const *info);
657   int           vc_net_remove(nid_t nid, struct vc_net_addr const *info);
658
659   int           vc_get_nflags(nid_t, struct vc_net_flags *);
660   int           vc_set_nflags(nid_t, struct vc_net_flags const *);
661
662   struct vc_net_caps {
663       uint_least64_t    ncaps;
664       uint_least64_t    cmask;
665   };
666
667   int           vc_get_ncaps(nid_t, struct vc_net_caps *);
668   int           vc_set_ncaps(nid_t, struct vc_net_caps const *);
669
670
671     /* iattr related functions */
672
673   int           vc_set_iattr(char const *filename, xid_t xid,
674                              uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
675
676   int           vc_fset_iattr(int fd, xid_t xid,
677                               uint_least32_t flags, uint_least32_t mask);
678
679     /** \brief   Returns information about attributes and assigned context of a file.
680      *  \ingroup syscalls
681      *
682      *  This function returns the VC_IATTR_XXX flags and about the assigned
683      *  context of a file. To request an information, the appropriate bit in
684      *  \c mask must be set and the corresponding parameter (\a xid or \a
685      *  flags) must not be NULL.
686      *
687      *  E.g. to receive the assigned context, the \c VC_IATTR_XID bit must be
688      *  set in \a mask, and \a xid must point to valid memory.
689      *
690      *  Possible flags are \c VC_IATTR_ADMIN, \c VC_IATTR_WATCH , \c VC_IATTR_HIDE,
691      *  \c VC_IATTR_BARRIER, \c VC_IATTR_IUNLINK and \c VC_IATTR_IMMUTABLE.
692      *
693      *  \param filename  The name of the file whose attributes shall be determined.
694
695      *  \param xid       When non-zero and the VC_IATTR_XID bit is set in \a mask,
696      *                   the assigned context of \a filename will be stored there.
697      *  \param flags     When non-zero, a bitmask of current attributes will be
698      *                   stored there. These attributes must be requested explicitly
699      *                   by setting the appropriate bit in \a mask
700      *  \param mask      Points to a bitmask which tells which attributes shall be
701      *                   determined. On return, it will masquerade the attributes
702      *                   which were determined.
703      *
704      *  \pre  mask!=0 && !((*mask&VC_IATTR_XID) && xid==0) && !((*mask&~VC_IATTR_XID) && flags==0) */
705   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
706                              uint_least32_t * /*@null@*/ flags,
707                              uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
708
709   int           vc_fget_iattr(int fd, xid_t * /*@null@*/ xid,
710                               uint_least32_t * /*@null@*/ flags,
711                               uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((4));
712   
713   /** \brief   Returns the context of \c filename
714    *  \ingroup syscalls
715    *
716    *  This function calls vc_get_iattr() with appropriate arguments to
717    *  determine the context of \c filename. In error-case or when no context
718    *  is assigned, \c VC_NOCTX will be returned. To differ between both cases,
719    *  \c errno must be examined.
720    *
721    *  \b WARNING: this function can modify \c errno although no error happened.
722    *
723    *  \param   filename  The file to check
724    *  \returns The assigned context, or VC_NOCTX when an error occured or no
725    *           such assignment exists. \c errno will be 0 in the latter case */
726   xid_t         vc_getfilecontext(char const *filename) VC_ATTR_NONNULL((1));
727
728
729     /* vhi related functions */
730   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
731                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
732                  vcVHI_DOMAINNAME }             vc_uts_type;
733   
734   int           vc_set_vhi_name(xid_t xid, vc_uts_type type,
735                                 char const *val, size_t len) VC_ATTR_NONNULL((3));
736   int           vc_get_vhi_name(xid_t xid, vc_uts_type type,
737                                 char *val, size_t len)       VC_ATTR_NONNULL((3));
738
739     /* namespace related functions */
740   int           vc_enter_namespace(xid_t xid, uint_least64_t mask);
741   int           vc_set_namespace(xid_t xid, uint_least64_t mask);
742   int           vc_cleanup_namespace();
743   uint_least64_t vc_get_space_mask();
744
745
746     /* disk limit related things */
747   struct vc_ctx_dlimit {
748       uint_least32_t    space_used;
749       uint_least32_t    space_total;
750       uint_least32_t    inodes_used;
751       uint_least32_t    inodes_total;
752       uint_least32_t    reserved;
753   };
754   
755
756   /** Add a disk limit to a file system. */
757   int           vc_add_dlimit(char const *filename, xid_t xid,
758                               uint_least32_t flags) VC_ATTR_NONNULL((1));
759   /** Remove a disk limit from a file system. */
760   int           vc_rem_dlimit(char const *filename, xid_t xid,
761                               uint_least32_t flags) VC_ATTR_NONNULL((1));
762
763   /** Set a disk limit. */
764   int           vc_set_dlimit(char const *filename, xid_t xid,
765                               uint_least32_t flags,
766                               struct vc_ctx_dlimit const *limits) VC_ATTR_NONNULL((1,4));
767   /** Get a disk limit. */
768   int           vc_get_dlimit(char const *filename, xid_t xid,
769                               uint_least32_t flags,
770                               struct vc_ctx_dlimit *limits) VC_ATTR_NONNULL((1));
771
772     /* scheduler related syscalls */
773   struct vc_set_sched {
774       uint_least32_t    set_mask;
775       int_least32_t     fill_rate;
776       int_least32_t     interval;
777       int_least32_t     fill_rate2;
778       int_least32_t     interval2;
779       int_least32_t     tokens;
780       int_least32_t     tokens_min;
781       int_least32_t     tokens_max;
782       int_least32_t     priority_bias;
783       int_least32_t     cpu_id;
784       int_least32_t     bucket_id;
785   };
786
787   int           vc_set_sched(xid_t xid, struct vc_set_sched const *) VC_ATTR_NONNULL((2));
788   int           vc_get_sched(xid_t xid, struct vc_set_sched *) VC_ATTR_NONNULL((2));
789
790   struct vc_sched_info {
791       int_least32_t     cpu_id;
792       int_least32_t     bucket_id;
793       uint_least64_t    user_msec;
794       uint_least64_t    sys_msec;
795       uint_least64_t    hold_msec;
796       uint_least32_t    token_usec;
797       int_least32_t     vavavoom;
798   };
799
800   int           vc_sched_info(xid_t xid, struct vc_sched_info *info) VC_ATTR_NONNULL((2));
801
802     /* misc. syscalls */
803   int           vc_set_mapping(xid_t xid, const char *device, const char *target, uint32_t flags);
804
805
806   /** \brief    Information about parsing errors
807    *  \ingroup  helper
808    */
809   struct vc_err_listparser {
810       char const        *ptr;           ///< Pointer to the first character of an erroneous string
811       size_t            len;            ///< Length of the erroneous string
812   };
813
814   /** \brief   Converts a single string into bcapability
815    *  \ingroup helper
816    *
817    *  \param   str   The string to be parsed;
818    *                 both "CAP_xxx" and "xxx" will be accepted
819    *  \param   len   The length of the string, or \c 0 for automatic detection
820    *
821    *  \returns 0 on error; a bitmask on success
822    *  \pre     \a str != 0
823    */
824   uint_least64_t        vc_text2bcap(char const *str, size_t len);
825
826   /** \brief   Converts the lowest bit of a bcapability or the entire value
827    *           (when possible) to a textual representation
828    *  \ingroup helper
829    *
830    *  \param   val  The string to be converted; on success, the detected bit(s)
831    *                will be unset, in errorcase only the lowest set bit
832    *
833    *  \returns A textual representation of \a val resp. of its lowest set bit;
834    *           or \c NULL in errorcase.
835    *  \pre     \a val!=0
836    *  \post    \a *val<sub>old</sub> \c != 0  \c <-->
837    *               \a *val<sub>old</sub> > \a *val<sub>new</sub>
838    *  \post    \a *val<sub>old</sub> \c == 0  \c --->  \a result == 0
839    */
840   char const *  vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
841
842   /** \brief   Converts a string into a bcapability-bitmask
843    *  \ingroup helper
844    *
845    *  Syntax of \a str: \verbinclude list2xxx.syntax
846    *
847    *  When the \c `~' prefix is used, the bits will be unset and a `~' after
848    *  another `~' will cancel both ones. The \c `^' prefix specifies a
849    *  bitnumber instead of a bitmask.
850    *
851    *  "literal name" is everything which will be accepted by the
852    *  vc_text2bcap() function. The special values for \c NAME will be
853    *  recognized case insensitively
854    *
855    *  \param  str   The string to be parsed
856    *  \param  len   The length of the string, or \c 0 for automatic detection
857    *  \param  err   Pointer to a structure for error-information, or \c NULL.
858    *  \param  cap   Pointer to a vc_ctx_caps structure holding the results;
859    *                only the \a bcaps and \a bmask fields will be changed and
860    *                already set values will not be honored. When an error
861    *                occured, \a cap will have the value of all processed valid
862    *                \c BCAP parts.
863    *
864    *  \returns 0 on success, -1 on error. In error case, \a err will hold
865    *           position and length of the first not understood BCAP part
866    *  \pre     \a str != 0 && \a cap != 0;
867    *           \a cap->bcaps and \a cap->bmask must be initialized
868    */
869   int                   vc_list2bcap(char const *str, size_t len,
870                                      struct vc_err_listparser *err,
871                                      struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
872
873   uint_least64_t        vc_text2ccap(char const *, size_t len);
874   char const *          vc_loccap2text(uint_least64_t *);
875   int                   vc_list2ccap(char const *, size_t len,
876                                      struct vc_err_listparser *err,
877                                      struct vc_ctx_caps *);
878
879   int                   vc_list2cflag(char const *, size_t len,
880                                      struct vc_err_listparser *err,
881                                      struct vc_ctx_flags *flags);
882   uint_least64_t        vc_text2cflag(char const *, size_t len);
883   char const *          vc_locflag2text(uint_least64_t *);
884   
885   uint_least32_t        vc_list2cflag_compat(char const *, size_t len,
886                                             struct vc_err_listparser *err);
887   uint_least32_t        vc_text2cflag_compat(char const *, size_t len);
888   char const *          vc_hicflag2text_compat(uint_least32_t);
889
890   int                   vc_text2cap(char const *);
891   char const *          vc_cap2text(unsigned int);
892
893   
894   int                   vc_list2nflag(char const *, size_t len,
895                                      struct vc_err_listparser *err,
896                                      struct vc_net_flags *flags);
897   uint_least64_t        vc_text2nflag(char const *, size_t len);
898   char const *          vc_lonflag2text(uint_least64_t *);
899
900   uint_least64_t        vc_text2ncap(char const *, size_t len);
901   char const *          vc_loncap2text(uint_least64_t *);
902   int                   vc_list2ncap(char const *, size_t len,
903                                      struct vc_err_listparser *err,
904                                      struct vc_net_caps *);
905
906   uint_least64_t                vc_get_insecurebcaps() VC_ATTR_CONST;
907   inline static uint_least64_t  vc_get_insecureccaps() {
908     return ~(VC_VXC_SET_UTSNAME|VC_VXC_RAW_ICMP);
909   }
910   
911   inline static int     vc_setfilecontext(char const *filename, xid_t xid) {
912     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
913   }
914
915
916   uint_least32_t        vc_text2personalityflag(char const *str,
917                                                 size_t len) VC_ATTR_NONNULL((1));
918
919   char const *          vc_lopersonality2text(uint_least32_t *) VC_ATTR_NONNULL((1));
920   
921   int                   vc_list2personalityflag(char const /*@in@*/ *,
922                                                 size_t len,
923                                                 uint_least32_t /*@out@*/ *personality,
924                                                 struct vc_err_listparser /*@out@*/ *err) VC_ATTR_NONNULL((1,3));
925
926   uint_least32_t        vc_str2personalitytype(char const /*@in@*/*,
927                                                size_t len) VC_ATTR_NONNULL((1));
928
929     
930   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
931                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
932                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI,
933                  vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER, vcFEATURE_VWAIT,
934                  vcFEATURE_VNET, vcFEATURE_VSTAT }
935     vcFeatureSet;
936
937   bool          vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
938   bool          vc_isSupportedString(char const *);
939
940   
941   typedef enum { vcTYPE_INVALID, vcTYPE_MAIN, vcTYPE_WATCH,
942                  vcTYPE_STATIC, vcTYPE_DYNAMIC }
943     vcXidType;
944   
945   vcXidType     vc_getXIDType(xid_t xid) VC_ATTR_CONST;
946
947     /** Returns true iff \a xid is a dynamic xid */
948   bool          vc_is_dynamic_xid(xid_t xid);
949
950
951   /* The management part */
952
953 #define VC_LIMIT_VSERVER_NAME_LEN       1024
954   
955   typedef enum { vcCFG_NONE, vcCFG_AUTO,
956                  vcCFG_LEGACY,
957                  vcCFG_RECENT_SHORT,
958                  vcCFG_RECENT_FULL }            vcCfgStyle;
959
960
961   /** Maps an xid given at '--xid' options to an xid_t */
962   xid_t         vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
963   /** Maps a  nid given at '--nid' options to a  nid_t */
964   nid_t         vc_nidopt2nid(char const *, bool honor_static, char const **err_info);
965
966   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
967   
968   /** Resolves the name of the vserver. The result will be allocated and must
969       be freed by the caller. */
970   char *        vc_getVserverName(char const *id, vcCfgStyle style);
971
972   /** Returns the path of the vserver configuration directory. When the given
973    *  vserver does not exist, or when it does not have such a directory, NULL
974    *  will be returned. Else, the result will be allocated and must be freed
975    *  by the caller. */
976   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
977
978   /** Returns the path of the configuration directory for the given
979    *  application. The result will be allocated and must be freed by the
980    *  caller. */
981   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
982
983   /** Returns the path to the vserver root-directory. The result will be
984    *  allocated and must be freed by the caller. */
985   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
986
987   /** Returns the ctx of the given vserver. When vserver is not running and
988    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
989    *  'honor_static' is true and a static assignment exists, those value will
990    *  be returned. Else, the result will be VC_NOCTX.
991    *
992    *  When 'is_running' is not null, the status of the vserver will be
993    *  assigned to this variable. */
994   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
995                                  bool honor_static, bool /*@null@*/ *is_running);
996
997   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
998       be used as the directory holding the mapping-links; when NULL, the
999       default value will be assumed.  The result will be allocated and must be
1000       freed by the caller. */
1001   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
1002                                    /*@null@*/char const *revdir);
1003
1004   int           vc_compareVserverById(char const *lhs, vcCfgStyle lhs_style,
1005                                       char const *rhs, vcCfgStyle rhs_style);
1006  
1007 #define vcSKEL_INTERFACES       1u
1008 #define vcSKEL_PKGMGMT          2u
1009 #define vcSKEL_FILESYSTEM       4u
1010
1011   /** Create a basic configuration skeleton for a vserver plus toplevel
1012    *  directories for pkgmanagemt and filesystem (when requested). */
1013   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
1014
1015
1016 #ifdef __cplusplus
1017 }
1018 #endif
1019
1020 #undef VC_ATTR_PURE
1021 #undef VC_ATTR_ALWAYSINLINE
1022 #undef VC_ATTR_NORETURN
1023 #undef VC_ATTR_UNUSED
1024 #undef VC_ATTR_NONNULL
1025
1026 #endif