1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2*4882a593Smuzhiyun #ifndef _UAPI_LINUX_WATCH_QUEUE_H 3*4882a593Smuzhiyun #define _UAPI_LINUX_WATCH_QUEUE_H 4*4882a593Smuzhiyun 5*4882a593Smuzhiyun #include <linux/types.h> 6*4882a593Smuzhiyun #include <linux/fcntl.h> 7*4882a593Smuzhiyun #include <linux/ioctl.h> 8*4882a593Smuzhiyun 9*4882a593Smuzhiyun #define O_NOTIFICATION_PIPE O_EXCL /* Parameter to pipe2() selecting notification pipe */ 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun #define IOC_WATCH_QUEUE_SET_SIZE _IO('W', 0x60) /* Set the size in pages */ 12*4882a593Smuzhiyun #define IOC_WATCH_QUEUE_SET_FILTER _IO('W', 0x61) /* Set the filter */ 13*4882a593Smuzhiyun 14*4882a593Smuzhiyun enum watch_notification_type { 15*4882a593Smuzhiyun WATCH_TYPE_META = 0, /* Special record */ 16*4882a593Smuzhiyun WATCH_TYPE_KEY_NOTIFY = 1, /* Key change event notification */ 17*4882a593Smuzhiyun WATCH_TYPE__NR = 2 18*4882a593Smuzhiyun }; 19*4882a593Smuzhiyun 20*4882a593Smuzhiyun enum watch_meta_notification_subtype { 21*4882a593Smuzhiyun WATCH_META_REMOVAL_NOTIFICATION = 0, /* Watched object was removed */ 22*4882a593Smuzhiyun WATCH_META_LOSS_NOTIFICATION = 1, /* Data loss occurred */ 23*4882a593Smuzhiyun }; 24*4882a593Smuzhiyun 25*4882a593Smuzhiyun /* 26*4882a593Smuzhiyun * Notification record header. This is aligned to 64-bits so that subclasses 27*4882a593Smuzhiyun * can contain __u64 fields. 28*4882a593Smuzhiyun */ 29*4882a593Smuzhiyun struct watch_notification { 30*4882a593Smuzhiyun __u32 type:24; /* enum watch_notification_type */ 31*4882a593Smuzhiyun __u32 subtype:8; /* Type-specific subtype (filterable) */ 32*4882a593Smuzhiyun __u32 info; 33*4882a593Smuzhiyun #define WATCH_INFO_LENGTH 0x0000007f /* Length of record */ 34*4882a593Smuzhiyun #define WATCH_INFO_LENGTH__SHIFT 0 35*4882a593Smuzhiyun #define WATCH_INFO_ID 0x0000ff00 /* ID of watchpoint */ 36*4882a593Smuzhiyun #define WATCH_INFO_ID__SHIFT 8 37*4882a593Smuzhiyun #define WATCH_INFO_TYPE_INFO 0xffff0000 /* Type-specific info */ 38*4882a593Smuzhiyun #define WATCH_INFO_TYPE_INFO__SHIFT 16 39*4882a593Smuzhiyun #define WATCH_INFO_FLAG_0 0x00010000 /* Type-specific info, flag bit 0 */ 40*4882a593Smuzhiyun #define WATCH_INFO_FLAG_1 0x00020000 /* ... */ 41*4882a593Smuzhiyun #define WATCH_INFO_FLAG_2 0x00040000 42*4882a593Smuzhiyun #define WATCH_INFO_FLAG_3 0x00080000 43*4882a593Smuzhiyun #define WATCH_INFO_FLAG_4 0x00100000 44*4882a593Smuzhiyun #define WATCH_INFO_FLAG_5 0x00200000 45*4882a593Smuzhiyun #define WATCH_INFO_FLAG_6 0x00400000 46*4882a593Smuzhiyun #define WATCH_INFO_FLAG_7 0x00800000 47*4882a593Smuzhiyun }; 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun /* 50*4882a593Smuzhiyun * Notification filtering rules (IOC_WATCH_QUEUE_SET_FILTER). 51*4882a593Smuzhiyun */ 52*4882a593Smuzhiyun struct watch_notification_type_filter { 53*4882a593Smuzhiyun __u32 type; /* Type to apply filter to */ 54*4882a593Smuzhiyun __u32 info_filter; /* Filter on watch_notification::info */ 55*4882a593Smuzhiyun __u32 info_mask; /* Mask of relevant bits in info_filter */ 56*4882a593Smuzhiyun __u32 subtype_filter[8]; /* Bitmask of subtypes to filter on */ 57*4882a593Smuzhiyun }; 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun struct watch_notification_filter { 60*4882a593Smuzhiyun __u32 nr_filters; /* Number of filters */ 61*4882a593Smuzhiyun __u32 __reserved; /* Must be 0 */ 62*4882a593Smuzhiyun struct watch_notification_type_filter filters[]; 63*4882a593Smuzhiyun }; 64*4882a593Smuzhiyun 65*4882a593Smuzhiyun 66*4882a593Smuzhiyun /* 67*4882a593Smuzhiyun * Extended watch removal notification. This is used optionally if the type 68*4882a593Smuzhiyun * wants to indicate an identifier for the object being watched, if there is 69*4882a593Smuzhiyun * such. This can be distinguished by the length. 70*4882a593Smuzhiyun * 71*4882a593Smuzhiyun * type -> WATCH_TYPE_META 72*4882a593Smuzhiyun * subtype -> WATCH_META_REMOVAL_NOTIFICATION 73*4882a593Smuzhiyun */ 74*4882a593Smuzhiyun struct watch_notification_removal { 75*4882a593Smuzhiyun struct watch_notification watch; 76*4882a593Smuzhiyun __u64 id; /* Type-dependent identifier */ 77*4882a593Smuzhiyun }; 78*4882a593Smuzhiyun 79*4882a593Smuzhiyun /* 80*4882a593Smuzhiyun * Type of key/keyring change notification. 81*4882a593Smuzhiyun */ 82*4882a593Smuzhiyun enum key_notification_subtype { 83*4882a593Smuzhiyun NOTIFY_KEY_INSTANTIATED = 0, /* Key was instantiated (aux is error code) */ 84*4882a593Smuzhiyun NOTIFY_KEY_UPDATED = 1, /* Key was updated */ 85*4882a593Smuzhiyun NOTIFY_KEY_LINKED = 2, /* Key (aux) was added to watched keyring */ 86*4882a593Smuzhiyun NOTIFY_KEY_UNLINKED = 3, /* Key (aux) was removed from watched keyring */ 87*4882a593Smuzhiyun NOTIFY_KEY_CLEARED = 4, /* Keyring was cleared */ 88*4882a593Smuzhiyun NOTIFY_KEY_REVOKED = 5, /* Key was revoked */ 89*4882a593Smuzhiyun NOTIFY_KEY_INVALIDATED = 6, /* Key was invalidated */ 90*4882a593Smuzhiyun NOTIFY_KEY_SETATTR = 7, /* Key's attributes got changed */ 91*4882a593Smuzhiyun }; 92*4882a593Smuzhiyun 93*4882a593Smuzhiyun /* 94*4882a593Smuzhiyun * Key/keyring notification record. 95*4882a593Smuzhiyun * - watch.type = WATCH_TYPE_KEY_NOTIFY 96*4882a593Smuzhiyun * - watch.subtype = enum key_notification_type 97*4882a593Smuzhiyun */ 98*4882a593Smuzhiyun struct key_notification { 99*4882a593Smuzhiyun struct watch_notification watch; 100*4882a593Smuzhiyun __u32 key_id; /* The key/keyring affected */ 101*4882a593Smuzhiyun __u32 aux; /* Per-type auxiliary data */ 102*4882a593Smuzhiyun }; 103*4882a593Smuzhiyun 104*4882a593Smuzhiyun #endif /* _UAPI_LINUX_WATCH_QUEUE_H */ 105