lib/vserver.h

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