none
[openafs-wiki.git] / AFSLore / DemandAttach.mdwn
1 ## <a name="Demand-Attach File-Server (DAFS)"></a> Demand-Attach File-Server (DAFS)
2
3 OpenAFS 1.5 contains Demand-Attach File-Server (DAFS). DAFS is a significant departure from the more _traditional_ AFS file-server and this document details those changes.
4
5 <div>
6   <ul>
7     <li><a href="#Demand-Attach File-Server (DAFS)"> Demand-Attach File-Server (DAFS)</a></li>
8     <li><a href="#Why Demand-Attach File-Server (D"> Why Demand-Attach File-Server (DAFS) ?</a></li>
9     <li><a href="#An Overview of Demand-Attach Fil"> An Overview of Demand-Attach File-Server</a></li>
10     <li><a href="#The Gory Details of the Demand-A"> The Gory Details of the Demand-Attach File-Server</a><ul>
11         <li><a href="#File-server Start-up / Shutdown"> File-server Start-up / Shutdown Sequence</a></li>
12         <li><a href="#Volume Finite-State Automata"> Volume Finite-State Automata</a></li>
13         <li><a href="#Volume Least Recently Used (VLRU"> Volume Least Recently Used (VLRU) Queues</a></li>
14         <li><a href="#Vnode Finite-State Automata"> Vnode Finite-State Automata</a></li>
15         <li><a href="#Demand Salvaging"> Demand Salvaging</a></li>
16         <li><a href="#File-Server Host / Callback Stat"> File-Server Host / Callback State</a></li>
17       </ul>
18     </li>
19     <li><a href="#File-Server Arguments (relating"> File-Server Arguments (relating to Demand-Attach)</a></li>
20   </ul>
21 </div>
22
23 ## <a name="Why Demand-Attach File-Server (D"></a> Why Demand-Attach File-Server (DAFS) ?
24
25 On a traditional file-server, volumes are attached at start-up and detached only at shutdown. Any attached volume can be modified and changes are periodically flushed to disk or on shutdown. When a file-server isn't shutdown cleanly, the integrity of every attached volume has to be verified by the salvager, whether the volume had been modified or not. As file-servers grow larger (and the number of volumes increase), the length of time required to salvage and attach volumes increases, e.g. it takes around two hours for a file-server housing 512GB data to salvage and attach volumes !
26
27 On a Demand-Attach File-Server (DAFS), volumes are attached only when accessed by clients. On start-up, the file-server reads only the volume headers to determine what volumes reside on what partitions. When accessed by clients, the volumes are attached. After some period of inactivity, volumes are automatically detached. This dramatically improves start-up and shutdown times. A demand-attach file-server can be restarted in seconds compared to hours for the same traditional file-server.
28
29 The primary objective of the demand-attach file-server was to dramatically reduce the amount of time required to restart an AFS file-server.
30
31 Large portions of this document were taken / influenced by the presentation entitled [Demand Attach / Fast-Restart Fileserver](http://workshop.openafs.org/afsbpw06/talks/tkeiser-dafs.pdf) given by Tom Keiser at the [AFS and Kerberos Best Practices Workshop](http://workshop.openafs.org/) in [2006](http://workshop.openafs.org/afsbpw06/).
32
33 ## <a name="An Overview of Demand-Attach Fil"></a> An Overview of Demand-Attach File-Server
34
35 Demand-attach necessitated a significant re-design of certain aspects of the AFS code, including:
36
37 - volume package has a number of severe limitations
38   - single global lock, leading to poor scaling
39   - lock is held across high latency operations, e.g. disk I/O
40   - no notion of state for concurrently accessed objects
41 - the vnode package suffers from the same limitations
42 - breaking callbacks is time consuming
43 - salvaging does not have to be done with the file-server offline
44
45 The changes implemented for demand-attach include:
46
47 - [[volume finite-state automata|AFSLore/DemandAttach#Volume_Finite_State_Automata]]
48 - volumes are attached on demand
49 - volume _garbage collector_ to detach unused volumes
50 - notion of volume state means read-only volumes aren't salvaged
51 - [[vnode finite-state automata|AFSLore/DemandAttach#Vnode_Finite_State_Automata]]
52 - global lock is only held when required and never held across high-latency operations
53 - automatic salvaging of volumes
54 - shutdown is done in parallel (maximum number of threads utilized)
55 - callbacks are no longer broken on shutdown
56 - instead, host / callback state is preserved across restarts
57
58 ## <a name="The Gory Details of the Demand-A"></a> The Gory Details of the Demand-Attach File-Server
59
60 ### <a name="File-server Start-up / Shutdown"></a><a name="File-server Start-up / Shutdown "></a> File-server Start-up / Shutdown Sequence
61
62 The table below compares the start-up sequence for a traditional file-server and a demand-attach file-server.
63
64 <table border="1" cellpadding="0" cellspacing="0">
65   <tr>
66     <th bgcolor="#99CCCC"><strong> Traditional </strong></th>
67     <th bgcolor="#99CCCC"><strong> Demand-Attach </strong></th>
68   </tr>
69   <tr>
70     <td>   </td>
71     <td> %BULLET% host / callback state restored </td>
72   </tr>
73   <tr>
74     <td>   </td>
75     <td> %BULLET% host / callback state consistency verified </td>
76   </tr>
77   <tr>
78     <td> %BULLET% build vice partition list </td>
79     <td> %BULLET% build vice partition list </td>
80   </tr>
81   <tr>
82     <td> %BULLET% volumes are attached </td>
83     <td> %BULLET% volume headers read </td>
84   </tr>
85   <tr>
86     <td>   </td>
87     <td> %BULLET% volumes placed into <em>pre-attached</em> state </td>
88   </tr>
89 </table>
90
91 The [[host / callback state|AFSLore/DemandAttach#FSStateDat]] is covered later. The _pre-attached_ state indicates that the file-server has read the volume headers and is aware that the volume exists, but that it has not been attached (and hence is not on-line).
92
93 The shutdown sequence for both file-server types is:
94
95 <table border="1" cellpadding="0" cellspacing="0">
96   <tr>
97     <th bgcolor="#99CCCC"><strong> Traditional </strong></th>
98     <th bgcolor="#99CCCC"><strong> Demand-Attach </strong></th>
99   </tr>
100   <tr>
101     <td> %BULLET% break callbacks </td>
102     <td> %BULLET% quiesce host / callback state </td>
103   </tr>
104   <tr>
105     <td> %BULLET% shutdown volumes </td>
106     <td> %BULLET% shutdown on-line volumes </td>
107   </tr>
108   <tr>
109     <td>   </td>
110     <td> %BULLET% verify host / callback state consistency </td>
111   </tr>
112   <tr>
113     <td>   </td>
114     <td> %BULLET% save host / callback state </td>
115   </tr>
116 </table>
117
118 On a traditional file-server, volumes are off-lined (detached) serially. In demand-attach, as many threads as possible are used to detach volumes, which is possible due to the notion of a volume has an associated state.
119
120 ### <a name="Volume Finite-State Automata"></a> Volume Finite-State Automata
121
122 The volume finite-state automata is available in the source tree under `doc/arch/dafs-fsa.dot`
123
124 <a name="VolumeLeastRecentlyUsed"></a>
125
126 ### <a name="Volume Least Recently Used (VLRU"></a> Volume Least Recently Used (VLRU) Queues
127
128 The Volume Least Recently Used (VLRU) is a garbage collection facility which automatically off-lines volumes in the background. The purpose of this facility is to pro-actively off-line infrequently used volumes to improve shutdown and salvage times. The process of off-lining a volume from the "attached" state to the "pre-attached" state is called soft detachment.
129
130 VLRU works in a manner similar to a generational garbage collector. There are five queues on which volumes can reside.
131
132 <table border="1" cellpadding="0" cellspacing="0">
133   <tr>
134     <th bgcolor="#99CCCC"><strong> Queue </strong></th>
135     <th bgcolor="#99CCCC"><strong> Meaning </strong></th>
136   </tr>
137   <tr>
138     <td> candidate </td>
139     <td> Volumes which have not been accessed recently and hence are candidates for soft detachment. </td>
140   </tr>
141   <tr>
142     <td> held </td>
143     <td> Volumes which are administratively prevented from VLRU activity, i.e. will never be detached. </td>
144   </tr>
145   <tr>
146     <td> intermediate (mid) </td>
147     <td> Volumes transitioning from new -&gt; old (see [[AFSLore.DemandAttach#VLRUStateTransitions][state transitions] for details). </td>
148   </tr>
149   <tr>
150     <td> new </td>
151     <td> Volumes which have been accessed. See [[AFSLore.DemandAttach#VLRUStateTransitions][state transitions] for details. </td>
152   </tr>
153   <tr>
154     <td> old </td>
155     <td> Volumes which are continually accessed. See [[AFSLore.DemandAttach.#VLRUStateTransitions][state transitions] for details. </td>
156   </tr>
157 </table>
158
159 The state of the various VLRU queues is dumped with the file-server state and at shutdown.
160
161 <a name="VLRUStateTransitions"></a> The VLRU queues new, mid (intermediate) and old are generational queues for active volumes. State transitions are controlled by inactivity timers and are
162
163 <table border="1" cellpadding="0" cellspacing="0">
164   <tr>
165     <th bgcolor="#99CCCC"><strong> Transition </strong></th>
166     <th bgcolor="#99CCCC"><strong> Timeout (minutes) </strong></th>
167     <th bgcolor="#99CCCC"><strong> Actual Timeout (in MS) </strong></th>
168     <th bgcolor="#99CCCC"><strong> Reason (since last transition) </strong></th>
169   </tr>
170   <tr>
171     <td> candidate-&gt;new </td>
172     <td> - </td>
173     <td> - </td>
174     <td> new activity </td>
175   </tr>
176   <tr>
177     <td> new-&gt;candidate </td>
178     <td> 1 * vlruthresh </td>
179     <td> 24 hrs </td>
180     <td> no activity </td>
181   </tr>
182   <tr>
183     <td> new-&gt;mid </td>
184     <td> 2 * vlruthresh </td>
185     <td> 48 hrs </td>
186     <td> activity </td>
187   </tr>
188   <tr>
189     <td> mid-&gt;old </td>
190     <td> 4 * vlruthresh </td>
191     <td> 96 hrs </td>
192     <td> activity </td>
193   </tr>
194   <tr>
195     <td> old-&gt;mid </td>
196     <td> 2 * vlruthresh </td>
197     <td> 48 hrs </td>
198     <td> no activity </td>
199   </tr>
200   <tr>
201     <td> mid-&gt;new </td>
202     <td> 1 * vlruthresh </td>
203     <td> 24 hrs </td>
204     <td> no activity </td>
205   </tr>
206 </table>
207
208 `vlruthresh` has been optimized for RO file-servers, where volumes are frequently accessed once a day and soft-detaching has little effect (RO volumes are not salvaged; one of the main reasons for soft detaching).
209
210 ### <a name="Vnode Finite-State Automata"></a> Vnode Finite-State Automata
211
212 The vnode finite-state automata is available in the source tree under `doc/arch/dafs-vnode-fsa.dot`
213
214 `/usr/afs/bin/fssync-debug` provides low-level inspection and control of the file-server volume package. \*Indiscriminate use of <code>**fsync-debug**</code> can lead to extremely bad things occurring. Use with care. %ENDCOLOR%
215
216 <a name="SalvageServer"></a>
217
218 ### <a name="Demand Salvaging"></a> Demand Salvaging
219
220 Demand salvaging is implemented by the `salvageserver`. The actual code for salvaging a volume remains largely unchanged. However, the method for invoking salvaging with demand-attach has changed:
221
222 - file-server automatically requests volumes be salvaged as required, i.e. they are marked as requiring salvaging when attached.
223 - manual initiation of salvaging may be required when access is through the `volserver` (may be addressed at some later date).
224 - `bos salvage` requires the `-forceDAFS` flag to initiate salvaging wit DAFS. However, %RED% **salvaging should not be initiated using this method**.%ENDCOLOR%
225 - infinite salvage, attach, salvage, ... loops are possible. There is therefore a hard-limit on the number of times a volume will be salvaged which is reset when the volume is removed or the file-server is restarted.
226 - volumes are salvaged in parallel and is controlled by the `-Parallel` argument to the `salvageserver`. Defaults to 4.
227 - the `salvageserver` and the `inode` file-server are incompatible:
228   - because volumes are inter-mingled on a partition (rather than being separated), a lock for the entire partition on which the volume is located is held throughout. Both the `fileserver` and `volserver` will block if they require this lock, e.g. to restore / dump a volume located on the partition.
229   - inodes for a particular volume can be located anywhere on a partition. Salvaging therefore results in **every** inode on a partition having to be read to determine whether it belongs to the volume. This is extremely I/O intensive and leads to horrendous salvaging performance.
230 - `/usr/afs/bin/salvsync-debug` provides low-level inspection and control over the `salvageserver`. %RED% **Indiscriminate use of `salvsync-debug` can lead to extremely bad things occurring. Use with care.** %ENDCOLOR%
231
232 <a name="FSStateDat"></a>
233
234 ### <a name="File-Server Host / Callback Stat"></a> File-Server Host / Callback State
235
236 Host / callback information is persistent across restarts with demand-attach. On shutdown, the file-server writes the data to `/usr/afs/local/fsstate.dat`. The contents of this file are read and verified at start-up and hence it is unnecessary to break callbacks on shutdown with demand-attach.
237
238 The contents of `fsstate.dat` can be inspected using `/usr/afs/bin/state_analyzer`.
239
240 ## <a name="File-Server Arguments (relating"></a><a name="File-Server Arguments (relating "></a> File-Server Arguments (relating to Demand-Attach)
241
242 These are available in the man-pages (section 8) for the fileserver; some details are provided here for convenience:
243
244 Arguments controlling the host / callback state:
245
246 <table border="1" cellpadding="0" cellspacing="0">
247   <tr>
248     <th bgcolor="#99CCCC"><strong> Parameter </strong></th>
249     <th bgcolor="#99CCCC"><strong> Options </strong></th>
250     <th bgcolor="#99CCCC"><strong> Default </strong></th>
251     <th bgcolor="#99CCCC"><strong> Suggested Value </strong></th>
252     <th bgcolor="#99CCCC"><strong> Meaning </strong></th>
253   </tr>
254   <tr>
255     <td><code>fs-state-dont-save</code></td>
256     <td> n/a </td>
257     <td> state saved </td>
258     <td> - </td>
259     <td><code>fileserver</code> state will not be saved during shutdown </td>
260   </tr>
261   <tr>
262     <td><code>fs-state-dont-restore</code></td>
263     <td> n/a </td>
264     <td> state restored </td>
265     <td> - </td>
266     <td><code>fileserver</code> state will not be restored during startup </td>
267   </tr>
268   <tr>
269     <td><code>fs-state-verify</code></td>
270     <td><none %vbar%="%VBAR%" %vbar^%="%VBAR^%" both="both" restore="restore" save="save"> </none></td>
271     <td> both </td>
272     <td> - </td>
273     <td> Controls the behavior of the state verification mechanism. Before saving or restoring the <code>fileserver</code> state information, the internal host and callback data structures are verified. A value of 'none' turns off all verification. A value of 'save' only performs the verification steps prior to saving state to disk. A value of 'restore' only performs the verification steps after restoring state from disk. A value of 'both' performs all verification steps both prior to saving and after restoring state. </td>
274   </tr>
275 </table>
276
277 Arguments controlling the [[VLRU:|Main/WebHome#VolumeLeastRecentlyUsed]]
278
279 <table border="1" cellpadding="0" cellspacing="0">
280   <tr>
281     <th bgcolor="#99CCCC"><strong> Parameter </strong></th>
282     <th bgcolor="#99CCCC"><strong> Options </strong></th>
283     <th bgcolor="#99CCCC"><strong> Default </strong></th>
284     <th bgcolor="#99CCCC"><strong> Suggested Value </strong></th>
285     <th bgcolor="#99CCCC"><strong> Meaning </strong></th>
286   </tr>
287   <tr>
288     <td><code>vattachpar</code></td>
289     <td> positive integer </td>
290     <td> 1 </td>
291     <td> 128 </td>
292     <td> Controls the parallelism of the volume package start-up and shutdown routines. On start-up, vice partitions are scanned for volumes to pre-attach using a number of worker threads, the number of which is the minimum of <code>vattachpar</code> or the number of vice partitions. On shutdown, <code>vattachpar</code> worker threads are used to detach volumes. The shutdown code is mp-scaleable well beyond the number of vice partitions. Tom Keiser (from SNA) found 128 threads for a single vice partition had a statistically significant performance improvement over 64 threads. </td>
293   </tr>
294   <tr>
295     <td><code>vhashsize</code></td>
296     <td> positive integer </td>
297     <td> 8 </td>
298     <td> 11 </td>
299     <td> This parameter controls the size of the volume hash table. The table will contain 2^( <code>vhashsize</code>) entries. Hash bucket utilization statistics are given in the <code>fileserver</code> state information as well as on shutdown. </td>
300   </tr>
301   <tr>
302     <td><code>vlrudisable</code></td>
303     <td> n/a </td>
304     <td> enabled </td>
305     <td> - </td>
306     <td> Disables the Volume Least Recently Used (VLRU) cache. </td>
307   </tr>
308   <tr>
309     <td><code>vlruthresh</code></td>
310     <td> positive integer </td>
311     <td> 120 minutes </td>
312     <td> 1440 (24 hrs) </td>
313     <td> Minutes of inactivity before a volume is eligible for soft detachment. </td>
314   </tr>
315   <tr>
316     <td><code>vlruinterval</code></td>
317     <td> positive integer </td>
318     <td> 120 seconds </td>
319     <td> - </td>
320     <td> Number of seconds between VLRU candidate queue scans </td>
321   </tr>
322   <tr>
323     <td><code>vlrumax</code></td>
324     <td> positive integer </td>
325     <td> 8 </td>
326     <td> 8 </td>
327     <td> Max number of volumes which will be soft detached in a single pass of the scanner </td>
328   </tr>
329 </table>