obd_statfs.txt

   1 OBD Statfs
   2 ^^^^^^^^^^
   3 [[struct-obd-statfs]]
   4
   5 An 'obd_statfs' structure conveys file-system-wide information for the
   6 back-end file system of a given target (MDT or OST).
   7
   8 ----
   9 struct obd_statfs {
  10         __u64  os_type;
  11         __u64  os_blocks;
  12         __u64  os_bfree;
  13         __u64  os_bavail;
  14         __u64  os_files;
  15         __u64  os_ffree;
  16         __u8   os_fsid[40];
  17         __u32  os_bsize;
  18         __u32  os_namelen;
  19         __u64  os_maxbytes;
  20         __u32  os_state;
  21         __u32  os_fprecreated;
  22         __u32  os_spare2;
  23         __u32  os_spare3;
  24         __u32  os_spare4;
  25         __u32  os_spare5;
  26         __u32  os_spare6;
  27         __u32  os_spare7;
  28         __u32  os_spare8;
  29         __u32  os_spare9;
  30 };
  31 ----
  32
  33 Most of the fields correspond directly to the 'struct statfs' fields
  34 returned by a 'statfs()' system call and have the same meaning. The
  35 values are for the back-end storage of the target in question (MDT or
  36 OST).
  37
  38 Teh 'os_type' field gives the type of the target's back-end file
  39 system:
  40
  41 .Back-end file types ('os_type') for Lustre targets
  42 [options="header"]
  43 |====
  44 | f_type                     | value
  45 | EXT4_SUPER_MAGIC (ldiskfs) | 0xEF53
  46 | ZFS_SUPER_MAGIC            | 0x2fc12fc1
  47 |====
  48
  49 The 'os_blocks' field is the total number of blocks in the target, in
  50 units of os_bsize.
  51
  52 The 'os_bfree' field is the number of blocks not currently in use.
  53
  54 The 'os_bavail' is the number of blocks available to be allocated to
  55 new files.  The number of available blocks is typically lower than
  56 the number of free blocks due to <<grant>> and blocks reserved for
  57 target internal usage such as metadata.
  58
  59 The 'os_files' field is the total number of files on the target, both
  60 allocated and free.  For some OSD types this is a static number, and
  61 for others this is dynamic based on os_ffree and the amount of free
  62 space.
  63
  64 The 'os_ffree' field is the current number of files that could be
  65 created based on current usage.  For some OSD types this is a function
  66 of the free space in the device and may increase or decrease as free
  67 space changes.
  68
  69 The 'os_fsid' is intended to be the target backing device UUID in
  70 ASCII format.  The current osd-ldiskfs and osd-zfs implementations
  71 do not fill this field in.
  72
  73 The 'os_bsize' field is the block size in bytes. This is for computing
  74 the total, free, and available space in combination with 'os_blocks',
  75 'os_bfree', and 'os_bavail' respectively.  It does not necessarily
  76 represent the minimum or optimal IO size.
  77
  78 The 'os_namelen' field gives the maximum name length for files on the
  79 back-end file system in bytes.
  80
  81 The 'os_maxbytes' field is the maximum size of a single object
  82 (i.e. the maximum byte offset that can be written to).  This is the
  83 same value as the 'ocd_maxbytes' field of the 'obd_connect_data'
  84 structure.
  85
  86 The 'os_state' field encodes the status of the underlying back-end
  87 file system. It can be:
  88
  89 .Back-end file system state
  90 [options="header"]
  91 |====
  92 | os_state flag     | value
  93 | OS_STATE_DEGRADED | 0x1
  94 | OS_STATE_READONLY | 0x2
  95 |====
  96
  97 In normal operation the 'os_state' value is returned as 0x0.  If the
  98 back-end file system has a RAID configuration that is degraded or
  99 rebuilding the state is returned with the OS_STATE_DEGRADED (0x1) flag
 100 set. If the file system has been set to read-only, either manually at
 101 mount or automatcially due to detected corruption of the underlying
 102 target filesystem, then 'os_state' is returned with OS_STATE_READONLY (0x2)
 103 set, for example if it was explicitly mounted read-only, or
 104 corruption has been detected at runtime in the backing filesystem.
 105
 106 The 'os_fprecreated' field counts the number of pre-created objects
 107 available on an OST. The 'os_fprecreated' value counts as "used"
 108 inodes, so it reduces 'os_ffree'. Lustre places a hard limit of
 109 2*OST_MAX_PRECREATE (2*20000) on the number of precreates it will
 110 allow for an OST. There are currently no precreated objects on an MDT
 111 so it is just 0 in that case.