added Vector_zeroEnd() function
[util-vserver.git] / util-vserver / 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 /** the value which means a random (the next free) ctx */
64 #define VC_DYNAMIC_XID          ((xid_t)(-1))
65 /** the value which means the current ctx */
66 #define VC_SAMECTX              ((xid_t)(-2))
67
68 #define VC_NONID                ((nid_t)(-1))
69 #define VC_DYNAMIC_NID          ((nid_t)(-1))
70
71 #define VC_LIM_INFINITY         (~0ULL)
72 #define VC_LIM_KEEP             (~1ULL)
73
74   
75 #ifndef S_CTX_INFO_LOCK
76 #  define S_CTX_INFO_LOCK       1
77 #endif
78
79 #ifndef S_CTX_INFO_SCHED
80 #  define S_CTX_INFO_SCHED      2
81 #endif
82
83 #ifndef S_CTX_INFO_NPROC
84 #  define S_CTX_INFO_NPROC      4
85 #endif
86
87 #ifndef S_CTX_INFO_PRIVATE
88 #  define S_CTX_INFO_PRIVATE    8
89 #endif
90
91 #ifndef S_CTX_INFO_INIT
92 #  define S_CTX_INFO_INIT       16
93 #endif
94
95 #ifndef S_CTX_INFO_HIDEINFO
96 #  define S_CTX_INFO_HIDEINFO   32
97 #endif
98
99 #ifndef S_CTX_INFO_ULIMIT
100 #  define S_CTX_INFO_ULIMIT     64
101 #endif
102
103 #ifndef S_CTX_INFO_NAMESPACE
104 #  define S_CTX_INFO_NAMESPACE  128
105 #endif
106
107 #define VC_CAP_CHOWN                     0
108 #define VC_CAP_DAC_OVERRIDE              1
109 #define VC_CAP_DAC_READ_SEARCH           2
110 #define VC_CAP_FOWNER                    3
111 #define VC_CAP_FSETID                    4
112 #define VC_CAP_KILL                      5
113 #define VC_CAP_SETGID                    6
114 #define VC_CAP_SETUID                    7
115 #define VC_CAP_SETPCAP                   8
116 #define VC_CAP_LINUX_IMMUTABLE           9
117 #define VC_CAP_NET_BIND_SERVICE         10
118 #define VC_CAP_NET_BROADCAST            11
119 #define VC_CAP_NET_ADMIN                12
120 #define VC_CAP_NET_RAW                  13
121 #define VC_CAP_IPC_LOCK                 14
122 #define VC_CAP_IPC_OWNER                15
123 #define VC_CAP_SYS_MODULE               16
124 #define VC_CAP_SYS_RAWIO                17
125 #define VC_CAP_SYS_CHROOT               18
126 #define VC_CAP_SYS_PTRACE               19
127 #define VC_CAP_SYS_PACCT                20
128 #define VC_CAP_SYS_ADMIN                21
129 #define VC_CAP_SYS_BOOT                 22
130 #define VC_CAP_SYS_NICE                 23
131 #define VC_CAP_SYS_RESOURCE             24
132 #define VC_CAP_SYS_TIME                 25
133 #define VC_CAP_SYS_TTY_CONFIG           26
134 #define VC_CAP_MKNOD                    27
135 #define VC_CAP_LEASE                    28
136 #define VC_CAP_QUOTACTL                 29
137
138 #define VC_IMMUTABLE_FILE_FL            0x0000010lu
139 #define VC_IMMUTABLE_LINK_FL            0x0008000lu
140 #define VC_IMMUTABLE_ALL                (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
141
142 #define VC_IATTR_XID                    0x01000000u
143
144 #define VC_IATTR_ADMIN                  0x00000001u
145 #define VC_IATTR_WATCH                  0x00000002u
146 #define VC_IATTR_HIDE                   0x00000004u
147 #define VC_IATTR_FLAGS                  0x00000007u
148
149 #define VC_IATTR_BARRIER                0x00010000u
150 #define VC_IATTR_IUNLINK                0x00020000u
151 #define VC_IATTR_IMMUTABLE              0x00040000u
152
153
154 // the flags
155 #define VC_VXF_INFO_LOCK                0x00000001ull
156 #define VC_VXF_INFO_NPROC               0x00000004ull
157 #define VC_VXF_INFO_PRIVATE             0x00000008ull
158 #define VC_VXF_INFO_INIT                0x00000010ull
159
160 #define VC_VXF_INFO_HIDEINFO            0x00000020ull
161 #define VC_VXF_INFO_ULIMIT              0x00000040ull
162 #define VC_VXF_INFO_NAMESPACE           0x00000080ull
163
164 #define VC_VXF_SCHED_HARD               0x00000100ull
165 #define VC_VXF_SCHED_PRIO               0x00000200ull
166 #define VC_VXF_SCHED_PAUSE              0x00000400ull
167
168 #define VC_VXF_VIRT_MEM                 0x00010000ull
169 #define VC_VXF_VIRT_UPTIME              0x00020000ull
170 #define VC_VXF_VIRT_CPU                 0x00040000ull
171
172 #define VC_VXF_HIDE_MOUNT               0x01000000ull
173 #define VC_VXF_HIDE_NETIF               0x02000000ull
174
175 #define VC_VXF_STATE_SETUP              (1ULL<<32)
176 #define VC_VXF_STATE_INIT               (1ULL<<33)
177
178 // the ccapabilities
179 #define VC_VXC_SET_UTSNAME              0x00000001ull
180 #define VC_VXC_SET_RLIMIT               0x00000002ull
181
182 #define VC_VXC_ICMP_PING                0x00000100ull
183
184 #define VC_VXC_SECURE_MOUNT             0x00010000ull
185
186
187 /** \defgroup  syscalls Syscall wrappers
188  *  Functions which are calling the vserver syscall directly. */
189
190 /** \defgroup  helper   Helper functions
191  *  Functions which are doing general helper tasks like parameter parsing. */
192
193 /** \typedef  an_unsigned_integer_type  xid_t
194  *  The identifier of a context. */
195
196 #ifdef IS_DOXYGEN
197 typedef an_unsigned_integer_type        xid_t;
198 typedef an_unsigned_integer_type        nid_t;
199 #endif
200
201 #ifdef __cplusplus
202 extern "C" {
203 #endif
204
205   struct vc_ip_mask_pair {
206     uint32_t    ip;
207       uint32_t  mask;
208   };
209
210     /** \brief   Returns the version of the current kernel API.
211      *  \ingroup syscalls
212      *  \returns The versionnumber of the kernel API
213      */
214   int   vc_get_version();
215   
216     /** \brief   Moves current process into a context
217      *  \ingroup syscalls
218      *
219      *  Puts current process into context \a ctx, removes the capabilities
220      *  given in \a remove_cap and sets \a flags.
221      *
222      *  \param ctx         The new context; special values for are
223      *  - VC_SAMECTX      which means the current context (just for changing caps and flags)
224      *  - VC_DYNAMIC_XID  which means the next free context; this value can be used by
225      *                    ordinary users also
226      *  \param remove_cap  The linux capabilities which will be \b removed.
227      *  \param flags       Special flags which will be set.
228      *
229      *  \returns  The new context-id, or VC_NOCTX on errors; errno
230      *            will be set appropriately
231      *
232      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
233   xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
234
235     /** \brief  Sets the ipv4root information.
236      *  \ingroup syscalls
237      *  \pre    \a nb < NB_IPV4ROOT && \a ips != 0 */
238   int   vc_set_ipv4root(uint32_t  bcast, size_t nb,
239                         struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
240
241     /** \brief  Returns the value of NB_IPV4ROOT.
242      *  \ingroup helper
243      *
244      *  This function returns the value of NB_IPV4ROOT which was used when the
245      *  library was built, but \b not the value which is used by the currently
246      *  running kernel. */
247   size_t        vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
248
249     /** \brief   Creates a context without starting it.
250      *  \ingroup syscalls
251      *
252      *  This functions initializes a new context. When already in a freshly
253      *  created context, this old context will be discarded.
254      *
255      *  \param xid  The new context; special values are:
256      *  - VC_DYNAMIC_XID which means to create a dynamic context
257      *
258      *  \returns the xid of the created context, or VC_NOCTX on errors. errno
259      *           will be set appropriately. */
260   xid_t vc_ctx_create(xid_t xid);
261
262     /** \brief   Moves the current process into the specified context.
263      *  \ingroup syscalls
264      *
265      *  \param   xid  The new context
266      *  \returns 0 on success, -1 on errors */
267   int   vc_ctx_migrate(xid_t xid);
268   
269     /* rlimit related functions */
270   
271     /** \brief  The type which is used for a single limit value.
272      *
273      *  Special values are
274      *  - VC_LIM_INFINITY ... which is the infinite value
275      *  - VC_LIM_KEEP     ... which is used to mark values which shall not be
276      *                        modified by the vc_set_rlimit() operation.
277      *
278      *  Else, the interpretation of the value depends on the corresponding
279      *  resource; it might be bytes, pages, seconds or litres of beer. */
280   typedef uint_least64_t        vc_limit_t;
281
282     /** \brief  The limits of a resources.
283      *
284      *  This is a triple consisting of a minimum, soft and hardlimit. */
285   struct vc_rlimit {
286       vc_limit_t        min;    ///< the guaranted minimum of a resources
287       vc_limit_t        soft;   ///< the softlimit of a resource
288       vc_limit_t        hard;   ///< the absolute hardlimit of a resource
289   };
290
291     /** \brief  Masks describing the supported limits. */
292   struct  vc_rlimit_mask {
293       uint_least32_t    min;    ///< masks the resources supporting a minimum limit
294       uint_least32_t    soft;   ///< masks the resources supporting a soft limit
295       uint_least32_t    hard;   ///< masks the resources supporting a hard limit
296   };
297
298     /** \brief   Returns the limits of \a resource.
299      *  \ingroup syscalls
300      *
301      *  \param  xid       The id of the context
302      *  \param  resource  The resource which will be queried
303      *  \param  lim       The result which will be filled with the limits
304      *
305      *  \returns 0 on success, and -1 on errors. */
306   int   vc_get_rlimit(xid_t xid, int resource,
307                       struct vc_rlimit       /*@out@*/ *lim) VC_ATTR_NONNULL((3));
308     /** \brief   Sets the limits of \a resource.
309      *  \ingroup syscalls
310      *
311      *  \param  xid       The id of the context
312      *  \param  resource  The resource which will be queried
313      *  \param  lim       The new limits
314      *
315      *  \returns 0 on success, and -1 on errors. */
316   int   vc_set_rlimit(xid_t xid, int resource,
317                       struct vc_rlimit const /*@in@*/  *lim) VC_ATTR_NONNULL((3));
318   int   vc_get_rlimit_mask(xid_t xid,
319                            struct vc_rlimit_mask *lim)       VC_ATTR_NONNULL((2));
320     /** \brief   Parses a string describing a limit
321      *  \ingroup helper
322      *
323      *  This function parses \a str and interprets special words like \p "inf"
324      *  or suffixes. Valid suffixes are
325      *  - \p k ... 1000
326      *  - \p m ... 1000000
327      *  - \p K ... 1024
328      *  - \p M ... 1048576
329      *
330      *  \param str  The string which shall be parsed
331      *  \param res  Will be filled with the interpreted value; in errorcase,
332      *              this value is undefined.
333      *
334      *  \returns \a true, iff the string \a str could be parsed. \a res will
335      *  be filled with the interpreted value in this case. 
336      *
337      *  \pre \a str!=0 && \a res!=0
338      */
339   bool  vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res)      VC_ATTR_NONNULL((1,2));
340
341
342   /** \brief    Sends a signal to a context/pid
343    *  \ingroup  syscalls
344    *
345    *  Special values for \a pid are:
346    *  - -1   which means every process in ctx except the init-process
347    *  -  0   which means every process in ctx inclusive the init-process */
348   int   vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
349
350
351   struct vc_nx_info {
352       nid_t     nid;
353   };
354   
355   nid_t         vc_get_task_nid(pid_t pid);
356   int           vc_get_nx_info(nid_t nid, struct vc_nx_info *) VC_ATTR_NONNULL((2));
357
358   typedef enum { vcNET_IPV4, vcNET_IPV6, vcNET_IPV4R, vcNET_IPV6R }     vc_net_nx_type;
359   
360   struct vc_net_nx {
361       vc_net_nx_type    type;
362       size_t            count;
363       uint32_t          ip;
364       uint32_t          mask;
365   };
366
367   nid_t         vc_net_create(nid_t nid);
368   int           vc_net_migrate(nid_t nid);
369
370   int           vc_net_add(nid_t nid, struct vc_net_nx const *info);
371   int           vc_net_remove(nid_t nid, struct vc_net_nx const *info);
372
373   struct vc_net_flags {
374       uint_least64_t    flagword;
375       uint_least64_t    mask;
376   };
377   
378   int           vc_get_nflags(nid_t, struct vc_net_flags *);
379   int           vc_set_nflags(nid_t, struct vc_net_flags const *);
380
381   
382   struct vc_net_caps {
383       uint_least64_t    ncaps;
384       uint_least64_t    cmask;
385   };
386
387   int           vc_get_ncaps(nid_t, struct vc_net_caps *);
388   int           vc_set_ncaps(nid_t, struct vc_net_caps const *);
389
390
391   
392
393   int           vc_set_iattr(char const *filename, xid_t xid,
394                              uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
395   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
396                              uint_least32_t * /*@null@*/ flags,
397                              uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
398
399   struct vc_vx_info {
400       xid_t     xid;
401       pid_t     initpid;
402   };
403   
404     /** Returns the context of the given process. pid==0 means the current process. */
405   xid_t         vc_get_task_xid(pid_t pid);
406   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
407
408
409   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
410                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
411                  vcVHI_DOMAINNAME }             vc_uts_type;
412   
413   int           vc_set_vhi_name(xid_t xid, vc_uts_type type,
414                                 char const *val, size_t len) VC_ATTR_NONNULL((3));
415   int           vc_get_vhi_name(xid_t xid, vc_uts_type type,
416                                 char *val, size_t len)       VC_ATTR_NONNULL((3));
417
418     /** Returns true iff \a xid is a dynamic xid */
419   bool          vc_is_dynamic_xid(xid_t xid);
420
421   int           vc_enter_namespace(xid_t xid);
422   int           vc_set_namespace();
423   int           vc_cleanup_namespace();
424
425   
426   /** \brief    Flags of process-contexts
427    */
428   struct  vc_ctx_flags {
429       /** \brief Mask of set context flags */
430       uint_least64_t    flagword;
431       /** \brief Mask of set and unset context flags when used by set
432        *         operations, or modifiable flags when used by get
433        *         operations */
434       uint_least64_t    mask;
435   };
436
437   /** \brief    Capabilities of process-contexts */
438   struct  vc_ctx_caps {
439       /** \brief  Mask of set common system capabilities */
440       uint_least64_t    bcaps;
441       /** \brief Mask of set and unset common system capabilities when used by
442        *         set operations, or the modifiable capabilities when used by
443        *         get operations */
444       uint_least64_t    bmask;
445       /** \brief Mask of set process context capabilities */
446       uint_least64_t    ccaps;
447       /** \brief Mask of set and unset process context capabilities when used
448        *         by set operations, or the modifiable capabilities when used
449        *         by get operations */
450       uint_least64_t    cmask;
451   };
452
453   /** \brief    Information about parsing errors
454    */
455   struct vc_err_listparser {
456       char const        *ptr;           ///< Pointer to the first character of an erroneous string
457       size_t            len;            ///< Length of the erroneous string
458   };
459  
460   int                   vc_get_cflags(xid_t xid, struct vc_ctx_flags *)       VC_ATTR_NONNULL((2));
461   int                   vc_set_cflags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
462
463   int                   vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
464   int                   vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
465
466   /** \brief   Converts a single string into bcapability
467    *  \ingroup helper
468    *
469    *  \param   str   The string to be parsed;
470    *                 both "CAP_xxx" and "xxx" will be accepted
471    *  \param   len   The length of the string, or \c 0 for automatic detection
472    *
473    *  \returns 0 on error; a bitmask on success
474    *  \pre     \a str != 0
475    */
476   uint_least64_t        vc_text2bcap(char const *str, size_t len);
477
478   /** \brief   Converts the lowest bit of a bcapability or the entire value
479    *           (when possible) to a textual representation
480    *  \ingroup helper
481    *
482    *  \param   val  The string to be converted; on success, the detected bit(s)
483    *                will be unset, in errorcase only the lowest set bit
484    *
485    *  \returns A textual representation of \a val resp. of its lowest set bit;
486    *           or \c NULL in errorcase.
487    *  \pre     \a val!=0
488    *  \post    \a *val<sub>old</sub> \c != 0  \c <-->
489    *               \a *val<sub>old</sub> > \a *val<sub>new</sub>
490    *  \post    \a *val<sub>old</sub> \c == 0  \c --->  \a result == 0
491    */
492   char const *  vc_lobcap2text(uint_least64_t *val) VC_ATTR_NONNULL((1));
493
494   /** \brief   Converts a string into a bcapability-bitmask
495    *  \ingroup helper
496    *
497    *  Syntax of \a str: \verbinclude list2xxx.syntax
498    *
499    *  When the \c `~' prefix is used, the bits will be unset and a `~' after
500    *  another `~' will cancel both ones. The \c `^' prefix specifies a
501    *  bitnumber instead of a bitmask.
502    *
503    *  "literal name" is everything which will be accepted by the
504    *  vc_text2bcap() function. The special values for \c NAME will be
505    *  recognized case insensitively
506    *
507    *  \param  str   The string to be parsed
508    *  \param  len   The length of the string, or \c 0 for automatic detection
509    *  \param  err   Pointer to a structure for error-information, or \c NULL.
510    *  \param  cap   Pointer to a vc_ctx_caps structure holding the results;
511    *                only the \a bcaps and \a bmask fields will be changed and
512    *                already set values will not be honored. When an error
513    *                occured, \a cap will have the value of all processed valid
514    *                \c BCAP parts.
515    *
516    *  \returns 0 on success, -1 on error. In error case, \a err will hold
517    *           position and length of the first not understood BCAP part
518    *  \pre     \a str != 0 && \a cap != 0;
519    *           \a cap->bcaps and \a cap->bmask must be initialized
520    */
521   int                   vc_list2bcap(char const *str, size_t len,
522                                      struct vc_err_listparser *err,
523                                      struct vc_ctx_caps *cap) VC_ATTR_NONNULL((1,4));
524
525   uint_least64_t        vc_text2ccap(char const *, size_t len);
526   char const *          vc_loccap2text(uint_least64_t *);
527   int                   vc_list2ccap(char const *, size_t len,
528                                      struct vc_err_listparser *err,
529                                      struct vc_ctx_caps *);
530
531   int                   vc_list2cflag(char const *, size_t len,
532                                      struct vc_err_listparser *err,
533                                      struct vc_ctx_flags *flags);
534   uint_least64_t        vc_text2cflag(char const *, size_t len);
535   char const *          vc_locflag2text(uint_least64_t *);
536   
537   uint_least32_t        vc_list2cflag_compat(char const *, size_t len,
538                                             struct vc_err_listparser *err);
539   uint_least32_t        vc_text2cflag_compat(char const *, size_t len);
540   char const *          vc_hicflag2text_compat(uint_least32_t);
541
542   int                   vc_text2cap(char const *);
543   char const *          vc_cap2text(unsigned int);
544
545   
546   int                   vc_list2nflag(char const *, size_t len,
547                                      struct vc_err_listparser *err,
548                                      struct vc_net_flags *flags);
549   uint_least64_t        vc_text2nflag(char const *, size_t len);
550   char const *          vc_lonflag2text(uint_least64_t *);
551
552   uint_least64_t        vc_text2ncap(char const *, size_t len);
553   char const *          vc_loncap2text(uint_least64_t *);
554   int                   vc_list2ncap(char const *, size_t len,
555                                      struct vc_err_listparser *err,
556                                      struct vc_net_caps *);
557
558   uint_least64_t                vc_get_insecurebcaps() VC_ATTR_CONST;
559   inline static uint_least64_t  vc_get_insecureccaps() {
560     return ~(VC_VXC_SET_UTSNAME|VC_VXC_ICMP_PING);
561   }
562   
563   inline static int     vc_setfilecontext(char const *filename, xid_t xid) {
564     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
565   }
566   
567   inline static xid_t   vc_getfilecontext(char const *filename) {
568     xid_t       res;
569     if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
570     return res;
571   }
572
573
574   struct vc_set_sched {
575       int32_t   fill_rate;
576       int32_t   interval;
577       int32_t   tokens;
578       int32_t   tokens_min;
579       int32_t   tokens_max;
580       uint64_t  cpu_mask;
581   };
582
583   int           vc_set_sched(xid_t xid, struct vc_set_sched const *);
584   
585   
586   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
587                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
588                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI,
589                  vcFEATURE_VSHELPER0, vcFEATURE_VSHELPER }
590     vcFeatureSet;
591
592   bool          vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
593   bool          vc_isSupportedString(char const *);
594
595   /* The management part */
596
597 #define VC_LIMIT_VSERVER_NAME_LEN       1024
598   
599   typedef enum { vcCFG_NONE, vcCFG_AUTO,
600                  vcCFG_LEGACY,
601                  vcCFG_RECENT_SHORT,
602                  vcCFG_RECENT_FULL }            vcCfgStyle;
603
604
605   /** Maps an xid given at '--xid' options to an xid_t */
606   xid_t         vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
607
608   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
609   
610   /** Resolves the name of the vserver. The result will be allocated and must
611       be freed by the caller. */
612   char *        vc_getVserverName(char const *id, vcCfgStyle style);
613
614   /** Returns the path of the vserver configuration directory. When the given
615    *  vserver does not exist, or when it does not have such a directory, NULL
616    *  will be returned. Else, the result will be allocated and must be freed
617    *  by the caller. */
618   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
619
620   /** Returns the path of the configuration directory for the given
621    *  application. The result will be allocated and must be freed by the
622    *  caller. */
623   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
624
625   /** Returns the path to the vserver root-directory. The result will be
626    *  allocated and must be freed by the caller. */
627   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
628
629   /** Returns the ctx of the given vserver. When vserver is not running and
630    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
631    *  'honor_static' is true and a static assignment exists, those value will
632    *  be returned. Else, the result will be VC_NOCTX.
633    *
634    *  When 'is_running' is not null, the status of the vserver will be
635    *  assigned to this variable. */
636   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
637                                  bool honor_static, bool /*@null@*/ *is_running);
638
639   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
640       be used as the directory holding the mapping-links; when NULL, the
641       default value will be assumed.  The result will be allocated and must be
642       freed by the caller. */
643   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
644                                    /*@null@*/char const *revdir);
645
646 #define vcSKEL_INTERFACES       1u
647 #define vcSKEL_PKGMGMT          2u
648 #define vcSKEL_FILESYSTEM       4u
649   
650   /** Create a basic configuration skeleton for a vserver plus toplevel
651    *  directories for pkgmanagemt and filesystem (when requested). */
652   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
653   
654 #ifdef __cplusplus
655 }
656 #endif
657
658 #undef VC_ATTR_PURE
659 #undef VC_ATTR_ALWAYSINLINE
660 #undef VC_ATTR_NORETURN
661 #undef VC_ATTR_UNUSED
662 #undef VC_ATTR_NONNULL
663
664 #endif