History

io_uring/zcrx: rename notif to event

"Notification" is too long and the abbreviated version is used in several places, which is inconsistent and more ambiguous for users. Rename it to event, which is easier to keep consistent. To keep the change small, only change uapi/ + do necessary fix ups, and the rest of internals can be adjusted in the next release.

Pavel Begunkov committed 3 months ago

Commit e366c151 parent 201e3085 files · +40 −39Browse files

Showing the changes to include/uapi/linux (2 of 5 files). Show all

Unified · Split

2 files
  1. include/uapi/linux/io_uring/query.h +4 −4
  2. include/uapi/linux/io_uring/zcrx.h +14 −14
include/uapi/linux/io_uring/query.h+4−4
@@ -23,7 +23,7 @@ enum { · 22 unmodified lines
23 IO_URING_QUERY_OPCODES = 0,23 IO_URING_QUERY_OPCODES = 0,
24 IO_URING_QUERY_ZCRX = 1,24 IO_URING_QUERY_ZCRX = 1,
25 IO_URING_QUERY_SCQ = 2,25 IO_URING_QUERY_SCQ = 2,
26 IO_URING_QUERY_ZCRX_NOTIF = 3,26 IO_URING_QUERY_ZCRX_EVENT = 3,
27 27
28 __IO_URING_QUERY_MAX,28 __IO_URING_QUERY_MAX,
29};29};
@@ -63,9 +63,9 @@ struct io_uring_query_zcrx { · 33 unmodified lines
63 __u64 __resv2;63 __u64 __resv2;
64};64};
65 65
66struct io_uring_query_zcrx_notif {66struct io_uring_query_zcrx_event {
67 /* Bitmask of supported ZCRX_NOTIF_* flags */67 /* Bitmask of supported ZCRX_EVENT_* flags */
68 __u32 notif_flags;68 __u32 event_flags;
69 /* Size of zcrx_stats */69 /* Size of zcrx_stats */
70 __u32 stats_size;70 __u32 stats_size;
71 /* Required alignment for the stats struct within the region (ie stats_offset) */71 /* Required alignment for the stats struct within the region (ie stats_offset) */
include/uapi/linux/io_uring/zcrx.h+14−14
@@ -65,19 +65,19 @@ enum zcrx_features { · 64 unmodified lines
65 * value in struct io_uring_zcrx_ifq_reg::rx_buf_len.65 * value in struct io_uring_zcrx_ifq_reg::rx_buf_len.
66 */66 */
67 ZCRX_FEATURE_RX_PAGE_SIZE = 1 << 0,67 ZCRX_FEATURE_RX_PAGE_SIZE = 1 << 0,
68 ZCRX_FEATURE_NOTIFICATION = 1 << 1,68 ZCRX_FEATURE_EVENT = 1 << 1,
69};69};
70 70
71enum zcrx_notification_type {71enum zcrx_event_type {
72 ZCRX_NOTIF_ALLOC_FAIL,72 ZCRX_EVENT_ALLOC_FAIL,
73 ZCRX_NOTIF_COPY,73 ZCRX_EVENT_COPY,
74 74
75 __ZCRX_NOTIF_TYPE_LAST,75 __ZCRX_EVENT_TYPE_LAST,
76};76};
77 77
78enum zcrx_notification_desc_flags {78enum zcrx_event_desc_flags {
79 /* If set, stats_offset holds a valid offset to a zcrx_stats struct */79 /* If set, stats_offset holds a valid offset to a zcrx_stats struct */
80 ZCRX_NOTIF_DESC_FLAG_STATS = 1 << 0,80 ZCRX_EVENT_DESC_FLAG_STATS = 1 << 0,
81};81};
82 82
83struct zcrx_stats {83struct zcrx_stats {
@@ -85,10 +85,10 @@ struct zcrx_stats { · 1 unmodified line
85 __u64 copy_bytes; /* cumulative bytes copied */85 __u64 copy_bytes; /* cumulative bytes copied */
86};86};
87 87
88struct zcrx_notification_desc {88struct zcrx_event_desc {
89 __u64 user_data;89 __u64 user_data;
90 __u32 type_mask;90 __u32 type_mask;
91 __u32 flags; /* see enum zcrx_notification_desc_flags */91 __u32 flags; /* see enum zcrx_event_desc_flags */
92 __u64 stats_offset; /* offset from the beginning of refill ring region for stats */92 __u64 stats_offset; /* offset from the beginning of refill ring region for stats */
93 __u64 __resv2[9];93 __u64 __resv2[9];
94};94};
@@ -108,14 +108,14 @@ struct io_uring_zcrx_ifq_reg { · 13 unmodified lines
108 struct io_uring_zcrx_offsets offsets;108 struct io_uring_zcrx_offsets offsets;
109 __u32 zcrx_id;109 __u32 zcrx_id;
110 __u32 rx_buf_len;110 __u32 rx_buf_len;
111 __u64 notif_desc; /* see struct zcrx_notification_desc */111 __u64 event_desc; /* see struct zcrx_event_desc */
112 __u64 __resv[2];112 __u64 __resv[2];
113};113};
114 114
115enum zcrx_ctrl_op {115enum zcrx_ctrl_op {
116 ZCRX_CTRL_FLUSH_RQ,116 ZCRX_CTRL_FLUSH_RQ,
117 ZCRX_CTRL_EXPORT,117 ZCRX_CTRL_EXPORT,
118 ZCRX_CTRL_ARM_NOTIFICATION,118 ZCRX_CTRL_ARM_EVENT,
119 119
120 __ZCRX_CTRL_LAST,120 __ZCRX_CTRL_LAST,
121};121};
@@ -129,8 +129,8 @@ struct zcrx_ctrl_export { · 7 unmodified lines
129 __u32 __resv1[11];129 __u32 __resv1[11];
130};130};
131 131
132struct zcrx_ctrl_arm_notif {132struct zcrx_ctrl_arm_event {
133 __u32 notif_type;133 __u32 event_type; /* see enum zcrx_event_type */
134 __u32 __resv[11];134 __u32 __resv[11];
135};135};
136 136
@@ -142,7 +142,7 @@ struct zcrx_ctrl { · 5 unmodified lines
142 union {142 union {
143 struct zcrx_ctrl_export zc_export;143 struct zcrx_ctrl_export zc_export;
144 struct zcrx_ctrl_flush_rq zc_flush;144 struct zcrx_ctrl_flush_rq zc_flush;
145 struct zcrx_ctrl_arm_notif zc_arm_notif;145 struct zcrx_ctrl_arm_event zc_arm_event;
146 };146 };
147};147};
148 148