xref: /freebsd/share/man/man7/tuning.7 (revision 9fd69f37d28cfd7438cac3eeb45fe9dd46b4d7dd)
1.\" Copyright (C) 2001 Matthew Dillon. All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.\" $FreeBSD$
25.\"
26.Dd January 23, 2009
27.Dt TUNING 7
28.Os
29.Sh NAME
30.Nm tuning
31.Nd performance tuning under FreeBSD
32.Sh SYSTEM SETUP - DISKLABEL, NEWFS, TUNEFS, SWAP
33When using
34.Xr bsdlabel 8
35or
36.Xr sysinstall 8
37to lay out your file systems on a hard disk it is important to remember
38that hard drives can transfer data much more quickly from outer tracks
39than they can from inner tracks.
40To take advantage of this you should
41try to pack your smaller file systems and swap closer to the outer tracks,
42follow with the larger file systems, and end with the largest file systems.
43It is also important to size system standard file systems such that you
44will not be forced to resize them later as you scale the machine up.
45I usually create, in order, a 128M root, 1G swap, 128M
46.Pa /var ,
47128M
48.Pa /var/tmp ,
493G
50.Pa /usr ,
51and use any remaining space for
52.Pa /home .
53.Pp
54You should typically size your swap space to approximately 2x main memory
55for systems with less than 2GB of RAM, or approximately 1x main memory
56if you have more.
57If you do not have a lot of RAM, though, you will generally want a lot
58more swap.
59It is not recommended that you configure any less than
60256M of swap on a system and you should keep in mind future memory
61expansion when sizing the swap partition.
62The kernel's VM paging algorithms are tuned to perform best when there is
63at least 2x swap versus main memory.
64Configuring too little swap can lead
65to inefficiencies in the VM page scanning code as well as create issues
66later on if you add more memory to your machine.
67Finally, on larger systems
68with multiple SCSI disks (or multiple IDE disks operating on different
69controllers), we strongly recommend that you configure swap on each drive.
70The swap partitions on the drives should be approximately the same size.
71The kernel can handle arbitrary sizes but
72internal data structures scale to 4 times the largest swap partition.
73Keeping
74the swap partitions near the same size will allow the kernel to optimally
75stripe swap space across the N disks.
76Do not worry about overdoing it a
77little, swap space is the saving grace of
78.Ux
79and even if you do not normally use much swap, it can give you more time to
80recover from a runaway program before being forced to reboot.
81.Pp
82How you size your
83.Pa /var
84partition depends heavily on what you intend to use the machine for.
85This
86partition is primarily used to hold mailboxes, the print spool, and log
87files.
88Some people even make
89.Pa /var/log
90its own partition (but except for extreme cases it is not worth the waste
91of a partition ID).
92If your machine is intended to act as a mail
93or print server,
94or you are running a heavily visited web server, you should consider
95creating a much larger partition \(en perhaps a gig or more.
96It is very easy
97to underestimate log file storage requirements.
98.Pp
99Sizing
100.Pa /var/tmp
101depends on the kind of temporary file usage you think you will need.
102128M is
103the minimum we recommend.
104Also note that sysinstall will create a
105.Pa /tmp
106directory.
107Dedicating a partition for temporary file storage is important for
108two reasons: first, it reduces the possibility of file system corruption
109in a crash, and second it reduces the chance of a runaway process that
110fills up
111.Oo Pa /var Oc Ns Pa /tmp
112from blowing up more critical subsystems (mail,
113logging, etc).
114Filling up
115.Oo Pa /var Oc Ns Pa /tmp
116is a very common problem to have.
117.Pp
118In the old days there were differences between
119.Pa /tmp
120and
121.Pa /var/tmp ,
122but the introduction of
123.Pa /var
124(and
125.Pa /var/tmp )
126led to massive confusion
127by program writers so today programs haphazardly use one or the
128other and thus no real distinction can be made between the two.
129So it makes sense to have just one temporary directory and
130softlink to it from the other
131.Pa tmp
132directory locations.
133However you handle
134.Pa /tmp ,
135the one thing you do not want to do is leave it sitting
136on the root partition where it might cause root to fill up or possibly
137corrupt root in a crash/reboot situation.
138.Pp
139The
140.Pa /usr
141partition holds the bulk of the files required to support the system and
142a subdirectory within it called
143.Pa /usr/local
144holds the bulk of the files installed from the
145.Xr ports 7
146hierarchy.
147If you do not use ports all that much and do not intend to keep
148system source
149.Pq Pa /usr/src
150on the machine, you can get away with
151a 1 gigabyte
152.Pa /usr
153partition.
154However, if you install a lot of ports
155(especially window managers and Linux-emulated binaries), we recommend
156at least a 2 gigabyte
157.Pa /usr
158and if you also intend to keep system source
159on the machine, we recommend a 3 gigabyte
160.Pa /usr .
161Do not underestimate the
162amount of space you will need in this partition, it can creep up and
163surprise you!
164.Pp
165The
166.Pa /home
167partition is typically used to hold user-specific data.
168I usually size it to the remainder of the disk.
169.Pp
170Why partition at all?
171Why not create one big
172.Pa /
173partition and be done with it?
174Then I do not have to worry about undersizing things!
175Well, there are several reasons this is not a good idea.
176First,
177each partition has different operational characteristics and separating them
178allows the file system to tune itself to those characteristics.
179For example,
180the root and
181.Pa /usr
182partitions are read-mostly, with very little writing, while
183a lot of reading and writing could occur in
184.Pa /var
185and
186.Pa /var/tmp .
187By properly
188partitioning your system fragmentation introduced in the smaller more
189heavily write-loaded partitions will not bleed over into the mostly-read
190partitions.
191Additionally, keeping the write-loaded partitions closer to
192the edge of the disk (i.e., before the really big partitions instead of after
193in the partition table) will increase I/O performance in the partitions
194where you need it the most.
195Now it is true that you might also need I/O
196performance in the larger partitions, but they are so large that shifting
197them more towards the edge of the disk will not lead to a significant
198performance improvement whereas moving
199.Pa /var
200to the edge can have a huge impact.
201Finally, there are safety concerns.
202Having a small neat root partition that
203is essentially read-only gives it a greater chance of surviving a bad crash
204intact.
205.Pp
206Properly partitioning your system also allows you to tune
207.Xr newfs 8 ,
208and
209.Xr tunefs 8
210parameters.
211Tuning
212.Xr newfs 8
213requires more experience but can lead to significant improvements in
214performance.
215There are three parameters that are relatively safe to tune:
216.Em blocksize , bytes/i-node ,
217and
218.Em cylinders/group .
219.Pp
220.Fx
221performs best when using 8K or 16K file system block sizes.
222The default file system block size is 16K,
223which provides best performance for most applications,
224with the exception of those that perform random access on large files
225(such as database server software).
226Such applications tend to perform better with a smaller block size,
227although modern disk characteristics are such that the performance
228gain from using a smaller block size may not be worth consideration.
229Using a block size larger than 16K
230can cause fragmentation of the buffer cache and
231lead to lower performance.
232.Pp
233The defaults may be unsuitable
234for a file system that requires a very large number of i-nodes
235or is intended to hold a large number of very small files.
236Such a file system should be created with an 8K or 4K block size.
237This also requires you to specify a smaller
238fragment size.
239We recommend always using a fragment size that is 1/8
240the block size (less testing has been done on other fragment size factors).
241The
242.Xr newfs 8
243options for this would be
244.Dq Li "newfs -f 1024 -b 8192 ..." .
245.Pp
246If a large partition is intended to be used to hold fewer, larger files, such
247as database files, you can increase the
248.Em bytes/i-node
249ratio which reduces the number of i-nodes (maximum number of files and
250directories that can be created) for that partition.
251Decreasing the number
252of i-nodes in a file system can greatly reduce
253.Xr fsck 8
254recovery times after a crash.
255Do not use this option
256unless you are actually storing large files on the partition, because if you
257overcompensate you can wind up with a file system that has lots of free
258space remaining but cannot accommodate any more files.
259Using 32768, 65536, or 262144 bytes/i-node is recommended.
260You can go higher but
261it will have only incremental effects on
262.Xr fsck 8
263recovery times.
264For example,
265.Dq Li "newfs -i 32768 ..." .
266.Pp
267.Xr tunefs 8
268may be used to further tune a file system.
269This command can be run in
270single-user mode without having to reformat the file system.
271However, this is possibly the most abused program in the system.
272Many people attempt to
273increase available file system space by setting the min-free percentage to 0.
274This can lead to severe file system fragmentation and we do not recommend
275that you do this.
276Really the only
277.Xr tunefs 8
278option worthwhile here is turning on
279.Em softupdates
280with
281.Dq Li "tunefs -n enable /filesystem" .
282(Note: in
283.Fx 4.5
284and later, softupdates can be turned on using the
285.Fl U
286option to
287.Xr newfs 8 ,
288and
289.Xr sysinstall 8
290will typically enable softupdates automatically for non-root file systems).
291Softupdates drastically improves meta-data performance, mainly file
292creation and deletion.
293We recommend enabling softupdates on most file systems; however, there
294are two limitations to softupdates that you should be aware of when
295determining whether to use it on a file system.
296First, softupdates guarantees file system consistency in the
297case of a crash but could very easily be several seconds (even a minute!\&)
298behind on pending write to the physical disk.
299If you crash you may lose more work
300than otherwise.
301Secondly, softupdates delays the freeing of file system
302blocks.
303If you have a file system (such as the root file system) which is
304close to full, doing a major update of it, e.g.\&
305.Dq Li "make installworld" ,
306can run it out of space and cause the update to fail.
307For this reason, softupdates will not be enabled on the root file system
308during a typical install.
309There is no loss of performance since the root
310file system is rarely written to.
311.Pp
312A number of run-time
313.Xr mount 8
314options exist that can help you tune the system.
315The most obvious and most dangerous one is
316.Cm async .
317Only use this option in conjunction with
318.Xr gjournal 8 ,
319as it is far too dangerous on a normal file system.
320A less dangerous and more
321useful
322.Xr mount 8
323option is called
324.Cm noatime .
325.Ux
326file systems normally update the last-accessed time of a file or
327directory whenever it is accessed.
328This operation is handled in
329.Fx
330with a delayed write and normally does not create a burden on the system.
331However, if your system is accessing a huge number of files on a continuing
332basis the buffer cache can wind up getting polluted with atime updates,
333creating a burden on the system.
334For example, if you are running a heavily
335loaded web site, or a news server with lots of readers, you might want to
336consider turning off atime updates on your larger partitions with this
337.Xr mount 8
338option.
339However, you should not gratuitously turn off atime
340updates everywhere.
341For example, the
342.Pa /var
343file system customarily
344holds mailboxes, and atime (in combination with mtime) is used to
345determine whether a mailbox has new mail.
346You might as well leave
347atime turned on for mostly read-only partitions such as
348.Pa /
349and
350.Pa /usr
351as well.
352This is especially useful for
353.Pa /
354since some system utilities
355use the atime field for reporting.
356.Sh STRIPING DISKS
357In larger systems you can stripe partitions from several drives together
358to create a much larger overall partition.
359Striping can also improve
360the performance of a file system by splitting I/O operations across two
361or more disks.
362The
363.Xr gstripe 8 ,
364.Xr gvinum 8 ,
365and
366.Xr ccdconfig 8
367utilities may be used to create simple striped file systems.
368Generally
369speaking, striping smaller partitions such as the root and
370.Pa /var/tmp ,
371or essentially read-only partitions such as
372.Pa /usr
373is a complete waste of time.
374You should only stripe partitions that require serious I/O performance,
375typically
376.Pa /var , /home ,
377or custom partitions used to hold databases and web pages.
378Choosing the proper stripe size is also
379important.
380File systems tend to store meta-data on power-of-2 boundaries
381and you usually want to reduce seeking rather than increase seeking.
382This
383means you want to use a large off-center stripe size such as 1152 sectors
384so sequential I/O does not seek both disks and so meta-data is distributed
385across both disks rather than concentrated on a single disk.
386If
387you really need to get sophisticated, we recommend using a real hardware
388RAID controller from the list of
389.Fx
390supported controllers.
391.Sh SYSCTL TUNING
392.Xr sysctl 8
393variables permit system behavior to be monitored and controlled at
394run-time.
395Some sysctls simply report on the behavior of the system; others allow
396the system behavior to be modified;
397some may be set at boot time using
398.Xr rc.conf 5 ,
399but most will be set via
400.Xr sysctl.conf 5 .
401There are several hundred sysctls in the system, including many that appear
402to be candidates for tuning but actually are not.
403In this document we will only cover the ones that have the greatest effect
404on the system.
405.Pp
406The
407.Va vm.overcommit
408sysctl defines the overcommit behaviour of the vm subsystem.
409The virtual memory system always does accounting of the swap space
410reservation, both total for system and per-user.
411Corresponding values
412are available through sysctl
413.Va vm.swap_total ,
414that gives the total bytes available for swapping, and
415.Va vm.swap_reserved ,
416that gives number of bytes that may be needed to back all currently
417allocated anonymous memory.
418.Pp
419Setting bit 0 of the
420.Va vm.overcommit
421sysctl causes the virtual memory system to return failure
422to the process when allocation of memory causes
423.Va vm.swap_reserved
424to exceed
425.Va vm.swap_total .
426Bit 1 of the sysctl enforces
427.Dv RLIMIT_SWAP
428limit
429(see
430.Xr getrlimit 2 ) .
431Root is exempt from this limit.
432Bit 2 allows to count most of the physical
433memory as allocatable, except wired and free reserved pages
434(accounted by
435.Va vm.stats.vm.v_free_target
436and
437.Va vm.stats.vm.v_wire_count
438sysctls, respectively).
439.Pp
440The
441.Va kern.ipc.maxpipekva
442loader tunable is used to set a hard limit on the
443amount of kernel address space allocated to mapping of pipe buffers.
444Use of the mapping allows the kernel to eliminate a copy of the
445data from writer address space into the kernel, directly copying
446the content of mapped buffer to the reader.
447Increasing this value to a higher setting, such as `25165824' might
448improve performance on systems where space for mapping pipe buffers
449is quickly exhausted.
450This exhaustion is not fatal; however, and it will only cause pipes to
451to fall back to using double-copy.
452.Pp
453The
454.Va kern.ipc.shm_use_phys
455sysctl defaults to 0 (off) and may be set to 0 (off) or 1 (on).
456Setting
457this parameter to 1 will cause all System V shared memory segments to be
458mapped to unpageable physical RAM.
459This feature only has an effect if you
460are either (A) mapping small amounts of shared memory across many (hundreds)
461of processes, or (B) mapping large amounts of shared memory across any
462number of processes.
463This feature allows the kernel to remove a great deal
464of internal memory management page-tracking overhead at the cost of wiring
465the shared memory into core, making it unswappable.
466.Pp
467The
468.Va vfs.vmiodirenable
469sysctl defaults to 1 (on).
470This parameter controls how directories are cached
471by the system.
472Most directories are small and use but a single fragment
473(typically 1K) in the file system and even less (typically 512 bytes) in
474the buffer cache.
475However, when operating in the default mode the buffer
476cache will only cache a fixed number of directories even if you have a huge
477amount of memory.
478Turning on this sysctl allows the buffer cache to use
479the VM Page Cache to cache the directories.
480The advantage is that all of
481memory is now available for caching directories.
482The disadvantage is that
483the minimum in-core memory used to cache a directory is the physical page
484size (typically 4K) rather than 512 bytes.
485We recommend turning this option off in memory-constrained environments;
486however, when on, it will substantially improve the performance of services
487that manipulate a large number of files.
488Such services can include web caches, large mail systems, and news systems.
489Turning on this option will generally not reduce performance even with the
490wasted memory but you should experiment to find out.
491.Pp
492The
493.Va vfs.write_behind
494sysctl defaults to 1 (on).
495This tells the file system to issue media
496writes as full clusters are collected, which typically occurs when writing
497large sequential files.
498The idea is to avoid saturating the buffer
499cache with dirty buffers when it would not benefit I/O performance.
500However,
501this may stall processes and under certain circumstances you may wish to turn
502it off.
503.Pp
504The
505.Va vfs.hirunningspace
506sysctl determines how much outstanding write I/O may be queued to
507disk controllers system-wide at any given instance.
508The default is
509usually sufficient but on machines with lots of disks you may want to bump
510it up to four or five megabytes.
511Note that setting too high a value
512(exceeding the buffer cache's write threshold) can lead to extremely
513bad clustering performance.
514Do not set this value arbitrarily high!
515Also,
516higher write queueing values may add latency to reads occurring at the same
517time.
518.Pp
519There are various other buffer-cache and VM page cache related sysctls.
520We do not recommend modifying these values.
521As of
522.Fx 4.3 ,
523the VM system does an extremely good job tuning itself.
524.Pp
525The
526.Va net.inet.tcp.sendspace
527and
528.Va net.inet.tcp.recvspace
529sysctls are of particular interest if you are running network intensive
530applications.
531They control the amount of send and receive buffer space
532allowed for any given TCP connection.
533The default sending buffer is 32K; the default receiving buffer
534is 64K.
535You can often
536improve bandwidth utilization by increasing the default at the cost of
537eating up more kernel memory for each connection.
538We do not recommend
539increasing the defaults if you are serving hundreds or thousands of
540simultaneous connections because it is possible to quickly run the system
541out of memory due to stalled connections building up.
542But if you need
543high bandwidth over a fewer number of connections, especially if you have
544gigabit Ethernet, increasing these defaults can make a huge difference.
545You can adjust the buffer size for incoming and outgoing data separately.
546For example, if your machine is primarily doing web serving you may want
547to decrease the recvspace in order to be able to increase the
548sendspace without eating too much kernel memory.
549Note that the routing table (see
550.Xr route 8 )
551can be used to introduce route-specific send and receive buffer size
552defaults.
553.Pp
554As an additional management tool you can use pipes in your
555firewall rules (see
556.Xr ipfw 8 )
557to limit the bandwidth going to or from particular IP blocks or ports.
558For example, if you have a T1 you might want to limit your web traffic
559to 70% of the T1's bandwidth in order to leave the remainder available
560for mail and interactive use.
561Normally a heavily loaded web server
562will not introduce significant latencies into other services even if
563the network link is maxed out, but enforcing a limit can smooth things
564out and lead to longer term stability.
565Many people also enforce artificial
566bandwidth limitations in order to ensure that they are not charged for
567using too much bandwidth.
568.Pp
569Setting the send or receive TCP buffer to values larger than 65535 will result
570in a marginal performance improvement unless both hosts support the window
571scaling extension of the TCP protocol, which is controlled by the
572.Va net.inet.tcp.rfc1323
573sysctl.
574These extensions should be enabled and the TCP buffer size should be set
575to a value larger than 65536 in order to obtain good performance from
576certain types of network links; specifically, gigabit WAN links and
577high-latency satellite links.
578RFC1323 support is enabled by default.
579.Pp
580The
581.Va net.inet.tcp.always_keepalive
582sysctl determines whether or not the TCP implementation should attempt
583to detect dead TCP connections by intermittently delivering
584.Dq keepalives
585on the connection.
586By default, this is enabled for all applications; by setting this
587sysctl to 0, only applications that specifically request keepalives
588will use them.
589In most environments, TCP keepalives will improve the management of
590system state by expiring dead TCP connections, particularly for
591systems serving dialup users who may not always terminate individual
592TCP connections before disconnecting from the network.
593However, in some environments, temporary network outages may be
594incorrectly identified as dead sessions, resulting in unexpectedly
595terminated TCP connections.
596In such environments, setting the sysctl to 0 may reduce the occurrence of
597TCP session disconnections.
598.Pp
599The
600.Va net.inet.tcp.delayed_ack
601TCP feature is largely misunderstood.
602Historically speaking, this feature
603was designed to allow the acknowledgement to transmitted data to be returned
604along with the response.
605For example, when you type over a remote shell,
606the acknowledgement to the character you send can be returned along with the
607data representing the echo of the character.
608With delayed acks turned off,
609the acknowledgement may be sent in its own packet, before the remote service
610has a chance to echo the data it just received.
611This same concept also
612applies to any interactive protocol (e.g.\& SMTP, WWW, POP3), and can cut the
613number of tiny packets flowing across the network in half.
614The
615.Fx
616delayed ACK implementation also follows the TCP protocol rule that
617at least every other packet be acknowledged even if the standard 100ms
618timeout has not yet passed.
619Normally the worst a delayed ACK can do is
620slightly delay the teardown of a connection, or slightly delay the ramp-up
621of a slow-start TCP connection.
622While we are not sure we believe that
623the several FAQs related to packages such as SAMBA and SQUID which advise
624turning off delayed acks may be referring to the slow-start issue.
625In
626.Fx ,
627it would be more beneficial to increase the slow-start flightsize via
628the
629.Va net.inet.tcp.slowstart_flightsize
630sysctl rather than disable delayed acks.
631.Pp
632The
633.Va net.inet.tcp.inflight.enable
634sysctl turns on bandwidth delay product limiting for all TCP connections.
635The system will attempt to calculate the bandwidth delay product for each
636connection and limit the amount of data queued to the network to just the
637amount required to maintain optimum throughput.
638This feature is useful
639if you are serving data over modems, GigE, or high speed WAN links (or
640any other link with a high bandwidth*delay product), especially if you are
641also using window scaling or have configured a large send window.
642If you enable this option, you should also be sure to set
643.Va net.inet.tcp.inflight.debug
644to 0 (disable debugging), and for production use setting
645.Va net.inet.tcp.inflight.min
646to at least 6144 may be beneficial.
647Note however, that setting high
648minimums may effectively disable bandwidth limiting depending on the link.
649The limiting feature reduces the amount of data built up in intermediate
650router and switch packet queues as well as reduces the amount of data built
651up in the local host's interface queue.
652With fewer packets queued up,
653interactive connections, especially over slow modems, will also be able
654to operate with lower round trip times.
655However, note that this feature
656only affects data transmission (uploading / server-side).
657It does not
658affect data reception (downloading).
659.Pp
660Adjusting
661.Va net.inet.tcp.inflight.stab
662is not recommended.
663This parameter defaults to 20, representing 2 maximal packets added
664to the bandwidth delay product window calculation.
665The additional
666window is required to stabilize the algorithm and improve responsiveness
667to changing conditions, but it can also result in higher ping times
668over slow links (though still much lower than you would get without
669the inflight algorithm).
670In such cases you may
671wish to try reducing this parameter to 15, 10, or 5, and you may also
672have to reduce
673.Va net.inet.tcp.inflight.min
674(for example, to 3500) to get the desired effect.
675Reducing these parameters
676should be done as a last resort only.
677.Pp
678The
679.Va net.inet.ip.portrange.*
680sysctls control the port number ranges automatically bound to TCP and UDP
681sockets.
682There are three ranges: a low range, a default range, and a
683high range, selectable via the
684.Dv IP_PORTRANGE
685.Xr setsockopt 2
686call.
687Most
688network programs use the default range which is controlled by
689.Va net.inet.ip.portrange.first
690and
691.Va net.inet.ip.portrange.last ,
692which default to 49152 and 65535, respectively.
693Bound port ranges are
694used for outgoing connections, and it is possible to run the system out
695of ports under certain circumstances.
696This most commonly occurs when you are
697running a heavily loaded web proxy.
698The port range is not an issue
699when running a server which handles mainly incoming connections, such as a
700normal web server, or has a limited number of outgoing connections, such
701as a mail relay.
702For situations where you may run out of ports,
703we recommend decreasing
704.Va net.inet.ip.portrange.first
705modestly.
706A range of 10000 to 30000 ports may be reasonable.
707You should also consider firewall effects when changing the port range.
708Some firewalls
709may block large ranges of ports (usually low-numbered ports) and expect systems
710to use higher ranges of ports for outgoing connections.
711By default
712.Va net.inet.ip.portrange.last
713is set at the maximum allowable port number.
714.Pp
715The
716.Va kern.ipc.somaxconn
717sysctl limits the size of the listen queue for accepting new TCP connections.
718The default value of 128 is typically too low for robust handling of new
719connections in a heavily loaded web server environment.
720For such environments,
721we recommend increasing this value to 1024 or higher.
722The service daemon
723may itself limit the listen queue size (e.g.\&
724.Xr sendmail 8 ,
725apache) but will
726often have a directive in its configuration file to adjust the queue size up.
727Larger listen queues also do a better job of fending off denial of service
728attacks.
729.Pp
730The
731.Va kern.maxfiles
732sysctl determines how many open files the system supports.
733The default is
734typically a few thousand but you may need to bump this up to ten or twenty
735thousand if you are running databases or large descriptor-heavy daemons.
736The read-only
737.Va kern.openfiles
738sysctl may be interrogated to determine the current number of open files
739on the system.
740.Pp
741The
742.Va vm.swap_idle_enabled
743sysctl is useful in large multi-user systems where you have lots of users
744entering and leaving the system and lots of idle processes.
745Such systems
746tend to generate a great deal of continuous pressure on free memory reserves.
747Turning this feature on and adjusting the swapout hysteresis (in idle
748seconds) via
749.Va vm.swap_idle_threshold1
750and
751.Va vm.swap_idle_threshold2
752allows you to depress the priority of pages associated with idle processes
753more quickly then the normal pageout algorithm.
754This gives a helping hand
755to the pageout daemon.
756Do not turn this option on unless you need it,
757because the tradeoff you are making is to essentially pre-page memory sooner
758rather than later, eating more swap and disk bandwidth.
759In a small system
760this option will have a detrimental effect but in a large system that is
761already doing moderate paging this option allows the VM system to stage
762whole processes into and out of memory more easily.
763.Sh LOADER TUNABLES
764Some aspects of the system behavior may not be tunable at runtime because
765memory allocations they perform must occur early in the boot process.
766To change loader tunables, you must set their values in
767.Xr loader.conf 5
768and reboot the system.
769.Pp
770.Va kern.maxusers
771controls the scaling of a number of static system tables, including defaults
772for the maximum number of open files, sizing of network memory resources, etc.
773As of
774.Fx 4.5 ,
775.Va kern.maxusers
776is automatically sized at boot based on the amount of memory available in
777the system, and may be determined at run-time by inspecting the value of the
778read-only
779.Va kern.maxusers
780sysctl.
781Some sites will require larger or smaller values of
782.Va kern.maxusers
783and may set it as a loader tunable; values of 64, 128, and 256 are not
784uncommon.
785We do not recommend going above 256 unless you need a huge number
786of file descriptors; many of the tunable values set to their defaults by
787.Va kern.maxusers
788may be individually overridden at boot-time or run-time as described
789elsewhere in this document.
790Systems older than
791.Fx 4.4
792must set this value via the kernel
793.Xr config 8
794option
795.Cd maxusers
796instead.
797.Pp
798The
799.Va kern.dfldsiz
800and
801.Va kern.dflssiz
802tunables set the default soft limits for process data and stack size
803respectively.
804Processes may increase these up to the hard limits by calling
805.Xr setrlimit 2 .
806The
807.Va kern.maxdsiz ,
808.Va kern.maxssiz ,
809and
810.Va kern.maxtsiz
811tunables set the hard limits for process data, stack, and text size
812respectively; processes may not exceed these limits.
813The
814.Va kern.sgrowsiz
815tunable controls how much the stack segment will grow when a process
816needs to allocate more stack.
817.Pp
818.Va kern.ipc.nmbclusters
819may be adjusted to increase the number of network mbufs the system is
820willing to allocate.
821Each cluster represents approximately 2K of memory,
822so a value of 1024 represents 2M of kernel memory reserved for network
823buffers.
824You can do a simple calculation to figure out how many you need.
825If you have a web server which maxes out at 1000 simultaneous connections,
826and each connection eats a 16K receive and 16K send buffer, you need
827approximately 32MB worth of network buffers to deal with it.
828A good rule of
829thumb is to multiply by 2, so 32MBx2 = 64MB/2K = 32768.
830So for this case
831you would want to set
832.Va kern.ipc.nmbclusters
833to 32768.
834We recommend values between
8351024 and 4096 for machines with moderates amount of memory, and between 4096
836and 32768 for machines with greater amounts of memory.
837Under no circumstances
838should you specify an arbitrarily high value for this parameter, it could
839lead to a boot-time crash.
840The
841.Fl m
842option to
843.Xr netstat 1
844may be used to observe network cluster use.
845Older versions of
846.Fx
847do not have this tunable and require that the
848kernel
849.Xr config 8
850option
851.Dv NMBCLUSTERS
852be set instead.
853.Pp
854More and more programs are using the
855.Xr sendfile 2
856system call to transmit files over the network.
857The
858.Va kern.ipc.nsfbufs
859sysctl controls the number of file system buffers
860.Xr sendfile 2
861is allowed to use to perform its work.
862This parameter nominally scales
863with
864.Va kern.maxusers
865so you should not need to modify this parameter except under extreme
866circumstances.
867See the
868.Sx TUNING
869section in the
870.Xr sendfile 2
871manual page for details.
872.Sh KERNEL CONFIG TUNING
873There are a number of kernel options that you may have to fiddle with in
874a large-scale system.
875In order to change these options you need to be
876able to compile a new kernel from source.
877The
878.Xr config 8
879manual page and the handbook are good starting points for learning how to
880do this.
881Generally the first thing you do when creating your own custom
882kernel is to strip out all the drivers and services you do not use.
883Removing things like
884.Dv INET6
885and drivers you do not have will reduce the size of your kernel, sometimes
886by a megabyte or more, leaving more memory available for applications.
887.Pp
888.Dv SCSI_DELAY
889may be used to reduce system boot times.
890The defaults are fairly high and
891can be responsible for 5+ seconds of delay in the boot process.
892Reducing
893.Dv SCSI_DELAY
894to something below 5 seconds could work (especially with modern drives).
895.Pp
896There are a number of
897.Dv *_CPU
898options that can be commented out.
899If you only want the kernel to run
900on a Pentium class CPU, you can easily remove
901.Dv I486_CPU ,
902but only remove
903.Dv I586_CPU
904if you are sure your CPU is being recognized as a Pentium II or better.
905Some clones may be recognized as a Pentium or even a 486 and not be able
906to boot without those options.
907If it works, great!
908The operating system
909will be able to better use higher-end CPU features for MMU, task switching,
910timebase, and even device operations.
911Additionally, higher-end CPUs support
9124MB MMU pages, which the kernel uses to map the kernel itself into memory,
913increasing its efficiency under heavy syscall loads.
914.Sh IDE WRITE CACHING
915.Fx 4.3
916flirted with turning off IDE write caching.
917This reduced write bandwidth
918to IDE disks but was considered necessary due to serious data consistency
919issues introduced by hard drive vendors.
920Basically the problem is that
921IDE drives lie about when a write completes.
922With IDE write caching turned
923on, IDE hard drives will not only write data to disk out of order, they
924will sometimes delay some of the blocks indefinitely under heavy disk
925load.
926A crash or power failure can result in serious file system
927corruption.
928So our default was changed to be safe.
929Unfortunately, the
930result was such a huge loss in performance that we caved in and changed the
931default back to on after the release.
932You should check the default on
933your system by observing the
934.Va hw.ata.wc
935sysctl variable.
936If IDE write caching is turned off, you can turn it back
937on by setting the
938.Va hw.ata.wc
939loader tunable to 1.
940More information on tuning the ATA driver system may be found in the
941.Xr ata 4
942manual page.
943If you need performance, go with SCSI.
944.Sh CPU, MEMORY, DISK, NETWORK
945The type of tuning you do depends heavily on where your system begins to
946bottleneck as load increases.
947If your system runs out of CPU (idle times
948are perpetually 0%) then you need to consider upgrading the CPU or moving to
949an SMP motherboard (multiple CPU's), or perhaps you need to revisit the
950programs that are causing the load and try to optimize them.
951If your system
952is paging to swap a lot you need to consider adding more memory.
953If your
954system is saturating the disk you typically see high CPU idle times and
955total disk saturation.
956.Xr systat 1
957can be used to monitor this.
958There are many solutions to saturated disks:
959increasing memory for caching, mirroring disks, distributing operations across
960several machines, and so forth.
961If disk performance is an issue and you
962are using IDE drives, switching to SCSI can help a great deal.
963While modern
964IDE drives compare with SCSI in raw sequential bandwidth, the moment you
965start seeking around the disk SCSI drives usually win.
966.Pp
967Finally, you might run out of network suds.
968The first line of defense for
969improving network performance is to make sure you are using switches instead
970of hubs, especially these days where switches are almost as cheap.
971Hubs
972have severe problems under heavy loads due to collision back-off and one bad
973host can severely degrade the entire LAN.
974Second, optimize the network path
975as much as possible.
976For example, in
977.Xr firewall 7
978we describe a firewall protecting internal hosts with a topology where
979the externally visible hosts are not routed through it.
980Use 100BaseT rather
981than 10BaseT, or use 1000BaseT rather than 100BaseT, depending on your needs.
982Most bottlenecks occur at the WAN link (e.g.\&
983modem, T1, DSL, whatever).
984If expanding the link is not an option it may be possible to use the
985.Xr dummynet 4
986feature to implement peak shaving or other forms of traffic shaping to
987prevent the overloaded service (such as web services) from affecting other
988services (such as email), or vice versa.
989In home installations this could
990be used to give interactive traffic (your browser,
991.Xr ssh 1
992logins) priority
993over services you export from your box (web services, email).
994.Sh SEE ALSO
995.Xr netstat 1 ,
996.Xr systat 1 ,
997.Xr sendfile 2 ,
998.Xr ata 4 ,
999.Xr dummynet 4 ,
1000.Xr login.conf 5 ,
1001.Xr rc.conf 5 ,
1002.Xr sysctl.conf 5 ,
1003.Xr firewall 7 ,
1004.Xr hier 7 ,
1005.Xr ports 7 ,
1006.Xr boot 8 ,
1007.Xr bsdlabel 8 ,
1008.Xr ccdconfig 8 ,
1009.Xr config 8 ,
1010.Xr fsck 8 ,
1011.Xr gjournal 8 ,
1012.Xr gstripe 8 ,
1013.Xr gvinum 8 ,
1014.Xr ifconfig 8 ,
1015.Xr ipfw 8 ,
1016.Xr loader 8 ,
1017.Xr mount 8 ,
1018.Xr newfs 8 ,
1019.Xr route 8 ,
1020.Xr sysctl 8 ,
1021.Xr sysinstall 8 ,
1022.Xr tunefs 8
1023.Sh HISTORY
1024The
1025.Nm
1026manual page was originally written by
1027.An Matthew Dillon
1028and first appeared
1029in
1030.Fx 4.3 ,
1031May 2001.
1032