Add a dsched(4) manual page.
[dragonfly.git] / share / man / man4 / dsched.4
1 .\"
2 .\" Redistribution and use in source and binary forms, with or without
3 .\" modification, are permitted provided that the following conditions
4 .\" are met:
5 .\" 1. Redistributions of source code must retain the above copyright
6 .\"    notice, this list of conditions and the following disclaimer.
7 .\" 2. Redistributions in binary form must reproduce the above copyright
8 .\"    notice, this list of conditions and the following disclaimer in the
9 .\"    documentation and/or other materials provided with the distribution.
10 .\"
11 .Dd August 16, 2010
12 .Os
13 .Dt DSCHED 4
14 .Sh NAME
15 .Nm dsched
16 .Nd kernel disk scheduler framework
17 .Sh DESCRIPTION
18 The
19 .Nm
20 framework implements a disk scheduler framework that can be
21 used to switch disk scheduling policies at runtime for each
22 disk in the system.
23 The
24 .Nm
25 framework and the policies for each disk can be managed via
26 .Xr loader 8
27 tunables and via
28 .Xr sysctl 8
29 variables.
30 .Sh LOADER TUNABLES
31 Tunables can be set at the
32 .Xr loader 8
33 prompt before booting the kernel or stored in
34 .Xr loader.conf 5 .
35 .Bl -tag -width ".Va dsched.policy.default"
36 .It Va dsched.policy.default
37 This tunable sets the default policy used for every device that
38 has no policy specified via any of the other tunables.
39 .It Va dsched.policy.da0
40 This tunable sets the dsched policy for the disk da0.
41 The default value is 0.
42 .It Va dsched.policy.da
43 This tunable sets the dsched policy for all disks created by
44 the driver
45 .Xr da 4 .
46 .El
47 .Sh SYSCTL VARIABLES
48 .Bl -tag -width ".Va dsched.policy.SN39A39"
49 .It Va dsched.debug
50 set the debug-level, 0 means no debugging, 5 for maximum.
51 .It Va dsched.policy.default
52 shows and sets the current default dsched policy.
53 .It Va dsched.policy.da0
54 shows and sets the current policy for the disk da0.
55 .It Va dsched.policy.SN39A39
56 shows and sets the current policy for the disk with serial number
57 SN39A39.
58 .El
59 .Pp
60 .Bl -tag -width ".Va dsched.policy.SN39A39"
61 The following are informative only:
62 .It Va dsched.policies
63 shows all available dsched policies, separated by spaces.
64 .El
65 .Sh SEE ALSO
66 .Xr loader.conf 5 ,
67 .Xr sysctl.conf 5
68 .\".Xr dsched 9
69 .Sh HISTORY
70 The
71 .Nm
72 framework first appeared in
73 .Dx 2.5 .
74 .Sh AUTHORS
75 The
76 .Nm
77 framework was written by
78 .An Alex Hornung .