lib/vserver.h

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