sys/sys/rctl.h

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