]>
Commit | Line | Data |
---|---|---|
6542aa9c PL |
1 | /* |
2 | * QEMU Block driver for native access to files on NFS shares | |
3 | * | |
f1a7ff77 | 4 | * Copyright (c) 2014-2017 Peter Lieven <[email protected]> |
6542aa9c PL |
5 | * |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
19 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
22 | * THE SOFTWARE. | |
23 | */ | |
24 | ||
80c71a24 | 25 | #include "qemu/osdep.h" |
6542aa9c | 26 | |
c63b0201 | 27 | #if !defined(_WIN32) |
6542aa9c | 28 | #include <poll.h> |
c63b0201 | 29 | #endif |
6542aa9c PL |
30 | #include "qemu/config-file.h" |
31 | #include "qemu/error-report.h" | |
d165b8cb | 32 | #include "qapi/error.h" |
6542aa9c | 33 | #include "block/block_int.h" |
609f45ea | 34 | #include "block/qdict.h" |
6542aa9c PL |
35 | #include "trace.h" |
36 | #include "qemu/iov.h" | |
db725815 | 37 | #include "qemu/main-loop.h" |
0b8fa32f | 38 | #include "qemu/module.h" |
922a01a0 | 39 | #include "qemu/option.h" |
6542aa9c | 40 | #include "qemu/uri.h" |
0d94b746 | 41 | #include "qemu/cutils.h" |
e4ec5ad4 PD |
42 | #include "sysemu/sysemu.h" |
43 | #include "sysemu/replay.h" | |
9af23989 | 44 | #include "qapi/qapi-visit-block-core.h" |
94d6a7a7 | 45 | #include "qapi/qmp/qdict.h" |
94d6a7a7 | 46 | #include "qapi/qmp/qstring.h" |
94d6a7a7 AA |
47 | #include "qapi/qobject-input-visitor.h" |
48 | #include "qapi/qobject-output-visitor.h" | |
6542aa9c PL |
49 | #include <nfsc/libnfs.h> |
50 | ||
94d6a7a7 | 51 | |
29c838cd | 52 | #define QEMU_NFS_MAX_READAHEAD_SIZE 1048576 |
d99b26c4 | 53 | #define QEMU_NFS_MAX_PAGECACHE_SIZE (8388608 / NFS_BLKSIZE) |
7725b8bf | 54 | #define QEMU_NFS_MAX_DEBUG_LEVEL 2 |
29c838cd | 55 | |
6542aa9c PL |
56 | typedef struct NFSClient { |
57 | struct nfs_context *context; | |
58 | struct nfsfh *fh; | |
59 | int events; | |
60 | bool has_zero_init; | |
471799d1 | 61 | AioContext *aio_context; |
37d1e4d9 | 62 | QemuMutex mutex; |
c63b0201 | 63 | uint64_t st_blocks; |
38f8d5e0 | 64 | bool cache_used; |
94d6a7a7 AA |
65 | NFSServer *server; |
66 | char *path; | |
67 | int64_t uid, gid, tcp_syncnt, readahead, pagecache, debug; | |
6542aa9c PL |
68 | } NFSClient; |
69 | ||
70 | typedef struct NFSRPC { | |
d746427a | 71 | BlockDriverState *bs; |
6542aa9c PL |
72 | int ret; |
73 | int complete; | |
74 | QEMUIOVector *iov; | |
75 | struct stat *st; | |
76 | Coroutine *co; | |
471799d1 | 77 | NFSClient *client; |
6542aa9c PL |
78 | } NFSRPC; |
79 | ||
94d6a7a7 AA |
80 | static int nfs_parse_uri(const char *filename, QDict *options, Error **errp) |
81 | { | |
82 | URI *uri = NULL; | |
83 | QueryParams *qp = NULL; | |
84 | int ret = -EINVAL, i; | |
85 | ||
86 | uri = uri_parse(filename); | |
87 | if (!uri) { | |
88 | error_setg(errp, "Invalid URI specified"); | |
89 | goto out; | |
90 | } | |
f69165a8 | 91 | if (g_strcmp0(uri->scheme, "nfs") != 0) { |
94d6a7a7 AA |
92 | error_setg(errp, "URI scheme must be 'nfs'"); |
93 | goto out; | |
94 | } | |
95 | ||
96 | if (!uri->server) { | |
97 | error_setg(errp, "missing hostname in URI"); | |
98 | goto out; | |
99 | } | |
100 | ||
101 | if (!uri->path) { | |
102 | error_setg(errp, "missing file path in URI"); | |
103 | goto out; | |
104 | } | |
105 | ||
106 | qp = query_params_parse(uri->query); | |
107 | if (!qp) { | |
108 | error_setg(errp, "could not parse query parameters"); | |
109 | goto out; | |
110 | } | |
111 | ||
46f5ac20 EB |
112 | qdict_put_str(options, "server.host", uri->server); |
113 | qdict_put_str(options, "server.type", "inet"); | |
114 | qdict_put_str(options, "path", uri->path); | |
94d6a7a7 AA |
115 | |
116 | for (i = 0; i < qp->n; i++) { | |
8d20abe8 | 117 | unsigned long long val; |
94d6a7a7 AA |
118 | if (!qp->p[i].value) { |
119 | error_setg(errp, "Value for NFS parameter expected: %s", | |
120 | qp->p[i].name); | |
121 | goto out; | |
122 | } | |
8d20abe8 | 123 | if (parse_uint_full(qp->p[i].value, &val, 0)) { |
94d6a7a7 AA |
124 | error_setg(errp, "Illegal value for NFS parameter: %s", |
125 | qp->p[i].name); | |
126 | goto out; | |
127 | } | |
128 | if (!strcmp(qp->p[i].name, "uid")) { | |
46f5ac20 | 129 | qdict_put_str(options, "user", qp->p[i].value); |
94d6a7a7 | 130 | } else if (!strcmp(qp->p[i].name, "gid")) { |
46f5ac20 | 131 | qdict_put_str(options, "group", qp->p[i].value); |
94d6a7a7 | 132 | } else if (!strcmp(qp->p[i].name, "tcp-syncnt")) { |
46f5ac20 | 133 | qdict_put_str(options, "tcp-syn-count", qp->p[i].value); |
94d6a7a7 | 134 | } else if (!strcmp(qp->p[i].name, "readahead")) { |
46f5ac20 | 135 | qdict_put_str(options, "readahead-size", qp->p[i].value); |
94d6a7a7 | 136 | } else if (!strcmp(qp->p[i].name, "pagecache")) { |
46f5ac20 | 137 | qdict_put_str(options, "page-cache-size", qp->p[i].value); |
94d6a7a7 | 138 | } else if (!strcmp(qp->p[i].name, "debug")) { |
46f5ac20 | 139 | qdict_put_str(options, "debug", qp->p[i].value); |
94d6a7a7 AA |
140 | } else { |
141 | error_setg(errp, "Unknown NFS parameter name: %s", | |
142 | qp->p[i].name); | |
143 | goto out; | |
144 | } | |
145 | } | |
146 | ret = 0; | |
147 | out: | |
148 | if (qp) { | |
149 | query_params_free(qp); | |
150 | } | |
151 | if (uri) { | |
152 | uri_free(uri); | |
153 | } | |
154 | return ret; | |
155 | } | |
156 | ||
157 | static bool nfs_has_filename_options_conflict(QDict *options, Error **errp) | |
158 | { | |
159 | const QDictEntry *qe; | |
160 | ||
161 | for (qe = qdict_first(options); qe; qe = qdict_next(options, qe)) { | |
162 | if (!strcmp(qe->key, "host") || | |
163 | !strcmp(qe->key, "path") || | |
164 | !strcmp(qe->key, "user") || | |
165 | !strcmp(qe->key, "group") || | |
166 | !strcmp(qe->key, "tcp-syn-count") || | |
167 | !strcmp(qe->key, "readahead-size") || | |
168 | !strcmp(qe->key, "page-cache-size") || | |
7103d916 | 169 | !strcmp(qe->key, "debug") || |
94d6a7a7 AA |
170 | strstart(qe->key, "server.", NULL)) |
171 | { | |
172 | error_setg(errp, "Option %s cannot be used with a filename", | |
173 | qe->key); | |
174 | return true; | |
175 | } | |
176 | } | |
177 | ||
178 | return false; | |
179 | } | |
180 | ||
181 | static void nfs_parse_filename(const char *filename, QDict *options, | |
182 | Error **errp) | |
183 | { | |
184 | if (nfs_has_filename_options_conflict(options, errp)) { | |
185 | return; | |
186 | } | |
187 | ||
188 | nfs_parse_uri(filename, options, errp); | |
189 | } | |
190 | ||
6542aa9c PL |
191 | static void nfs_process_read(void *arg); |
192 | static void nfs_process_write(void *arg); | |
193 | ||
37d1e4d9 | 194 | /* Called with QemuMutex held. */ |
6542aa9c PL |
195 | static void nfs_set_events(NFSClient *client) |
196 | { | |
197 | int ev = nfs_which_events(client->context); | |
198 | if (ev != client->events) { | |
dca21ef2 FZ |
199 | aio_set_fd_handler(client->aio_context, nfs_get_fd(client->context), |
200 | false, | |
471799d1 | 201 | (ev & POLLIN) ? nfs_process_read : NULL, |
f6a51c84 SH |
202 | (ev & POLLOUT) ? nfs_process_write : NULL, |
203 | NULL, client); | |
6542aa9c PL |
204 | |
205 | } | |
206 | client->events = ev; | |
207 | } | |
208 | ||
209 | static void nfs_process_read(void *arg) | |
210 | { | |
211 | NFSClient *client = arg; | |
9d456654 | 212 | |
37d1e4d9 | 213 | qemu_mutex_lock(&client->mutex); |
6542aa9c PL |
214 | nfs_service(client->context, POLLIN); |
215 | nfs_set_events(client); | |
37d1e4d9 | 216 | qemu_mutex_unlock(&client->mutex); |
6542aa9c PL |
217 | } |
218 | ||
219 | static void nfs_process_write(void *arg) | |
220 | { | |
221 | NFSClient *client = arg; | |
9d456654 | 222 | |
37d1e4d9 | 223 | qemu_mutex_lock(&client->mutex); |
6542aa9c PL |
224 | nfs_service(client->context, POLLOUT); |
225 | nfs_set_events(client); | |
37d1e4d9 | 226 | qemu_mutex_unlock(&client->mutex); |
6542aa9c PL |
227 | } |
228 | ||
d746427a | 229 | static void nfs_co_init_task(BlockDriverState *bs, NFSRPC *task) |
6542aa9c PL |
230 | { |
231 | *task = (NFSRPC) { | |
471799d1 | 232 | .co = qemu_coroutine_self(), |
d746427a PB |
233 | .bs = bs, |
234 | .client = bs->opaque, | |
6542aa9c PL |
235 | }; |
236 | } | |
237 | ||
238 | static void nfs_co_generic_bh_cb(void *opaque) | |
239 | { | |
240 | NFSRPC *task = opaque; | |
1919631e | 241 | |
a2c0fe2f | 242 | task->complete = 1; |
1919631e | 243 | aio_co_wake(task->co); |
6542aa9c PL |
244 | } |
245 | ||
37d1e4d9 | 246 | /* Called (via nfs_service) with QemuMutex held. */ |
6542aa9c PL |
247 | static void |
248 | nfs_co_generic_cb(int ret, struct nfs_context *nfs, void *data, | |
249 | void *private_data) | |
250 | { | |
251 | NFSRPC *task = private_data; | |
6542aa9c | 252 | task->ret = ret; |
d746427a | 253 | assert(!task->st); |
6542aa9c PL |
254 | if (task->ret > 0 && task->iov) { |
255 | if (task->ret <= task->iov->size) { | |
256 | qemu_iovec_from_buf(task->iov, 0, data, task->ret); | |
257 | } else { | |
258 | task->ret = -EIO; | |
259 | } | |
260 | } | |
20fccb18 PL |
261 | if (task->ret < 0) { |
262 | error_report("NFS Error: %s", nfs_get_error(nfs)); | |
263 | } | |
e4ec5ad4 PD |
264 | replay_bh_schedule_oneshot_event(task->client->aio_context, |
265 | nfs_co_generic_bh_cb, task); | |
6542aa9c PL |
266 | } |
267 | ||
69785a22 PL |
268 | static int coroutine_fn nfs_co_preadv(BlockDriverState *bs, uint64_t offset, |
269 | uint64_t bytes, QEMUIOVector *iov, | |
270 | int flags) | |
6542aa9c PL |
271 | { |
272 | NFSClient *client = bs->opaque; | |
273 | NFSRPC task; | |
274 | ||
d746427a | 275 | nfs_co_init_task(bs, &task); |
6542aa9c PL |
276 | task.iov = iov; |
277 | ||
6e8a355d DB |
278 | WITH_QEMU_LOCK_GUARD(&client->mutex) { |
279 | if (nfs_pread_async(client->context, client->fh, | |
280 | offset, bytes, nfs_co_generic_cb, &task) != 0) { | |
281 | return -ENOMEM; | |
282 | } | |
6542aa9c | 283 | |
6e8a355d DB |
284 | nfs_set_events(client); |
285 | } | |
6542aa9c | 286 | while (!task.complete) { |
6542aa9c PL |
287 | qemu_coroutine_yield(); |
288 | } | |
289 | ||
290 | if (task.ret < 0) { | |
291 | return task.ret; | |
292 | } | |
293 | ||
294 | /* zero pad short reads */ | |
295 | if (task.ret < iov->size) { | |
296 | qemu_iovec_memset(iov, task.ret, 0, iov->size - task.ret); | |
297 | } | |
298 | ||
299 | return 0; | |
300 | } | |
301 | ||
69785a22 PL |
302 | static int coroutine_fn nfs_co_pwritev(BlockDriverState *bs, uint64_t offset, |
303 | uint64_t bytes, QEMUIOVector *iov, | |
304 | int flags) | |
6542aa9c PL |
305 | { |
306 | NFSClient *client = bs->opaque; | |
307 | NFSRPC task; | |
308 | char *buf = NULL; | |
ef503a84 | 309 | bool my_buffer = false; |
6542aa9c | 310 | |
d746427a | 311 | nfs_co_init_task(bs, &task); |
6542aa9c | 312 | |
ef503a84 PL |
313 | if (iov->niov != 1) { |
314 | buf = g_try_malloc(bytes); | |
315 | if (bytes && buf == NULL) { | |
316 | return -ENOMEM; | |
317 | } | |
318 | qemu_iovec_to_buf(iov, 0, buf, bytes); | |
319 | my_buffer = true; | |
320 | } else { | |
321 | buf = iov->iov[0].iov_base; | |
2347dd7b KW |
322 | } |
323 | ||
6e8a355d DB |
324 | WITH_QEMU_LOCK_GUARD(&client->mutex) { |
325 | if (nfs_pwrite_async(client->context, client->fh, | |
326 | offset, bytes, buf, | |
327 | nfs_co_generic_cb, &task) != 0) { | |
328 | if (my_buffer) { | |
329 | g_free(buf); | |
330 | } | |
331 | return -ENOMEM; | |
ef503a84 | 332 | } |
6542aa9c | 333 | |
6e8a355d DB |
334 | nfs_set_events(client); |
335 | } | |
6542aa9c | 336 | while (!task.complete) { |
6542aa9c PL |
337 | qemu_coroutine_yield(); |
338 | } | |
339 | ||
ef503a84 PL |
340 | if (my_buffer) { |
341 | g_free(buf); | |
342 | } | |
6542aa9c | 343 | |
69785a22 | 344 | if (task.ret != bytes) { |
6542aa9c PL |
345 | return task.ret < 0 ? task.ret : -EIO; |
346 | } | |
347 | ||
348 | return 0; | |
349 | } | |
350 | ||
351 | static int coroutine_fn nfs_co_flush(BlockDriverState *bs) | |
352 | { | |
353 | NFSClient *client = bs->opaque; | |
354 | NFSRPC task; | |
355 | ||
d746427a | 356 | nfs_co_init_task(bs, &task); |
6542aa9c | 357 | |
6e8a355d DB |
358 | WITH_QEMU_LOCK_GUARD(&client->mutex) { |
359 | if (nfs_fsync_async(client->context, client->fh, nfs_co_generic_cb, | |
360 | &task) != 0) { | |
361 | return -ENOMEM; | |
362 | } | |
6542aa9c | 363 | |
6e8a355d DB |
364 | nfs_set_events(client); |
365 | } | |
6542aa9c | 366 | while (!task.complete) { |
6542aa9c PL |
367 | qemu_coroutine_yield(); |
368 | } | |
369 | ||
370 | return task.ret; | |
371 | } | |
372 | ||
471799d1 SH |
373 | static void nfs_detach_aio_context(BlockDriverState *bs) |
374 | { | |
375 | NFSClient *client = bs->opaque; | |
376 | ||
dca21ef2 | 377 | aio_set_fd_handler(client->aio_context, nfs_get_fd(client->context), |
f6a51c84 | 378 | false, NULL, NULL, NULL, NULL); |
471799d1 SH |
379 | client->events = 0; |
380 | } | |
381 | ||
382 | static void nfs_attach_aio_context(BlockDriverState *bs, | |
383 | AioContext *new_context) | |
384 | { | |
385 | NFSClient *client = bs->opaque; | |
386 | ||
387 | client->aio_context = new_context; | |
388 | nfs_set_events(client); | |
389 | } | |
390 | ||
6542aa9c PL |
391 | static void nfs_client_close(NFSClient *client) |
392 | { | |
393 | if (client->context) { | |
601dc655 PL |
394 | qemu_mutex_lock(&client->mutex); |
395 | aio_set_fd_handler(client->aio_context, nfs_get_fd(client->context), | |
396 | false, NULL, NULL, NULL, NULL); | |
397 | qemu_mutex_unlock(&client->mutex); | |
6542aa9c PL |
398 | if (client->fh) { |
399 | nfs_close(client->context, client->fh); | |
113fe792 | 400 | client->fh = NULL; |
6542aa9c | 401 | } |
d2c6becb PL |
402 | #ifdef LIBNFS_FEATURE_UMOUNT |
403 | nfs_umount(client->context); | |
404 | #endif | |
6542aa9c | 405 | nfs_destroy_context(client->context); |
113fe792 | 406 | client->context = NULL; |
6542aa9c | 407 | } |
113fe792 JC |
408 | g_free(client->path); |
409 | qemu_mutex_destroy(&client->mutex); | |
410 | qapi_free_NFSServer(client->server); | |
411 | client->server = NULL; | |
6542aa9c PL |
412 | } |
413 | ||
414 | static void nfs_file_close(BlockDriverState *bs) | |
415 | { | |
416 | NFSClient *client = bs->opaque; | |
417 | nfs_client_close(client); | |
418 | } | |
419 | ||
c22a0345 | 420 | static int64_t nfs_client_open(NFSClient *client, BlockdevOptionsNfs *opts, |
cb8d4bf6 | 421 | int flags, int open_flags, Error **errp) |
6542aa9c | 422 | { |
f1a7ff77 | 423 | int64_t ret = -EINVAL; |
6542aa9c | 424 | struct stat st; |
6542aa9c PL |
425 | char *file = NULL, *strp = NULL; |
426 | ||
113fe792 | 427 | qemu_mutex_init(&client->mutex); |
94d6a7a7 | 428 | |
c22a0345 | 429 | client->path = g_strdup(opts->path); |
94d6a7a7 AA |
430 | |
431 | strp = strrchr(client->path, '/'); | |
6542aa9c PL |
432 | if (strp == NULL) { |
433 | error_setg(errp, "Invalid URL specified"); | |
434 | goto fail; | |
435 | } | |
436 | file = g_strdup(strp); | |
437 | *strp = 0; | |
438 | ||
c22a0345 KW |
439 | /* Steal the NFSServer object from opts; set the original pointer to NULL |
440 | * to avoid use after free and double free. */ | |
441 | client->server = opts->server; | |
442 | opts->server = NULL; | |
94d6a7a7 | 443 | |
6542aa9c PL |
444 | client->context = nfs_init_context(); |
445 | if (client->context == NULL) { | |
446 | error_setg(errp, "Failed to init NFS context"); | |
447 | goto fail; | |
448 | } | |
449 | ||
c22a0345 KW |
450 | if (opts->has_user) { |
451 | client->uid = opts->user; | |
94d6a7a7 AA |
452 | nfs_set_uid(client->context, client->uid); |
453 | } | |
454 | ||
c22a0345 KW |
455 | if (opts->has_group) { |
456 | client->gid = opts->group; | |
94d6a7a7 AA |
457 | nfs_set_gid(client->context, client->gid); |
458 | } | |
459 | ||
c22a0345 KW |
460 | if (opts->has_tcp_syn_count) { |
461 | client->tcp_syncnt = opts->tcp_syn_count; | |
94d6a7a7 AA |
462 | nfs_set_tcp_syncnt(client->context, client->tcp_syncnt); |
463 | } | |
464 | ||
465 | #ifdef LIBNFS_FEATURE_READAHEAD | |
c22a0345 | 466 | if (opts->has_readahead_size) { |
94d6a7a7 AA |
467 | if (open_flags & BDRV_O_NOCACHE) { |
468 | error_setg(errp, "Cannot enable NFS readahead " | |
469 | "if cache.direct = on"); | |
6542aa9c PL |
470 | goto fail; |
471 | } | |
c22a0345 | 472 | client->readahead = opts->readahead_size; |
94d6a7a7 | 473 | if (client->readahead > QEMU_NFS_MAX_READAHEAD_SIZE) { |
3dc6f869 AF |
474 | warn_report("Truncating NFS readahead size to %d", |
475 | QEMU_NFS_MAX_READAHEAD_SIZE); | |
94d6a7a7 | 476 | client->readahead = QEMU_NFS_MAX_READAHEAD_SIZE; |
7c24384b | 477 | } |
94d6a7a7 | 478 | nfs_set_readahead(client->context, client->readahead); |
d99b26c4 | 479 | #ifdef LIBNFS_FEATURE_PAGECACHE |
94d6a7a7 | 480 | nfs_set_pagecache_ttl(client->context, 0); |
d99b26c4 | 481 | #endif |
94d6a7a7 AA |
482 | client->cache_used = true; |
483 | } | |
d99b26c4 | 484 | #endif |
94d6a7a7 | 485 | |
d99b26c4 | 486 | #ifdef LIBNFS_FEATURE_PAGECACHE |
c22a0345 | 487 | if (opts->has_page_cache_size) { |
94d6a7a7 AA |
488 | if (open_flags & BDRV_O_NOCACHE) { |
489 | error_setg(errp, "Cannot enable NFS pagecache " | |
490 | "if cache.direct = on"); | |
491 | goto fail; | |
492 | } | |
c22a0345 | 493 | client->pagecache = opts->page_cache_size; |
94d6a7a7 | 494 | if (client->pagecache > QEMU_NFS_MAX_PAGECACHE_SIZE) { |
3dc6f869 AF |
495 | warn_report("Truncating NFS pagecache size to %d pages", |
496 | QEMU_NFS_MAX_PAGECACHE_SIZE); | |
94d6a7a7 AA |
497 | client->pagecache = QEMU_NFS_MAX_PAGECACHE_SIZE; |
498 | } | |
499 | nfs_set_pagecache(client->context, client->pagecache); | |
500 | nfs_set_pagecache_ttl(client->context, 0); | |
501 | client->cache_used = true; | |
502 | } | |
7725b8bf | 503 | #endif |
94d6a7a7 | 504 | |
7725b8bf | 505 | #ifdef LIBNFS_FEATURE_DEBUG |
c22a0345 KW |
506 | if (opts->has_debug) { |
507 | client->debug = opts->debug; | |
94d6a7a7 AA |
508 | /* limit the maximum debug level to avoid potential flooding |
509 | * of our log files. */ | |
510 | if (client->debug > QEMU_NFS_MAX_DEBUG_LEVEL) { | |
3dc6f869 AF |
511 | warn_report("Limiting NFS debug level to %d", |
512 | QEMU_NFS_MAX_DEBUG_LEVEL); | |
94d6a7a7 | 513 | client->debug = QEMU_NFS_MAX_DEBUG_LEVEL; |
6542aa9c | 514 | } |
94d6a7a7 | 515 | nfs_set_debug(client->context, client->debug); |
6542aa9c | 516 | } |
94d6a7a7 | 517 | #endif |
6542aa9c | 518 | |
94d6a7a7 | 519 | ret = nfs_mount(client->context, client->server->host, client->path); |
6542aa9c PL |
520 | if (ret < 0) { |
521 | error_setg(errp, "Failed to mount nfs share: %s", | |
522 | nfs_get_error(client->context)); | |
523 | goto fail; | |
524 | } | |
525 | ||
526 | if (flags & O_CREAT) { | |
527 | ret = nfs_creat(client->context, file, 0600, &client->fh); | |
528 | if (ret < 0) { | |
529 | error_setg(errp, "Failed to create file: %s", | |
530 | nfs_get_error(client->context)); | |
531 | goto fail; | |
532 | } | |
533 | } else { | |
534 | ret = nfs_open(client->context, file, flags, &client->fh); | |
535 | if (ret < 0) { | |
536 | error_setg(errp, "Failed to open file : %s", | |
537 | nfs_get_error(client->context)); | |
538 | goto fail; | |
539 | } | |
540 | } | |
541 | ||
542 | ret = nfs_fstat(client->context, client->fh, &st); | |
543 | if (ret < 0) { | |
544 | error_setg(errp, "Failed to fstat file: %s", | |
545 | nfs_get_error(client->context)); | |
546 | goto fail; | |
547 | } | |
548 | ||
549 | ret = DIV_ROUND_UP(st.st_size, BDRV_SECTOR_SIZE); | |
c63b0201 | 550 | #if !defined(_WIN32) |
18a8056e | 551 | client->st_blocks = st.st_blocks; |
c63b0201 | 552 | #endif |
6542aa9c | 553 | client->has_zero_init = S_ISREG(st.st_mode); |
94d6a7a7 | 554 | *strp = '/'; |
6542aa9c | 555 | goto out; |
94d6a7a7 | 556 | |
6542aa9c PL |
557 | fail: |
558 | nfs_client_close(client); | |
559 | out: | |
6542aa9c PL |
560 | g_free(file); |
561 | return ret; | |
562 | } | |
563 | ||
a1a42af4 KW |
564 | static BlockdevOptionsNfs *nfs_options_qdict_to_qapi(QDict *options, |
565 | Error **errp) | |
c22a0345 KW |
566 | { |
567 | BlockdevOptionsNfs *opts = NULL; | |
c22a0345 | 568 | Visitor *v; |
c82be42c | 569 | const QDictEntry *e; |
c22a0345 | 570 | |
af91062e MA |
571 | v = qobject_input_visitor_new_flat_confused(options, errp); |
572 | if (!v) { | |
a1a42af4 | 573 | return NULL; |
c22a0345 KW |
574 | } |
575 | ||
b11a093c | 576 | visit_type_BlockdevOptionsNfs(v, NULL, &opts, errp); |
c22a0345 | 577 | visit_free(v); |
b11a093c | 578 | if (!opts) { |
a1a42af4 KW |
579 | return NULL; |
580 | } | |
581 | ||
c82be42c KW |
582 | /* Remove the processed options from the QDict (the visitor processes |
583 | * _all_ options in the QDict) */ | |
584 | while ((e = qdict_first(options))) { | |
585 | qdict_del(options, e->key); | |
586 | } | |
587 | ||
a1a42af4 KW |
588 | return opts; |
589 | } | |
590 | ||
591 | static int64_t nfs_client_open_qdict(NFSClient *client, QDict *options, | |
592 | int flags, int open_flags, Error **errp) | |
593 | { | |
594 | BlockdevOptionsNfs *opts; | |
182454dc | 595 | int64_t ret; |
a1a42af4 KW |
596 | |
597 | opts = nfs_options_qdict_to_qapi(options, errp); | |
598 | if (opts == NULL) { | |
c22a0345 KW |
599 | ret = -EINVAL; |
600 | goto fail; | |
601 | } | |
602 | ||
603 | ret = nfs_client_open(client, opts, flags, open_flags, errp); | |
604 | fail: | |
c22a0345 KW |
605 | qapi_free_BlockdevOptionsNfs(opts); |
606 | return ret; | |
607 | } | |
608 | ||
6542aa9c PL |
609 | static int nfs_file_open(BlockDriverState *bs, QDict *options, int flags, |
610 | Error **errp) { | |
611 | NFSClient *client = bs->opaque; | |
612 | int64_t ret; | |
6542aa9c | 613 | |
471799d1 SH |
614 | client->aio_context = bdrv_get_aio_context(bs); |
615 | ||
c22a0345 KW |
616 | ret = nfs_client_open_qdict(client, options, |
617 | (flags & BDRV_O_RDWR) ? O_RDWR : O_RDONLY, | |
618 | bs->open_flags, errp); | |
6542aa9c | 619 | if (ret < 0) { |
94d6a7a7 | 620 | return ret; |
6542aa9c | 621 | } |
113fe792 | 622 | |
6542aa9c | 623 | bs->total_sectors = ret; |
8f23aaf5 EB |
624 | if (client->has_zero_init) { |
625 | bs->supported_truncate_flags = BDRV_REQ_ZERO_WRITE; | |
626 | } | |
b3ac2b94 | 627 | return 0; |
6542aa9c PL |
628 | } |
629 | ||
fd752801 HR |
630 | static QemuOptsList nfs_create_opts = { |
631 | .name = "nfs-create-opts", | |
632 | .head = QTAILQ_HEAD_INITIALIZER(nfs_create_opts.head), | |
633 | .desc = { | |
634 | { | |
635 | .name = BLOCK_OPT_SIZE, | |
636 | .type = QEMU_OPT_SIZE, | |
637 | .help = "Virtual disk size" | |
638 | }, | |
639 | { /* end of list */ } | |
640 | } | |
641 | }; | |
642 | ||
a1a42af4 | 643 | static int nfs_file_co_create(BlockdevCreateOptions *options, Error **errp) |
6542aa9c | 644 | { |
a1a42af4 | 645 | BlockdevCreateOptionsNfs *opts = &options->u.nfs; |
5839e53b | 646 | NFSClient *client = g_new0(NFSClient, 1); |
a1a42af4 KW |
647 | int ret; |
648 | ||
649 | assert(options->driver == BLOCKDEV_DRIVER_NFS); | |
6542aa9c | 650 | |
471799d1 SH |
651 | client->aio_context = qemu_get_aio_context(); |
652 | ||
a1a42af4 KW |
653 | ret = nfs_client_open(client, opts->location, O_CREAT, 0, errp); |
654 | if (ret < 0) { | |
655 | goto out; | |
656 | } | |
657 | ret = nfs_ftruncate(client->context, client->fh, opts->size); | |
658 | nfs_client_close(client); | |
659 | ||
660 | out: | |
661 | g_free(client); | |
662 | return ret; | |
663 | } | |
664 | ||
b92902df ML |
665 | static int coroutine_fn nfs_file_co_create_opts(BlockDriver *drv, |
666 | const char *url, | |
667 | QemuOpts *opts, | |
a1a42af4 KW |
668 | Error **errp) |
669 | { | |
670 | BlockdevCreateOptions *create_options; | |
671 | BlockdevCreateOptionsNfs *nfs_opts; | |
672 | QDict *options; | |
673 | int ret; | |
674 | ||
675 | create_options = g_new0(BlockdevCreateOptions, 1); | |
676 | create_options->driver = BLOCKDEV_DRIVER_NFS; | |
677 | nfs_opts = &create_options->u.nfs; | |
678 | ||
6542aa9c | 679 | /* Read out options */ |
a1a42af4 KW |
680 | nfs_opts->size = ROUND_UP(qemu_opt_get_size_del(opts, BLOCK_OPT_SIZE, 0), |
681 | BDRV_SECTOR_SIZE); | |
6542aa9c | 682 | |
94d6a7a7 AA |
683 | options = qdict_new(); |
684 | ret = nfs_parse_uri(url, options, errp); | |
685 | if (ret < 0) { | |
686 | goto out; | |
687 | } | |
688 | ||
a1a42af4 KW |
689 | nfs_opts->location = nfs_options_qdict_to_qapi(options, errp); |
690 | if (nfs_opts->location == NULL) { | |
691 | ret = -EINVAL; | |
692 | goto out; | |
693 | } | |
694 | ||
695 | ret = nfs_file_co_create(create_options, errp); | |
6542aa9c PL |
696 | if (ret < 0) { |
697 | goto out; | |
698 | } | |
a1a42af4 KW |
699 | |
700 | ret = 0; | |
6542aa9c | 701 | out: |
cb3e7f08 | 702 | qobject_unref(options); |
a1a42af4 | 703 | qapi_free_BlockdevCreateOptions(create_options); |
6542aa9c PL |
704 | return ret; |
705 | } | |
706 | ||
707 | static int nfs_has_zero_init(BlockDriverState *bs) | |
708 | { | |
709 | NFSClient *client = bs->opaque; | |
710 | return client->has_zero_init; | |
711 | } | |
712 | ||
c63b0201 | 713 | #if !defined(_WIN32) |
37d1e4d9 | 714 | /* Called (via nfs_service) with QemuMutex held. */ |
d746427a PB |
715 | static void |
716 | nfs_get_allocated_file_size_cb(int ret, struct nfs_context *nfs, void *data, | |
717 | void *private_data) | |
718 | { | |
719 | NFSRPC *task = private_data; | |
720 | task->ret = ret; | |
721 | if (task->ret == 0) { | |
722 | memcpy(task->st, data, sizeof(struct stat)); | |
723 | } | |
724 | if (task->ret < 0) { | |
725 | error_report("NFS Error: %s", nfs_get_error(nfs)); | |
726 | } | |
e2a6ae7f PB |
727 | |
728 | /* Set task->complete before reading bs->wakeup. */ | |
d73415a3 | 729 | qatomic_mb_set(&task->complete, 1); |
c9d1a561 | 730 | bdrv_wakeup(task->bs); |
d746427a PB |
731 | } |
732 | ||
6542aa9c PL |
733 | static int64_t nfs_get_allocated_file_size(BlockDriverState *bs) |
734 | { | |
735 | NFSClient *client = bs->opaque; | |
736 | NFSRPC task = {0}; | |
737 | struct stat st; | |
738 | ||
18a8056e PL |
739 | if (bdrv_is_read_only(bs) && |
740 | !(bs->open_flags & BDRV_O_NOCACHE)) { | |
741 | return client->st_blocks * 512; | |
742 | } | |
743 | ||
d746427a | 744 | task.bs = bs; |
6542aa9c | 745 | task.st = &st; |
d746427a | 746 | if (nfs_fstat_async(client->context, client->fh, nfs_get_allocated_file_size_cb, |
6542aa9c PL |
747 | &task) != 0) { |
748 | return -ENOMEM; | |
749 | } | |
750 | ||
aa92d6c4 | 751 | nfs_set_events(client); |
d746427a | 752 | BDRV_POLL_WHILE(bs, !task.complete); |
6542aa9c | 753 | |
055c6f91 | 754 | return (task.ret < 0 ? task.ret : st.st_blocks * 512); |
6542aa9c | 755 | } |
c63b0201 | 756 | #endif |
6542aa9c | 757 | |
061ca8a3 | 758 | static int coroutine_fn |
c80d8b06 | 759 | nfs_file_co_truncate(BlockDriverState *bs, int64_t offset, bool exact, |
92b92799 KW |
760 | PreallocMode prealloc, BdrvRequestFlags flags, |
761 | Error **errp) | |
6542aa9c PL |
762 | { |
763 | NFSClient *client = bs->opaque; | |
f59adb32 HR |
764 | int ret; |
765 | ||
8243ccb7 HR |
766 | if (prealloc != PREALLOC_MODE_OFF) { |
767 | error_setg(errp, "Unsupported preallocation mode '%s'", | |
977c736f | 768 | PreallocMode_str(prealloc)); |
8243ccb7 HR |
769 | return -ENOTSUP; |
770 | } | |
771 | ||
f59adb32 HR |
772 | ret = nfs_ftruncate(client->context, client->fh, offset); |
773 | if (ret < 0) { | |
774 | error_setg_errno(errp, -ret, "Failed to truncate file"); | |
775 | return ret; | |
776 | } | |
777 | ||
778 | return 0; | |
6542aa9c PL |
779 | } |
780 | ||
18a8056e PL |
781 | /* Note that this will not re-establish a connection with the NFS server |
782 | * - it is effectively a NOP. */ | |
783 | static int nfs_reopen_prepare(BDRVReopenState *state, | |
784 | BlockReopenQueue *queue, Error **errp) | |
785 | { | |
786 | NFSClient *client = state->bs->opaque; | |
787 | struct stat st; | |
788 | int ret = 0; | |
789 | ||
790 | if (state->flags & BDRV_O_RDWR && bdrv_is_read_only(state->bs)) { | |
791 | error_setg(errp, "Cannot open a read-only mount as read-write"); | |
792 | return -EACCES; | |
793 | } | |
794 | ||
38f8d5e0 | 795 | if ((state->flags & BDRV_O_NOCACHE) && client->cache_used) { |
d99b26c4 PL |
796 | error_setg(errp, "Cannot disable cache if libnfs readahead or" |
797 | " pagecache is enabled"); | |
38f8d5e0 PL |
798 | return -EINVAL; |
799 | } | |
800 | ||
18a8056e PL |
801 | /* Update cache for read-only reopens */ |
802 | if (!(state->flags & BDRV_O_RDWR)) { | |
803 | ret = nfs_fstat(client->context, client->fh, &st); | |
804 | if (ret < 0) { | |
805 | error_setg(errp, "Failed to fstat file: %s", | |
806 | nfs_get_error(client->context)); | |
807 | return ret; | |
808 | } | |
c63b0201 | 809 | #if !defined(_WIN32) |
18a8056e | 810 | client->st_blocks = st.st_blocks; |
c63b0201 | 811 | #endif |
18a8056e PL |
812 | } |
813 | ||
814 | return 0; | |
815 | } | |
816 | ||
998b3a1e | 817 | static void nfs_refresh_filename(BlockDriverState *bs) |
94d6a7a7 AA |
818 | { |
819 | NFSClient *client = bs->opaque; | |
94d6a7a7 AA |
820 | |
821 | if (client->uid && !client->gid) { | |
822 | snprintf(bs->exact_filename, sizeof(bs->exact_filename), | |
823 | "nfs://%s%s?uid=%" PRId64, client->server->host, client->path, | |
824 | client->uid); | |
825 | } else if (!client->uid && client->gid) { | |
826 | snprintf(bs->exact_filename, sizeof(bs->exact_filename), | |
827 | "nfs://%s%s?gid=%" PRId64, client->server->host, client->path, | |
828 | client->gid); | |
829 | } else if (client->uid && client->gid) { | |
830 | snprintf(bs->exact_filename, sizeof(bs->exact_filename), | |
831 | "nfs://%s%s?uid=%" PRId64 "&gid=%" PRId64, | |
832 | client->server->host, client->path, client->uid, client->gid); | |
833 | } else { | |
834 | snprintf(bs->exact_filename, sizeof(bs->exact_filename), | |
835 | "nfs://%s%s", client->server->host, client->path); | |
836 | } | |
94d6a7a7 AA |
837 | } |
838 | ||
0dcbc54a HR |
839 | static char *nfs_dirname(BlockDriverState *bs, Error **errp) |
840 | { | |
841 | NFSClient *client = bs->opaque; | |
842 | ||
843 | if (client->uid || client->gid) { | |
844 | bdrv_refresh_filename(bs); | |
845 | error_setg(errp, "Cannot generate a base directory for NFS node '%s'", | |
846 | bs->filename); | |
847 | return NULL; | |
848 | } | |
849 | ||
850 | return g_strdup_printf("nfs://%s%s/", client->server->host, client->path); | |
851 | } | |
852 | ||
d99b26c4 | 853 | #ifdef LIBNFS_FEATURE_PAGECACHE |
2b148f39 PB |
854 | static void coroutine_fn nfs_co_invalidate_cache(BlockDriverState *bs, |
855 | Error **errp) | |
d99b26c4 PL |
856 | { |
857 | NFSClient *client = bs->opaque; | |
858 | nfs_pagecache_invalidate(client->context, client->fh); | |
859 | } | |
860 | #endif | |
861 | ||
2654267c HR |
862 | static const char *nfs_strong_runtime_opts[] = { |
863 | "path", | |
864 | "user", | |
865 | "group", | |
866 | "server.", | |
867 | ||
868 | NULL | |
869 | }; | |
870 | ||
6542aa9c | 871 | static BlockDriver bdrv_nfs = { |
471799d1 SH |
872 | .format_name = "nfs", |
873 | .protocol_name = "nfs", | |
874 | ||
875 | .instance_size = sizeof(NFSClient), | |
94d6a7a7 | 876 | .bdrv_parse_filename = nfs_parse_filename, |
fd752801 HR |
877 | .create_opts = &nfs_create_opts, |
878 | ||
471799d1 | 879 | .bdrv_has_zero_init = nfs_has_zero_init, |
c63b0201 YL |
880 | /* libnfs does not provide the allocated filesize of a file on win32. */ |
881 | #if !defined(_WIN32) | |
471799d1 | 882 | .bdrv_get_allocated_file_size = nfs_get_allocated_file_size, |
c63b0201 | 883 | #endif |
061ca8a3 | 884 | .bdrv_co_truncate = nfs_file_co_truncate, |
471799d1 SH |
885 | |
886 | .bdrv_file_open = nfs_file_open, | |
887 | .bdrv_close = nfs_file_close, | |
a1a42af4 | 888 | .bdrv_co_create = nfs_file_co_create, |
efc75e2a | 889 | .bdrv_co_create_opts = nfs_file_co_create_opts, |
18a8056e | 890 | .bdrv_reopen_prepare = nfs_reopen_prepare, |
471799d1 | 891 | |
69785a22 PL |
892 | .bdrv_co_preadv = nfs_co_preadv, |
893 | .bdrv_co_pwritev = nfs_co_pwritev, | |
471799d1 SH |
894 | .bdrv_co_flush_to_disk = nfs_co_flush, |
895 | ||
896 | .bdrv_detach_aio_context = nfs_detach_aio_context, | |
897 | .bdrv_attach_aio_context = nfs_attach_aio_context, | |
94d6a7a7 | 898 | .bdrv_refresh_filename = nfs_refresh_filename, |
0dcbc54a | 899 | .bdrv_dirname = nfs_dirname, |
d99b26c4 | 900 | |
2654267c HR |
901 | .strong_runtime_opts = nfs_strong_runtime_opts, |
902 | ||
d99b26c4 | 903 | #ifdef LIBNFS_FEATURE_PAGECACHE |
2b148f39 | 904 | .bdrv_co_invalidate_cache = nfs_co_invalidate_cache, |
d99b26c4 | 905 | #endif |
6542aa9c PL |
906 | }; |
907 | ||
908 | static void nfs_block_init(void) | |
909 | { | |
910 | bdrv_register(&bdrv_nfs); | |
911 | } | |
912 | ||
913 | block_init(nfs_block_init); |