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