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