1 .TH llapi_changelog_start 3 "2022-11-08" "" "Lustre User API"
3 llapi_changelog_start, llapi_changelog_set_xflags, llapi_changelog_fini \- Initialize and clean a read instance for MDT changelogs
6 .B #include <lustre/lustreapi.h>
8 .BI "int llapi_changelog_start(void **" priv ", enum changelog_send_flag " flags ,
9 .BI " const char *" device ", long long " startrec ");"
11 .BI "int llapi_changelog_set_xflags(void *" priv,
12 .BI " enum changelog_send_extra_flag " extra_flags ");"
14 .BI "int llapi_changelog_fini(void **" priv ");"
19 .B llapi_changelog_start()
20 initializes a new instance
22 to read MDT changelogs. It opens the changelog char device
23 corresponding to the MDT's name given by
25 (e.g: "lustrefs-MDT0000").
27 A changelog starting point can be specified with
30 .B llapi_changelog_recv()
31 will get changelog records with numbers greater or equal than
33 0 value means that all records will be read.
35 Some options can be passed to
36 .B llapi_changelog_start()
41 .B enum changelog_send_flag
48 CHANGELOG_FLAG_EXTRA_FLAGS
52 Use changelog follow mode:
53 .B llapi_changelog_recv()
54 will not return when all records have been read. Instead it will block until a
55 new record is available. It avoids restarting an instance and re-scan for newer
59 Deprecated since Lustre 2.10.
62 Pack jobid into the changelog records if available.
64 CHANGELOG_FLAG_EXTRA_FLAG
65 Pack additional flag bits into the changelog record.
68 .B llapi_changelog_set_xflags()
69 specifies additional changelog flags with
73 To use those extra flags, CHANGELOG_FLAG_EXTRA_FLAG must be set by
74 .B llapi_changelog_start()
79 .B enum changelog_send_extra_flag
83 CHANGELOG_EXTRA_FLAG_UIDGID
84 CHANGELOG_EXTRA_FLAG_NID
85 CHANGELOG_EXTRA_FLAG_OMODE
86 CHANGELOG_EXTRA_FLAG_XATTR
89 CHANGELOG_EXTRA_FLAG_UIDGID
90 Pack uid/gid into the changelog record
92 CHANGELOG_EXTRA_FLAG_NID
93 Pack nid into the changelog record
95 CHANGELOG_EXTRA_FLAG_OMODE
96 Pack open mode into the changelog record
98 CHANGELOG_EXTRA_FLAG_XATTR
99 Pack xattr name into the changelog record
102 .B llapi_changelog_fini()
103 closes the MDT's changelog char device and free internal pointers for the instance
107 Return 0 on success or a negative errno value on failure.
111 Insufficient memory to complete operation.
114 One or more invalid arguments are given.
117 MDT's changelog char device not found. Is the Lustre FS mounted?
120 Not enough permissions to open the changelog char device. By default, the device
121 is only accessible to the root user.
123 An example can be found for in lfs.c source file.
125 implements the following command:
127 .BI "lfs changelog [--follow] " MDTNAME " [" STARTREC " [" ENDREC "]]"
129 .BR lfs-changelog (1),
130 .BR llapi_changelog_clear (3)
131 .BR llapi_changelog_get_fd (3),
132 .BR llapi_changelog_in_buf (3),
133 .BR llapi_changelog_recv (3),