fs/cifsd/oplock.h

   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 /* SMB Oplock levels */
  15 #define OPLOCK_NONE      0
  16 #define OPLOCK_EXCLUSIVE 1
  17 #define OPLOCK_BATCH     2
  18 #define OPLOCK_READ      3  /* level 2 oplock */
  19
  20 /* SMB2 Oplock levels */
  21 #define SMB2_OPLOCK_LEVEL_NONE          0x00
  22 #define SMB2_OPLOCK_LEVEL_II            0x01
  23 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE     0x08
  24 #define SMB2_OPLOCK_LEVEL_BATCH         0x09
  25 #define SMB2_OPLOCK_LEVEL_LEASE         0xFF
  26
  27 /* Oplock states */
  28 #define OPLOCK_STATE_NONE       0x00
  29 #define OPLOCK_ACK_WAIT         0x01
  30 #define OPLOCK_CLOSING          0x02
  31
  32 #define OPLOCK_WRITE_TO_READ            0x01
  33 #define OPLOCK_READ_HANDLE_TO_READ      0x02
  34 #define OPLOCK_WRITE_TO_NONE            0x04
  35 #define OPLOCK_READ_TO_NONE             0x08
  36
  37 #define SMB2_LEASE_KEY_SIZE             16
  38
  39 struct lease_ctx_info {
  40         __u8                    lease_key[SMB2_LEASE_KEY_SIZE];
  41         __le32                  req_state;
  42         __le32                  flags;
  43         __le64                  duration;
  44         __u8                    parent_lease_key[SMB2_LEASE_KEY_SIZE];
  45         int                     version;
  46 };
  47
  48 struct lease_table {
  49         char                    client_guid[SMB2_CLIENT_GUID_SIZE];
  50         struct list_head        lease_list;
  51         struct list_head        l_entry;
  52         spinlock_t              lb_lock;
  53 };
  54
  55 struct lease {
  56         __u8                    lease_key[SMB2_LEASE_KEY_SIZE];
  57         __le32                  state;
  58         __le32                  new_state;
  59         __le32                  flags;
  60         __le64                  duration;
  61         __u8                    parent_lease_key[SMB2_LEASE_KEY_SIZE];
  62         int                     version;
  63         unsigned short          epoch;
  64         struct lease_table      *l_lb;
  65 };
  66
  67 struct oplock_info {
  68         struct ksmbd_conn       *conn;
  69         struct ksmbd_session    *sess;
  70         struct ksmbd_work       *work;
  71         struct ksmbd_file       *o_fp;
  72         int                     level;
  73         int                     op_state;
  74         unsigned long           pending_break;
  75         u64                     fid;
  76         atomic_t                breaking_cnt;
  77         atomic_t                refcount;
  78         __u16                   Tid;
  79         bool                    is_lease;
  80         bool                    open_trunc;     /* truncate on open */
  81         struct lease            *o_lease;
  82         struct list_head        interim_list;
  83         struct list_head        op_entry;
  84         struct list_head        lease_entry;
  85         wait_queue_head_t oplock_q; /* Other server threads */
  86         wait_queue_head_t oplock_brk; /* oplock breaking wait */
  87         struct rcu_head         rcu_head;
  88 };
  89
  90 struct lease_break_info {
  91         __le32                  curr_state;
  92         __le32                  new_state;
  93         __le16                  epoch;
  94         char                    lease_key[SMB2_LEASE_KEY_SIZE];
  95 };
  96
  97 struct oplock_break_info {
  98         int level;
  99         int open_trunc;
 100         int fid;
 101 };
 102
 103 int smb_grant_oplock(struct ksmbd_work *work, int req_op_level,
 104                      u64 pid, struct ksmbd_file *fp, __u16 tid,
 105                      struct lease_ctx_info *lctx, int share_ret);
 106 void smb_break_all_levII_oplock(struct ksmbd_work *work,
 107                                 struct ksmbd_file *fp, int is_trunc);
 108 int opinfo_write_to_read(struct oplock_info *opinfo);
 109 int opinfo_read_handle_to_read(struct oplock_info *opinfo);
 110 int opinfo_write_to_none(struct oplock_info *opinfo);
 111 int opinfo_read_to_none(struct oplock_info *opinfo);
 112 void close_id_del_oplock(struct ksmbd_file *fp);
 113 void smb_break_all_oplock(struct ksmbd_work *work, struct ksmbd_file *fp);
 114 struct oplock_info *opinfo_get(struct ksmbd_file *fp);
 115 void opinfo_put(struct oplock_info *opinfo);
 116
 117 /* Lease related functions */
 118 void create_lease_buf(u8 *rbuf, struct lease *lease);
 119 struct lease_ctx_info *parse_lease_state(void *open_req);
 120 __u8 smb2_map_lease_to_oplock(__le32 lease_state);
 121 int lease_read_to_write(struct oplock_info *opinfo);
 122
 123 /* Durable related functions */
 124 void create_durable_rsp_buf(char *cc);
 125 void create_durable_v2_rsp_buf(char *cc, struct ksmbd_file *fp);
 126 void create_mxac_rsp_buf(char *cc, int maximal_access);
 127 void create_disk_id_rsp_buf(char *cc, __u64 file_id, __u64 vol_id);
 128 void create_posix_rsp_buf(char *cc, struct ksmbd_file *fp);
 129 struct create_context *smb2_find_context_vals(void *open_req, const char *str);
 130 struct oplock_info *lookup_lease_in_table(struct ksmbd_conn *conn,
 131                                           char *lease_key);
 132 int find_same_lease_key(struct ksmbd_session *sess, struct ksmbd_inode *ci,
 133                         struct lease_ctx_info *lctx);
 134 void destroy_lease_table(struct ksmbd_conn *conn);
 135 int smb2_check_durable_oplock(struct ksmbd_file *fp,
 136                               struct lease_ctx_info *lctx, char *name);
 137 #endif /* __KSMBD_OPLOCK_H */