1 #ifndef QEMU_9P_H 2 #define QEMU_9P_H 3 4 #include <dirent.h> 5 #include <utime.h> 6 #include <sys/resource.h> 7 #include "fsdev/file-op-9p.h" 8 #include "fsdev/9p-iov-marshal.h" 9 #include "qemu/thread.h" 10 #include "qemu/coroutine.h" 11 12 enum { 13 P9_TLERROR = 6, 14 P9_RLERROR, 15 P9_TSTATFS = 8, 16 P9_RSTATFS, 17 P9_TLOPEN = 12, 18 P9_RLOPEN, 19 P9_TLCREATE = 14, 20 P9_RLCREATE, 21 P9_TSYMLINK = 16, 22 P9_RSYMLINK, 23 P9_TMKNOD = 18, 24 P9_RMKNOD, 25 P9_TRENAME = 20, 26 P9_RRENAME, 27 P9_TREADLINK = 22, 28 P9_RREADLINK, 29 P9_TGETATTR = 24, 30 P9_RGETATTR, 31 P9_TSETATTR = 26, 32 P9_RSETATTR, 33 P9_TXATTRWALK = 30, 34 P9_RXATTRWALK, 35 P9_TXATTRCREATE = 32, 36 P9_RXATTRCREATE, 37 P9_TREADDIR = 40, 38 P9_RREADDIR, 39 P9_TFSYNC = 50, 40 P9_RFSYNC, 41 P9_TLOCK = 52, 42 P9_RLOCK, 43 P9_TGETLOCK = 54, 44 P9_RGETLOCK, 45 P9_TLINK = 70, 46 P9_RLINK, 47 P9_TMKDIR = 72, 48 P9_RMKDIR, 49 P9_TRENAMEAT = 74, 50 P9_RRENAMEAT, 51 P9_TUNLINKAT = 76, 52 P9_RUNLINKAT, 53 P9_TVERSION = 100, 54 P9_RVERSION, 55 P9_TAUTH = 102, 56 P9_RAUTH, 57 P9_TATTACH = 104, 58 P9_RATTACH, 59 P9_TERROR = 106, 60 P9_RERROR, 61 P9_TFLUSH = 108, 62 P9_RFLUSH, 63 P9_TWALK = 110, 64 P9_RWALK, 65 P9_TOPEN = 112, 66 P9_ROPEN, 67 P9_TCREATE = 114, 68 P9_RCREATE, 69 P9_TREAD = 116, 70 P9_RREAD, 71 P9_TWRITE = 118, 72 P9_RWRITE, 73 P9_TCLUNK = 120, 74 P9_RCLUNK, 75 P9_TREMOVE = 122, 76 P9_RREMOVE, 77 P9_TSTAT = 124, 78 P9_RSTAT, 79 P9_TWSTAT = 126, 80 P9_RWSTAT, 81 }; 82 83 84 /* qid.types */ 85 enum { 86 P9_QTDIR = 0x80, 87 P9_QTAPPEND = 0x40, 88 P9_QTEXCL = 0x20, 89 P9_QTMOUNT = 0x10, 90 P9_QTAUTH = 0x08, 91 P9_QTTMP = 0x04, 92 P9_QTSYMLINK = 0x02, 93 P9_QTLINK = 0x01, 94 P9_QTFILE = 0x00, 95 }; 96 97 enum p9_proto_version { 98 V9FS_PROTO_2000U = 0x01, 99 V9FS_PROTO_2000L = 0x02, 100 }; 101 102 #define P9_NOTAG UINT16_MAX 103 #define P9_NOFID UINT32_MAX 104 #define P9_MAXWELEM 16 105 106 #define FID_REFERENCED 0x1 107 #define FID_NON_RECLAIMABLE 0x2 108 static inline char *rpath(FsContext *ctx, const char *path) 109 { 110 return g_strdup_printf("%s/%s", ctx->fs_root, path); 111 } 112 113 /* 114 * ample room for Twrite/Rread header 115 * size[4] Tread/Twrite tag[2] fid[4] offset[8] count[4] 116 */ 117 #define P9_IOHDRSZ 24 118 119 typedef struct V9fsPDU V9fsPDU; 120 struct V9fsState; 121 122 typedef struct { 123 uint32_t size_le; 124 uint8_t id; 125 uint16_t tag_le; 126 } QEMU_PACKED P9MsgHeader; 127 128 struct V9fsPDU 129 { 130 uint32_t size; 131 uint16_t tag; 132 uint8_t id; 133 uint8_t cancelled; 134 CoQueue complete; 135 struct V9fsState *s; 136 QLIST_ENTRY(V9fsPDU) next; 137 uint32_t idx; 138 }; 139 140 141 /* FIXME 142 * 1) change user needs to set groups and stuff 143 */ 144 145 #define MAX_REQ 128 146 #define MAX_TAG_LEN 32 147 148 #define BUG_ON(cond) assert(!(cond)) 149 150 typedef struct V9fsFidState V9fsFidState; 151 152 enum { 153 P9_FID_NONE = 0, 154 P9_FID_FILE, 155 P9_FID_DIR, 156 P9_FID_XATTR, 157 }; 158 159 typedef struct V9fsConf 160 { 161 /* tag name for the device */ 162 char *tag; 163 char *fsdev_id; 164 } V9fsConf; 165 166 typedef struct V9fsXattr 167 { 168 uint64_t copied_len; 169 uint64_t len; 170 void *value; 171 V9fsString name; 172 int flags; 173 bool xattrwalk_fid; 174 } V9fsXattr; 175 176 typedef struct V9fsDir { 177 DIR *stream; 178 QemuMutex readdir_mutex; 179 } V9fsDir; 180 181 static inline void v9fs_readdir_lock(V9fsDir *dir) 182 { 183 qemu_mutex_lock(&dir->readdir_mutex); 184 } 185 186 static inline void v9fs_readdir_unlock(V9fsDir *dir) 187 { 188 qemu_mutex_unlock(&dir->readdir_mutex); 189 } 190 191 static inline void v9fs_readdir_init(V9fsDir *dir) 192 { 193 qemu_mutex_init(&dir->readdir_mutex); 194 } 195 196 /* 197 * Filled by fs driver on open and other 198 * calls. 199 */ 200 union V9fsFidOpenState { 201 int fd; 202 V9fsDir dir; 203 V9fsXattr xattr; 204 /* 205 * private pointer for fs drivers, that 206 * have its own internal representation of 207 * open files. 208 */ 209 void *private; 210 }; 211 212 struct V9fsFidState 213 { 214 int fid_type; 215 int32_t fid; 216 V9fsPath path; 217 V9fsFidOpenState fs; 218 V9fsFidOpenState fs_reclaim; 219 int flags; 220 int open_flags; 221 uid_t uid; 222 int ref; 223 int clunked; 224 V9fsFidState *next; 225 V9fsFidState *rclm_lst; 226 }; 227 228 typedef struct V9fsState 229 { 230 QLIST_HEAD(, V9fsPDU) free_list; 231 QLIST_HEAD(, V9fsPDU) active_list; 232 V9fsFidState *fid_list; 233 FileOperations *ops; 234 FsContext ctx; 235 char *tag; 236 enum p9_proto_version proto_version; 237 int32_t msize; 238 V9fsPDU pdus[MAX_REQ]; 239 const struct V9fsTransport *transport; 240 /* 241 * lock ensuring atomic path update 242 * on rename. 243 */ 244 CoRwlock rename_lock; 245 int32_t root_fid; 246 Error *migration_blocker; 247 V9fsConf fsconf; 248 V9fsQID root_qid; 249 } V9fsState; 250 251 /* 9p2000.L open flags */ 252 #define P9_DOTL_RDONLY 00000000 253 #define P9_DOTL_WRONLY 00000001 254 #define P9_DOTL_RDWR 00000002 255 #define P9_DOTL_NOACCESS 00000003 256 #define P9_DOTL_CREATE 00000100 257 #define P9_DOTL_EXCL 00000200 258 #define P9_DOTL_NOCTTY 00000400 259 #define P9_DOTL_TRUNC 00001000 260 #define P9_DOTL_APPEND 00002000 261 #define P9_DOTL_NONBLOCK 00004000 262 #define P9_DOTL_DSYNC 00010000 263 #define P9_DOTL_FASYNC 00020000 264 #define P9_DOTL_DIRECT 00040000 265 #define P9_DOTL_LARGEFILE 00100000 266 #define P9_DOTL_DIRECTORY 00200000 267 #define P9_DOTL_NOFOLLOW 00400000 268 #define P9_DOTL_NOATIME 01000000 269 #define P9_DOTL_CLOEXEC 02000000 270 #define P9_DOTL_SYNC 04000000 271 272 /* 9p2000.L at flags */ 273 #define P9_DOTL_AT_REMOVEDIR 0x200 274 275 /* 9P2000.L lock type */ 276 #define P9_LOCK_TYPE_RDLCK 0 277 #define P9_LOCK_TYPE_WRLCK 1 278 #define P9_LOCK_TYPE_UNLCK 2 279 280 #define P9_LOCK_SUCCESS 0 281 #define P9_LOCK_BLOCKED 1 282 #define P9_LOCK_ERROR 2 283 #define P9_LOCK_GRACE 3 284 285 #define P9_LOCK_FLAGS_BLOCK 1 286 #define P9_LOCK_FLAGS_RECLAIM 2 287 288 typedef struct V9fsFlock 289 { 290 uint8_t type; 291 uint32_t flags; 292 uint64_t start; /* absolute offset */ 293 uint64_t length; 294 uint32_t proc_id; 295 V9fsString client_id; 296 } V9fsFlock; 297 298 typedef struct V9fsGetlock 299 { 300 uint8_t type; 301 uint64_t start; /* absolute offset */ 302 uint64_t length; 303 uint32_t proc_id; 304 V9fsString client_id; 305 } V9fsGetlock; 306 307 extern int open_fd_hw; 308 extern int total_open_fd; 309 310 static inline void v9fs_path_write_lock(V9fsState *s) 311 { 312 if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) { 313 qemu_co_rwlock_wrlock(&s->rename_lock); 314 } 315 } 316 317 static inline void v9fs_path_read_lock(V9fsState *s) 318 { 319 if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) { 320 qemu_co_rwlock_rdlock(&s->rename_lock); 321 } 322 } 323 324 static inline void v9fs_path_unlock(V9fsState *s) 325 { 326 if (s->ctx.export_flags & V9FS_PATHNAME_FSCONTEXT) { 327 qemu_co_rwlock_unlock(&s->rename_lock); 328 } 329 } 330 331 static inline uint8_t v9fs_request_cancelled(V9fsPDU *pdu) 332 { 333 return pdu->cancelled; 334 } 335 336 void coroutine_fn v9fs_reclaim_fd(V9fsPDU *pdu); 337 void v9fs_path_init(V9fsPath *path); 338 void v9fs_path_free(V9fsPath *path); 339 void v9fs_path_sprintf(V9fsPath *path, const char *fmt, ...); 340 void v9fs_path_copy(V9fsPath *lhs, V9fsPath *rhs); 341 int v9fs_name_to_path(V9fsState *s, V9fsPath *dirpath, 342 const char *name, V9fsPath *path); 343 int v9fs_device_realize_common(V9fsState *s, Error **errp); 344 void v9fs_device_unrealize_common(V9fsState *s, Error **errp); 345 346 ssize_t pdu_marshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...); 347 ssize_t pdu_unmarshal(V9fsPDU *pdu, size_t offset, const char *fmt, ...); 348 V9fsPDU *pdu_alloc(V9fsState *s); 349 void pdu_free(V9fsPDU *pdu); 350 void pdu_submit(V9fsPDU *pdu); 351 void v9fs_reset(V9fsState *s); 352 353 struct V9fsTransport { 354 ssize_t (*pdu_vmarshal)(V9fsPDU *pdu, size_t offset, const char *fmt, 355 va_list ap); 356 ssize_t (*pdu_vunmarshal)(V9fsPDU *pdu, size_t offset, const char *fmt, 357 va_list ap); 358 void (*init_in_iov_from_pdu)(V9fsPDU *pdu, struct iovec **piov, 359 unsigned int *pniov, size_t size); 360 void (*init_out_iov_from_pdu)(V9fsPDU *pdu, struct iovec **piov, 361 unsigned int *pniov); 362 void (*push_and_notify)(V9fsPDU *pdu); 363 }; 364 365 static inline int v9fs_register_transport(V9fsState *s, 366 const struct V9fsTransport *t) 367 { 368 assert(!s->transport); 369 s->transport = t; 370 return 0; 371 } 372 373 #endif 374