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