gfs2-uevents.rst 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. .. SPDX-License-Identifier: GPL-2.0
  2. ================
  3. uevents and GFS2
  4. ================
  5. During the lifetime of a GFS2 mount, a number of uevents are generated.
  6. This document explains what the events are and what they are used
  7. for (by gfs_controld in gfs2-utils).
  8. A list of GFS2 uevents
  9. ======================
  10. 1. ADD
  11. ------
  12. The ADD event occurs at mount time. It will always be the first
  13. uevent generated by the newly created filesystem. If the mount
  14. is successful, an ONLINE uevent will follow. If it is not successful
  15. then a REMOVE uevent will follow.
  16. The ADD uevent has two environment variables: SPECTATOR=[0|1]
  17. and RDONLY=[0|1] that specify the spectator status (a read-only mount
  18. with no journal assigned), and read-only (with journal assigned) status
  19. of the filesystem respectively.
  20. 2. ONLINE
  21. ---------
  22. The ONLINE uevent is generated after a successful mount or remount. It
  23. has the same environment variables as the ADD uevent. The ONLINE
  24. uevent, along with the two environment variables for spectator and
  25. RDONLY are a relatively recent addition (2.6.32-rc+) and will not
  26. be generated by older kernels.
  27. 3. CHANGE
  28. ---------
  29. The CHANGE uevent is used in two places. One is when reporting the
  30. successful mount of the filesystem by the first node (FIRSTMOUNT=Done).
  31. This is used as a signal by gfs_controld that it is then ok for other
  32. nodes in the cluster to mount the filesystem.
  33. The other CHANGE uevent is used to inform of the completion
  34. of journal recovery for one of the filesystems journals. It has
  35. two environment variables, JID= which specifies the journal id which
  36. has just been recovered, and RECOVERY=[Done|Failed] to indicate the
  37. success (or otherwise) of the operation. These uevents are generated
  38. for every journal recovered, whether it is during the initial mount
  39. process or as the result of gfs_controld requesting a specific journal
  40. recovery via the /sys/fs/gfs2/<fsname>/lock_module/recovery file.
  41. Because the CHANGE uevent was used (in early versions of gfs_controld)
  42. without checking the environment variables to discover the state, we
  43. cannot add any more functions to it without running the risk of
  44. someone using an older version of the user tools and breaking their
  45. cluster. For this reason the ONLINE uevent was used when adding a new
  46. uevent for a successful mount or remount.
  47. 4. OFFLINE
  48. ----------
  49. The OFFLINE uevent is only generated due to filesystem errors and is used
  50. as part of the "withdraw" mechanism. Currently this doesn't give any
  51. information about what the error is, which is something that needs to
  52. be fixed.
  53. 5. REMOVE
  54. ---------
  55. The REMOVE uevent is generated at the end of an unsuccessful mount
  56. or at the end of a umount of the filesystem. All REMOVE uevents will
  57. have been preceded by at least an ADD uevent for the same filesystem,
  58. and unlike the other uevents is generated automatically by the kernel's
  59. kobject subsystem.
  60. Information common to all GFS2 uevents (uevent environment variables)
  61. =====================================================================
  62. 1. LOCKTABLE=
  63. --------------
  64. The LOCKTABLE is a string, as supplied on the mount command
  65. line (locktable=) or via fstab. It is used as a filesystem label
  66. as well as providing the information for a lock_dlm mount to be
  67. able to join the cluster.
  68. 2. LOCKPROTO=
  69. -------------
  70. The LOCKPROTO is a string, and its value depends on what is set
  71. on the mount command line, or via fstab. It will be either
  72. lock_nolock or lock_dlm. In the future other lock managers
  73. may be supported.
  74. 3. JOURNALID=
  75. -------------
  76. If a journal is in use by the filesystem (journals are not
  77. assigned for spectator mounts) then this will give the
  78. numeric journal id in all GFS2 uevents.
  79. 4. UUID=
  80. --------
  81. With recent versions of gfs2-utils, mkfs.gfs2 writes a UUID
  82. into the filesystem superblock. If it exists, this will
  83. be included in every uevent relating to the filesystem.