lib/vserver.h

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