Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 1 | /* |
| 2 | * include/net/9p/client.h |
| 3 | * |
| 4 | * 9P Client Definitions |
| 5 | * |
Eric Van Hensbergen | 8a0dc95 | 2008-02-06 19:25:03 -0600 | [diff] [blame] | 6 | * Copyright (C) 2008 by Eric Van Hensbergen <ericvh@gmail.com> |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 7 | * Copyright (C) 2007 by Latchesar Ionkov <lucho@ionkov.net> |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License version 2 |
| 11 | * as published by the Free Software Foundation. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License |
| 19 | * along with this program; if not, write to: |
| 20 | * Free Software Foundation |
| 21 | * 51 Franklin Street, Fifth Floor |
| 22 | * Boston, MA 02111-1301 USA |
| 23 | * |
| 24 | */ |
| 25 | |
| 26 | #ifndef NET_9P_CLIENT_H |
| 27 | #define NET_9P_CLIENT_H |
| 28 | |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 29 | /* Number of requests per row */ |
| 30 | #define P9_ROW_MAXTAG 255 |
| 31 | |
Sripathi Kodi | 0fb80ab | 2010-03-05 18:49:11 +0000 | [diff] [blame] | 32 | /** enum p9_proto_versions - 9P protocol versions |
| 33 | * @p9_proto_legacy: 9P Legacy mode, pre-9P2000.u |
| 34 | * @p9_proto_2000u: 9P2000.u extension |
Sripathi Kodi | 45bc21e | 2010-03-08 17:33:04 +0000 | [diff] [blame] | 35 | * @p9_proto_2000L: 9P2000.L extension |
Sripathi Kodi | 0fb80ab | 2010-03-05 18:49:11 +0000 | [diff] [blame] | 36 | */ |
| 37 | |
| 38 | enum p9_proto_versions{ |
| 39 | p9_proto_legacy = 0, |
| 40 | p9_proto_2000u = 1, |
Sripathi Kodi | 45bc21e | 2010-03-08 17:33:04 +0000 | [diff] [blame] | 41 | p9_proto_2000L = 2, |
Sripathi Kodi | 0fb80ab | 2010-03-05 18:49:11 +0000 | [diff] [blame] | 42 | }; |
| 43 | |
| 44 | |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 45 | /** |
Eric Van Hensbergen | 8b81ef5 | 2008-10-13 18:45:25 -0500 | [diff] [blame] | 46 | * enum p9_trans_status - different states of underlying transports |
| 47 | * @Connected: transport is connected and healthy |
| 48 | * @Disconnected: transport has been disconnected |
| 49 | * @Hung: transport is connected by wedged |
| 50 | * |
| 51 | * This enumeration details the various states a transport |
| 52 | * instatiation can be in. |
| 53 | */ |
| 54 | |
| 55 | enum p9_trans_status { |
| 56 | Connected, |
Aneesh Kumar K.V | 6d96d3a | 2010-03-29 18:13:59 -0500 | [diff] [blame] | 57 | BeginDisconnect, |
Eric Van Hensbergen | 8b81ef5 | 2008-10-13 18:45:25 -0500 | [diff] [blame] | 58 | Disconnected, |
| 59 | Hung, |
| 60 | }; |
| 61 | |
| 62 | /** |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 63 | * enum p9_req_status_t - virtio request status |
| 64 | * @REQ_STATUS_IDLE: request slot unused |
| 65 | * @REQ_STATUS_ALLOC: request has been allocated but not sent |
Eric Van Hensbergen | 673d62cd | 2008-10-13 18:45:22 -0500 | [diff] [blame] | 66 | * @REQ_STATUS_UNSENT: request waiting to be sent |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 67 | * @REQ_STATUS_SENT: request sent to server |
| 68 | * @REQ_STATUS_FLSH: a flush has been sent for this request |
| 69 | * @REQ_STATUS_RCVD: response received from server |
| 70 | * @REQ_STATUS_FLSHD: request has been flushed |
Eric Van Hensbergen | 673d62cd | 2008-10-13 18:45:22 -0500 | [diff] [blame] | 71 | * @REQ_STATUS_ERROR: request encountered an error on the client side |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 72 | * |
| 73 | * The @REQ_STATUS_IDLE state is used to mark a request slot as unused |
| 74 | * but use is actually tracked by the idpool structure which handles tag |
| 75 | * id allocation. |
| 76 | * |
| 77 | */ |
| 78 | |
| 79 | enum p9_req_status_t { |
| 80 | REQ_STATUS_IDLE, |
| 81 | REQ_STATUS_ALLOC, |
Eric Van Hensbergen | 673d62cd | 2008-10-13 18:45:22 -0500 | [diff] [blame] | 82 | REQ_STATUS_UNSENT, |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 83 | REQ_STATUS_SENT, |
| 84 | REQ_STATUS_FLSH, |
| 85 | REQ_STATUS_RCVD, |
| 86 | REQ_STATUS_FLSHD, |
| 87 | REQ_STATUS_ERROR, |
| 88 | }; |
| 89 | |
| 90 | /** |
| 91 | * struct p9_req_t - request slots |
| 92 | * @status: status of this request slot |
| 93 | * @t_err: transport error |
Eric Van Hensbergen | 51a87c5 | 2008-10-16 08:30:07 -0500 | [diff] [blame] | 94 | * @flush_tag: tag of request being flushed (for flush requests) |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 95 | * @wq: wait_queue for the client to block on for this request |
| 96 | * @tc: the request fcall structure |
| 97 | * @rc: the response fcall structure |
| 98 | * @aux: transport specific data (provided for trans_fd migration) |
Eric Van Hensbergen | 673d62cd | 2008-10-13 18:45:22 -0500 | [diff] [blame] | 99 | * @req_list: link for higher level objects to chain requests |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 100 | * |
| 101 | * Transport use an array to track outstanding requests |
| 102 | * instead of a list. While this may incurr overhead during initial |
| 103 | * allocation or expansion, it makes request lookup much easier as the |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 104 | * tag id is a index into an array. (We use tag+1 so that we can accommodate |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 105 | * the -1 tag for the T_VERSION request). |
| 106 | * This also has the nice effect of only having to allocate wait_queues |
| 107 | * once, instead of constantly allocating and freeing them. Its possible |
| 108 | * other resources could benefit from this scheme as well. |
| 109 | * |
| 110 | */ |
| 111 | |
| 112 | struct p9_req_t { |
| 113 | int status; |
| 114 | int t_err; |
| 115 | wait_queue_head_t *wq; |
| 116 | struct p9_fcall *tc; |
| 117 | struct p9_fcall *rc; |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 118 | void *aux; |
Eric Van Hensbergen | 673d62cd | 2008-10-13 18:45:22 -0500 | [diff] [blame] | 119 | |
Eric Van Hensbergen | 673d62cd | 2008-10-13 18:45:22 -0500 | [diff] [blame] | 120 | struct list_head req_list; |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 121 | }; |
| 122 | |
| 123 | /** |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 124 | * struct p9_client - per client instance state |
| 125 | * @lock: protect @fidlist |
| 126 | * @msize: maximum data size negotiated by protocol |
| 127 | * @dotu: extension flags negotiated by protocol |
Sripathi Kodi | 0fb80ab | 2010-03-05 18:49:11 +0000 | [diff] [blame] | 128 | * @proto_version: 9P protocol version to use |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 129 | * @trans_mod: module API instantiated with this client |
| 130 | * @trans: tranport instance state and API |
| 131 | * @conn: connection state information used by trans_fd |
| 132 | * @fidpool: fid handle accounting for session |
| 133 | * @fidlist: List of active fid handles |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 134 | * @tagpool - transaction id accounting for session |
| 135 | * @reqs - 2D array of requests |
| 136 | * @max_tag - current maximum tag id allocated |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 137 | * |
| 138 | * The client structure is used to keep track of various per-client |
| 139 | * state that has been instantiated. |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 140 | * In order to minimize per-transaction overhead we use a |
| 141 | * simple array to lookup requests instead of a hash table |
| 142 | * or linked list. In order to support larger number of |
| 143 | * transactions, we make this a 2D array, allocating new rows |
| 144 | * when we need to grow the total number of the transactions. |
| 145 | * |
| 146 | * Each row is 256 requests and we'll support up to 256 rows for |
| 147 | * a total of 64k concurrent requests per session. |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 148 | * |
| 149 | * Bugs: duplicated data and potentially unnecessary elements. |
| 150 | */ |
| 151 | |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 152 | struct p9_client { |
| 153 | spinlock_t lock; /* protect client structure */ |
| 154 | int msize; |
Sripathi Kodi | 0fb80ab | 2010-03-05 18:49:11 +0000 | [diff] [blame] | 155 | unsigned char proto_version; |
Eric Van Hensbergen | 8a0dc95 | 2008-02-06 19:25:03 -0600 | [diff] [blame] | 156 | struct p9_trans_module *trans_mod; |
Eric Van Hensbergen | 8b81ef5 | 2008-10-13 18:45:25 -0500 | [diff] [blame] | 157 | enum p9_trans_status status; |
| 158 | void *trans; |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 159 | struct p9_conn *conn; |
| 160 | |
| 161 | struct p9_idpool *fidpool; |
| 162 | struct list_head fidlist; |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 163 | |
| 164 | struct p9_idpool *tagpool; |
| 165 | struct p9_req_t *reqs[P9_ROW_MAXTAG]; |
| 166 | int max_tag; |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 167 | }; |
| 168 | |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 169 | /** |
| 170 | * struct p9_fid - file system entity handle |
| 171 | * @clnt: back pointer to instantiating &p9_client |
| 172 | * @fid: numeric identifier for this handle |
| 173 | * @mode: current mode of this fid (enum?) |
| 174 | * @qid: the &p9_qid server identifier this handle points to |
| 175 | * @iounit: the server reported maximum transaction size for this file |
| 176 | * @uid: the numeric uid of the local user who owns this handle |
Eric Van Hensbergen | 3e2796a | 2009-11-02 08:39:28 -0600 | [diff] [blame] | 177 | * @rdir: readdir accounting structure (allocated on demand) |
Eric Van Hensbergen | ee44399 | 2008-03-05 07:08:09 -0600 | [diff] [blame] | 178 | * @flist: per-client-instance fid tracking |
| 179 | * @dlist: per-dentry fid tracking |
| 180 | * |
| 181 | * TODO: This needs lots of explanation. |
| 182 | */ |
| 183 | |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 184 | struct p9_fid { |
| 185 | struct p9_client *clnt; |
| 186 | u32 fid; |
| 187 | int mode; |
| 188 | struct p9_qid qid; |
| 189 | u32 iounit; |
| 190 | uid_t uid; |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 191 | |
Eric Van Hensbergen | 3e2796a | 2009-11-02 08:39:28 -0600 | [diff] [blame] | 192 | void *rdir; |
| 193 | |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 194 | struct list_head flist; |
| 195 | struct list_head dlist; /* list of all fids attached to a dentry */ |
| 196 | }; |
| 197 | |
Sripathi Kodi | 7751bdb | 2010-06-04 13:41:26 +0000 | [diff] [blame] | 198 | /** |
| 199 | * struct p9_dirent - directory entry structure |
| 200 | * @qid: The p9 server qid for this dirent |
| 201 | * @d_off: offset to the next dirent |
| 202 | * @d_type: type of file |
| 203 | * @d_name: file name |
| 204 | */ |
| 205 | |
| 206 | struct p9_dirent { |
| 207 | struct p9_qid qid; |
| 208 | u64 d_off; |
| 209 | unsigned char d_type; |
| 210 | char d_name[256]; |
| 211 | }; |
| 212 | |
Sripathi Kodi | bda8e77 | 2010-03-25 12:45:30 +0000 | [diff] [blame] | 213 | int p9_client_statfs(struct p9_fid *fid, struct p9_rstatfs *sb); |
Sripathi Kodi | 4681dbd | 2010-03-25 12:47:26 +0000 | [diff] [blame] | 214 | int p9_client_rename(struct p9_fid *fid, struct p9_fid *newdirfid, char *name); |
Eric Van Hensbergen | 8a0dc95 | 2008-02-06 19:25:03 -0600 | [diff] [blame] | 215 | struct p9_client *p9_client_create(const char *dev_name, char *options); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 216 | void p9_client_destroy(struct p9_client *clnt); |
| 217 | void p9_client_disconnect(struct p9_client *clnt); |
Aneesh Kumar K.V | 6d96d3a | 2010-03-29 18:13:59 -0500 | [diff] [blame] | 218 | void p9_client_begin_disconnect(struct p9_client *clnt); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 219 | struct p9_fid *p9_client_attach(struct p9_client *clnt, struct p9_fid *afid, |
Latchesar Ionkov | ba17674 | 2007-10-17 14:31:07 -0500 | [diff] [blame] | 220 | char *uname, u32 n_uname, char *aname); |
Harsh Prateek Bora | b76225e | 2011-03-31 15:49:39 +0530 | [diff] [blame] | 221 | struct p9_fid *p9_client_walk(struct p9_fid *oldfid, uint16_t nwname, |
| 222 | char **wnames, int clone); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 223 | int p9_client_open(struct p9_fid *fid, int mode); |
| 224 | int p9_client_fcreate(struct p9_fid *fid, char *name, u32 perm, int mode, |
| 225 | char *extension); |
Venkateswararao Jujjuri (JV) | 652df9a | 2010-06-03 15:16:59 -0700 | [diff] [blame] | 226 | int p9_client_link(struct p9_fid *fid, struct p9_fid *oldfid, char *newname); |
Venkateswararao Jujjuri (JV) | 50cc42f | 2010-06-09 15:59:31 -0700 | [diff] [blame] | 227 | int p9_client_symlink(struct p9_fid *fid, char *name, char *symname, gid_t gid, |
| 228 | struct p9_qid *qid); |
Venkateswararao Jujjuri (JV) | 5643135 | 2010-06-17 18:27:46 -0700 | [diff] [blame] | 229 | int p9_client_create_dotl(struct p9_fid *ofid, char *name, u32 flags, u32 mode, |
| 230 | gid_t gid, struct p9_qid *qid); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 231 | int p9_client_clunk(struct p9_fid *fid); |
Venkateswararao Jujjuri (JV) | b165d60 | 2010-10-22 10:13:12 -0700 | [diff] [blame] | 232 | int p9_client_fsync(struct p9_fid *fid, int datasync); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 233 | int p9_client_remove(struct p9_fid *fid); |
Eric Van Hensbergen | 0fc9655 | 2008-10-13 20:36:17 -0500 | [diff] [blame] | 234 | int p9_client_read(struct p9_fid *fid, char *data, char __user *udata, |
| 235 | u64 offset, u32 count); |
Eric Van Hensbergen | 0fc9655 | 2008-10-13 20:36:17 -0500 | [diff] [blame] | 236 | int p9_client_write(struct p9_fid *fid, char *data, const char __user *udata, |
| 237 | u64 offset, u32 count); |
Sripathi Kodi | 7751bdb | 2010-06-04 13:41:26 +0000 | [diff] [blame] | 238 | int p9_client_readdir(struct p9_fid *fid, char *data, u32 count, u64 offset); |
| 239 | int p9dirent_read(char *buf, int len, struct p9_dirent *dirent, |
| 240 | int proto_version); |
Eric Van Hensbergen | 51a87c5 | 2008-10-16 08:30:07 -0500 | [diff] [blame] | 241 | struct p9_wstat *p9_client_stat(struct p9_fid *fid); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 242 | int p9_client_wstat(struct p9_fid *fid, struct p9_wstat *wst); |
Sripathi Kodi | 87d7845 | 2010-06-18 11:50:10 +0530 | [diff] [blame] | 243 | int p9_client_setattr(struct p9_fid *fid, struct p9_iattr_dotl *attr); |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 244 | |
Sripathi Kodi | f085312 | 2010-07-12 20:07:23 +0530 | [diff] [blame] | 245 | struct p9_stat_dotl *p9_client_getattr_dotl(struct p9_fid *fid, |
| 246 | u64 request_mask); |
| 247 | |
M. Mohan Kumar | 4b43516 | 2010-06-16 14:27:01 +0530 | [diff] [blame] | 248 | int p9_client_mknod_dotl(struct p9_fid *oldfid, char *name, int mode, |
| 249 | dev_t rdev, gid_t gid, struct p9_qid *); |
M. Mohan Kumar | 01a622b | 2010-06-16 14:27:22 +0530 | [diff] [blame] | 250 | int p9_client_mkdir_dotl(struct p9_fid *fid, char *name, int mode, |
| 251 | gid_t gid, struct p9_qid *); |
M. Mohan Kumar | a099027 | 2010-09-27 11:34:24 +0530 | [diff] [blame] | 252 | int p9_client_lock_dotl(struct p9_fid *fid, struct p9_flock *flock, u8 *status); |
M. Mohan Kumar | 1d769cd | 2010-09-27 12:22:13 +0530 | [diff] [blame] | 253 | int p9_client_getlock_dotl(struct p9_fid *fid, struct p9_getlock *fl); |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 254 | struct p9_req_t *p9_tag_lookup(struct p9_client *, u16); |
Eric Van Hensbergen | 91b8534 | 2008-10-13 18:45:21 -0500 | [diff] [blame] | 255 | void p9_client_cb(struct p9_client *c, struct p9_req_t *req); |
Eric Van Hensbergen | fea511a | 2008-10-13 18:45:23 -0500 | [diff] [blame] | 256 | |
Tom Tucker | fc79d4b | 2008-10-22 18:47:39 -0500 | [diff] [blame] | 257 | int p9_parse_header(struct p9_fcall *, int32_t *, int8_t *, int16_t *, int); |
Eric Van Hensbergen | 02da398 | 2008-10-16 08:29:30 -0500 | [diff] [blame] | 258 | int p9stat_read(char *, int, struct p9_wstat *, int); |
Eric Van Hensbergen | 51a87c5 | 2008-10-16 08:30:07 -0500 | [diff] [blame] | 259 | void p9stat_free(struct p9_wstat *); |
| 260 | |
Sripathi Kodi | 342fee1 | 2010-03-05 18:50:14 +0000 | [diff] [blame] | 261 | int p9_is_proto_dotu(struct p9_client *clnt); |
| 262 | int p9_is_proto_dotl(struct p9_client *clnt); |
Aneesh Kumar K.V | 0ef63f3 | 2010-05-31 13:22:45 +0530 | [diff] [blame] | 263 | struct p9_fid *p9_client_xattrwalk(struct p9_fid *, const char *, u64 *); |
Aneesh Kumar K.V | eda25e46 | 2010-05-31 13:22:50 +0530 | [diff] [blame] | 264 | int p9_client_xattrcreate(struct p9_fid *, const char *, u64, int); |
M. Mohan Kumar | 329176c | 2010-09-28 19:59:25 +0530 | [diff] [blame] | 265 | int p9_client_readlink(struct p9_fid *fid, char **target); |
Eric Van Hensbergen | 02da398 | 2008-10-16 08:29:30 -0500 | [diff] [blame] | 266 | |
Latchesar Ionkov | bd238fb | 2007-07-10 17:57:28 -0500 | [diff] [blame] | 267 | #endif /* NET_9P_CLIENT_H */ |