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