1 <?xml version='1.0' encoding='UTF-8'?>
2 <!-- This document was created with Syntext Serna Free. --><chapter xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US" xml:id="lustreproc">
3 <title xml:id="lustreproc.title">LustreProc</title>
4 <para>The <literal>/proc</literal> file system acts as an interface to internal data structures in the kernel. The <literal>/proc</literal> variables can be used to control aspects of Lustre performance and provide information.</para>
5 <para>This chapter describes Lustre /proc entries and includes the following sections:</para>
8 <para><xref linkend="dbdoclet.50438271_90999"/></para>
11 <para><xref linkend="dbdoclet.50438271_78950"/></para>
14 <para><xref linkend="dbdoclet.50438271_83523"/></para>
17 <section xml:id="dbdoclet.50438271_90999">
18 <title><indexterm><primary>proc</primary></indexterm>Proc Entries for Lustre</title>
19 <para>This section describes <literal>/proc</literal> entries for Lustre.</para>
21 <title>Locating Lustre File Systems and Servers</title>
22 <para>Use the proc files on the MGS to locate the following:</para>
25 <para> All known file systems</para>
26 <screen># cat /proc/fs/lustre/mgs/MGS/filesystems
33 <para> The server names participating in a file system (for each file system that has at least one server running)</para>
34 <screen># cat /proc/fs/lustre/mgs/MGS/live/spfs
41 <para>All servers are named according to this convention: <literal><fsname>-<MDT|OST><XXXX></literal>. This can be shown for live servers under <literal>/proc/fs/lustre/devices</literal>:</para>
42 <screen># cat /proc/fs/lustre/devices
44 1 UP mgc MGC192.168.10.34@tcp 1f45bb57-d9be-2ddb-c0b0-5431a49226705
45 2 UP mdt MDS MDS_uuid 3
46 3 UP lov lustre-mdtlov lustre-mdtlov_UUID 4
47 4 UP mds lustre-MDT0000 lustre-MDT0000_UUID 7
48 5 UP osc lustre-OST0000-osc lustre-mdtlov_UUID 5
49 6 UP osc lustre-OST0001-osc lustre-mdtlov_UUID 5
50 7 UP lov lustre-clilov-ce63ca00 08ac6584-6c4a-3536-2c6d-b36cf9cbdaa04
51 8 UP mdc lustre-MDT0000-mdc-ce63ca00 08ac6584-6c4a-3536-2c6d-b36cf9cbdaa05
52 9 UP osc lustre-OST0000-osc-ce63ca00 08ac6584-6c4a-3536-2c6d-b36cf9cbdaa05
53 10 UP osc lustre-OST0001-osc-ce63ca00 08ac6584-6c4a-3536-2c6d-b36cf9cbdaa05</screen>
54 <para>Or from the device label at any time:</para>
55 <screen># e2label /dev/sda
56 lustre-MDT0000</screen>
59 <title><indexterm><primary>proc</primary><secondary>timeouts</secondary></indexterm>Lustre Timeouts</title>
60 <para>Lustre uses two types of timeouts.</para>
63 <para>LND timeouts that ensure point-to-point communications complete in finite time in the presence of failures. These timeouts are logged with the <literal>S_LND</literal> flag set. They may <emphasis>not</emphasis> be printed as console messages, so you should check the Lustre log for <literal>D_NETERROR</literal> messages, or enable printing of <literal>D_NETERROR</literal> messages to the console (<literal>echo + neterror > /proc/sys/lnet/printk</literal>).</para>
66 <para>Congested routers can be a source of spurious LND timeouts. To avoid this, increase the number of LNET router buffers to reduce back-pressure and/or increase LND timeouts on all nodes on all connected networks. You should also consider increasing the total number of LNET router nodes in the system so that the aggregate router bandwidth matches the aggregate server bandwidth.</para>
69 <para>Lustre timeouts that ensure Lustre RPCs complete in finite time in the presence of failures. These timeouts should <emphasis>always</emphasis> be printed as console messages. If Lustre timeouts are not accompanied by LNET timeouts, then you need to increase the lustre timeout on both servers and clients.</para>
72 <para>Specific Lustre timeouts are described below.</para>
73 <para><literal> /proc/sys/lustre/timeout </literal></para>
74 <para>This is the time period that a client waits for a server to complete an RPC (default is 100s). Servers wait half of this time for a normal client RPC to complete and a quarter of this time for a single bulk request (read or write of up to 1 MB) to complete. The client pings recoverable targets (MDS and OSTs) at one quarter of the timeout, and the server waits one and a half times the timeout before evicting a client for being "stale."</para>
76 <para>Lustre sends periodic 'PING' messages to servers with which it had no communication for a specified period of time. Any network activity on the file system that triggers network traffic toward servers also works as a health check.</para>
78 <para><literal> /proc/sys/lustre/ldlm_timeout </literal></para>
79 <para>This is the time period for which a server will wait for a client to reply to an initial AST (lock cancellation request) where default is 20s for an OST and 6s for an MDS. If the client replies to the AST, the server will give it a normal timeout (half of the client timeout) to flush any dirty data and release the lock.</para>
80 <para><literal> /proc/sys/lustre/fail_loc </literal></para>
81 <para>This is the internal debugging failure hook.</para>
82 <para>See <literal>lustre/include/linux/obd_support.h</literal> for the definitions of individual failure locations. The default value is 0 (zero).</para>
83 <screen>sysctl -w lustre.fail_loc=0x80000122 # drop a single reply</screen>
84 <para><literal> /proc/sys/lustre/dump_on_timeout </literal></para>
85 <para>This triggers dumps of the Lustre debug log when timeouts occur. The default value is 0 (zero).</para>
86 <para><literal> /proc/sys/lustre/dump_on_eviction </literal></para>
87 <para>This triggers dumps of the Lustre debug log when an eviction occurs. The default value is 0 (zero). By default, debug logs are dumped to the /tmp folder; this location can be changed via /proc.</para>
90 <title><indexterm><primary>proc</primary><secondary>adaptive timeouts</secondary></indexterm>Adaptive Timeouts</title>
91 <para>Lustre offers an adaptive mechanism to set RPC timeouts. The adaptive timeouts feature (enabled, by default) causes servers to track actual RPC completion times, and to report estimated completion times for future RPCs back to clients. The clients use these estimates to set their future RPC timeout values. If server request processing slows down for any reason, the RPC completion estimates increase, and the clients allow more time for RPC completion.</para>
92 <para>If RPCs queued on the server approach their timeouts, then the server sends an early reply to the client, telling the client to allow more time. In this manner, clients avoid RPC timeouts and disconnect/reconnect cycles. Conversely, as a server speeds up, RPC timeout values decrease, allowing faster detection of non-responsive servers and faster attempts to reconnect to a server's failover partner.</para>
93 <para>In previous Lustre versions, the static obd_timeout (<literal>/proc/sys/lustre/timeout</literal>) value was used as the maximum completion time for all RPCs; this value also affected the client-server ping interval and initial recovery timer. Now, with adaptive timeouts, obd_timeout is only used for the ping interval and initial recovery estimate. When a client reconnects during recovery, the server uses the client's timeout value to reset the recovery wait period; i.e., the server learns how long the client had been willing to wait, and takes this into account when adjusting the recovery period.</para>
95 <title><indexterm><primary>proc</primary><secondary>configuring adaptive timeouts</secondary></indexterm><indexterm><primary>configuring</primary><secondary>adaptive timeouts</secondary></indexterm>Configuring Adaptive Timeouts</title>
96 <para>One of the goals of adaptive timeouts is to relieve users from having to tune the <literal>obd_timeout</literal> value. In general, <literal>obd_timeout</literal> should no longer need to be changed. However, there are several parameters related to adaptive timeouts that users can set. In most situations, the default values should be used.</para>
97 <para>The following parameters can be set persistently system-wide using <literal>lctl conf_param</literal> on the MGS. For example, <literal>lctl conf_param work1.sys.at_max=1500</literal> sets the at_max value for all servers and clients using the work1 file system.</para>
99 <para>Nodes using multiple Lustre file systems must use the same <literal>at_*</literal> values for all file systems.)</para>
101 <informaltable frame="all">
103 <colspec colname="c1" colwidth="50*"/>
104 <colspec colname="c2" colwidth="50*"/>
108 <para><emphasis role="bold">Parameter</emphasis></para>
111 <para><emphasis role="bold">Description</emphasis></para>
118 <para> <literal> at_min </literal></para>
121 <para>Sets the minimum adaptive timeout (in seconds). Default value is 0. The at_min parameter is the minimum processing time that a server will report. Clients base their timeouts on this value, but they do not use this value directly. If you experience cases in which, for unknown reasons, the adaptive timeout value is too short and clients time out their RPCs (usually due to temporary network outages), then you can increase the at_min value to compensate for this. Ideally, users should leave at_min set to its default.</para>
126 <para> <literal> at_max </literal></para>
129 <para>Sets the maximum adaptive timeout (in seconds). The <literal>at_max</literal> parameter is an upper-limit on the service time estimate, and is used as a 'failsafe' in case of rogue/bad/buggy code that would lead to never-ending estimate increases. If at_max is reached, an RPC request is considered 'broken' and should time out.</para>
130 <para>Setting at_max to 0 causes adaptive timeouts to be disabled and the old fixed-timeout method (<literal>obd_timeout</literal>) to be used. This is the default value in Lustre 1.6.5.</para>
132 <para>It is possible that slow hardware might validly cause the service estimate to increase beyond the default value of at_max. In this case, you should increase at_max to the maximum time you are willing to wait for an RPC completion.</para>
138 <para> <literal> at_history </literal></para>
141 <para>Sets a time period (in seconds) within which adaptive timeouts remember the slowest event that occurred. Default value is 600.</para>
146 <para> <literal> at_early_margin </literal></para>
149 <para>Sets how far before the deadline Lustre sends an early reply. Default value is 5<footnote>
150 <para>This default was chosen as a reasonable time in which to send a reply from the point at which it was sent.</para>
156 <para> <literal> at_extra </literal></para>
159 <para>Sets the incremental amount of time that a server asks for, with each early reply. The server does not know how much time the RPC will take, so it asks for a fixed value. Default value is 30<footnote>
160 <para>This default was chosen as a balance between sending too many early replies for the same RPC and overestimating the actual completion time</para>
161 </footnote>. When a server finds a queued request about to time out (and needs to send an early reply out), the server adds the at_extra value. If the time expires, the Lustre client enters recovery status and reconnects to restore it to normal status.</para>
162 <para>If you see multiple early replies for the same RPC asking for multiple 30-second increases, change the at_extra value to a larger number to cut down on early replies sent and, therefore, network load.</para>
167 <para> <literal> ldlm_enqueue_min </literal></para>
170 <para> Sets the minimum lock enqueue time. Default value is 100. The <literal>ldlm_enqueue</literal> time is the maximum of the measured enqueue estimate (influenced by at_min and at_max parameters), multiplied by a weighting factor, and the <literal>ldlm_enqueue_min</literal> setting. LDLM lock enqueues were based on the <literal>obd_timeout</literal> value; now they have a dedicated minimum value. Lock enqueues increase as the measured enqueue times increase (similar to adaptive timeouts).</para>
176 <para>Adaptive timeouts are enabled, by default. To disable adaptive timeouts, at run time, set <literal>at_max</literal> to 0. On the MGS, run:</para>
177 <screen>$ lctl conf_param <fsname>.sys.at_max=0</screen>
179 <para>Changing adaptive timeouts status at runtime may cause transient timeout, reconnect, recovery, etc.</para>
183 <title><indexterm><primary>proc</primary><secondary>interpreting adaptive timeouts</secondary></indexterm>Interpreting Adaptive Timeouts Information</title>
184 <para>Adaptive timeouts information can be read from <literal>/proc/fs/lustre/*/timeouts</literal> files (for each service and client) or with the lctl command.</para>
185 <para>This is an example from the <literal>/proc/fs/lustre/*/timeouts</literal> files:</para>
186 <screen>cfs21:~# cat /proc/fs/lustre/ost/OSS/ost_io/timeouts</screen>
187 <para>This is an example using the <literal>lctl</literal> command:</para>
188 <screen>$ lctl get_param -n ost.*.ost_io.timeouts</screen>
189 <para>This is the sample output:</para>
190 <screen>service : cur 33 worst 34 (at 1193427052, 0d0h26m40s ago) 1 1 33 2</screen>
191 <para>The <literal>ost_io</literal> service on this node is currently reporting an estimate of 33 seconds. The worst RPC service time was 34 seconds, and it happened 26 minutes ago.</para>
192 <para>The output also provides a history of service times. In the example, there are 4 "bins" of <literal>adaptive_timeout_history</literal>, with the maximum RPC time in each bin reported. In 0-150 seconds, the maximum RPC time was 1, with the same result in 150-300 seconds. From 300-450 seconds, the worst (maximum) RPC time was 33 seconds, and from 450-600s the worst time was 2 seconds. The current estimated service time is the maximum value of the 4 bins (33 seconds in this example).</para>
193 <para>Service times (as reported by the servers) are also tracked in the client OBDs:</para>
194 <screen>cfs21:# lctl get_param osc.*.timeouts
195 last reply : 1193428639, 0d0h00m00s ago
196 network : cur 1 worst 2 (at 1193427053, 0d0h26m26s ago) 1 1 1 1
197 portal 6 : cur 33 worst 34 (at 1193427052, 0d0h26m27s ago) 33 33 33 2
198 portal 28 : cur 1 worst 1 (at 1193426141, 0d0h41m38s ago) 1 1 1 1
199 portal 7 : cur 1 worst 1 (at 1193426141, 0d0h41m38s ago) 1 0 1 1
200 portal 17 : cur 1 worst 1 (at 1193426177, 0d0h41m02s ago) 1 0 0 1
202 <para>In this case, RPCs to portal 6, the <literal>OST_IO_PORTAL</literal> (see <literal>lustre/include/lustre/lustre_idl.h</literal>), shows the history of what the <literal>ost_io</literal> portal has reported as the service estimate.</para>
203 <para>Server statistic files also show the range of estimates in the normal min/max/sum/sumsq manner.</para>
204 <screen>cfs21:~# lctl get_param mdt.*.mdt.stats
206 req_timeout 6 samples [sec] 1 10 15 105
212 <title><indexterm><primary>proc</primary><secondary>LNET</secondary></indexterm><indexterm><primary>LNET</primary><secondary>proc</secondary></indexterm>LNET Information</title>
213 <para>This section describes<literal> /proc</literal> entries for LNET information.</para>
214 <para><literal> /proc/sys/lnet/peers </literal></para>
215 <para>Shows all NIDs known to this node and also gives information on the queue state.</para>
216 <screen># cat /proc/sys/lnet/peers
217 nid refs state max rtr min tx min queue
218 0@lo 1 ~rtr 0 0 0 0 0 0
219 192.168.10.35@tcp 1 ~rtr 8 8 8 8 6 0
220 192.168.10.36@tcp 1 ~rtr 8 8 8 8 6 0
221 192.168.10.37@tcp 1 ~rtr 8 8 8 8 6 0</screen>
222 <para>The fields are explained below:</para>
223 <informaltable frame="all">
225 <colspec colname="c1" colwidth="50*"/>
226 <colspec colname="c2" colwidth="50*"/>
230 <para><emphasis role="bold">Field</emphasis></para>
233 <para><emphasis role="bold">Description</emphasis></para>
242 <replaceable>refs</replaceable>
247 <para>A reference count (principally used for debugging)</para>
254 <replaceable>state</replaceable>
259 <para>Only valid to refer to routers. Possible values:</para>
262 <para>~ rtr (indicates this node is not a router)</para>
265 <para>up/down (indicates this node is a router)</para>
268 <para>auto_fail must be enabled</para>
275 <para> <literal> max </literal></para>
278 <para>Maximum number of concurrent sends from this peer</para>
283 <para> <literal> rtr </literal></para>
286 <para>Routing buffer credits.</para>
291 <para> <literal> min </literal></para>
294 <para>Minimum routing buffer credits seen.</para>
299 <para> <literal> tx </literal></para>
302 <para>Send credits.</para>
307 <para> <literal> min </literal></para>
310 <para>Minimum send credits seen.</para>
315 <para> <literal> queue </literal></para>
318 <para>Total bytes in active/queued sends.</para>
324 <para>Credits work like a semaphore. At start they are initialized to allow a certain number of operations (8 in this example). LNET keeps a track of the minimum value so that you can see how congested a resource was.</para>
325 <para>If <literal>rtr/tx</literal> is less than max, there are operations in progress. The number of operations is equal to <literal>rtr</literal> or <literal>tx</literal> subtracted from max.</para>
326 <para>If <literal>rtr/tx</literal> is greater that max, there are operations blocking.</para>
327 <para>LNET also limits concurrent sends and router buffers allocated to a single peer so that no peer can occupy all these resources.</para>
328 <para><literal> /proc/sys/lnet/nis </literal></para>
329 <screen># cat /proc/sys/lnet/nis
330 nid refs peer max tx min
332 192.168.10.34@tcp 4 8 256 256 252
334 <para>Shows the current queue health on this node. The fields are explained below:</para>
335 <informaltable frame="all">
337 <colspec colname="c1" colwidth="50*"/>
338 <colspec colname="c2" colwidth="50*"/>
342 <para><emphasis role="bold">Field</emphasis></para>
345 <para><emphasis role="bold">Description</emphasis></para>
352 <para> <literal> nid </literal></para>
355 <para>Network interface</para>
360 <para> <literal> refs </literal></para>
363 <para>Internal reference counter</para>
368 <para> <literal> peer </literal></para>
371 <para>Number of peer-to-peer send credits on this NID. Credits are used to size buffer pools</para>
376 <para> <literal> max </literal></para>
379 <para>Total number of send credits on this NID.</para>
384 <para> <literal> tx </literal></para>
387 <para>Current number of send credits available on this NID.</para>
392 <para> <literal> min </literal></para>
395 <para>Lowest number of send credits available on this NID.</para>
400 <para> <literal> queue </literal></para>
403 <para>Total bytes in active/queued sends.</para>
409 <para>Subtracting <literal>max</literal> - <literal>tx</literal> yields the number of sends currently active. A large or increasing number of active sends may indicate a problem.</para>
410 <screen># cat /proc/sys/lnet/nis
411 nid refs peer max tx min
413 10.67.73.173@tcp 4 8 256 256 253
417 <title><indexterm><primary>proc</primary><secondary>free space</secondary></indexterm>Free Space Distribution</title>
418 <para>Free-space stripe weighting, as set, gives a priority of "0" to free space (versus trying to place the stripes "widely" -- nicely distributed across OSSs and OSTs to maximize network balancing). To adjust this priority (as a percentage), use the <literal>qos_prio_free</literal> proc tunable:</para>
419 <screen>$ cat /proc/fs/lustre/lov/<fsname>-mdtlov/qos_prio_free</screen>
420 <para>Currently, the default is 90%. You can permanently set this value by running this command on the MGS:</para>
421 <screen>$ lctl conf_param <fsname>-MDT0000.lov.qos_prio_free=90</screen>
422 <para>Setting the priority to 100% means that OSS distribution does not count in the weighting, but the stripe assignment is still done via weighting. If OST 2 has twice as much free space as OST 1, it is twice as likely to be used, but it is NOT guaranteed to be used.</para>
423 <para>Also note that free-space stripe weighting does not activate until two OSTs are imbalanced by more than 20%. Until then, a faster round-robin stripe allocator is used. (The new round-robin order also maximizes network balancing.)</para>
425 <title><indexterm><primary>proc</primary><secondary>striping</secondary></indexterm>Managing Stripe Allocation</title>
426 <para>The MDS uses two methods to manage stripe allocation and determine which OSTs to use for file object storage:</para>
429 <para><emphasis role="bold">QOS</emphasis></para>
430 <para>Quality of Service (QOS) considers an OST's available blocks, speed, and the number of existing objects, etc. Using these criteria, the MDS selects OSTs with more free space more often than OSTs with less free space.</para>
435 <para><emphasis role="bold">RR</emphasis></para>
436 <para>Round-Robin (RR) allocates objects evenly across all OSTs. The RR stripe allocator is faster than QOS, and used often because it distributes space usage/load best in most situations, maximizing network balancing and improving performance.</para>
439 <para>Whether QOS or RR is used depends on the setting of the <literal>qos_threshold_rr</literal> proc tunable. The <literal>qos_threshold_rr</literal> variable specifies a percentage threshold where the use of QOS or RR becomes more/less likely. The <literal>qos_threshold_rr</literal> tunable can be set as an integer, from 0 to 100, and results in this stripe allocation behavior:</para>
442 <para> If <literal>qos_threshold_rr</literal> is set to 0, then QOS is always used</para>
445 <para> If <literal>qos_threshold_rr</literal> is set to 100, then RR is always used</para>
448 <para> The larger the <literal>qos_threshold_rr</literal> setting, the greater the possibility that RR is used instead of QOS</para>
454 <section xml:id="dbdoclet.50438271_78950">
455 <title><indexterm><primary>proc</primary><secondary>I/O tunables</secondary></indexterm>Lustre I/O Tunables</title>
456 <para>The section describes I/O tunables.</para>
457 <para><literal> /proc/fs/lustre/llite/<fsname>-<uid>/max_cache_mb </literal></para>
458 <screen># cat /proc/fs/lustre/llite/lustre-ce63ca00/max_cached_mb 128</screen>
459 <para>This tunable is the maximum amount of inactive data cached by the client (default is 3/4 of RAM).</para>
461 <title><indexterm><primary>proc</primary><secondary>RPC tunables</secondary></indexterm>Client I/O RPC Stream Tunables</title>
462 <para>The Lustre engine always attempts to pack an optimal amount of data into each I/O RPC and attempts to keep a consistent number of issued RPCs in progress at a time. Lustre exposes several tuning variables to adjust behavior according to network conditions and cluster size. Each OSC has its own tree of these tunables. For example:</para>
463 <screen>$ ls -d /proc/fs/lustre/osc/OSC_client_ost1_MNT_client_2 /localhost
464 /proc/fs/lustre/osc/OSC_uml0_ost1_MNT_localhost
465 /proc/fs/lustre/osc/OSC_uml0_ost2_MNT_localhost
466 /proc/fs/lustre/osc/OSC_uml0_ost3_MNT_localhost
467 $ ls /proc/fs/lustre/osc/OSC_uml0_ost1_MNT_localhost
468 blocksizefilesfree max_dirty_mb ost_server_uuid stats</screen>
469 <para>... and so on.</para>
470 <para>RPC stream tunables are described below.</para>
471 <para><literal> /proc/fs/lustre/osc/<object name>/max_dirty_mb </literal></para>
472 <para>This tunable controls how many MBs of dirty data can be written and queued up in the OSC. POSIX file writes that are cached contribute to this count. When the limit is reached, additional writes stall until previously-cached writes are written to the server. This may be changed by writing a single ASCII integer to the file. Only values between 0 and 512 are allowable. If 0 is given, no writes are cached. Performance suffers noticeably unless you use large writes (1 MB or more).</para>
473 <para><literal> /proc/fs/lustre/osc/<object name>/cur_dirty_bytes </literal></para>
474 <para>This tunable is a read-only value that returns the current amount of bytes written and cached on this OSC.</para>
475 <para><literal> /proc/fs/lustre/osc/<object name>/max_pages_per_rpc </literal></para>
476 <para>This tunable is the maximum number of pages that will undergo I/O in a single RPC to the OST. The minimum is a single page and the maximum for this setting is platform dependent (256 for i386/x86_64, possibly less for ia64/PPC with larger <literal>PAGE_SIZE</literal>), though generally amounts to a total of 1 MB in the RPC.</para>
477 <para><literal> /proc/fs/lustre/osc/<object name>/max_rpcs_in_flight </literal></para>
478 <para>This tunable is the maximum number of concurrent RPCs in flight from an OSC to its OST. If the OSC tries to initiate an RPC but finds that it already has the same number of RPCs outstanding, it will wait to issue further RPCs until some complete. The minimum setting is 1 and maximum setting is 32. If you are looking to improve small file I/O performance, increase the <literal>max_rpcs_in_flight</literal> value.</para>
479 <para>To maximize performance, the value for <literal>max_dirty_mb</literal> is recommended to be 4 * <literal>max_pages_per_rpc</literal> * <literal>max_rpcs_in_flight</literal>.</para>
483 <replaceable><object name></replaceable>
485 varies depending on the specific Lustre configuration. For <literal><object name></literal> examples, refer to the sample command output.</para>
489 <title><indexterm><primary>proc</primary><secondary>watching RPC</secondary></indexterm>Watching the Client RPC Stream</title>
490 <para>The same directory contains a <literal>rpc_stats</literal> file with a histogram showing the composition of previous RPCs. The histogram can be cleared by writing any value into the <literal>rpc_stats</literal> file.</para>
491 <screen># cat /proc/fs/lustre/osc/spfs-OST0000-osc-c45f9c00/rpc_stats
492 snapshot_time: 1174867307.156604 (secs.usecs)
493 read RPCs in flight: 0
494 write RPCs in flight: 0
495 pending write pages: 0
496 pending read pages: 0
498 pages per rpc rpcs % cum % | rpcs % cum %
502 rpcs in flight rpcs % cum % | rpcs % cum %
506 offset rpcs % cum % | rpcs % cum %
510 <informaltable frame="all">
512 <colspec colname="c1" colwidth="50*"/>
513 <colspec colname="c2" colwidth="50*"/>
517 <para><emphasis role="bold">Field</emphasis></para>
520 <para><emphasis role="bold">Description</emphasis></para>
527 <para> <emphasis role="bold">{read,write} RPCs in flight</emphasis></para>
530 <para>Number of read/write RPCs issued by the OSC, but not complete at the time of the snapshot. This value should always be less than or equal to max_rpcs_in_flight.</para>
535 <para> <emphasis role="bold">pending {read,write} pages</emphasis></para>
538 <para>Number of pending read/write pages that have been queued for I/O in the OSC.</para>
543 <para> <emphasis role="bold">pages per RPC</emphasis></para>
546 <para>When an RPC is sent, the number of pages it consists of is recorded (in order). A single page RPC increments the 0: row.</para>
551 <para> <emphasis role="bold">RPCs in flight</emphasis></para>
554 <para>When an RPC is sent, the number of other RPCs that are pending is recorded. When the first RPC is sent, the 0: row is incremented. If the first RPC is sent while another is pending, the 1: row is incremented and so on. As each RPC *completes*, the number of pending RPCs is not tabulated.</para>
555 <para>This table is a good way to visualize the concurrency of the RPC stream. Ideally, you will see a large clump around the max_rpcs_in_flight value, which shows that the network is being kept busy.</para>
560 <para> <emphasis role="bold">offset</emphasis></para>
571 <title><indexterm><primary>proc</primary><secondary>read/write survey</secondary></indexterm>Client Read-Write Offset Survey</title>
572 <para>The offset_stats parameter maintains statistics for occurrences where a series of read or write calls from a process did not access the next sequential location. The offset field is reset to 0 (zero) whenever a different file is read/written.</para>
573 <para>Read/write offset statistics are off, by default. The statistics can be activated by writing anything into the <literal>offset_stats</literal> file.</para>
574 <para>Example:</para>
575 <screen># cat /proc/fs/lustre/llite/lustre-f57dee00/rw_offset_stats
576 snapshot_time: 1155748884.591028 (secs.usecs)
577 R/W PID RANGE START RANGE END SMALLEST EXTENT LARGEST EXTENT OFFSET
578 R 8385 0 128 128 128 0
579 R 8385 0 224 224 224 -128
580 W 8385 0 250 50 100 0
581 W 8385 100 1110 10 500 -150
582 W 8384 0 5233 5233 5233 0
583 R 8385 500 600 100 100 -610</screen>
585 <informaltable frame="all">
587 <colspec colname="c1" colwidth="50*"/>
588 <colspec colname="c2" colwidth="50*"/>
592 <para><emphasis role="bold">Field</emphasis></para>
595 <para><emphasis role="bold">Description</emphasis></para>
602 <para> <literal> R/W </literal></para>
605 <para>Whether the non-sequential call was a read or write</para>
610 <para> <literal> PID </literal></para>
613 <para>Process ID which made the read/write call.</para>
618 <para> <literal> Range Start/Range End </literal></para>
621 <para>Range in which the read/write calls were sequential.</para>
626 <para> <literal> Smallest Extent </literal></para>
629 <para>Smallest extent (single read/write) in the corresponding range.</para>
634 <para> <literal> Largest Extent </literal></para>
637 <para>Largest extent (single read/write) in the corresponding range.</para>
642 <para> <literal> Offset </literal></para>
645 <para>Difference from the previous range end to the current range start.</para>
646 <para>For example, Smallest-Extent indicates that the writes in the range 100 to 1110 were sequential, with a minimum write of 10 and a maximum write of 500. This range was started with an offset of -150. That means this is the difference between the last entry's range-end and this entry's range-start for the same file.</para>
647 <para>The <literal>rw_offset_stats</literal> file can be cleared by writing to it:</para>
648 <screen>echo > /proc/fs/lustre/llite/lustre-f57dee00/rw_offset_stats</screen>
656 <title><indexterm><primary>proc</primary><secondary>read/write survey</secondary></indexterm>Client Read-Write Extents Survey</title>
657 <para><emphasis role="bold">Client-Based I/O Extent Size Survey</emphasis></para>
658 <para>The <literal>rw_extent_stats</literal> histogram in the <literal>llite</literal> directory shows you the statistics for the sizes of the read-write I/O extents. This file does not maintain the per-process statistics.</para>
659 <para>Example:</para>
660 <screen>$ cat /proc/fs/lustre/llite/lustre-ee5af200/extents_stats
661 snapshot_time: 1213828728.348516 (secs.usecs)
663 extents calls % cum% | calls % cum%
665 0K - 4K : 0 0 0 | 2 2 2
666 4K - 8K : 0 0 0 | 0 0 2
667 8K - 16K : 0 0 0 | 0 0 2
668 16K - 32K : 0 0 0 | 20 23 26
669 32K - 64K : 0 0 0 | 0 0 26
670 64K - 128K : 0 0 0 | 51 60 86
671 128K - 256K : 0 0 0 | 0 0 86
672 256K - 512K : 0 0 0 | 0 0 86
673 512K - 1024K : 0 0 0 | 0 0 86
674 1M - 2M : 0 0 0 | 11 13 100</screen>
675 <para>The file can be cleared by issuing the following command:</para>
676 <screen>$ echo > cat /proc/fs/lustre/llite/lustre-ee5af200/extents_stats</screen>
677 <para><emphasis role="bold">Per-Process Client I/O Statistics</emphasis></para>
678 <para>The <literal>extents_stats_per_process</literal> file maintains the I/O extent size statistics on a per-process basis. So you can track the per-process statistics for the last <literal>MAX_PER_PROCESS_HIST</literal> processes.</para>
679 <para>Example:</para>
680 <screen>$ cat /proc/fs/lustre/llite/lustre-ee5af200/extents_stats_per_process
681 snapshot_time: 1213828762.204440 (secs.usecs)
683 extents calls % cum% | calls % cum%
686 0K - 4K : 0 0 0 | 0 0 0
687 4K - 8K : 0 0 0 | 0 0 0
688 8K - 16K : 0 0 0 | 0 0 0
689 16K - 32K : 0 0 0 | 0 0 0
690 32K - 64K : 0 0 0 | 0 0 0
691 64K - 128K : 0 0 0 | 0 0 0
692 128K - 256K : 0 0 0 | 0 0 0
693 256K - 512K : 0 0 0 | 0 0 0
694 512K - 1024K : 0 0 0 | 0 0 0
695 1M - 2M : 0 0 0 | 10 100 100
698 0K - 4K : 0 0 0 | 0 0 0
699 4K - 8K : 0 0 0 | 0 0 0
700 8K - 16K : 0 0 0 | 0 0 0
701 16K - 32K : 0 0 0 | 20 100 100
704 0K - 4K : 0 0 0 | 0 0 0
705 4K - 8K : 0 0 0 | 0 0 0
706 8K - 16K : 0 0 0 | 0 0 0
707 16K - 32K : 0 0 0 | 0 0 0
708 32K - 64K : 0 0 0 | 0 0 0
709 64K - 128K : 0 0 0 | 16 100 100
712 0K - 4K : 0 0 0 | 1 100 100
715 0K - 4K : 0 0 0 | 1 100 100
719 <section xml:id="dbdoclet.50438271_55057">
720 <title><indexterm><primary>proc</primary><secondary>block I/O</secondary></indexterm>Watching the OST Block I/O Stream</title>
721 <para>Similarly, there is a <literal>brw_stats</literal> histogram in the obdfilter directory which shows you the statistics for number of I/O requests sent to the disk, their size and whether they are contiguous on the disk or not.</para>
722 <screen>cat /proc/fs/lustre/obdfilter/lustre-OST0000/brw_stats
723 snapshot_time: 1174875636.764630 (secs:usecs)
725 pages per brw brws % cum % | rpcs % cum %
728 discont pages rpcs % cum % | rpcs % cum %
731 discont blocks rpcs % cum % | rpcs % cum %
734 dio frags rpcs % cum % | rpcs % cum %
737 disk ios in flight rpcs % cum % | rpcs % cum %
740 io time (1/1000s) rpcs % cum % | rpcs % cum %
743 disk io size rpcs % cum % | rpcs % cum %
747 <para>The fields are explained below:</para>
748 <informaltable frame="all">
750 <colspec colname="c1" colwidth="50*"/>
751 <colspec colname="c2" colwidth="50*"/>
755 <para><emphasis role="bold">Field</emphasis></para>
758 <para><emphasis role="bold">Description</emphasis></para>
765 <para> <literal> pages per brw </literal></para>
768 <para>Number of pages per RPC request, which should match aggregate client <literal>rpc_stats</literal>.</para>
773 <para> <literal> discont pages </literal></para>
776 <para>Number of discontinuities in the logical file offset of each page in a single RPC.</para>
781 <para> <literal> discont blocks </literal></para>
784 <para>Number of discontinuities in the physical block allocation in the file system for a single RPC.</para>
790 <para>For each Lustre service, the following information is provided:</para>
793 <para>Number of requests</para>
796 <para>Request wait time (avg, min, max and std dev)</para>
799 <para>Service idle time (% of elapsed time)</para>
802 <para>Additionally, data on each Lustre service is provided by service type:</para>
805 <para>Number of requests of this type</para>
808 <para>Request service time (avg, min, max and std dev)</para>
813 <title><indexterm><primary>proc</primary><secondary>readahead</secondary></indexterm>Using File Readahead and Directory Statahead</title>
814 <para>Lustre 1.6.5.1 introduced file readahead and directory statahead functionality that read data into memory in anticipation of a process actually requesting the data. File readahead functionality reads file content data into memory. Directory statahead functionality reads metadata into memory. When readahead and/or statahead work well, a data-consuming process finds that the information it needs is available when requested, and it is unnecessary to wait for network I/O.</para>
816 <title>Tuning File Readahead</title>
817 <para>File readahead is triggered when two or more sequential reads by an application fail to be satisfied by the Linux buffer cache. The size of the initial readahead is 1 MB. Additional readaheads grow linearly, and increment until the readahead cache on the client is full at 40 MB.</para>
818 <para><literal> /proc/fs/lustre/llite/<fsname>-<uid>/max_read_ahead_mb </literal></para>
819 <para>This tunable controls the maximum amount of data readahead on a file. Files are read ahead in RPC-sized chunks (1 MB or the size of read() call, if larger) after the second sequential read on a file descriptor. Random reads are done at the size of the read() call only (no readahead). Reads to non-contiguous regions of the file reset the readahead algorithm, and readahead is not triggered again until there are sequential reads again. To disable readahead, set this tunable to 0. The default value is 40 MB.</para>
820 <para><literal> /proc/fs/lustre/llite/<fsname>-<uid>/max_read_ahead_whole_mb </literal></para>
821 <para>This tunable controls the maximum size of a file that is read in its entirety, regardless of the size of the <literal>read()</literal>.</para>
824 <title>Tuning Directory Statahead</title>
825 <para>When the <literal>ls -l</literal> process opens a directory, its process ID is recorded. When the first directory entry is ''stated'' with this recorded process ID, a statahead thread is triggered which stats ahead all of the directory entries, in order. The <literal>ls -l</literal> process can use the stated directory entries directly, improving performance.</para>
826 <para><literal> /proc/fs/lustre/llite/*/statahead_max </literal></para>
827 <para>This tunable controls whether directory <literal>statahead</literal> is enabled and the maximum statahead count. By default, statahead is active.</para>
828 <para>To disable statahead, set this tunable to:</para>
829 <screen>echo 0 > /proc/fs/lustre/llite/*/statahead_max</screen>
830 <para>To set the maximum statahead count (n), set this tunable to:</para>
831 <screen>echo n > /proc/fs/lustre/llite/*/statahead_max</screen>
832 <para>The maximum value of n is 8192.</para>
835 <replaceable role="bold"> /proc/fs/lustre/llite/*/statahead_status </replaceable>
838 <para>This is a read-only interface that indicates the current statahead status.</para>
842 <title><indexterm><primary>proc</primary><secondary>read cache</secondary></indexterm>OSS Read Cache</title>
843 <para>The OSS read cache feature provides read-only caching of data on an OSS. This functionality uses the regular Linux page cache to store the data. Just like caching from a regular filesytem in Linux, OSS read cache uses as much physical memory as is allocated.</para>
844 <para>OSS read cache improves Lustre performance in these situations:</para>
847 <para>Many clients are accessing the same data set (as in HPC applications and when diskless clients boot from Lustre)</para>
850 <para>One client is storing data while another client is reading it (essentially exchanging data via the OST)</para>
853 <para>A client has very limited caching of its own</para>
856 <para>OSS read cache offers these benefits:</para>
859 <para>Allows OSTs to cache read data more frequently</para>
862 <para>Improves repeated reads to match network speeds instead of disk speeds</para>
865 <para>Provides the building blocks for OST write cache (small-write aggregation)</para>
869 <title>Using OSS Read Cache</title>
870 <para>OSS read cache is implemented on the OSS, and does not require any special support on the client side. Since OSS read cache uses the memory available in the Linux page cache, you should use I/O patterns to determine the appropriate amount of memory for the cache; if the data is mostly reads, then more cache is required than for writes.</para>
871 <para>OSS read cache is enabled, by default, and managed by the following tunables:</para>
874 <para><literal>read_cache_enable</literal> controls whether data read from disk during a read request is kept in memory and available for later read requests for the same data, without having to re-read it from disk. By default, read cache is enabled (<literal>read_cache_enable = 1</literal>).</para>
877 <para>When the OSS receives a read request from a client, it reads data from disk into its memory and sends the data as a reply to the requests. If read cache is enabled, this data stays in memory after the client's request is finished, and the OSS skips reading data from disk when subsequent read requests for the same are received. The read cache is managed by the Linux kernel globally across all OSTs on that OSS, and the least recently used cache pages will be dropped from memory when the amount of free memory is running low.</para>
878 <para>If read cache is disabled (<literal>read_cache_enable = 0</literal>), then the OSS will discard the data after the client's read requests are serviced and, for subsequent read requests, the OSS must read the data from disk.</para>
879 <para>To disable read cache on all OSTs of an OSS, run:</para>
880 <screen>root@oss1# lctl set_param obdfilter.*.read_cache_enable=0</screen>
881 <para>To re-enable read cache on one OST, run:</para>
882 <screen>root@oss1# lctl set_param obdfilter.{OST_name}.read_cache_enable=1</screen>
883 <para>To check if read cache is enabled on all OSTs on an OSS, run:</para>
884 <screen>root@oss1# lctl get_param obdfilter.*.read_cache_enable</screen>
887 <para><literal>writethrough_cache_enable</literal> controls whether data sent to the OSS as a write request is kept in the read cache and available for later reads, or if it is discarded from cache when the write is completed. By default, writethrough cache is enabled (<literal>writethrough_cache_enable = 1</literal>).</para>
890 <para>When the OSS receives write requests from a client, it receives data from the client into its memory and writes the data to disk. If writethrough cache is enabled, this data stays in memory after the write request is completed, allowing the OSS to skip reading this data from disk if a later read request, or partial-page write request, for the same data is received.</para>
891 <para>If writethrough cache is disabled (<literal>writethrough_cache_enabled = 0</literal>), then the OSS discards the data after the client's write request is completed, and for subsequent read request, or partial-page write request, the OSS must re-read the data from disk.</para>
892 <para>Enabling writethrough cache is advisable if clients are doing small or unaligned writes that would cause partial-page updates, or if the files written by one node are immediately being accessed by other nodes. Some examples where this might be useful include producer-consumer I/O models or shared-file writes with a different node doing I/O not aligned on 4096-byte boundaries. Disabling writethrough cache is advisable in the case where files are mostly written to the file system but are not re-read within a short time period, or files are only written and re-read by the same node, regardless of whether the I/O is aligned or not.</para>
893 <para>To disable writethrough cache on all OSTs of an OSS, run:</para>
894 <screen>root@oss1# lctl set_param obdfilter.*.writethrough_cache_enable=0</screen>
895 <para>To re-enable writethrough cache on one OST, run:</para>
896 <screen>root@oss1# lctl set_param \
897 obdfilter.{OST_name}.writethrough_cache_enable=1</screen>
898 <para>To check if writethrough cache is</para>
899 <screen>root@oss1# lctl set_param obdfilter.*.writethrough_cache_enable=1</screen>
902 <para><literal>readcache_max_filesize</literal> controls the maximum size of a file that both the read cache and writethrough cache will try to keep in memory. Files larger than <literal>readcache_max_filesize</literal> will not be kept in cache for either reads or writes.</para>
905 <para>This can be very useful for workloads where relatively small files are repeatedly accessed by many clients, such as job startup files, executables, log files, etc., but large files are read or written only once. By not putting the larger files into the cache, it is much more likely that more of the smaller files will remain in cache for a longer time.</para>
906 <para>When setting <literal>readcache_max_filesize</literal>, the input value can be specified in bytes, or can have a suffix to indicate other binary units such as <emphasis role="bold">K</emphasis>ilobytes, <emphasis role="bold">M</emphasis>egabytes, <emphasis role="bold">G</emphasis>igabytes, <emphasis role="bold">T</emphasis>erabytes, or <emphasis role="bold">P</emphasis>etabytes.</para>
907 <para>To limit the maximum cached file size to 32MB on all OSTs of an OSS, run:</para>
908 <screen>root@oss1# lctl set_param obdfilter.*.readcache_max_filesize=32M</screen>
909 <para>To disable the maximum cached file size on an OST, run:</para>
910 <screen>root@oss1# lctl set_param \
911 obdfilter.{OST_name}.readcache_max_filesize=-1</screen>
912 <para>To check the current maximum cached file size on all OSTs of an OSS, run:</para>
913 <screen>root@oss1# lctl get_param obdfilter.*.readcache_max_filesize</screen>
917 <title><indexterm><primary>proc</primary><secondary>OSS journal</secondary></indexterm>OSS Asynchronous Journal Commit</title>
918 <para>The OSS asynchronous journal commit feature synchronously writes data to disk without forcing a journal flush. This reduces the number of seeks and significantly improves performance on some hardware.</para>
920 <para>Asynchronous journal commit cannot work with O_DIRECT writes, a journal flush is still forced.</para>
922 <para>When asynchronous journal commit is enabled, client nodes keep data in the page cache (a page reference). Lustre clients monitor the last committed transaction number (transno) in messages sent from the OSS to the clients. When a client sees that the last committed transno reported by the OSS is >=bulk write transno, it releases the reference on the corresponding pages. To avoid page references being held for too long on clients after a bulk write, a 7 second ping request is scheduled (jbd commit time is 5 seconds) after the bulk write reply is received, so the OSS has an opportunity to report the last committed transno.</para>
923 <para>If the OSS crashes before the journal commit occurs, then the intermediate data is lost. However, new OSS recovery functionality (introduced in the asynchronous journal commit feature), causes clients to replay their write requests and compensate for the missing disk updates by restoring the state of the file system.</para>
924 <para>To enable asynchronous journal commit, set the <literal>sync_journal parameter</literal> to zero (<literal>sync_journal=0</literal>):</para>
925 <screen>$ lctl set_param obdfilter.*.sync_journal=0
926 obdfilter.lol-OST0001.sync_journal=0</screen>
927 <para>By default, <literal>sync_journal</literal> is disabled (<literal>sync_journal=1</literal>), which forces a journal flush after every bulk write.</para>
928 <para>When asynchronous journal commit is used, clients keep a page reference until the journal transaction commits. This can cause problems when a client receives a blocking callback, because pages need to be removed from the page cache, but they cannot be removed because of the extra page reference.</para>
929 <para>This problem is solved by forcing a journal flush on lock cancellation. When this happens, the client is granted the metadata blocks that have hit the disk, and it can safely release the page reference before processing the blocking callback. The parameter which controls this action is <literal>sync_on_lock_cancel</literal>, which can be set to the following values:</para>
932 <para><literal>always</literal>: Always force a journal flush on lock cancellation</para>
935 <para><literal>blocking</literal>: Force a journal flush only when the local cancellation is due to a blocking callback</para>
938 <para><literal>never</literal>: Do not force any journal flush</para>
941 <para>Here is an example of <literal>sync_on_lock_cancel</literal> being set not to force a journal flush:</para>
942 <screen>$ lctl get_param obdfilter.*.sync_on_lock_cancel
943 obdfilter.lol-OST0001.sync_on_lock_cancel=never</screen>
944 <para>By default, <literal>sync_on_lock_cancel</literal> is set to never, because asynchronous journal commit is disabled by default.</para>
945 <para>When asynchronous journal commit is enabled (<literal>sync_journal=0</literal>), <literal>sync_on_lock_cancel</literal> is automatically set to always, if it was previously set to never.</para>
946 <para>Similarly, when asynchronous journal commit is disabled, (<literal>sync_journal=1</literal>), <literal>sync_on_lock_cancel</literal> is enforced to never.</para>
949 <title><indexterm><primary>proc</primary><secondary>mballoc history</secondary></indexterm><literal>mballoc</literal> History</title>
950 <para><literal> /proc/fs/ldiskfs/sda/mb_history </literal></para>
951 <para>Multi-Block-Allocate (<literal>mballoc</literal>), enables Lustre to ask <literal>ldiskfs</literal> to allocate multiple blocks with a single request to the block allocator. Typically, an <literal>ldiskfs</literal> file system allocates only one block per time. Each <literal>mballoc</literal>-enabled partition has this file. This is sample output:</para>
952 <screen>pid inode goal result found grps cr \ merge tail broken
953 2838 139267 17/12288/1 17/12288/1 1 0 0 \ M 1 8192
954 2838 139267 17/12289/1 17/12289/1 1 0 0 \ M 0 0
955 2838 139267 17/12290/1 17/12290/1 1 0 0 \ M 1 2
956 2838 24577 3/12288/1 3/12288/1 1 0 0 \ M 1 8192
957 2838 24578 3/12288/1 3/771/1 1 1 1 \ 0 0
958 2838 32769 4/12288/1 4/12288/1 1 0 0 \ M 1 8192
959 2838 32770 4/12288/1 4/12289/1 13 1 1 \ 0 0
960 2838 32771 4/12288/1 5/771/1 26 2 1 \ 0 0
961 2838 32772 4/12288/1 5/896/1 31 2 1 \ 1 128
962 2838 32773 4/12288/1 5/897/1 31 2 1 \ 0 0
963 2828 32774 4/12288/1 5/898/1 31 2 1 \ 1 2
964 2838 32775 4/12288/1 5/899/1 31 2 1 \ 0 0
965 2838 32776 4/12288/1 5/900/1 31 2 1 \ 1 4
966 2838 32777 4/12288/1 5/901/1 31 2 1 \ 0 0
967 2838 32778 4/12288/1 5/902/1 31 2 1 \ 1 2</screen>
968 <para>The parameters are described below:</para>
969 <informaltable frame="all">
971 <colspec colname="c1" colwidth="50*"/>
972 <colspec colname="c2" colwidth="50*"/>
976 <para><emphasis role="bold">Parameter</emphasis></para>
979 <para><emphasis role="bold">Description</emphasis></para>
986 <para> <emphasis role="bold">
987 <literal>pid</literal>
991 <para>Process that made the allocation.</para>
996 <para> <emphasis role="bold">
997 <literal>inode</literal>
1001 <para>inode number allocated blocks</para>
1006 <para> <emphasis role="bold">
1007 <literal>goal</literal>
1011 <para>Initial request that came to <literal>mballoc</literal> (group/block-in-group/number-of-blocks)</para>
1016 <para> <emphasis role="bold">
1017 <literal>result</literal>
1021 <para>What <literal>mballoc</literal> actually found for this request.</para>
1026 <para> <emphasis role="bold">
1027 <literal>found</literal>
1031 <para>Number of free chunks <literal>mballoc</literal> found and measured before the final decision.</para>
1036 <para> <emphasis role="bold">
1037 <literal>grps</literal>
1041 <para>Number of groups <literal>mballoc</literal> scanned to satisfy the request.</para>
1046 <para> <emphasis role="bold">
1047 <literal>cr</literal>
1051 <para>Stage at which <literal>mballoc</literal> found the result:</para>
1052 <para><emphasis role="bold">0</emphasis> - best in terms of resource allocation. The request was 1MB or larger and was satisfied directly via the kernel buddy allocator.</para>
1053 <para><emphasis role="bold">1</emphasis> - regular stage (good at resource consumption)</para>
1054 <para><emphasis role="bold">2</emphasis> - fs is quite fragmented (not that bad at resource consumption)</para>
1055 <para><emphasis role="bold">3</emphasis> - fs is very fragmented (worst at resource consumption)</para>
1060 <para> <emphasis role="bold">
1061 <literal>queue</literal>
1065 <para>Total bytes in active/queued sends.</para>
1070 <para> <emphasis role="bold">
1071 <literal>merge</literal>
1075 <para>Whether the request hit the goal. This is good as extents code can now merge new blocks to existing extent, eliminating the need for extents tree growth.</para>
1080 <para> <emphasis role="bold">
1081 <literal>tail</literal>
1085 <para>Number of blocks left free after the allocation breaks large free chunks.</para>
1090 <para> <emphasis role="bold">
1091 <literal>broken</literal>
1095 <para>How large the broken chunk was.</para>
1101 <para>Most customers are probably interested in found/cr. If cr is 0 1 and found is less than 100, then <literal>mballoc</literal> is doing quite well.</para>
1102 <para>Also, number-of-blocks-in-request (third number in the goal triple) can tell the number of blocks requested by the <literal>obdfilter</literal>. If the <literal>obdfilter</literal> is doing a lot of small requests (just few blocks), then either the client is processing input/output to a lot of small files, or something may be wrong with the client (because it is better if client sends large input/output requests). This can be investigated with the OSC <literal>rpc_stats</literal> or OST <literal>brw_stats</literal> mentioned above.</para>
1103 <para>Number of groups scanned (<literal>grps</literal> column) should be small. If it reaches a few dozen often, then either your disk file system is pretty fragmented or <literal>mballoc</literal> is doing something wrong in the group selection part.</para>
1105 <section remap="h3">
1106 <title><indexterm><primary>proc</primary><secondary>mballoc3 tunables</secondary></indexterm><literal>mballoc3</literal> Tunables</title>
1107 <para>Lustre version 1.6.1 and later includes <literal>mballoc3</literal>, which was built on top of <literal>mballoc2</literal>. By default, mballoc3 is enabled, and adds these features:</para>
1110 <para> Pre-allocation for single files (helps to resist fragmentation)</para>
1113 <para> Pre-allocation for a group of files (helps to pack small files into large, contiguous chunks)</para>
1116 <para> Stream allocation (helps to decrease the seek rate)</para>
1119 <para>The following <literal>mballoc3</literal> tunables are available:</para>
1120 <informaltable frame="all">
1122 <colspec colname="c1" colwidth="50*"/>
1123 <colspec colname="c2" colwidth="50*"/>
1127 <para><emphasis role="bold">Field</emphasis></para>
1130 <para><emphasis role="bold">Description</emphasis></para>
1137 <para> <emphasis role="bold">
1138 <literal>stats</literal>
1142 <para>Enables/disables the collection of statistics. Collected statistics can be found</para>
1143 <para>in <literal>/proc/fs/ldiskfs2/<dev>/mb_history</literal>.</para>
1148 <para> <literal> max_to_scan </literal></para>
1151 <para>Maximum number of free chunks that <literal>mballoc</literal> finds before a final decision to avoid livelock.</para>
1156 <para> <literal> min_to_scan </literal></para>
1159 <para>Minimum number of free chunks that <literal>mballoc</literal> finds before a final decision. This is useful for a very small request, to resist fragmentation of big free chunks.</para>
1164 <para> <literal> order2_req </literal></para>
1167 <para>For requests equal to 2^N (where N >= <literal>order2_req</literal>), a very fast search via buddy structures is used.</para>
1172 <para> <literal> stream_req </literal></para>
1175 <para>Requests smaller or equal to this value are packed together to form large write I/Os.</para>
1181 <para>The following tunables, providing more control over allocation policy, will be available in the next version:</para>
1182 <informaltable frame="all">
1184 <colspec colname="c1" colwidth="50*"/>
1185 <colspec colname="c2" colwidth="50*"/>
1189 <para><emphasis role="bold">Field</emphasis></para>
1192 <para><emphasis role="bold">Description</emphasis></para>
1199 <para> <literal> stats </literal></para>
1202 <para>Enables/disables the collection of statistics. Collected statistics can be found in <literal>/proc/fs/ldiskfs2/<dev>/mb_history</literal>.</para>
1207 <para> <literal> max_to_scan </literal></para>
1210 <para>Maximum number of free chunks that <literal>mballoc</literal> finds before a final decision to avoid livelock.</para>
1215 <para> <literal> min_to_scan </literal></para>
1218 <para>Minimum number of free chunks that <literal>mballoc</literal> finds before a final decision. This is useful for a very small request, to resist fragmentation of big free chunks.</para>
1223 <para> <literal> order2_req </literal></para>
1226 <para>For requests equal to 2^N (where N >= <literal>order2_req</literal>), a very fast search via buddy structures is used.</para>
1231 <para> <literal> small_req </literal></para>
1233 <entry morerows="1">
1234 <para>All requests are divided into 3 categories:</para>
1235 <para>< small_req (packed together to form large, aggregated requests)</para>
1236 <para>< large_req (allocated mostly in linearly)</para>
1237 <para>> large_req (very large requests so the arm seek does not matter)</para>
1238 <para>The idea is that we try to pack small requests to form large requests, and then place all large requests (including compound from the small ones) close to one another, causing as few arm seeks as possible.</para>
1243 <para> <literal> large_req </literal></para>
1248 <para> <literal> prealloc_table </literal></para>
1251 <para>The amount of space to preallocate depends on the current file size. The idea is that for small files we do not need 1 MB preallocations and for large files, 1 MB preallocations are not large enough; it is better to preallocate 4 MB.</para>
1256 <para> <literal> group_prealloc </literal></para>
1259 <para>The amount of space preallocated for small requests to be grouped.</para>
1266 <section remap="h3">
1267 <title><indexterm><primary>proc</primary><secondary>locking</secondary></indexterm>Locking</title>
1268 <para><literal> /proc/fs/lustre/ldlm/ldlm/namespaces/<OSC name|MDC name>/lru_size </literal></para>
1269 <para>The <literal>lru_size</literal> parameter is used to control the number of client-side locks in an LRU queue. LRU size is dynamic, based on load. This optimizes the number of locks available to nodes that have different workloads (e.g., login/build nodes vs. compute nodes vs. backup nodes).</para>
1270 <para>The total number of locks available is a function of the server's RAM. The default limit is 50 locks/1 MB of RAM. If there is too much memory pressure, then the LRU size is shrunk. The number of locks on the server is limited to {number of OST/MDT on node} * {number of clients} * {client lru_size}.</para>
1273 <para>To enable automatic LRU sizing, set the <literal>lru_size</literal> parameter to 0. In this case, the <literal>lru_size</literal> parameter shows the current number of locks being used on the export. (In Lustre 1.6.5.1 and later, LRU sizing is enabled, by default.)</para>
1276 <para>To specify a maximum number of locks, set the lru_size parameter to a value > 0 (former numbers are okay, 100 * CPU_NR). We recommend that you only increase the LRU size on a few login nodes where users access the file system interactively.</para>
1279 <para>To clear the LRU on a single client, and as a result flush client cache, without changing the <literal>lru_size</literal> value:</para>
1280 <screen>$ lctl set_param ldlm.namespaces.<osc_name|mdc_name>.lru_size=clear</screen>
1281 <para>If you shrink the LRU size below the number of existing unused locks, then the unused locks are canceled immediately. Use echo clear to cancel all locks without changing the value.</para>
1283 <para>Currently, the lru_size parameter can only be set temporarily with <literal>lctl set_param</literal>; it cannot be set permanently.</para>
1285 <para>To disable LRU sizing, run this command on the Lustre clients:</para>
1286 <screen>$ lctl set_param ldlm.namespaces.*osc*.lru_size=$((NR_CPU*100))</screen>
1287 <para>Replace <literal>NR_CPU</literal> value with the number of CPUs on the node.</para>
1288 <para>To determine the number of locks being granted:</para>
1289 <screen>$ lctl get_param ldlm.namespaces.*.pool.limit</screen>
1291 <section xml:id="dbdoclet.50438271_87260">
1292 <title><indexterm><primary>proc</primary><secondary>thread counts</secondary></indexterm>Setting MDS and OSS Thread Counts</title>
1293 <para>MDS and OSS thread counts (minimum and maximum) can be set via the <literal>{min,max}_thread_count tunable</literal>. For each service, a new <literal>/proc/fs/lustre/{service}/*/thread_{min,max,started}</literal> entry is created. The tunable, <literal>{service}.thread_{min,max,started}</literal>, can be used to set the minimum and maximum thread counts or get the current number of running threads for the following services.</para>
1294 <informaltable frame="all">
1296 <colspec colname="c1" colwidth="50*"/>
1297 <colspec colname="c2" colwidth="50*"/>
1301 <para> <emphasis role="bold">Service</emphasis></para>
1304 <para> <emphasis role="bold">Description</emphasis></para>
1309 <literal> mdt.MDS.mds </literal>
1312 <para>normal metadata ops</para>
1317 <literal> mdt.MDS.mds_readpage </literal>
1320 <para>metadata readdir</para>
1325 <literal> mdt.MDS.mds_setattr </literal>
1328 <para>metadata setattr</para>
1333 <literal> ost.OSS.ost </literal>
1336 <para>normal data</para>
1341 <literal> ost.OSS.ost_io </literal>
1344 <para>bulk data IO</para>
1349 <literal> ost.OSS.ost_create </literal>
1352 <para>OST object pre-creation service</para>
1357 <literal> ldlm.services.ldlm_canceld </literal>
1360 <para>DLM lock cancel</para>
1365 <literal> ldlm.services.ldlm_cbd </literal>
1368 <para>DLM lock grant</para>
1376 <para>To temporarily set this tunable, run:</para>
1377 <screen># lctl {get,set}_param {service}.thread_{min,max,started} </screen>
1382 <para>To permanently set this tunable, run:</para>
1383 <screen># lctl conf_param {service}.thread_{min,max,started} </screen>
1384 <para>The following examples show how to set thread counts and get the number of running threads for the ost_io service.</para>
1389 <para>To get the number of running threads, run:</para>
1390 <screen># lctl get_param ost.OSS.ost_io.threads_started</screen>
1391 <para>The command output will be similar to this:</para>
1392 <screen>ost.OSS.ost_io.threads_started=128</screen>
1397 <para>To set the maximum number of threads (512), run:</para>
1398 <screen># lctl get_param ost.OSS.ost_io.threads_max</screen>
1399 <para>The command output will be:</para>
1400 <screen>ost.OSS.ost_io.threads_max=512</screen>
1405 <para> To set the maximum thread count to 256 instead of 512 (to avoid overloading the storage or for an array with requests), run:</para>
1406 <screen># lctl set_param ost.OSS.ost_io.threads_max=256</screen>
1407 <para>The command output will be:</para>
1408 <screen>ost.OSS.ost_io.threads_max=256</screen>
1413 <para> To check if the new <literal>threads_max</literal> setting is active, run:</para>
1414 <screen># lctl get_param ost.OSS.ost_io.threads_max</screen>
1415 <para>The command output will be similar to this:</para>
1416 <screen>ost.OSS.ost_io.threads_max=256</screen>
1420 <para>Currently, the maximum thread count setting is advisory because Lustre does not reduce the number of service threads in use, even if that number exceeds the <literal>threads_max</literal> value. Lustre does not stop service threads once they are started.</para>
1424 <section xml:id="dbdoclet.50438271_83523">
1425 <title><indexterm><primary>proc</primary><secondary>debug</secondary></indexterm>Debug</title>
1426 <para><literal> /proc/sys/lnet/debug </literal></para>
1427 <para>By default, Lustre generates a detailed log of all operations to aid in debugging. The level of debugging can affect the performance or speed you achieve with Lustre. Therefore, it is useful to reduce this overhead by turning down the debug level<footnote>
1428 <para>This controls the level of Lustre debugging kept in the internal log buffer. It does not alter the level of debugging that goes to syslog.</para>
1429 </footnote> to improve performance. Raise the debug level when you need to collect the logs for debugging problems. The debugging mask can be set with "symbolic names" instead of the numerical values that were used in prior releases. The new symbolic format is shown in the examples below.</para>
1431 <para>All of the commands below must be run as root; note the <literal>#</literal> nomenclature.</para>
1433 <para>To verify the debug level used by examining the <literal>sysctl</literal> that controls debugging, run:</para>
1434 <screen># sysctl lnet.debug
1435 lnet.debug = ioctl neterror warning error emerg ha config console</screen>
1436 <para>To turn off debugging (except for network error debugging), run this command on all concerned nodes:</para>
1437 <screen># sysctl -w lnet.debug="neterror"
1438 lnet.debug = neterror</screen>
1439 <para>To turn off debugging completely, run this command on all concerned nodes:</para>
1440 <screen># sysctl -w lnet.debug=0
1441 lnet.debug = 0</screen>
1442 <para>To set an appropriate debug level for a production environment, run:</para>
1443 <screen># sysctl -w lnet.debug="warning dlmtrace error emerg ha rpctrace vfstrace"
1444 lnet.debug = warning dlmtrace error emerg ha rpctrace vfstrace</screen>
1445 <para>The flags above collect enough high-level information to aid debugging, but they do not cause any serious performance impact.</para>
1446 <para>To clear all flags and set new ones, run:</para>
1447 <screen># sysctl -w lnet.debug="warning"
1448 lnet.debug = warning</screen>
1449 <para>To add new flags to existing ones, prefix them with a "<literal>+</literal>":</para>
1450 <screen># sysctl -w lnet.debug="+neterror +ha"
1451 lnet.debug = +neterror +ha
1453 lnet.debug = neterror warning ha</screen>
1454 <para>To remove flags, prefix them with a "<literal>-</literal>":</para>
1455 <screen># sysctl -w lnet.debug="-ha"
1458 lnet.debug = neterror warning</screen>
1459 <para>You can verify and change the debug level using the <literal>/proc</literal> interface in Lustre. To use the flags with <literal>/proc</literal>, run:</para>
1460 <screen># cat /proc/sys/lnet/debug
1462 # echo "+ha" > /proc/sys/lnet/debug
1463 # cat /proc/sys/lnet/debug
1465 # echo "-warning" > /proc/sys/lnet/debug
1466 # cat /proc/sys/lnet/debug
1467 neterror ha</screen>
1468 <para><literal> /proc/sys/lnet/subsystem_debug </literal></para>
1469 <para>This controls the debug logs for subsystems (see <literal>S_*</literal> definitions).</para>
1470 <para><literal> /proc/sys/lnet/debug_path </literal></para>
1471 <para>This indicates the location where debugging symbols should be stored for <literal>gdb</literal>. The default is set to <literal>/r/tmp/lustre-log-localhost.localdomain</literal>.</para>
1472 <para>These values can also be set via <literal>sysctl -w lnet.debug={value}</literal></para>
1474 <para>The above entries only exist when Lustre has already been loaded.</para>
1476 <para><literal> /proc/sys/lnet/panic_on_lbug </literal></para>
1477 <para>This causes Lustre to call ''panic'' when it detects an internal problem (an <literal>LBUG</literal>); panic crashes the node. This is particularly useful when a kernel crash dump utility is configured. The crash dump is triggered when the internal inconsistency is detected by Lustre.</para>
1478 <para><literal> /proc/sys/lnet/upcall </literal></para>
1479 <para>This allows you to specify the path to the binary which will be invoked when an <literal>LBUG</literal> is encountered. This binary is called with four parameters. The first one is the string ''<literal>LBUG</literal>''. The second one is the file where the <literal>LBUG</literal> occurred. The third one is the function name. The fourth one is the line number in the file.</para>
1480 <section remap="h3">
1481 <title>RPC Information for Other OBD Devices</title>
1482 <para>Some OBD devices maintain a count of the number of RPC events that they process. Sometimes these events are more specific to operations of the device, like llite, than actual raw RPC counts.</para>
1483 <screen>$ find /proc/fs/lustre/ -name stats
1484 /proc/fs/lustre/osc/lustre-OST0001-osc-ce63ca00/stats
1485 /proc/fs/lustre/osc/lustre-OST0000-osc-ce63ca00/stats
1486 /proc/fs/lustre/osc/lustre-OST0001-osc/stats
1487 /proc/fs/lustre/osc/lustre-OST0000-osc/stats
1488 /proc/fs/lustre/mdt/MDS/mds_readpage/stats
1489 /proc/fs/lustre/mdt/MDS/mds_setattr/stats
1490 /proc/fs/lustre/mdt/MDS/mds/stats
1491 /proc/fs/lustre/mds/lustre-MDT0000/exports/ab206805-0630-6647-8543-d24265c91a3d/stats
1492 /proc/fs/lustre/mds/lustre-MDT0000/exports/08ac6584-6c4a-3536-2c6d-b36cf9cbdaa0/stats
1493 /proc/fs/lustre/mds/lustre-MDT0000/stats
1494 /proc/fs/lustre/ldlm/services/ldlm_canceld/stats
1495 /proc/fs/lustre/ldlm/services/ldlm_cbd/stats
1496 /proc/fs/lustre/llite/lustre-ce63ca00/stats
1498 <section remap="h4">
1499 <title><indexterm><primary>proc</primary><secondary>statistics</secondary></indexterm>Interpreting OST Statistics</title>
1501 <para>See also <xref linkend="dbdoclet.50438219_84890"/> (llobdstat) and <xref linkend="dbdoclet.50438273_80593"/> (CollectL).</para>
1503 <para>The OST .../stats files can be used to track client statistics (client activity) for each OST. It is possible to get a periodic dump of values from these file (for example, every 10 seconds), that show the RPC rates (similar to iostat) by using the <literal>llstat.pl</literal> tool:</para>
1504 <screen># llstat /proc/fs/lustre/osc/lustre-OST0000-osc/stats
1505 /usr/bin/llstat: STATS on 09/14/07 /proc/fs/lustre/osc/lustre-OST0000-osc/stats on 192.168.10.34@tcp
1506 snapshot_time 1189732762.835363
1511 obd_ping 212</screen>
1512 <para>To clear the statistics, give the <literal>-c</literal> option to <literal>llstat.pl</literal>. To specify how frequently the statistics should be cleared (in seconds), use an integer for the <literal>-i</literal> option. This is sample output with <literal>-c</literal> and <literal>-i10</literal> options used, providing statistics every 10s):</para>
1513 <screen>$ llstat -c -i10 /proc/fs/lustre/ost/OSS/ost_io/stats
1515 /usr/bin/llstat: STATS on 06/06/07 /proc/fs/lustre/ost/OSS/ost_io/ stats on 192.168.16.35@tcp
1516 snapshot_time 1181074093.276072
1518 /proc/fs/lustre/ost/OSS/ost_io/stats @ 1181074103.284895
1519 Name Cur.Count Cur.Rate #Events Unit \last min avg max stddev
1520 req_waittime 8 0 8 [usec] 2078\ 34 259.75 868 317.49
1521 req_qdepth 8 0 8 [reqs] 1\ 0 0.12 1 0.35
1522 req_active 8 0 8 [reqs] 11\ 1 1.38 2 0.52
1523 reqbuf_avail 8 0 8 [bufs] 511\ 63 63.88 64 0.35
1524 ost_write 8 0 8 [bytes] 1697677\ 72914 212209.62 387579 91874.29
1526 /proc/fs/lustre/ost/OSS/ost_io/stats @ 1181074113.290180
1527 Name Cur.Count Cur.Rate #Events Unit \last min avg max stddev
1528 req_waittime 31 3 39 [usec] 30011\ 34 822.79 12245 2047.71
1529 req_qdepth 31 3 39 [reqs] 0\ 0 0.03 1 0.16
1530 req_active 31 3 39 [reqs] 58\ 1 1.77 3 0.74
1531 reqbuf_avail 31 3 39 [bufs] 1977\ 63 63.79 64 0.41
1532 ost_write 30 3 38 [bytes] 10284679\ 15019 315325.16 910694 197776.51
1534 /proc/fs/lustre/ost/OSS/ost_io/stats @ 1181074123.325560
1535 Name Cur.Count Cur.Rate #Events Unit \last min avg max stddev
1536 req_waittime 21 2 60 [usec] 14970\ 34 784.32 12245 1878.66
1537 req_qdepth 21 2 60 [reqs] 0\ 0 0.02 1 0.13
1538 req_active 21 2 60 [reqs] 33\ 1 1.70 3 0.70
1539 reqbuf_avail 21 2 60 [bufs] 1341\ 63 63.82 64 0.39
1540 ost_write 21 2 59 [bytes] 7648424\ 15019 332725.08 910694 180397.87
1543 <informaltable frame="all">
1545 <colspec colname="c1" colwidth="50*"/>
1546 <colspec colname="c2" colwidth="50*"/>
1550 <para><emphasis role="bold">Parameter</emphasis></para>
1553 <para><emphasis role="bold">Description</emphasis></para>
1560 <para> <literal> Cur. Count </literal></para>
1563 <para>Number of events of each type sent in the last interval (in this example, 10s)</para>
1568 <para> <literal> Cur. Rate </literal></para>
1571 <para>Number of events per second in the last interval</para>
1576 <para> <literal> #Events </literal></para>
1579 <para>Total number of such events since the system started</para>
1584 <para> <literal> Unit </literal></para>
1587 <para>Unit of measurement for that statistic (microseconds, requests, buffers)</para>
1592 <para> <literal> last </literal></para>
1595 <para>Average rate of these events (in units/event) for the last interval during which they arrived. For instance, in the above mentioned case of <literal>ost_destroy</literal> it took an average of 736 microseconds per destroy for the 400 object destroys in the previous 10 seconds.</para>
1600 <para> <literal> min </literal></para>
1603 <para>Minimum rate (in units/events) since the service started</para>
1608 <para> <literal> avg </literal></para>
1611 <para>Average rate</para>
1616 <para> <literal> max </literal></para>
1619 <para>Maximum rate</para>
1624 <para> <literal> stddev </literal></para>
1627 <para>Standard deviation (not measured in all cases)</para>
1633 <para>The events common to all services are:</para>
1634 <informaltable frame="all">
1636 <colspec colname="c1" colwidth="50*"/>
1637 <colspec colname="c2" colwidth="50*"/>
1641 <para><emphasis role="bold">Parameter</emphasis></para>
1644 <para><emphasis role="bold">Description</emphasis></para>
1651 <para> <literal> req_waittime </literal></para>
1654 <para>Amount of time a request waited in the queue before being handled by an available server thread.</para>
1659 <para> <literal> req_qdepth </literal></para>
1662 <para>Number of requests waiting to be handled in the queue for this service.</para>
1667 <para> <literal> req_active </literal></para>
1670 <para>Number of requests currently being handled.</para>
1675 <para> <literal> reqbuf_avail </literal></para>
1678 <para>Number of unsolicited lnet request buffers for this service.</para>
1684 <para>Some service-specific events of interest are:</para>
1685 <informaltable frame="all">
1687 <colspec colname="c1" colwidth="50*"/>
1688 <colspec colname="c2" colwidth="50*"/>
1692 <para><emphasis role="bold">Parameter</emphasis></para>
1695 <para><emphasis role="bold">Description</emphasis></para>
1702 <para> <literal> ldlm_enqueue </literal></para>
1705 <para>Time it takes to enqueue a lock (this includes file open on the MDS)</para>
1710 <para> <literal> mds_reint </literal></para>
1713 <para>Time it takes to process an MDS modification record (includes create, <literal>mkdir</literal>, <literal>unlink</literal>, <literal>rename</literal> and <literal>setattr</literal>)</para>
1720 <section remap="h4">
1721 <title><indexterm><primary>proc</primary><secondary>statistics</secondary></indexterm>Interpreting MDT Statistics</title>
1723 <para>See also <xref linkend="dbdoclet.50438219_84890"/> (llobdstat) and <xref linkend="dbdoclet.50438273_80593"/> (CollectL).</para>
1725 <para>The MDT .../stats files can be used to track MDT statistics for the MDS. Here is sample output for an MDT stats file:</para>
1726 <screen># cat /proc/fs/lustre/mds/*-MDT0000/stats
1727 snapshot_time 1244832003.676892 secs.usecs
1728 open 2 samples [reqs]
1729 close 1 samples [reqs]
1730 getxattr 3 samples [reqs]
1731 process_config 1 samples [reqs]
1732 connect 2 samples [reqs]
1733 disconnect 2 samples [reqs]
1734 statfs 3 samples [reqs]
1735 setattr 1 samples [reqs]
1736 getattr 3 samples [reqs]
1737 llog_init 6 samples [reqs]
1738 notify 16 samples [reqs]</screen>
git://git.whamcloud.com / doc / manual.git / blob