uapi/linux/dm-log-userspace.h

17  * in dm-dirty-log.h.  Its purpose is simply to pass the parameters and
37  * User-space will then wait to receive requests form the kernel, which it
41  * you will see 'Payload-to-userspace' and 'Payload-to-kernel'.  The
42  * 'Payload-to-userspace' is what the kernel sends in 'additional data' as
43  * necessary parameters to complete the request.  The 'Payload-to-kernel' is
44  * the 'additional data' returned to the kernel that contains the necessary
50  * DM_ULOG_CTR corresponds to (found in dm-dirty-log.h):
54  * Payload-to-userspace:
56  * Payload-to-kernel:
64  * will be used by all request types to a specific log.  The constructor must
68  * dm_ulog_request to the kernel - setting the 'error' field, filling the
75  * DM_ULOG_DTR corresponds to (found in dm-dirty-log.h):
78  * Payload-to-userspace:
80  * Payload-to-kernel:
84  * necessary to identify the log instance being destroyed.  There is no
88  * dm_ulog_request to the kernel - setting the 'error' field and clearing
94  * DM_ULOG_PRESUSPEND corresponds to (found in dm-dirty-log.h):
97  * Payload-to-userspace:
99  * Payload-to-kernel:
103  * necessary to identify the log instance being presuspended.  There is no
107  * dm_ulog_request to the kernel - setting the 'error' field and
113  * DM_ULOG_POSTSUSPEND corresponds to (found in dm-dirty-log.h):
116  * Payload-to-userspace:
118  * Payload-to-kernel:
122  * necessary to identify the log instance being postsuspended.  There is no
126  * dm_ulog_request to the kernel - setting the 'error' field and
132  * DM_ULOG_RESUME corresponds to (found in dm-dirty-log.h):
135  * Payload-to-userspace:
137  * Payload-to-kernel:
141  * necessary to identify the log instance being resumed.  There is no
145  * dm_ulog_request to the kernel - setting the 'error' field and
151  * DM_ULOG_GET_REGION_SIZE corresponds to (found in dm-dirty-log.h):
154  * Payload-to-userspace:
156  * Payload-to-kernel:
160  * It is returned in the payload area and 'data_size' is set to
164  * dm_ulog_request to the kernel - setting the 'error' field appropriately.
169  * DM_ULOG_IS_CLEAN corresponds to (found in dm-dirty-log.h):
172  * Payload-to-userspace:
173  *	__u64 - the region to get clean status on
174  * Payload-to-kernel:
181  * dm_ulog_request to the kernel - filling the payload with 0 (not clean) or
187  * DM_ULOG_IN_SYNC corresponds to (found in dm-dirty-log.h):
191  * Payload-to-userspace:
192  *	__u64 - the region to get sync status on
193  * Payload-to-kernel:
202  * DM_ULOG_FLUSH corresponds to (found in dm-dirty-log.h):
205  * Payload-to-userspace:
208  *		__u64 [] - region(s) to mark
211  * Payload-to-kernel:
220  * dm_ulog_request to the kernel - setting the 'error' field and clearing
226  * DM_ULOG_MARK_REGION corresponds to (found in dm-dirty-log.h):
229  * Payload-to-userspace:
230  *	__u64 [] - region(s) to mark
231  * Payload-to-kernel:
234  * Incoming payload contains the one or more regions to mark dirty.
239  * dm_ulog_request to the kernel - setting the 'error' field and clearing
245  * DM_ULOG_CLEAR_REGION corresponds to (found in dm-dirty-log.h):
248  * Payload-to-userspace:
249  *	__u64 [] - region(s) to clear
250  * Payload-to-kernel:
253  * Incoming payload contains the one or more regions to mark clean.
258  * dm_ulog_request to the kernel - setting the 'error' field and clearing
264  * DM_ULOG_GET_RESYNC_WORK corresponds to (found in dm-dirty-log.h):
267  * Payload-to-userspace:
269  * Payload-to-kernel:
272  *		__u64 r; -- The region to recover if i=1
277  * dm_ulog_request to the kernel - setting the 'error' field appropriately.
282  * DM_ULOG_SET_REGION_SYNC corresponds to (found in dm-dirty-log.h):
286  * Payload-to-userspace:
288  *		__u64 - region to set sync state on
291  * Payload-to-kernel:
295  * dm_ulog_request to the kernel - setting the 'error' field and clearing
301  * DM_ULOG_GET_SYNC_COUNT corresponds to (found in dm-dirty-log.h):
304  * Payload-to-userspace:
306  * Payload-to-kernel:
313  * dm_ulog_request to the kernel - setting the 'error' field and
319  * DM_ULOG_STATUS_INFO corresponds to (found in dm-dirty-log.h):
323  * Payload-to-userspace:
325  * Payload-to-kernel:
329  * dm_ulog_request to the kernel - setting the 'error' field and
335  * DM_ULOG_STATUS_TABLE corresponds to (found in dm-dirty-log.h):
339  * Payload-to-userspace:
341  * Payload-to-kernel:
345  * dm_ulog_request to the kernel - setting the 'error' field and
351  * DM_ULOG_IS_REMOTE_RECOVERING corresponds to (found in dm-dirty-log.h):
354  * Payload-to-userspace:
355  *	__u64 - region to determine recovery status on
356  * Payload-to-kernel:
363  * dm_ulog_request to the kernel - setting the 'error' field and
369  * (DM_ULOG_REQUEST_MASK & request_type) to get the request type
371  * Payload-to-userspace:
373  * Payload-to-kernel:
378  * set to zero and are reserved for future use and compatibility concerns.
380  * User-space should always use DM_ULOG_REQUEST_TYPE to acquire the
381  * request type from the 'request_type' field to maintain forward compatibility.
389  * change to the way information is passed between kernel
394  *	version 2:  DM_ULOG_CTR allowed to return a string containing a
395  *	            device name that is to be registered with DM via
401  *		    argument ('integrated_flush') is required to turn this
410 	 * identifier (uuid) are used to tie a request to a specific
413 	 * the 'luid'.  The uuid is what is required for node to node
423 	__s32 error;          /* Used to report back processing errors */