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