53e7481c19dbb9270e6b1269e3e3aab177765b90
[util-vserver.git] / util-vserver / lib / vserver.h
1 /* $Id$
2
3 *  Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
4 *   
5 *  This program is free software; you can redistribute it and/or modify
6 *  it under the terms of the GNU General Public License as published by
7 *  the Free Software Foundation; either version 2, or (at your option)
8 *  any later version.
9 *   
10 *  This program is distributed in the hope that it will be useful,
11 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 *  GNU General Public License for more details.
14 *   
15 *  You should have received a copy of the GNU General Public License
16 *  along with this program; if not, write to the Free Software
17 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20 /** \file vserver.h
21  *  \brief The public interface of the the libvserver library.
22  */
23
24 #ifndef H_VSERVER_SYSCALL_H
25 #define H_VSERVER_SYSCALL_H
26
27 #include <stdint.h>
28 #include <stdlib.h>
29 #include <stdbool.h>
30 #include <sys/types.h>
31
32 #ifndef IS_DOXYGEN
33 #if defined(__GNUC__)
34 #  define VC_ATTR_UNUSED                __attribute__((__unused__))
35 #  define VC_ATTR_NORETURN              __attribute__((__noreturn__))
36 #  define VC_ATTR_CONST                 __attribute__((__const__))
37 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30300
38 #    define VC_ATTR_NONNULL(ARGS)       __attribute__((__nonnull__ ARGS))
39 #    define VC_ATTR_ALWAYSINLINE        __attribute__((__always_inline__))
40 #  else
41 #    define VC_ATTR_NONNULL(ARGS)
42 #    define VC_ATTR_ALWAYSINLINE
43 #  endif
44 #  if __GNUC__*0x10000 + __GNUC_MINOR__*0x100 + __GNUC_PATCHLEVEL__ >= 0x30303
45 #    define VC_ATTR_PURE                __attribute__((__pure__))
46 #  else
47 #    define VC_ATTR_PURE
48 #  endif
49 #else
50 #  define VC_ATTR_NONNULL(ARGS)
51 #  define VC_ATTR_UNUSED
52 #  define VC_ATTR_NORETURN
53 #  define VC_ATTR_ALWAYSINLINE
54 #  define VC_ATTR_PURE
55 #  define VC_ATTR_CONST
56 #endif
57 #endif  // IS_DOXYGEN
58
59 /** the value which is returned in error-case (no ctx found) */
60 #define VC_NOCTX                ((xid_t)(-1))
61 /** the value which means a random (the next free) ctx */
62 #define VC_DYNAMIC_XID          ((xid_t)(-1))
63 /** the value which means the current ctx */
64 #define VC_SAMECTX              ((xid_t)(-2))
65
66 #define VC_LIM_INFINITY         (~0ULL)
67 #define VC_LIM_KEEP             (~1ULL)
68
69   
70 #ifndef S_CTX_INFO_LOCK
71 #  define S_CTX_INFO_LOCK       1
72 #endif
73
74 #ifndef S_CTX_INFO_SCHED
75 #  define S_CTX_INFO_SCHED      2
76 #endif
77
78 #ifndef S_CTX_INFO_NPROC
79 #  define S_CTX_INFO_NPROC      4
80 #endif
81
82 #ifndef S_CTX_INFO_PRIVATE
83 #  define S_CTX_INFO_PRIVATE    8
84 #endif
85
86 #ifndef S_CTX_INFO_INIT
87 #  define S_CTX_INFO_INIT       16
88 #endif
89
90 #ifndef S_CTX_INFO_HIDEINFO
91 #  define S_CTX_INFO_HIDEINFO   32
92 #endif
93
94 #ifndef S_CTX_INFO_ULIMIT
95 #  define S_CTX_INFO_ULIMIT     64
96 #endif
97
98 #ifndef S_CTX_INFO_NAMESPACE
99 #  define S_CTX_INFO_NAMESPACE  128
100 #endif
101
102 #define VC_CAP_CHOWN                     0
103 #define VC_CAP_DAC_OVERRIDE              1
104 #define VC_CAP_DAC_READ_SEARCH           2
105 #define VC_CAP_FOWNER                    3
106 #define VC_CAP_FSETID                    4
107 #define VC_CAP_KILL                      5
108 #define VC_CAP_SETGID                    6
109 #define VC_CAP_SETUID                    7
110 #define VC_CAP_SETPCAP                   8
111 #define VC_CAP_LINUX_IMMUTABLE           9
112 #define VC_CAP_NET_BIND_SERVICE         10
113 #define VC_CAP_NET_BROADCAST            11
114 #define VC_CAP_NET_ADMIN                12
115 #define VC_CAP_NET_RAW                  13
116 #define VC_CAP_IPC_LOCK                 14
117 #define VC_CAP_IPC_OWNER                15
118 #define VC_CAP_SYS_MODULE               16
119 #define VC_CAP_SYS_RAWIO                17
120 #define VC_CAP_SYS_CHROOT               18
121 #define VC_CAP_SYS_PTRACE               19
122 #define VC_CAP_SYS_PACCT                20
123 #define VC_CAP_SYS_ADMIN                21
124 #define VC_CAP_SYS_BOOT                 22
125 #define VC_CAP_SYS_NICE                 23
126 #define VC_CAP_SYS_RESOURCE             24
127 #define VC_CAP_SYS_TIME                 25
128 #define VC_CAP_SYS_TTY_CONFIG           26
129 #define VC_CAP_MKNOD                    27
130 #define VC_CAP_LEASE                    28
131 #define VC_CAP_QUOTACTL                 29
132
133 #define VC_IMMUTABLE_FILE_FL            0x00000010l
134 #define VC_IMMUTABLE_LINK_FL            0x00008000l
135 #define VC_IMMUTABLE_ALL                (VC_IMMUTABLE_LINK_FL|VC_IMMUTABLE_FILE_FL)
136
137 #define VC_IATTR_XID                    0x01000000
138
139 #define VC_IATTR_ADMIN                  0x00000001
140 #define VC_IATTR_WATCH                  0x00000002
141 #define VC_IATTR_HIDE                   0x00000004
142 #define VC_IATTR_FLAGS                  0x00000007
143
144 #define VC_IATTR_BARRIER                0x00010000
145 #define VC_IATTR_IUNLINK                0x00020000
146 #define VC_IATTR_IMMUTABLE              0x00040000
147
148
149 // the flags
150 #define VC_VXF_INFO_LOCK                0x00000001
151 #define VC_VXF_INFO_NPROC               0x00000004
152 #define VC_VXF_INFO_PRIVATE             0x00000008
153 #define VC_VXF_INFO_INIT                0x00000010
154
155 #define VC_VXF_INFO_HIDEINFO            0x00000020
156 #define VC_VXF_INFO_ULIMIT              0x00000040
157 #define VC_VXF_INFO_NAMESPACE           0x00000080
158
159 #define VC_VXF_SCHED_HARD               0x00000100
160 #define VC_VXF_SCHED_PRIO               0x00000200
161 #define VC_VXF_SCHED_PAUSE              0x00000400
162
163 #define VC_VXF_VIRT_MEM                 0x00010000
164 #define VC_VXF_VIRT_UPTIME              0x00020000
165 #define VC_VXF_VIRT_CPU                 0x00040000
166
167 #define VC_VXF_HIDE_MOUNT               0x01000000
168 #define VC_VXF_HIDE_NETIF               0x02000000
169
170 #define VC_VXF_STATE_SETUP              (1ULL<<32)
171 #define VC_VXF_STATE_INIT               (1ULL<<33)
172
173 // the ccapabilities
174 #define VC_VXC_SET_UTSNAME              0x00000001
175 #define VC_VXC_SET_RLIMIT               0x00000002
176
177 #define VC_VXC_ICMP_PING                0x00000100
178
179 #define VC_VXC_SECURE_MOUNT             0x00010000
180
181
182 /** \defgroup  syscalls Syscall wrappers
183  *  Functions which are calling the vserver syscall directly. */
184
185 /** \defgroup  helper   Helper functions
186  *  Functions which are doing general helper tasks like parameter parsing. */
187
188 /** \typedef  an_unsigned_integer_type  xid_t
189  *  The identifier of a context. */
190
191 #ifdef IS_DOXYGEN
192 typedef an_unsigned_integer_type        xid_t;
193 #endif
194
195 #ifdef __cplusplus
196 extern "C" {
197 #endif
198
199   struct vc_ip_mask_pair {
200     uint32_t    ip;
201       uint32_t  mask;
202   };
203
204     /** \brief   Returns the version of the current kernel API.
205      *  \ingroup syscalls
206      *  \returns The versionnumber of the kernel API
207      */
208   int   vc_get_version();
209   
210     /** \brief   Moves current process into a context
211      *  \ingroup syscalls
212      *
213      *  Puts current process into context \a ctx, removes the capabilities
214      *  given in \a remove_cap and sets \a flags.
215      *
216      *  \param ctx         The new context; special values for are
217      *  - VC_SAMECTX      which means the current context (just for changing caps and flags)
218      *  - VC_DYNAMIC_XID  which means the next free context; this value can be used by
219      *                    ordinary users also
220      *  \param remove_cap  The linux capabilities which will be \b removed.
221      *  \param flags       Special flags which will be set.
222      *
223      *  \returns  The new context-id, or VC_NOCTX on errors; errno
224      *            will be set appropriately
225      *
226      *  See http://vserver.13thfloor.at/Stuff/Logic.txt for details */
227   xid_t vc_new_s_context(xid_t ctx, unsigned int remove_cap, unsigned int flags);
228
229     /** \brief  Sets the ipv4root information.
230      *  \ingroup syscalls
231      *  \pre    \a nb < NB_IPV4ROOT && \a ips != 0 */
232   int   vc_set_ipv4root(uint32_t  bcast, size_t nb,
233                         struct vc_ip_mask_pair const *ips) VC_ATTR_NONNULL((3));
234
235     /** \brief  Returns the value of NB_IPV4ROOT.
236      *  \ingroup helper
237      *
238      *  This function returns the value of NB_IPV4ROOT which was used when the
239      *  library was built, but \b not the value which is used by the currently
240      *  running kernel. */
241   size_t        vc_get_nb_ipv4root() VC_ATTR_CONST VC_ATTR_PURE;
242
243     /** \brief   Creates a context without starting it.
244      *  \ingroup syscalls
245      *
246      *  This functions initializes a new context. When already in a freshly
247      *  created context, this old context will be discarded.
248      *
249      *  \param xid  The new context; special values are:
250      *  - VC_DYNAMIC_XID which means to create a dynamic context
251      *
252      *  \returns the xid of the created context, or VC_NOCTX on errors. errno
253      *           will be set appropriately. */
254   xid_t vc_create_context(xid_t xid);
255
256     /** \brief   Moves the current process into the specified context.
257      *  \ingroup syscalls
258      *
259      *  \param   xid  The new context
260      *  \returns 0 on success, -1 on errors */
261   int   vc_migrate_context(xid_t xid);
262   
263     /* rlimit related functions */
264   
265     /** \brief  The type which is used for a single limit value.
266      *
267      *  Special values are
268      *  - VC_LIM_INFINITY ... which is the infinite value
269      *  - VC_LIM_KEEP     ... which is used to mark values which shall not be
270      *                        modified by the vc_set_rlimit() operation.
271      *
272      *  Else, the interpretation of the value depends on the corresponding
273      *  resource; it might be bytes, pages, seconds or litres of beer. */
274   typedef uint_least64_t        vc_limit_t;
275
276     /** \brief  The limits of a resources.
277      *
278      *  This is a triple consisting of a minimum, soft and hardlimit. */
279   struct vc_rlimit {
280       vc_limit_t        min;    ///< the guaranted minimum of a resources
281       vc_limit_t        soft;   ///< the softlimit of a resource
282       vc_limit_t        hard;   ///< the absolute hardlimit of a resource
283   };
284
285     /** \brief  Masks describing the supported limits. */
286   struct  vc_rlimit_mask {
287       uint_least32_t    min;    ///< masks the resources supporting a minimum limit
288       uint_least32_t    soft;   ///< masks the resources supporting a soft limit
289       uint_least32_t    hard;   ///< masks the resources supporting a hard limit
290   };
291
292     /** \brief   Returns the limits of \a resource.
293      *  \ingroup syscalls
294      *
295      *  \param  xid       The id of the context
296      *  \param  resource  The resource which will be queried
297      *  \param  lim       The result which will be filled with the limits
298      *
299      *  \returns 0 on success, and -1 on errors. */
300   int   vc_get_rlimit(xid_t xid, int resource,
301                       struct vc_rlimit       /*@out@*/ *lim) VC_ATTR_NONNULL((3));
302     /** \brief   Sets the limits of \a resource.
303      *  \ingroup syscalls
304      *
305      *  \param  xid       The id of the context
306      *  \param  resource  The resource which will be queried
307      *  \param  lim       The new limits
308      *
309      *  \returns 0 on success, and -1 on errors. */
310   int   vc_set_rlimit(xid_t xid, int resource,
311                       struct vc_rlimit const /*@in@*/  *lim) VC_ATTR_NONNULL((3));
312   int   vc_get_rlimit_mask(xid_t xid,
313                            struct vc_rlimit_mask *lim)       VC_ATTR_NONNULL((2));
314     /** \brief   Parses a string describing a limit
315      *  \ingroup helper
316      *
317      *  This function parses \a str and interprets special words like \p "inf"
318      *  or suffixes. Valid suffixes are
319      *  - \p k ... 1000
320      *  - \p m ... 1000000
321      *  - \p K ... 1024
322      *  - \p M ... 1048576
323      *
324      *  \param str  The string which shall be parsed
325      *  \param res  Will be filled with the interpreted value; in errorcase,
326      *              this value is undefined.
327      *
328      *  \returns \a true, iff the string \a str could be parsed. \a res will
329      *  be filled with the interpreted value in this case. 
330      *
331      *  \pre \a str!=0 && \a res!=0
332      */
333   bool  vc_parseLimit(char const /*@in@*/ *str, vc_limit_t /*@out@*/ *res)      VC_ATTR_NONNULL((1,2));
334
335
336   /** \brief    Sends a signal to a context/pid
337    *  \ingroup  syscalls
338    *
339    *  Special values for \a pid are:
340    *  - -1   which means every process in ctx except the init-process
341    *  -  0   which means every process in ctx inclusive the init-process */
342   int   vc_ctx_kill(xid_t ctx, pid_t pid, int sig);
343
344
345
346   int           vc_set_iattr(char const *filename, xid_t xid,
347                              uint_least32_t flags, uint_least32_t mask) VC_ATTR_NONNULL((1));
348   int           vc_get_iattr(char const *filename, xid_t * /*@null@*/ xid,
349                              uint_least32_t * /*@null@*/ flags,
350                              uint_least32_t * /*@null@*/ mask) VC_ATTR_NONNULL((1));
351
352   struct vc_vx_info {
353       xid_t     xid;
354       pid_t     initpid;
355   };
356   
357     /** Returns the context of the given process. pid==0 means the current process. */
358   xid_t         vc_get_task_xid(pid_t pid);
359   int           vc_get_vx_info(xid_t xid, struct vc_vx_info *info) VC_ATTR_NONNULL((2));
360
361
362   typedef enum { vcVHI_CONTEXT, vcVHI_SYSNAME, vcVHI_NODENAME,
363                  vcVHI_RELEASE, vcVHI_VERSION, vcVHI_MACHINE,
364                  vcVHI_DOMAINNAME }             vc_uts_type;
365   
366   int           vc_set_vhi_name(xid_t xid, vc_uts_type type,
367                                 char const *val, size_t len) VC_ATTR_NONNULL((3));
368   int           vc_get_vhi_name(xid_t xid, vc_uts_type type,
369                                 char *val, size_t len)       VC_ATTR_NONNULL((3));
370
371     /** Returns true iff \a xid is a dynamic xid */
372   bool          vc_is_dynamic_xid(xid_t xid);
373
374   int           vc_enter_namespace(xid_t xid);
375   int           vc_set_namespace();
376   int           vc_cleanup_namespace();
377
378   struct  vc_ctx_flags {
379       uint_least64_t    flagword;
380       uint_least64_t    mask;
381   };
382   
383   struct  vc_ctx_caps {
384       uint_least64_t    bcaps;
385       uint_least64_t    bmask;
386       uint_least64_t    ccaps;
387       uint_least64_t    cmask;
388   };
389
390   struct vc_err_listparser {
391       char const        *ptr;
392       size_t            len;
393   };
394  
395   int                   vc_get_flags(xid_t xid, struct vc_ctx_flags *)       VC_ATTR_NONNULL((2));
396   int                   vc_set_flags(xid_t xid, struct vc_ctx_flags const *) VC_ATTR_NONNULL((2));
397
398   int                   vc_get_ccaps(xid_t xid, struct vc_ctx_caps *);
399   int                   vc_set_ccaps(xid_t xid, struct vc_ctx_caps const *);
400
401   uint_least64_t        vc_text2bcap(char const *, size_t len);
402   char const *          vc_lobcap2text(uint_least64_t *);
403   int                   vc_list2bcap(char const *, size_t len,
404                                      struct vc_err_listparser *err,
405                                      struct vc_ctx_caps *);
406
407   uint_least64_t        vc_text2ccap(char const *, size_t len);
408   char const *          vc_loccap2text(uint_least64_t *);
409   int                   vc_list2ccap(char const *, size_t len,
410                                      struct vc_err_listparser *err,
411                                      struct vc_ctx_caps *);
412
413   int                   vc_list2flag(char const *, size_t len,
414                                      struct vc_err_listparser *err,
415                                      struct vc_ctx_flags *flags);
416   uint_least64_t        vc_text2flag(char const *, size_t len);
417   char const *          vc_loflag2text(uint_least64_t *);
418   
419   uint_least32_t        vc_list2flag_compat(char const *, size_t len,
420                                             struct vc_err_listparser *err);
421   uint_least32_t        vc_text2flag_compat(char const *, size_t len);
422   char const *          vc_hiflag2text_compat(uint_least32_t);
423
424   uint_least32_t        vc_get_insecurecaps() VC_ATTR_CONST;
425   int                   vc_text2cap(char const *);
426   char const *          vc_cap2text(unsigned int);
427
428
429   inline static int     vc_setfilecontext(char const *filename, xid_t xid) {
430     return vc_set_iattr(filename, xid, 0, VC_IATTR_XID);
431   }
432   
433   inline static xid_t   vc_getfilecontext(char const *filename) {
434     xid_t       res;
435     if (vc_get_iattr(filename, &res, 0,0)==-1) return VC_NOCTX;
436     return res;
437   }
438
439
440   struct vc_set_sched {
441       int32_t   fill_rate;
442       int32_t   interval;
443       int32_t   tokens;
444       int32_t   tokens_min;
445       int32_t   tokens_max;
446       uint64_t  cpu_mask;
447   };
448
449   int           vc_set_sched(xid_t xid, struct vc_set_sched const *);
450   
451   
452   typedef enum { vcFEATURE_VKILL,  vcFEATURE_IATTR,   vcFEATURE_RLIMIT,
453                  vcFEATURE_COMPAT, vcFEATURE_MIGRATE, vcFEATURE_NAMESPACE,
454                  vcFEATURE_SCHED,  vcFEATURE_VINFO,   vcFEATURE_VHI,
455                  vcFEATURE_VSHELPER }
456     vcFeatureSet;
457
458   bool          vc_isSupported(vcFeatureSet) VC_ATTR_CONST;
459   bool          vc_isSupportedString(char const *);
460
461   /* The management part */
462
463 #define VC_LIMIT_VSERVER_NAME_LEN       1024
464   
465   typedef enum { vcCFG_NONE, vcCFG_AUTO,
466                  vcCFG_LEGACY,
467                  vcCFG_RECENT_SHORT,
468                  vcCFG_RECENT_FULL }            vcCfgStyle;
469
470
471   /** Maps an xid given at '--xid' options to an xid_t */
472   xid_t         vc_xidopt2xid(char const *, bool honor_static, char const **err_info);
473
474   vcCfgStyle    vc_getVserverCfgStyle(char const *id);
475   
476   /** Resolves the name of the vserver. The result will be allocated and must
477       be freed by the caller. */
478   char *        vc_getVserverName(char const *id, vcCfgStyle style);
479
480   /** Returns the path of the vserver configuration directory. When the given
481    *  vserver does not exist, or when it does not have such a directory, NULL
482    *  will be returned. Else, the result will be allocated and must be freed
483    *  by the caller. */
484   char *        vc_getVserverCfgDir(char const *id, vcCfgStyle style);
485
486   /** Returns the path of the configuration directory for the given
487    *  application. The result will be allocated and must be freed by the
488    *  caller. */
489   char *        vc_getVserverAppDir(char const *id, vcCfgStyle style, char const *app);
490
491   /** Returns the path to the vserver root-directory. The result will be
492    *  allocated and must be freed by the caller. */
493   char *        vc_getVserverVdir(char const *id, vcCfgStyle style, bool physical);
494
495   /** Returns the ctx of the given vserver. When vserver is not running and
496    *  'honor_static' is false, VC_NOCTX will be returned. Else, when
497    *  'honor_static' is true and a static assignment exists, those value will
498    *  be returned. Else, the result will be VC_NOCTX.
499    *
500    *  When 'is_running' is not null, the status of the vserver will be
501    *  assigned to this variable. */
502   xid_t         vc_getVserverCtx(char const *id, vcCfgStyle style,
503                                  bool honor_static, bool /*@null@*/ *is_running);
504
505   /** Resolves the cfg-path of the vserver owning the given ctx. 'revdir' will
506       be used as the directory holding the mapping-links; when NULL, the
507       default value will be assumed.  The result will be allocated and must be
508       freed by the caller. */
509   char *        vc_getVserverByCtx(xid_t ctx, /*@null@*/vcCfgStyle *style,
510                                    /*@null@*/char const *revdir);
511
512 #define vcSKEL_INTERFACES       1u
513 #define vcSKEL_PKGMGMT          2u
514 #define vcSKEL_FILESYSTEM       4u
515   
516   /** Create a basic configuration skeleton for a vserver plus toplevel
517    *  directories for pkgmanagemt and filesystem (when requested). */
518   int           vc_createSkeleton(char const *id, vcCfgStyle style, int flags);
519   
520 #ifdef __cplusplus
521 }
522 #endif
523
524 #undef VC_ATTR_PURE
525 #undef VC_ATTR_ALWAYSINLINE
526 #undef VC_ATTR_NORETURN
527 #undef VC_ATTR_UNUSED
528 #undef VC_ATTR_NONNULL
529
530 #endif