1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * RDMA Transport Layer
4 *
5 * Copyright (c) 2014 - 2018 ProfitBricks GmbH. All rights reserved.
6 * Copyright (c) 2018 - 2019 1&1 IONOS Cloud GmbH. All rights reserved.
7 * Copyright (c) 2019 - 2020 1&1 IONOS SE. All rights reserved.
8 */
9
10 #ifndef RTRS_CLT_H
11 #define RTRS_CLT_H
12
13 #include <linux/device.h>
14 #include "rtrs-pri.h"
15
16 /**
17 * enum rtrs_clt_state - Client states.
18 */
19 enum rtrs_clt_state {
20 RTRS_CLT_CONNECTING,
21 RTRS_CLT_CONNECTING_ERR,
22 RTRS_CLT_RECONNECTING,
23 RTRS_CLT_CONNECTED,
24 RTRS_CLT_CLOSING,
25 RTRS_CLT_CLOSED,
26 RTRS_CLT_DEAD,
27 };
28
29 enum rtrs_mp_policy {
30 MP_POLICY_RR,
31 MP_POLICY_MIN_INFLIGHT,
32 MP_POLICY_MIN_LATENCY,
33 };
34
35 /* see Documentation/ABI/testing/sysfs-class-rtrs-client for details */
36 struct rtrs_clt_stats_reconnects {
37 int successful_cnt;
38 int fail_cnt;
39 };
40
41 /* see Documentation/ABI/testing/sysfs-class-rtrs-client for details */
42 struct rtrs_clt_stats_cpu_migr {
43 atomic_t from;
44 int to;
45 };
46
47 /* stats for Read and write operation.
48 * see Documentation/ABI/testing/sysfs-class-rtrs-client for details
49 */
50 struct rtrs_clt_stats_rdma {
51 struct {
52 u64 cnt;
53 u64 size_total;
54 } dir[2];
55
56 u64 failover_cnt;
57 };
58
59 struct rtrs_clt_stats_pcpu {
60 struct rtrs_clt_stats_cpu_migr cpu_migr;
61 struct rtrs_clt_stats_rdma rdma;
62 };
63
64 struct rtrs_clt_stats {
65 struct kobject kobj_stats;
66 struct rtrs_clt_stats_pcpu __percpu *pcpu_stats;
67 struct rtrs_clt_stats_reconnects reconnects;
68 atomic_t inflight;
69 };
70
71 struct rtrs_clt_con {
72 struct rtrs_con c;
73 struct rtrs_iu *rsp_ius;
74 u32 queue_num;
75 unsigned int cpu;
76 struct mutex con_mutex;
77 int cm_err;
78 /* Set under con_mutex before CQ/QP teardown. */
79 bool destroyed;
80 };
81
82 /**
83 * rtrs_permit - permits the memory allocation for future RDMA operation.
84 * Combine with irq pinning to keep IO on same CPU.
85 */
86 struct rtrs_permit {
87 enum rtrs_clt_con_type con_type;
88 unsigned int cpu_id;
89 unsigned int mem_id;
90 unsigned int mem_off;
91 };
92
93 /**
94 * rtrs_clt_io_req - describes one inflight IO request
95 */
96 struct rtrs_clt_io_req {
97 struct rtrs_iu *iu;
98 struct scatterlist *sglist; /* list holding user data */
99 unsigned int sg_cnt;
100 unsigned int sg_size;
101 unsigned int data_len;
102 unsigned int usr_len;
103 void *priv;
104 bool in_use;
105 enum rtrs_mp_policy mp_policy;
106 struct rtrs_clt_con *con;
107 struct ib_sge *sge;
108 struct rtrs_permit *permit;
109 enum dma_data_direction dir;
110 void (*conf)(void *priv, int errno);
111
112 struct ib_mr *mr;
113 struct ib_cqe inv_cqe;
114 struct completion inv_comp;
115 int inv_errno;
116 bool need_inv_comp;
117 refcount_t ref;
118 };
119
120 struct rtrs_rbuf {
121 u64 addr;
122 u32 rkey;
123 };
124
125 struct rtrs_clt_path {
126 struct rtrs_path s;
127 struct rtrs_clt_sess *clt;
128 wait_queue_head_t state_wq;
129 enum rtrs_clt_state state;
130 atomic_t connected_cnt;
131 struct mutex init_mutex;
132 struct rtrs_clt_io_req *reqs;
133 struct delayed_work reconnect_dwork;
134 struct work_struct close_work;
135 struct work_struct err_recovery_work;
136 unsigned int reconnect_attempts;
137 bool established;
138 struct rtrs_rbuf *rbufs;
139 size_t max_io_size;
140 u32 max_hdr_size;
141 u32 chunk_size;
142 size_t queue_depth;
143 u32 max_pages_per_mr;
144 u32 flags;
145 struct kobject kobj;
146 u8 for_new_clt;
147 /* cache hca_port and hca_name to display in sysfs */
148 u8 hca_port;
149 char hca_name[IB_DEVICE_NAME_MAX];
150 struct list_head __percpu
151 *mp_skip_entry;
152 struct rtrs_clt_stats stats[];
153 };
154
155 struct rtrs_clt_sess {
156 struct list_head paths_list; /* rcu protected list */
157 size_t paths_num;
158 struct rtrs_clt_path
159 __rcu * __percpu *pcpu_path;
160 uuid_t paths_uuid;
161 int paths_up;
162 struct mutex paths_mutex;
163 struct mutex paths_ev_mutex;
164 char sessname[NAME_MAX];
165 u16 port;
166 unsigned int max_reconnect_attempts;
167 unsigned int reconnect_delay_sec;
168 unsigned int max_segments;
169 void *permits;
170 unsigned long *permits_map;
171 size_t queue_depth;
172 size_t max_io_size;
173 wait_queue_head_t permits_wait;
174 size_t pdu_sz;
175 void *priv;
176 void (*link_ev)(void *priv,
177 enum rtrs_clt_link_ev ev);
178 struct device dev;
179 struct kobject *kobj_paths;
180 enum rtrs_mp_policy mp_policy;
181 };
182
to_clt_con(struct rtrs_con * c)183 static inline struct rtrs_clt_con *to_clt_con(struct rtrs_con *c)
184 {
185 return container_of(c, struct rtrs_clt_con, c);
186 }
187
to_clt_path(struct rtrs_path * s)188 static inline struct rtrs_clt_path *to_clt_path(struct rtrs_path *s)
189 {
190 return container_of(s, struct rtrs_clt_path, s);
191 }
192
permit_size(struct rtrs_clt_sess * clt)193 static inline int permit_size(struct rtrs_clt_sess *clt)
194 {
195 return sizeof(struct rtrs_permit) + clt->pdu_sz;
196 }
197
get_permit(struct rtrs_clt_sess * clt,int idx)198 static inline struct rtrs_permit *get_permit(struct rtrs_clt_sess *clt,
199 int idx)
200 {
201 return (struct rtrs_permit *)(clt->permits + permit_size(clt) * idx);
202 }
203
204 int rtrs_clt_reconnect_from_sysfs(struct rtrs_clt_path *path);
205 void rtrs_clt_close_conns(struct rtrs_clt_path *clt_path, bool wait);
206 int rtrs_clt_create_path_from_sysfs(struct rtrs_clt_sess *clt,
207 struct rtrs_addr *addr);
208 int rtrs_clt_remove_path_from_sysfs(struct rtrs_clt_path *path,
209 const struct attribute *sysfs_self);
210
211 void rtrs_clt_set_max_reconnect_attempts(struct rtrs_clt_sess *clt, int value);
212 int rtrs_clt_get_max_reconnect_attempts(const struct rtrs_clt_sess *clt);
213 void free_path(struct rtrs_clt_path *clt_path);
214 void rtrs_clt_ib_event_handler(struct ib_event_handler *handler,
215 struct ib_event *ibevent);
216
217 /* rtrs-clt-stats.c */
218
219 int rtrs_clt_init_stats(struct rtrs_clt_stats *stats);
220
221 void rtrs_clt_inc_failover_cnt(struct rtrs_clt_stats *s);
222
223 void rtrs_clt_update_wc_stats(struct rtrs_clt_con *con);
224 void rtrs_clt_update_all_stats(struct rtrs_clt_io_req *req, int dir);
225
226 int rtrs_clt_reset_rdma_lat_distr_stats(struct rtrs_clt_stats *stats,
227 bool enable);
228 ssize_t rtrs_clt_stats_rdma_lat_distr_to_str(struct rtrs_clt_stats *stats,
229 char *page);
230 int rtrs_clt_reset_cpu_migr_stats(struct rtrs_clt_stats *stats, bool enable);
231 int rtrs_clt_stats_migration_from_cnt_to_str(struct rtrs_clt_stats *stats, char *buf);
232 int rtrs_clt_stats_migration_to_cnt_to_str(struct rtrs_clt_stats *stats, char *buf);
233 int rtrs_clt_reset_reconnects_stat(struct rtrs_clt_stats *stats, bool enable);
234 int rtrs_clt_stats_reconnects_to_str(struct rtrs_clt_stats *stats, char *buf);
235 int rtrs_clt_reset_rdma_stats(struct rtrs_clt_stats *stats, bool enable);
236 ssize_t rtrs_clt_stats_rdma_to_str(struct rtrs_clt_stats *stats,
237 char *page);
238 int rtrs_clt_reset_all_stats(struct rtrs_clt_stats *stats, bool enable);
239 ssize_t rtrs_clt_reset_all_help(struct rtrs_clt_stats *stats,
240 char *page);
241
242 /* rtrs-clt-sysfs.c */
243
244 int rtrs_clt_create_sysfs_root_files(struct rtrs_clt_sess *clt);
245 void rtrs_clt_destroy_sysfs_root(struct rtrs_clt_sess *clt);
246
247 int rtrs_clt_create_path_files(struct rtrs_clt_path *clt_path);
248 void rtrs_clt_destroy_path_files(struct rtrs_clt_path *clt_path,
249 const struct attribute *sysfs_self);
250
251 #endif /* RTRS_CLT_H */
252