2 * Copyright (c) 2000 Silicon Graphics, Inc. All Rights Reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * Further, this software is distributed without any warranty that it is
13 * free of the rightful claim of any third person regarding infringement
14 * or the like. Any license provided herein, whether implied or
15 * otherwise, applies only to this software file. Patent licenses, if
16 * any, provided herein do not apply to combinations of this program with
17 * other software, or any other product whatsoever.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write the Free Software Foundation, Inc., 59
21 * Temple Place - Suite 330, Boston MA 02111-1307, USA.
23 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24 * Mountain View, CA 94043, or:
28 * For further information regarding this notice, see:
30 * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
33 #include <sys/types.h>
44 #include <lib/dmport.h>
47 /*---------------------------------------------------------------------------
49 Test program used to test the DMAPI function dm_get_allocinfo(). The
52 dump_allocinfo [-D] [-n nelem] [-o offp] [-s sid] pathname
54 where pathname is the name of a file, 'offp' is a byte offset from the
55 beginning of the file where you want to start dumping, and 'nelem' allows
56 you to specify how many extent structures to use in each dm_get_allocinfo
59 The code checks the returned extents as much as possible for errors.
60 It detects bad ex_type values, verifies that there is always a trailing
61 hole at the end of the file, that the ex_offset of each extent matches the
62 ex_offset+ex_length of the previous extent, and that ex_offset+ex_length
63 is always an even multiple of 512. It verifies that all ex_offset values
64 after the first fall on a 512-byte boundary. It verifies that the '*offp'
65 value returned by dm_get_allocinfo() is 0 at the end of the file, and
66 equals ex_offset+ex_length of the last extent if not at the end of the file.
67 Any error is reported to stderr, and the program then terminates with a
70 The program produces output similar to xfs_bmap in order to make comparison
71 easier. Here is some sample output.
75 0: [0..127]: resv [1..511]
77 Line 1 gives the name of the file and the byte offset within the file where
78 the dump started. Line 2 appears once for each dm_get_allocinfo() call,
79 giving the return value (rc) and the number of extents which were returned.
80 Line 3 is repeated once for each extent. The first field "0:" is the extent
81 number. The second field "[0..127]:" give the starting and ending block for
82 the extent in 512-byte units. The third field is either "resv" to indicate
83 allocated space or "hole" if the extent is a hole. The fourth field
84 "[1..511]" only appears if the dump did not start with byte zero of the
85 first block. In that case, the first number shows the actual byte offset
86 within the block (1 in this case). The second number should always be
87 511 since we always dump to the end of a block.
92 Run the test scripts "test_allocinfo_1" and "test_allocinfo_2".
93 (The former compares dump_allocinfo output with xfs_bmap output. The latter
94 compares various dump_allocinfo outputs, from trials with many different
97 Produce a file with holes, and perform the following tests using just one
99 Dump extents from beginning of the file.
100 Dump from byte 1 of the file.
101 Dump from the last byte of the first extent.
102 Dump from the first byte of the second extent.
103 Dump from the middle of the second extent.
104 Dump the first byte of the last extent.
105 Dump the last byte of the last extent.
106 Dump the first byte after the last extent.
107 Dump starting at an offset way past the end of the file.
109 Produce a fragmented file with many adjacent DM_EXTENT_RES extents.
110 Repeat the above tests.
112 Produce a GRIO file with holes.
113 Repeat the above tests.
115 ----------------------------------------------------------------------------*/
118 extern char *sys_errlist[];
123 static int print_alloc(dm_sessid_t sid, void* hanp, size_t hlen,
124 char *pathname, dm_off_t startoff, u_int nelem);
133 fprintf(stderr, "usage:\t%s [-D] [-n nelem] [-o off] [-s sid] "
134 "pathname\n", Progname);
144 dm_sessid_t sid = DM_NO_SESSION;
145 dm_off_t startoff = 0; /* starting offset */
154 if (Progname = strrchr(argv[0], '/')) {
160 /* Crack and validate the command line options. */
162 while ((opt = getopt(argc, argv, "Dn:o:s:")) != EOF) {
168 nelem = atol(optarg);
171 startoff = atoll(optarg);
180 if (optind + 1 != argc)
182 pathname = argv[optind];
184 if (dm_init_service(&name)) {
185 fprintf(stderr, "dm_init_service failed, %s\n",
190 if (sid == DM_NO_SESSION)
191 find_test_session(&sid);
193 /* Get the file's handle and verify that it is a regular file. */
195 if (dm_path_to_handle(pathname, &hanp, &hlen)) {
196 fprintf(stderr, "can't get handle for %s\n", pathname);
199 if (dm_get_fileattr(sid, hanp, hlen, DM_NO_TOKEN, DM_AT_STAT, &sbuf)) {
200 fprintf(stderr, "dm_get_fileattr failed\n");
203 if (!S_ISREG(sbuf.dt_mode)) {
204 fprintf(stderr, "%s is not a regular file\n", pathname);
208 /* Print the allocation. */
210 if (print_alloc(sid, hanp, hlen, pathname, startoff, nelem))
213 dm_handle_free(hanp, hlen);
235 if (Dflag) fprintf(stdout, "%s: starting offset %lld\n", pathname, startoff);
237 /* Allocate space for the number of extents requested by the user. */
239 if ((extent = malloc(nelem * sizeof(*extent))) == NULL) {
240 fprintf(stderr, "can't malloc extent structures\n");
248 rc = dm_get_allocinfo(sid, hanp, hlen, DM_NO_TOKEN, &startoff,
249 nelem, extent, &nelemp);
251 fprintf(stderr, "dm_get_allocinfo failed, %s\n",
256 if (Dflag) fprintf(stdout, "\treturned %d, nelemp %d\n", rc, nelemp);
259 fprintf(stdout, " ex_type ex_offset ex_length\n");
261 /* Note: it is possible for nelemp to be zero! */
263 for (i = 0; i < nelemp; i++) {
264 /* The extent must either be reserved space or a hole. */
265 switch (extent[i].ex_type) {
273 fprintf(stderr, "invalid extent type %d\n",
278 if (i!=nelemp-1 || rc!=0) {
280 fprintf(stdout, "\t%d: [%lld..%lld]: %s", num,
281 extent[i].ex_offset / 512,
282 (extent[i].ex_offset +
283 extent[i].ex_length - 1) / 512, type);
284 if ((extent[i].ex_offset % 512 != 0) ||
285 (endoff % 512 != 0)) {
286 fprintf(stdout, "\t[%lld..%lld]\n",
287 extent[i].ex_offset % 512,
290 fprintf(stdout, "\n");
293 fprintf(stdout, "%5s %13lld %13lld\n",
294 type, extent[i].ex_offset,
295 extent[i].ex_length);
298 /* The ex_offset of the first extent should match the
299 'startoff' specified by the caller. The ex_offset
300 in subsequent extents should always match
301 (ex_offset + ex_length) of the previous extent,
302 and should always start on a 512 byte boundary.
305 if (extent[i].ex_offset != endoff) {
306 fprintf(stderr, "new extent (%lld)is not "
307 "adjacent to previous one (%lld)\n",
308 extent[i].ex_offset, endoff);
311 if (num && (extent[i].ex_offset % 512) != 0) {
312 fprintf(stderr, "non-initial ex_offset (%lld) "
313 "is not a 512-byte multiple\n",
314 extent[i].ex_offset);
318 /* Non-initial extents should have ex_length values
319 that are an even multiple of 512. The initial
320 extent should be a multiple of 512 less the offset
321 into the starting 512-byte block.
324 if (((extent[i].ex_offset % 512) + extent[i].ex_length) % 512 != 0) {
325 fprintf(stderr, "ex_length is incorrect based "
326 "upon the ex_offset\n");
330 endoff = extent[i].ex_offset + extent[i].ex_length;
331 num++; /* count of extents printed */
334 /* If not yet at end of file, the startoff parameter should
335 match the ex_offset plus ex_length of the last extent
339 if (rc && startoff != endoff) {
340 fprintf(stderr, "startoff is %lld, should be %lld\n",
345 /* If we are at end of file, the last extent should be a
349 if (!rc && type && strcmp(type, "hole")) {
350 fprintf(stderr, "file didn't end with a hole\n");
355 /* At end of file, startoff should always equal zero. */
358 fprintf(stderr, "startoff was not zero at end of file\n");