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