generic/60[78]: ensure the initial DAX file flag state before test
[xfstests-dev.git] / dmapi / src / sample_hsm / README
1 The files in this directory comprise a simple HSM example that uses 
2 the DMAPI. These files are distributed in the hope that they will be
3 useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
4 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  These programs
5 have been tested on an SGI platform (as of April 1995) and found
6 to be suitably functional; however, there is no guarantee that they
7 do, in fact, provide the functationality that is advertised. This
8 is a long winded way of saying they probably have bugs; if you 
9 find 'em, fix 'em. 
10
11 Okay, now that we have the disclaimers out of the way, here are the details.
12
13         migfind
14         =======
15 This will find all files of a specified size, and print out the handles.
16 It is normally used like this:
17         migfind -s 800k /migfs >& cand_file
18
19 This example will find all files greater than 800K in the /migfs filesystem,
20 and put the handles (converted to ascii) in the file 'cand_file'. The output
21 consists of three fields per line:
22         handle length           filehandle              file size in bytes
23
24         migout
25         ======
26 migout reads a list of handles as created by migfind, and migrates
27 the files data. The data is stored in files that are located in 
28 another directory. The usage is
29         migout /dmapi_fs/stagedir < cand_file
30
31 This will all the files specified by handle in 'cand_file', and
32 put their data in files located under the directory /dmapi_fs/stagedir'.
33 The staging directory must be on a filesystem that supports
34 the dmapi; the reason for this is to allow for a simplification
35 in the code that stores the location of the data as a DM attribute
36 (file handles are easier than path names).
37
38         migin
39         =====
40 This daemon waits for DMAPI events and dispatches worker bees
41 to actually stage the data in. The usage is:
42         migin -l dmapi_log /migfs
43 migin will fork/exec a 'wbee' to either bring the data back from
44 the staging directory, or to invalidate the file.
45
46
47 Other programs:
48 There are a couple of other programs in this directory. 
49
50         mrmean
51         ======
52 Simplist cleanup/debugging tool that will print information about
53 the active sessions. If desired, it can also respond to outstanding
54 events and destroy sessions that may have been left around from
55 a process exiting unexpectedly.
56
57         mls
58         ===
59 Simple ls type program to display information about a file, such
60 as the managed region info, allocation info, event lists, and
61 file handle.
62