sys/kern/subr_param.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1980, 1986, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)param.c     8.3 (Berkeley) 8/20/94
  37  */
  38
  39 #include <sys/cdefs.h>
  40 __FBSDID("$FreeBSD$");
  41
  42 #include "opt_param.h"
  43 #include "opt_msgbuf.h"
  44 #include "opt_maxphys.h"
  45 #include "opt_maxusers.h"
  46
  47 #include <sys/param.h>
  48 #include <sys/systm.h>
  49 #include <sys/buf.h>
  50 #include <sys/kernel.h>
  51 #include <sys/limits.h>
  52 #include <sys/msgbuf.h>
  53 #include <sys/sysctl.h>
  54 #include <sys/proc.h>
  55 #include <sys/vnode.h>
  56
  57 #include <vm/vm.h>
  58 #include <vm/vm_param.h>
  59 #include <vm/pmap.h>
  60
  61 /*
  62  * System parameter formulae.
  63  */
  64
  65 #ifndef HZ
  66 #  if defined(__mips__) || defined(__arm__)
  67 #    define     HZ 100
  68 #  else
  69 #    define     HZ 1000
  70 #  endif
  71 #  ifndef HZ_VM
  72 #    define     HZ_VM 100
  73 #  endif
  74 #else
  75 #  ifndef HZ_VM
  76 #    define     HZ_VM HZ
  77 #  endif
  78 #endif
  79 #define NPROC (20 + 16 * maxusers)
  80 #ifndef NBUF
  81 #define NBUF 0
  82 #endif
  83 #ifndef MAXFILES
  84 #define MAXFILES (40 + 32 * maxusers)
  85 #endif
  86
  87 static int sysctl_kern_vm_guest(SYSCTL_HANDLER_ARGS);
  88
  89 int     hz;                             /* system clock's frequency */
  90 int     tick;                           /* usec per tick (1000000 / hz) */
  91 time_t  tick_seconds_max;               /* max hz * seconds an integer can hold */
  92 struct bintime tick_bt;                 /* bintime per tick (1s / hz) */
  93 sbintime_t tick_sbt;
  94 int     maxusers;                       /* base tunable */
  95 int     maxproc;                        /* maximum # of processes */
  96 int     maxprocperuid;                  /* max # of procs per user */
  97 int     maxfiles;                       /* sys. wide open files limit */
  98 int     maxfilesperproc;                /* per-proc open files limit */
  99 int     msgbufsize;                     /* size of kernel message buffer */
 100 int     nbuf;                           /* number of bcache bufs */
 101 int     bio_transient_maxcnt;
 102 int     ngroups_max;                    /* max # groups per process */
 103 int     nswbuf;
 104 pid_t   pid_max = PID_MAX;
 105 u_long  maxswzone;                      /* max swmeta KVA storage */
 106 u_long  maxbcache;                      /* max buffer cache KVA storage */
 107 u_long  maxpipekva;                     /* Limit on pipe KVA */
 108 u_long  maxphys;                        /* max raw I/O transfer size */
 109 int     vm_guest = VM_GUEST_NO;         /* Running as virtual machine guest? */
 110 u_long  maxtsiz;                        /* max text size */
 111 u_long  dfldsiz;                        /* initial data size limit */
 112 u_long  maxdsiz;                        /* max data size */
 113 u_long  dflssiz;                        /* initial stack size limit */
 114 u_long  maxssiz;                        /* max stack size */
 115 u_long  sgrowsiz;                       /* amount to grow stack */
 116
 117 SYSCTL_INT(_kern, OID_AUTO, hz, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &hz, 0,
 118     "Number of clock ticks per second");
 119 SYSCTL_INT(_kern, OID_AUTO, hz_max, CTLFLAG_RD, SYSCTL_NULL_INT_PTR, HZ_MAXIMUM,
 120     "Maximum hz value supported");
 121 SYSCTL_INT(_kern, OID_AUTO, hz_min, CTLFLAG_RD, SYSCTL_NULL_INT_PTR, HZ_MINIMUM,
 122     "Minimum hz value supported");
 123 SYSCTL_INT(_kern, OID_AUTO, nbuf, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &nbuf, 0,
 124     "Number of buffers in the buffer cache");
 125 SYSCTL_INT(_kern, OID_AUTO, nswbuf, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &nswbuf, 0,
 126     "Number of swap buffers");
 127 SYSCTL_INT(_kern, OID_AUTO, msgbufsize, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &msgbufsize, 0,
 128     "Size of the kernel message buffer");
 129 SYSCTL_LONG(_kern, OID_AUTO, maxswzone, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &maxswzone, 0,
 130     "Maximum memory for swap metadata");
 131 SYSCTL_LONG(_kern, OID_AUTO, maxbcache, CTLFLAG_RDTUN | CTLFLAG_NOFETCH, &maxbcache, 0,
 132     "Maximum value of vfs.maxbufspace");
 133 SYSCTL_INT(_kern, OID_AUTO, bio_transient_maxcnt, CTLFLAG_RDTUN | CTLFLAG_NOFETCH,
 134     &bio_transient_maxcnt, 0,
 135     "Maximum number of transient BIOs mappings");
 136 SYSCTL_ULONG(_kern, OID_AUTO, maxtsiz, CTLFLAG_RWTUN | CTLFLAG_NOFETCH, &maxtsiz, 0,
 137     "Maximum text size");
 138 SYSCTL_ULONG(_kern, OID_AUTO, dfldsiz, CTLFLAG_RWTUN | CTLFLAG_NOFETCH, &dfldsiz, 0,
 139     "Initial data size limit");
 140 SYSCTL_ULONG(_kern, OID_AUTO, maxdsiz, CTLFLAG_RWTUN | CTLFLAG_NOFETCH, &maxdsiz, 0,
 141     "Maximum data size");
 142 SYSCTL_ULONG(_kern, OID_AUTO, dflssiz, CTLFLAG_RWTUN | CTLFLAG_NOFETCH, &dflssiz, 0,
 143     "Initial stack size limit");
 144 SYSCTL_ULONG(_kern, OID_AUTO, maxssiz, CTLFLAG_RWTUN | CTLFLAG_NOFETCH, &maxssiz, 0,
 145     "Maximum stack size");
 146 SYSCTL_ULONG(_kern, OID_AUTO, sgrowsiz, CTLFLAG_RWTUN | CTLFLAG_NOFETCH, &sgrowsiz, 0,
 147     "Amount to grow stack on a stack fault");
 148 SYSCTL_PROC(_kern, OID_AUTO, vm_guest,
 149     CTLFLAG_RD | CTLTYPE_STRING | CTLFLAG_MPSAFE, NULL, 0,
 150     sysctl_kern_vm_guest, "A",
 151     "Virtual machine guest detected?");
 152
 153 /*
 154  * The elements of this array are ordered based upon the values of the
 155  * corresponding enum VM_GUEST members.
 156  */
 157 static const char *const vm_guest_sysctl_names[] = {
 158         [VM_GUEST_NO] = "none",
 159         [VM_GUEST_VM] = "generic",
 160         [VM_GUEST_XEN] = "xen",
 161         [VM_GUEST_HV] = "hv",
 162         [VM_GUEST_VMWARE] = "vmware",
 163         [VM_GUEST_KVM] = "kvm",
 164         [VM_GUEST_BHYVE] = "bhyve",
 165         [VM_GUEST_VBOX] = "vbox",
 166         [VM_GUEST_PARALLELS] = "parallels",
 167         [VM_LAST] = NULL
 168 };
 169 CTASSERT(nitems(vm_guest_sysctl_names) - 1 == VM_LAST);
 170
 171 /*
 172  * Boot time overrides that are not scaled against main memory
 173  */
 174 void
 175 init_param1(void)
 176 {
 177
 178 #if !defined(__mips__) && !defined(__arm64__)
 179         TUNABLE_INT_FETCH("kern.kstack_pages", &kstack_pages);
 180 #endif
 181         hz = -1;
 182         TUNABLE_INT_FETCH("kern.hz", &hz);
 183         if (hz == -1)
 184                 hz = vm_guest > VM_GUEST_NO ? HZ_VM : HZ;
 185
 186         /* range check the "hz" value */
 187         if (__predict_false(hz < HZ_MINIMUM))
 188                 hz = HZ_MINIMUM;
 189         else if (__predict_false(hz > HZ_MAXIMUM))
 190                 hz = HZ_MAXIMUM;
 191
 192         tick = 1000000 / hz;
 193         tick_sbt = SBT_1S / hz;
 194         tick_bt = sbttobt(tick_sbt);
 195         tick_seconds_max = INT_MAX / hz;
 196
 197         /*
 198          * Arrange for ticks to wrap 10 minutes after boot to help catch
 199          * sign problems sooner.
 200          */
 201         ticks = INT_MAX - (hz * 10 * 60);
 202
 203         vn_lock_pair_pause_max = hz / 100;
 204         if (vn_lock_pair_pause_max == 0)
 205                 vn_lock_pair_pause_max = 1;
 206
 207 #ifdef VM_SWZONE_SIZE_MAX
 208         maxswzone = VM_SWZONE_SIZE_MAX;
 209 #endif
 210         TUNABLE_LONG_FETCH("kern.maxswzone", &maxswzone);
 211 #ifdef VM_BCACHE_SIZE_MAX
 212         maxbcache = VM_BCACHE_SIZE_MAX;
 213 #endif
 214         TUNABLE_LONG_FETCH("kern.maxbcache", &maxbcache);
 215         msgbufsize = MSGBUF_SIZE;
 216         TUNABLE_INT_FETCH("kern.msgbufsize", &msgbufsize);
 217
 218         maxtsiz = MAXTSIZ;
 219         TUNABLE_ULONG_FETCH("kern.maxtsiz", &maxtsiz);
 220         dfldsiz = DFLDSIZ;
 221         TUNABLE_ULONG_FETCH("kern.dfldsiz", &dfldsiz);
 222         maxdsiz = MAXDSIZ;
 223         TUNABLE_ULONG_FETCH("kern.maxdsiz", &maxdsiz);
 224         dflssiz = DFLSSIZ;
 225         TUNABLE_ULONG_FETCH("kern.dflssiz", &dflssiz);
 226         maxssiz = MAXSSIZ;
 227         TUNABLE_ULONG_FETCH("kern.maxssiz", &maxssiz);
 228         sgrowsiz = SGROWSIZ;
 229         TUNABLE_ULONG_FETCH("kern.sgrowsiz", &sgrowsiz);
 230
 231         /*
 232          * Let the administrator set {NGROUPS_MAX}, but disallow values
 233          * less than NGROUPS_MAX which would violate POSIX.1-2008 or
 234          * greater than INT_MAX-1 which would result in overflow.
 235          */
 236         ngroups_max = NGROUPS_MAX;
 237         TUNABLE_INT_FETCH("kern.ngroups", &ngroups_max);
 238         if (ngroups_max < NGROUPS_MAX)
 239                 ngroups_max = NGROUPS_MAX;
 240
 241         /*
 242          * Only allow to lower the maximal pid.
 243          * Prevent setting up a non-bootable system if pid_max is too low.
 244          */
 245         TUNABLE_INT_FETCH("kern.pid_max", &pid_max);
 246         if (pid_max > PID_MAX)
 247                 pid_max = PID_MAX;
 248         else if (pid_max < 300)
 249                 pid_max = 300;
 250
 251         TUNABLE_INT_FETCH("vfs.unmapped_buf_allowed", &unmapped_buf_allowed);
 252 }
 253
 254 /*
 255  * Boot time overrides that are scaled against main memory
 256  */
 257 void
 258 init_param2(long physpages)
 259 {
 260
 261         /* Base parameters */
 262         maxusers = MAXUSERS;
 263         TUNABLE_INT_FETCH("kern.maxusers", &maxusers);
 264         if (maxusers == 0) {
 265                 maxusers = physpages / (2 * 1024 * 1024 / PAGE_SIZE);
 266                 if (maxusers < 32)
 267                         maxusers = 32;
 268 #ifdef VM_MAX_AUTOTUNE_MAXUSERS
 269                 if (maxusers > VM_MAX_AUTOTUNE_MAXUSERS)
 270                         maxusers = VM_MAX_AUTOTUNE_MAXUSERS;
 271 #endif
 272                 /*
 273                  * Scales down the function in which maxusers grows once
 274                  * we hit 384.
 275                  */
 276                 if (maxusers > 384)
 277                         maxusers = 384 + ((maxusers - 384) / 8);
 278         }
 279
 280         /*
 281          * The following can be overridden after boot via sysctl.  Note:
 282          * unless overridden, these macros are ultimately based on maxusers.
 283          * Limit maxproc so that kmap entries cannot be exhausted by
 284          * processes.
 285          */
 286         maxproc = NPROC;
 287         TUNABLE_INT_FETCH("kern.maxproc", &maxproc);
 288         if (maxproc > (physpages / 12))
 289                 maxproc = physpages / 12;
 290         if (maxproc > pid_max)
 291                 maxproc = pid_max;
 292         maxprocperuid = (maxproc * 9) / 10;
 293
 294         /*
 295          * The default limit for maxfiles is 1/12 of the number of
 296          * physical page but not less than 16 times maxusers.
 297          * At most it can be 1/6 the number of physical pages.
 298          */
 299         maxfiles = imax(MAXFILES, physpages / 8);
 300         TUNABLE_INT_FETCH("kern.maxfiles", &maxfiles);
 301         if (maxfiles > (physpages / 4))
 302                 maxfiles = physpages / 4;
 303         maxfilesperproc = (maxfiles / 10) * 9;
 304         TUNABLE_INT_FETCH("kern.maxfilesperproc", &maxfilesperproc);
 305
 306         /*
 307          * Cannot be changed after boot.
 308          */
 309         nbuf = NBUF;
 310         TUNABLE_INT_FETCH("kern.nbuf", &nbuf);
 311         TUNABLE_INT_FETCH("kern.bio_transient_maxcnt", &bio_transient_maxcnt);
 312         maxphys = MAXPHYS;
 313         TUNABLE_ULONG_FETCH("kern.maxphys", &maxphys);
 314         if (maxphys == 0) {
 315                 maxphys = MAXPHYS;
 316         } else if (__bitcountl(maxphys) != 1) { /* power of two */
 317                 if (flsl(maxphys) == NBBY * sizeof(maxphys))
 318                         maxphys = MAXPHYS;
 319                 else
 320                         maxphys = 1UL << flsl(maxphys);
 321         }
 322         if (maxphys < PAGE_SIZE)
 323                 maxphys = MAXPHYS;
 324
 325         /*
 326          * Physical buffers are pre-allocated buffers (struct buf) that
 327          * are used as temporary holders for I/O, such as paging I/O.
 328          */
 329         TUNABLE_INT_FETCH("kern.nswbuf", &nswbuf);
 330
 331         /*
 332          * The default for maxpipekva is min(1/64 of the kernel address space,
 333          * max(1/64 of main memory, 512KB)).  See sys_pipe.c for more details.
 334          */
 335         maxpipekva = ptoa(physpages / 64);
 336         TUNABLE_LONG_FETCH("kern.ipc.maxpipekva", &maxpipekva);
 337         if (maxpipekva < 512 * 1024)
 338                 maxpipekva = 512 * 1024;
 339         if (maxpipekva > (VM_MAX_KERNEL_ADDRESS - VM_MIN_KERNEL_ADDRESS) / 64)
 340                 maxpipekva = (VM_MAX_KERNEL_ADDRESS - VM_MIN_KERNEL_ADDRESS) /
 341                     64;
 342 }
 343
 344 /*
 345  * Sysctl stringifying handler for kern.vm_guest.
 346  */
 347 static int
 348 sysctl_kern_vm_guest(SYSCTL_HANDLER_ARGS)
 349 {
 350         return (SYSCTL_OUT_STR(req, vm_guest_sysctl_names[vm_guest]));
 351 }