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