^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0+ */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * sysfs.h - sysfs support declarations.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2005-2014 Nippon Telegraph and Telephone Corporation.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2014 HGST, Inc., a Western Digital Company.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Written by Vyacheslav Dubeyko <Vyacheslav.Dubeyko@hgst.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #ifndef _NILFS_SYSFS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #define _NILFS_SYSFS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/sysfs.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define NILFS_ROOT_GROUP_NAME "nilfs2"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * struct nilfs_sysfs_dev_subgroups - device subgroup kernel objects
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) * @sg_superblock_kobj: /sys/fs/<nilfs>/<device>/superblock
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * @sg_superblock_kobj_unregister: completion state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) * @sg_segctor_kobj: /sys/fs/<nilfs>/<device>/segctor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) * @sg_segctor_kobj_unregister: completion state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * @sg_mounted_snapshots_kobj: /sys/fs/<nilfs>/<device>/mounted_snapshots
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) * @sg_mounted_snapshots_kobj_unregister: completion state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * @sg_checkpoints_kobj: /sys/fs/<nilfs>/<device>/checkpoints
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) * @sg_checkpoints_kobj_unregister: completion state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) * @sg_segments_kobj: /sys/fs/<nilfs>/<device>/segments
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * @sg_segments_kobj_unregister: completion state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) struct nilfs_sysfs_dev_subgroups {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) /* /sys/fs/<nilfs>/<device>/superblock */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) struct kobject sg_superblock_kobj;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) struct completion sg_superblock_kobj_unregister;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) /* /sys/fs/<nilfs>/<device>/segctor */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) struct kobject sg_segctor_kobj;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) struct completion sg_segctor_kobj_unregister;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) /* /sys/fs/<nilfs>/<device>/mounted_snapshots */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) struct kobject sg_mounted_snapshots_kobj;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) struct completion sg_mounted_snapshots_kobj_unregister;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) /* /sys/fs/<nilfs>/<device>/checkpoints */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) struct kobject sg_checkpoints_kobj;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) struct completion sg_checkpoints_kobj_unregister;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) /* /sys/fs/<nilfs>/<device>/segments */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) struct kobject sg_segments_kobj;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) struct completion sg_segments_kobj_unregister;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) #define NILFS_COMMON_ATTR_STRUCT(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) struct nilfs_##name##_attr { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) struct attribute attr; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) ssize_t (*show)(struct kobject *, struct attribute *, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) char *); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) ssize_t (*store)(struct kobject *, struct attribute *, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) const char *, size_t); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) NILFS_COMMON_ATTR_STRUCT(feature);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) #define NILFS_DEV_ATTR_STRUCT(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) struct nilfs_##name##_attr { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) struct attribute attr; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) ssize_t (*show)(struct nilfs_##name##_attr *, struct the_nilfs *, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) char *); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) ssize_t (*store)(struct nilfs_##name##_attr *, struct the_nilfs *, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) const char *, size_t); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) NILFS_DEV_ATTR_STRUCT(dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) NILFS_DEV_ATTR_STRUCT(segments);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) NILFS_DEV_ATTR_STRUCT(mounted_snapshots);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) NILFS_DEV_ATTR_STRUCT(checkpoints);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) NILFS_DEV_ATTR_STRUCT(superblock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) NILFS_DEV_ATTR_STRUCT(segctor);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #define NILFS_CP_ATTR_STRUCT(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) struct nilfs_##name##_attr { \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) struct attribute attr; \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) ssize_t (*show)(struct nilfs_##name##_attr *, struct nilfs_root *, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) char *); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) ssize_t (*store)(struct nilfs_##name##_attr *, struct nilfs_root *, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) const char *, size_t); \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) NILFS_CP_ATTR_STRUCT(snapshot);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) #define NILFS_ATTR(type, name, mode, show, store) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) static struct nilfs_##type##_attr nilfs_##type##_attr_##name = \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) __ATTR(name, mode, show, store)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) #define NILFS_INFO_ATTR(type, name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) NILFS_ATTR(type, name, 0444, NULL, NULL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) #define NILFS_RO_ATTR(type, name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) NILFS_ATTR(type, name, 0444, nilfs_##type##_##name##_show, NULL)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #define NILFS_RW_ATTR(type, name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) NILFS_ATTR(type, name, 0644, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) nilfs_##type##_##name##_show, \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) nilfs_##type##_##name##_store)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) #define NILFS_FEATURE_INFO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) NILFS_INFO_ATTR(feature, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) #define NILFS_FEATURE_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) NILFS_RO_ATTR(feature, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) #define NILFS_FEATURE_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) NILFS_RW_ATTR(feature, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define NILFS_DEV_INFO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) NILFS_INFO_ATTR(dev, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define NILFS_DEV_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) NILFS_RO_ATTR(dev, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) #define NILFS_DEV_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) NILFS_RW_ATTR(dev, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) #define NILFS_SEGMENTS_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) NILFS_RO_ATTR(segments, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) #define NILFS_SEGMENTS_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) NILFS_RW_ATTR(segs_info, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) #define NILFS_MOUNTED_SNAPSHOTS_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) NILFS_RO_ATTR(mounted_snapshots, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) #define NILFS_CHECKPOINTS_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) NILFS_RO_ATTR(checkpoints, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) #define NILFS_CHECKPOINTS_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) NILFS_RW_ATTR(checkpoints, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) #define NILFS_SNAPSHOT_INFO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) NILFS_INFO_ATTR(snapshot, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) #define NILFS_SNAPSHOT_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) NILFS_RO_ATTR(snapshot, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) #define NILFS_SNAPSHOT_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) NILFS_RW_ATTR(snapshot, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) #define NILFS_SUPERBLOCK_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) NILFS_RO_ATTR(superblock, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) #define NILFS_SUPERBLOCK_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) NILFS_RW_ATTR(superblock, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) #define NILFS_SEGCTOR_INFO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) NILFS_INFO_ATTR(segctor, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) #define NILFS_SEGCTOR_RO_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) NILFS_RO_ATTR(segctor, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) #define NILFS_SEGCTOR_RW_ATTR(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) NILFS_RW_ATTR(segctor, name)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) #define NILFS_FEATURE_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) (&nilfs_feature_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) #define NILFS_DEV_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) (&nilfs_dev_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) #define NILFS_SEGMENTS_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) (&nilfs_segments_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) #define NILFS_MOUNTED_SNAPSHOTS_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) (&nilfs_mounted_snapshots_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) #define NILFS_CHECKPOINTS_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) (&nilfs_checkpoints_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) #define NILFS_SNAPSHOT_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) (&nilfs_snapshot_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) #define NILFS_SUPERBLOCK_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) (&nilfs_superblock_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) #define NILFS_SEGCTOR_ATTR_LIST(name) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) (&nilfs_segctor_attr_##name.attr)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) #endif /* _NILFS_SYSFS_H */