lustre/doc/llsom_sync.8

   1 .TH llsom_sync 8 "2018 Jan 10" Lustre "Lustre Filesystem utility"
   2 .SH NAME
   3 llsom_sync \- Utility to sync file LSOM xattr.
   4 .SH SYNOPSIS
   5 .br
   6 .B llsom_sync --mdt|-m <mdt>  --user|-u <user id>
   7 .br
   8 .B\t\t\t [--daemonize|-d] [--verbose|-v] [--interval|-i]
   9 .br
  10 .B\t\t\t [--min-age|-a] [--max-cache|-c] [--sync|-s] <lustre_mount_point>
  11 .br
  12
  13 .SH DESCRIPTION
  14 .B llsom_sync
  15 is designed to sync file LSOM xattr in the Lustre Filesystem by
  16 using Lustre MDT changelogs.  A changelog user must be registered
  17 (see lctl (8) changelog_register) before using this tool.
  18
  19 .SH OPTIONS
  20
  21 .B --mdt=<mdt>
  22 .br
  23 The metadata device which need to be synced the LSOM xattr of files.
  24 A changelog user must be registered for this device.
  25
  26 .B --user=<user id>
  27 .br
  28 The changelog user id for the above MDT device. See lctl(8) changelog_register.
  29
  30 .B --daemonize
  31 .br
  32 Daemonize the program. In daemon mode, the utility will scan, process the
  33 changelog records and sync the LSOM xattr for files periodically.
  34
  35 .B --verbose
  36 .br
  37 Produce a verbose output.
  38
  39 .B --interval
  40 .br
  41 The time interval to scan the Lustre changelog and process the log record in
  42 daemon mode.
  43
  44 .B --min-age
  45 .br
  46 The time that llsom_sync tool will not try to sync the SOM data for any files
  47 closed less than this many seconds old. The default min-age value is 600s
  48 (10 minutes).
  49
  50 .B --max-cache
  51 .br
  52 The total memory used for the FID cache which can be with a suffix [KkGgMm].
  53 The default max-cache value is 256MB. For the parameter value < 100, it is
  54 taken as the percentage of total memory size used for the FID cache instead
  55 of the cache size.
  56
  57 .B --sync
  58 .br
  59 Sync file data to make the dirty data out of cache to ensure the blocks count
  60 is correct when update the file LSOM xattr. This option could hurt server
  61 performance significantly if thousands of fsync requests are sent.
  62
  63 .SH EXAMPLES
  64
  65 .TP
  66 Register a changelog consumer for MDT lustre-MDT0000
  67 $ cl_user=$(ssh root@mds01 lctl --device lustre-MDT0000 changelog_register -n)
  68 .br
  69 $ echo $cl_user
  70 .br
  71 cl1
  72
  73 .TP
  74 After perform some file operations on the Lustre Filesystem with
  75 mount point '/mnt/lustre' and the filesystem undergoes some changes,
  76 sync file LSOM xattr:
  77 $ llsom_sync --mdt=lustre-MDT0000 --user=$cl_user \\
  78 .br
  79              --verbose /mnt/lustre
  80
  81 .TP
  82 To deregister the changelog user (e.g. after this example, or if SOM
  83 updates are no longer needed):
  84 .br
  85 $ ssh root@mds01 lctl --device lustre-MDT0000 changelog_deregister $cl_user
  86
  87 .SH AUTHOR
  88 The llsom_sync command is part of the Lustre filesystem.
  89
  90 .SH SEE ALSO
  91 .BR lustre (7),
  92 .BR lctl (8)