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