xref: /linux/fs/smb/server/oplock.h (revision 2ed2e359dea752e7758d29a423033031a0b96584)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  *   Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
4  *   Copyright (C) 2018 Samsung Electronics Co., Ltd.
5  */
6 
7 #ifndef __KSMBD_OPLOCK_H
8 #define __KSMBD_OPLOCK_H
9 
10 #include "smb_common.h"
11 
12 #define OPLOCK_WAIT_TIME	(35 * HZ)
13 
14 /* Oplock states */
15 #define OPLOCK_STATE_NONE	0x00
16 #define OPLOCK_ACK_WAIT		0x01
17 #define OPLOCK_CLOSING		0x02
18 
19 #define OPLOCK_WRITE_TO_READ		0x01
20 #define OPLOCK_READ_HANDLE_TO_READ	0x02
21 #define OPLOCK_WRITE_TO_NONE		0x04
22 #define OPLOCK_READ_TO_NONE		0x08
23 
24 struct lease_ctx_info {
25 	__u8			lease_key[SMB2_LEASE_KEY_SIZE];
26 	__le32			req_state;
27 	__le32			flags;
28 	__le64			duration;
29 	__u8			parent_lease_key[SMB2_LEASE_KEY_SIZE];
30 	__le16			epoch;
31 	int			version;
32 	bool			is_dir;
33 };
34 
35 struct lease_table {
36 	char			client_guid[SMB2_CLIENT_GUID_SIZE];
37 	struct ksmbd_conn	*conn;
38 	struct list_head	lease_list;
39 	struct list_head	l_entry;
40 	spinlock_t		lb_lock;
41 };
42 
43 struct lease {
44 	__u8			lease_key[SMB2_LEASE_KEY_SIZE];
45 	__le32			state;
46 	__le32			new_state;
47 	__le32			flags;
48 	__le64			duration;
49 	__u8			parent_lease_key[SMB2_LEASE_KEY_SIZE];
50 	int			version;
51 	unsigned short		epoch;
52 	bool			is_dir;
53 	bool			reuse_epoch;
54 	struct ksmbd_inode	*ci;
55 	struct lease_table	*l_lb;
56 	struct list_head	l_entry;
57 	struct list_head	open_list;
58 	spinlock_t		lock;
59 	atomic_t		refcount;
60 };
61 
62 struct oplock_info {
63 	struct ksmbd_conn	*conn;
64 	struct ksmbd_session	*sess;
65 	struct ksmbd_work	*work;
66 	struct ksmbd_file	*o_fp;
67 	int                     level;
68 	int                     op_state;
69 	unsigned long		pending_break;
70 	u64			fid;
71 	atomic_t		breaking_cnt;
72 	atomic_t		refcount;
73 	__u16                   Tid;
74 	bool			is_lease;
75 	bool			open_trunc;	/* truncate on open */
76 	struct lease		*o_lease;
77 	struct list_head        op_entry;
78 	struct list_head        lease_entry;
79 	wait_queue_head_t	oplock_q; /* Other server threads */
80 	wait_queue_head_t	oplock_brk; /* oplock breaking wait */
81 	struct rcu_head		rcu;
82 };
83 
84 struct lease_break_info {
85 	__le32			curr_state;
86 	__le32			new_state;
87 	__le16			epoch;
88 	char			lease_key[SMB2_LEASE_KEY_SIZE];
89 };
90 
91 struct oplock_break_info {
92 	int level;
93 	int open_trunc;
94 	int fid;
95 };
96 
97 int smb_grant_oplock(struct ksmbd_work *work, int req_op_level,
98 		     u64 pid, struct ksmbd_file *fp, __u16 tid,
99 		     struct lease_ctx_info *lctx, int share_ret);
100 void smb_break_all_levII_oplock(struct ksmbd_work *work,
101 				struct ksmbd_file *fp, int is_trunc);
102 void smb_break_all_levII_oplock_no_interim(struct ksmbd_work *work,
103 					   struct ksmbd_file *fp, int is_trunc);
104 void smb_break_all_levII_oplock_for_delete(struct ksmbd_work *work,
105 					   struct ksmbd_file *fp);
106 int opinfo_write_to_read(struct oplock_info *opinfo);
107 int opinfo_read_handle_to_read(struct oplock_info *opinfo);
108 int opinfo_write_to_none(struct oplock_info *opinfo);
109 int opinfo_read_to_none(struct oplock_info *opinfo);
110 void close_id_del_oplock(struct ksmbd_file *fp);
111 void smb_break_all_oplock(struct ksmbd_work *work, struct ksmbd_file *fp);
112 struct oplock_info *opinfo_get(struct ksmbd_file *fp);
113 void opinfo_put(struct oplock_info *opinfo);
114 
115 /* Lease related functions */
116 void create_lease_buf(u8 *rbuf, struct lease *lease);
117 struct lease_ctx_info *parse_lease_state(void *open_req);
118 __u8 smb2_map_lease_to_oplock(__le32 lease_state);
119 void lease_update_oplock_levels(struct lease *lease);
120 int lease_read_to_write(struct oplock_info *opinfo);
121 
122 /* Durable related functions */
123 void create_durable_rsp_buf(char *cc);
124 void create_durable_v2_rsp_buf(char *cc, struct ksmbd_file *fp);
125 void create_mxac_rsp_buf(char *cc, int maximal_access);
126 void create_disk_id_rsp_buf(char *cc, __u64 file_id, __u64 vol_id);
127 void create_posix_rsp_buf(char *cc, struct ksmbd_file *fp);
128 struct create_context *smb2_find_context_vals(void *open_req, const char *tag, int tag_len);
129 struct oplock_info *lookup_lease_in_table(struct ksmbd_conn *conn,
130 					  char *lease_key);
131 int find_same_lease_key(struct ksmbd_conn *conn, struct ksmbd_inode *ci,
132 			struct lease_ctx_info *lctx);
133 void destroy_lease_table(struct ksmbd_conn *conn);
134 void smb_send_parent_lease_break_noti(struct ksmbd_file *fp,
135 				      struct lease_ctx_info *lctx);
136 void smb_lazy_parent_lease_break_close(struct ksmbd_file *fp);
137 int smb2_check_durable_oplock(struct ksmbd_conn *conn,
138 			      struct ksmbd_share_config *share,
139 			      struct ksmbd_file *fp,
140 			      struct lease_ctx_info *lctx,
141 			      struct ksmbd_user *user,
142 			      char *name);
143 #endif /* __KSMBD_OPLOCK_H */
144