sys/sys/rctl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2010 The FreeBSD Foundation
   5  * All rights reserved.
   6  *
   7  * This software was developed by Edward Tomasz Napierala under sponsorship
   8  * from the FreeBSD Foundation.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  * $FreeBSD$
  32  */
  33
  34 /*
  35  * Resource Limits.
  36  */
  37
  38 #ifndef _RCTL_H_
  39 #define _RCTL_H_
  40
  41 #include <sys/cdefs.h>
  42 #include <sys/queue.h>
  43 #include <sys/types.h>
  44 #include <sys/_task.h>
  45
  46 struct proc;
  47 struct uidinfo;
  48 struct loginclass;
  49 struct prison_racct;
  50 struct ucred;
  51 struct rctl_rule_link;
  52
  53 #ifdef _KERNEL
  54
  55 /*
  56  * Rules describe an action to be taken when conditions defined
  57  * in the rule are met.  There is no global list of rules; instead,
  58  * rules are linked to by the racct structures for all the subjects
  59  * they apply to - for example, a rule of type "user" is linked to the
  60  * appropriate struct uidinfo, and to all the processes of that user.
  61  *
  62  * 'rr_refcount' is equal to the number of rctl_rule_link structures
  63  * pointing to the rule.
  64  *
  65  * This structure must never change after being added, via rctl_rule_link
  66  * structures, to subjects.  In order to change a rule, add a new rule
  67  * and remove the previous one.
  68  */
  69 struct rctl_rule {
  70         int             rr_subject_type;
  71         union {
  72                 struct proc             *rs_proc;
  73                 struct uidinfo          *rs_uip;
  74                 struct loginclass       *rs_loginclass;
  75                 struct prison_racct     *rs_prison_racct;
  76         } rr_subject;
  77         int             rr_per;
  78         int             rr_resource;
  79         int             rr_action;
  80         int64_t         rr_amount;
  81         u_int           rr_refcount;
  82         struct task     rr_task;
  83 };
  84
  85 /*
  86  * Allowed values for rr_subject_type and rr_per fields.
  87  */
  88 #define RCTL_SUBJECT_TYPE_UNDEFINED     -1
  89 #define RCTL_SUBJECT_TYPE_PROCESS       0x0000
  90 #define RCTL_SUBJECT_TYPE_USER          0x0001
  91 #define RCTL_SUBJECT_TYPE_LOGINCLASS    0x0003
  92 #define RCTL_SUBJECT_TYPE_JAIL          0x0004
  93 #define RCTL_SUBJECT_TYPE_MAX           RCTL_SUBJECT_TYPE_JAIL
  94
  95 /*
  96  * Allowed values for rr_action field.
  97  */
  98 #define RCTL_ACTION_UNDEFINED           -1
  99 #define RCTL_ACTION_SIGHUP              SIGHUP
 100 #define RCTL_ACTION_SIGINT              SIGINT
 101 #define RCTL_ACTION_SIGQUIT             SIGQUIT
 102 #define RCTL_ACTION_SIGILL              SIGILL
 103 #define RCTL_ACTION_SIGTRAP             SIGTRAP
 104 #define RCTL_ACTION_SIGABRT             SIGABRT
 105 #define RCTL_ACTION_SIGEMT              SIGEMT
 106 #define RCTL_ACTION_SIGFPE              SIGFPE
 107 #define RCTL_ACTION_SIGKILL             SIGKILL
 108 #define RCTL_ACTION_SIGBUS              SIGBUS
 109 #define RCTL_ACTION_SIGSEGV             SIGSEGV
 110 #define RCTL_ACTION_SIGSYS              SIGSYS
 111 #define RCTL_ACTION_SIGPIPE             SIGPIPE
 112 #define RCTL_ACTION_SIGALRM             SIGALRM
 113 #define RCTL_ACTION_SIGTERM             SIGTERM
 114 #define RCTL_ACTION_SIGURG              SIGURG
 115 #define RCTL_ACTION_SIGSTOP             SIGSTOP
 116 #define RCTL_ACTION_SIGTSTP             SIGTSTP
 117 #define RCTL_ACTION_SIGCHLD             SIGCHLD
 118 #define RCTL_ACTION_SIGTTIN             SIGTTIN
 119 #define RCTL_ACTION_SIGTTOU             SIGTTOU
 120 #define RCTL_ACTION_SIGIO               SIGIO
 121 #define RCTL_ACTION_SIGXCPU             SIGXCPU
 122 #define RCTL_ACTION_SIGXFSZ             SIGXFSZ
 123 #define RCTL_ACTION_SIGVTALRM           SIGVTALRM
 124 #define RCTL_ACTION_SIGPROF             SIGPROF
 125 #define RCTL_ACTION_SIGWINCH            SIGWINCH
 126 #define RCTL_ACTION_SIGINFO             SIGINFO
 127 #define RCTL_ACTION_SIGUSR1             SIGUSR1
 128 #define RCTL_ACTION_SIGUSR2             SIGUSR2
 129 #define RCTL_ACTION_SIGTHR              SIGTHR
 130 #define RCTL_ACTION_SIGNAL_MAX          RCTL_ACTION_SIGTHR
 131 #define RCTL_ACTION_DENY                (RCTL_ACTION_SIGNAL_MAX + 1)
 132 #define RCTL_ACTION_LOG                 (RCTL_ACTION_SIGNAL_MAX + 2)
 133 #define RCTL_ACTION_DEVCTL              (RCTL_ACTION_SIGNAL_MAX + 3)
 134 #define RCTL_ACTION_THROTTLE            (RCTL_ACTION_SIGNAL_MAX + 4)
 135 #define RCTL_ACTION_MAX                 RCTL_ACTION_THROTTLE
 136
 137 #define RCTL_AMOUNT_UNDEFINED           -1
 138
 139 struct rctl_rule *rctl_rule_alloc(int flags);
 140 struct rctl_rule *rctl_rule_duplicate(const struct rctl_rule *rule, int flags);
 141 void    rctl_rule_acquire(struct rctl_rule *rule);
 142 void    rctl_rule_release(struct rctl_rule *rule);
 143 int     rctl_rule_add(struct rctl_rule *rule);
 144 int     rctl_rule_remove(struct rctl_rule *filter);
 145 int     rctl_enforce(struct proc *p, int resource, uint64_t amount);
 146 void    rctl_throttle_decay(struct racct *racct, int resource);
 147 int64_t rctl_pcpu_available(const struct proc *p);
 148 uint64_t rctl_get_limit(struct proc *p, int resource);
 149 uint64_t rctl_get_available(struct proc *p, int resource);
 150 const char *rctl_resource_name(int resource);
 151 void    rctl_proc_ucred_changed(struct proc *p, struct ucred *newcred);
 152 int     rctl_proc_fork(struct proc *parent, struct proc *child);
 153 void    rctl_racct_release(struct racct *racct);
 154 #else /* !_KERNEL */
 155
 156 /*
 157  * Syscall interface.
 158  */
 159 __BEGIN_DECLS
 160 int     rctl_get_racct(const char *inbufp, size_t inbuflen, char *outbufp,
 161             size_t outbuflen);
 162 int     rctl_get_rules(const char *inbufp, size_t inbuflen, char *outbufp,
 163             size_t outbuflen);
 164 int     rctl_get_limits(const char *inbufp, size_t inbuflen, char *outbufp,
 165             size_t outbuflen);
 166 int     rctl_add_rule(const char *inbufp, size_t inbuflen, char *outbufp,
 167             size_t outbuflen);
 168 int     rctl_remove_rule(const char *inbufp, size_t inbuflen, char *outbufp,
 169             size_t outbuflen);
 170 __END_DECLS
 171
 172 #endif /* !_KERNEL */
 173
 174 #endif /* !_RCTL_H_ */