1
The following changes since commit 248b23735645f7cbb503d9be6f5bf825f2a603ab:
1
The following changes since commit 8c1ecb590497b0349c550607db923972b37f6963:
2
2
3
Update version for v2.10.0-rc4 release (2017-08-24 17:34:26 +0100)
3
Merge remote-tracking branch 'remotes/stsquad/tags/pull-testing-next-280519-2' into staging (2019-05-28 17:38:32 +0100)
4
4
5
are available in the git repository at:
5
are available in the Git repository at:
6
6
7
git://github.com/stefanha/qemu.git tags/block-pull-request
7
https://github.com/XanClic/qemu.git tags/pull-block-2019-05-28
8
8
9
for you to fetch changes up to 3e4c705212abfe8c9882a00beb2d1466a8a53cec:
9
for you to fetch changes up to a2d665c1bc3624a8375e2f9a7d569f7565cc1358:
10
10
11
qcow2: allocate cluster_cache/cluster_data on demand (2017-08-30 18:02:10 +0100)
11
blockdev: loosen restrictions on drive-backup source node (2019-05-28 20:30:55 +0200)
12
12
13
----------------------------------------------------------------
13
----------------------------------------------------------------
14
Block patches:
15
- qcow2: Use threads for encrypted I/O
16
- qemu-img rebase: Optimizations
17
- backup job: Allow any source node, and some refactoring
18
- Some general simplifications in the block layer
14
19
15
----------------------------------------------------------------
20
----------------------------------------------------------------
21
Alberto Garcia (2):
22
block: Use bdrv_unref_child() for all children in bdrv_close()
23
block: Make bdrv_root_attach_child() unref child_bs on failure
16
24
17
Alberto Garcia (8):
25
Andrey Shinkevich (1):
18
throttle: Fix wrong variable name in the header documentation
26
qcow2-bitmap: initialize bitmap directory alignment
19
throttle: Update the throttle_fix_bucket() documentation
20
throttle: Make throttle_is_valid() a bit less verbose
21
throttle: Remove throttle_fix_bucket() / throttle_unfix_bucket()
22
throttle: Make LeakyBucket.avg and LeakyBucket.max integer types
23
throttle: Make burst_length 64bit and add range checks
24
throttle: Test the valid range of config values
25
misc: Remove unused Error variables
26
27
27
Dan Aloni (1):
28
Anton Nefedov (1):
28
nvme: Fix get/set number of queues feature, again
29
qcow2: skip writing zero buffers to empty COW areas
29
30
30
Eduardo Habkost (1):
31
John Snow (1):
31
oslib-posix: Print errors before aborting on qemu_alloc_stack()
32
blockdev: loosen restrictions on drive-backup source node
32
33
33
Fred Rolland (1):
34
Sam Eiderman (3):
34
qemu-doc: Add UUID support in initiator name
35
qemu-img: rebase: Reuse parent BlockDriverState
36
qemu-img: rebase: Reduce reads on in-chain rebase
37
qemu-img: rebase: Reuse in-chain BlockDriverState
35
38
36
Stefan Hajnoczi (4):
39
Vladimir Sementsov-Ogievskiy (13):
37
scripts: add argparse module for Python 2.6 compatibility
40
qcow2.h: add missing include
38
docker.py: Python 2.6 argparse compatibility
41
qcow2: add separate file for threaded data processing functions
39
tests: migration/guestperf Python 2.6 argparse compatibility
42
qcow2-threads: use thread_pool_submit_co
40
qcow2: allocate cluster_cache/cluster_data on demand
43
qcow2-threads: qcow2_co_do_compress: protect queuing by mutex
44
qcow2-threads: split out generic path
45
qcow2: qcow2_co_preadv: improve locking
46
qcow2: bdrv_co_pwritev: move encryption code out of the lock
47
qcow2: do encryption in threads
48
block/backup: simplify backup_incremental_init_copy_bitmap
49
block/backup: move to copy_bitmap with granularity
50
block/backup: refactor and tolerate unallocated cluster skipping
51
block/backup: unify different modes code path
52
block/backup: refactor: split out backup_calculate_cluster_size
41
53
42
include/qemu/throttle.h | 8 +-
54
block/Makefile.objs | 2 +-
43
block/qcow.c | 12 +-
55
qapi/block-core.json | 4 +-
44
block/qcow2-cluster.c | 17 +
56
block/qcow2.h | 26 ++-
45
block/qcow2.c | 20 +-
57
block.c | 46 +++---
46
dump.c | 4 +-
58
block/backup.c | 243 ++++++++++++---------------
47
hw/block/nvme.c | 4 +-
59
block/block-backend.c | 3 +-
48
tests/test-throttle.c | 80 +-
60
block/qcow2-bitmap.c | 3 +-
49
util/oslib-posix.c | 2 +
61
block/qcow2-cache.c | 1 -
50
util/throttle.c | 86 +-
62
block/qcow2-cluster.c | 10 +-
51
COPYING.PYTHON | 270 ++++
63
block/qcow2-refcount.c | 1 -
52
qemu-doc.texi | 5 +-
64
block/qcow2-snapshot.c | 1 -
53
scripts/argparse.py | 2406 ++++++++++++++++++++++++++++++++++++
65
block/qcow2-threads.c | 268 ++++++++++++++++++++++++++++++
54
tests/docker/docker.py | 4 +-
66
block/qcow2.c | 320 +++++++++++++-----------------------
55
tests/migration/guestperf/shell.py | 8 +-
67
block/quorum.c | 1 -
56
14 files changed, 2831 insertions(+), 95 deletions(-)
68
blockdev.c | 7 +-
57
create mode 100644 COPYING.PYTHON
69
blockjob.c | 2 +-
58
create mode 100644 scripts/argparse.py
70
qemu-img.c | 85 ++++++----
71
tests/test-bdrv-drain.c | 6 -
72
tests/test-bdrv-graph-mod.c | 1 -
73
block/trace-events | 1 +
74
tests/qemu-iotests/056 | 2 +-
75
tests/qemu-iotests/060 | 7 +-
76
tests/qemu-iotests/060.out | 5 +-
77
23 files changed, 615 insertions(+), 430 deletions(-)
78
create mode 100644 block/qcow2-threads.c
59
79
60
--
80
--
61
2.13.5
81
2.21.0
62
82
63
83
diff view generated by jsdifflib
1
Most qcow2 files are uncompressed so it is wasteful to allocate (32 + 1)
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
* cluster_size + 512 bytes upfront. Allocate s->cluster_cache and
3
s->cluster_data when the first read operation is performance on a
4
compressed cluster.
5
2
6
The buffers are freed in .bdrv_close(). .bdrv_open() no longer has any
3
qcow2.h depends on block_int.h. Compilation isn't broken currently only
7
code paths that can allocate these buffers, so remove the free functions
4
due to block_int.h always included before qcow2.h. Though, it seems
8
in the error code path.
5
better to directly include block_int.h in qcow2.h.
9
6
10
This patch can result in significant memory savings when many qcow2
7
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
11
disks are attached or backing file chains are long:
8
Reviewed-by: Alberto Garcia <berto@igalia.com>
9
Reviewed-by: Max Reitz <mreitz@redhat.com>
10
Message-id: 20190506142741.41731-2-vsementsov@virtuozzo.com
11
Signed-off-by: Max Reitz <mreitz@redhat.com>
12
---
13
block/qcow2.h | 1 +
14
block/qcow2-bitmap.c | 1 -
15
block/qcow2-cache.c | 1 -
16
block/qcow2-cluster.c | 1 -
17
block/qcow2-refcount.c | 1 -
18
block/qcow2-snapshot.c | 1 -
19
block/qcow2.c | 1 -
20
7 files changed, 1 insertion(+), 6 deletions(-)
12
21
13
Before 12.81% (1,023,193,088B)
22
diff --git a/block/qcow2.h b/block/qcow2.h
14
After 5.36% (393,893,888B)
23
index XXXXXXX..XXXXXXX 100644
15
24
--- a/block/qcow2.h
16
Reported-by: Alexey Kardashevskiy <aik@ozlabs.ru>
25
+++ b/block/qcow2.h
17
Tested-by: Alexey Kardashevskiy <aik@ozlabs.ru>
26
@@ -XXX,XX +XXX,XX @@
18
Reviewed-by: Eric Blake <eblake@redhat.com>
27
#include "crypto/block.h"
19
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
28
#include "qemu/coroutine.h"
20
Message-id: 20170821135530.32344-1-stefanha@redhat.com
29
#include "qemu/units.h"
21
Cc: Kevin Wolf <kwolf@redhat.com>
30
+#include "block/block_int.h"
22
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
31
23
---
32
//#define DEBUG_ALLOC
24
block/qcow2-cluster.c | 17 +++++++++++++++++
33
//#define DEBUG_ALLOC2
25
block/qcow2.c | 12 ------------
34
diff --git a/block/qcow2-bitmap.c b/block/qcow2-bitmap.c
26
2 files changed, 17 insertions(+), 12 deletions(-)
35
index XXXXXXX..XXXXXXX 100644
27
36
--- a/block/qcow2-bitmap.c
37
+++ b/block/qcow2-bitmap.c
38
@@ -XXX,XX +XXX,XX @@
39
#include "qapi/error.h"
40
#include "qemu/cutils.h"
41
42
-#include "block/block_int.h"
43
#include "qcow2.h"
44
45
/* NOTICE: BME here means Bitmaps Extension and used as a namespace for
46
diff --git a/block/qcow2-cache.c b/block/qcow2-cache.c
47
index XXXXXXX..XXXXXXX 100644
48
--- a/block/qcow2-cache.c
49
+++ b/block/qcow2-cache.c
50
@@ -XXX,XX +XXX,XX @@
51
*/
52
53
#include "qemu/osdep.h"
54
-#include "block/block_int.h"
55
#include "qemu-common.h"
56
#include "qcow2.h"
57
#include "trace.h"
28
diff --git a/block/qcow2-cluster.c b/block/qcow2-cluster.c
58
diff --git a/block/qcow2-cluster.c b/block/qcow2-cluster.c
29
index XXXXXXX..XXXXXXX 100644
59
index XXXXXXX..XXXXXXX 100644
30
--- a/block/qcow2-cluster.c
60
--- a/block/qcow2-cluster.c
31
+++ b/block/qcow2-cluster.c
61
+++ b/block/qcow2-cluster.c
32
@@ -XXX,XX +XXX,XX @@ int qcow2_decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset)
62
@@ -XXX,XX +XXX,XX @@
33
nb_csectors = ((cluster_offset >> s->csize_shift) & s->csize_mask) + 1;
63
34
sector_offset = coffset & 511;
64
#include "qapi/error.h"
35
csize = nb_csectors * 512 - sector_offset;
65
#include "qemu-common.h"
36
+
66
-#include "block/block_int.h"
37
+ /* Allocate buffers on first decompress operation, most images are
67
#include "qcow2.h"
38
+ * uncompressed and the memory overhead can be avoided. The buffers
68
#include "qemu/bswap.h"
39
+ * are freed in .bdrv_close().
69
#include "trace.h"
40
+ */
70
diff --git a/block/qcow2-refcount.c b/block/qcow2-refcount.c
41
+ if (!s->cluster_data) {
71
index XXXXXXX..XXXXXXX 100644
42
+ /* one more sector for decompressed data alignment */
72
--- a/block/qcow2-refcount.c
43
+ s->cluster_data = qemu_try_blockalign(bs->file->bs,
73
+++ b/block/qcow2-refcount.c
44
+ QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size + 512);
74
@@ -XXX,XX +XXX,XX @@
45
+ if (!s->cluster_data) {
75
#include "qemu/osdep.h"
46
+ return -ENOMEM;
76
#include "qapi/error.h"
47
+ }
77
#include "qemu-common.h"
48
+ }
78
-#include "block/block_int.h"
49
+ if (!s->cluster_cache) {
79
#include "qcow2.h"
50
+ s->cluster_cache = g_malloc(s->cluster_size);
80
#include "qemu/range.h"
51
+ }
81
#include "qemu/bswap.h"
52
+
82
diff --git a/block/qcow2-snapshot.c b/block/qcow2-snapshot.c
53
BLKDBG_EVENT(bs->file, BLKDBG_READ_COMPRESSED);
83
index XXXXXXX..XXXXXXX 100644
54
ret = bdrv_read(bs->file, coffset >> 9, s->cluster_data,
84
--- a/block/qcow2-snapshot.c
55
nb_csectors);
85
+++ b/block/qcow2-snapshot.c
86
@@ -XXX,XX +XXX,XX @@
87
88
#include "qemu/osdep.h"
89
#include "qapi/error.h"
90
-#include "block/block_int.h"
91
#include "qcow2.h"
92
#include "qemu/bswap.h"
93
#include "qemu/error-report.h"
56
diff --git a/block/qcow2.c b/block/qcow2.c
94
diff --git a/block/qcow2.c b/block/qcow2.c
57
index XXXXXXX..XXXXXXX 100644
95
index XXXXXXX..XXXXXXX 100644
58
--- a/block/qcow2.c
96
--- a/block/qcow2.c
59
+++ b/block/qcow2.c
97
+++ b/block/qcow2.c
60
@@ -XXX,XX +XXX,XX @@ static int qcow2_do_open(BlockDriverState *bs, QDict *options, int flags,
98
@@ -XXX,XX +XXX,XX @@
61
goto fail;
99
#define ZLIB_CONST
62
}
100
#include <zlib.h>
63
101
64
- s->cluster_cache = g_malloc(s->cluster_size);
102
-#include "block/block_int.h"
65
- /* one more sector for decompressed data alignment */
103
#include "block/qdict.h"
66
- s->cluster_data = qemu_try_blockalign(bs->file->bs, QCOW_MAX_CRYPT_CLUSTERS
104
#include "sysemu/block-backend.h"
67
- * s->cluster_size + 512);
105
#include "qemu/module.h"
68
- if (s->cluster_data == NULL) {
69
- error_setg(errp, "Could not allocate temporary cluster buffer");
70
- ret = -ENOMEM;
71
- goto fail;
72
- }
73
-
74
s->cluster_cache_offset = -1;
75
s->flags = flags;
76
77
@@ -XXX,XX +XXX,XX @@ static int qcow2_do_open(BlockDriverState *bs, QDict *options, int flags,
78
if (s->refcount_block_cache) {
79
qcow2_cache_destroy(bs, s->refcount_block_cache);
80
}
81
- g_free(s->cluster_cache);
82
- qemu_vfree(s->cluster_data);
83
qcrypto_block_free(s->crypto);
84
qapi_free_QCryptoBlockOpenOptions(s->crypto_opts);
85
return ret;
86
--
106
--
87
2.13.5
107
2.21.0
88
108
89
109
diff view generated by jsdifflib
1
The minimum Python version supported by QEMU is 2.6. The argparse
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
standard library module was only added in Python 2.7. Many scripts
3
would like to use argparse because it supports command-line
4
sub-commands.
5
2
6
This patch adds argparse. See the top of argparse.py for details.
3
Move compression-on-threads to separate file. Encryption will be in it
4
too.
7
5
8
Suggested-by: Daniel P. Berrange <berrange@redhat.com>
6
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
7
Reviewed-by: Alberto Garcia <berto@igalia.com>
10
Acked-by: John Snow <jsnow@redhat.com>
8
Reviewed-by: Max Reitz <mreitz@redhat.com>
11
Message-id: 20170825155732.15665-2-stefanha@redhat.com
9
Message-id: 20190506142741.41731-3-vsementsov@virtuozzo.com
12
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
Signed-off-by: Max Reitz <mreitz@redhat.com>
13
---
11
---
14
COPYING.PYTHON | 270 ++++++
12
block/Makefile.objs | 2 +-
15
scripts/argparse.py | 2406 +++++++++++++++++++++++++++++++++++++++++++++++++++
13
block/qcow2.h | 7 ++
16
2 files changed, 2676 insertions(+)
14
block/qcow2-threads.c | 201 ++++++++++++++++++++++++++++++++++++++++++
17
create mode 100644 COPYING.PYTHON
15
block/qcow2.c | 169 -----------------------------------
18
create mode 100644 scripts/argparse.py
16
4 files changed, 209 insertions(+), 170 deletions(-)
17
create mode 100644 block/qcow2-threads.c
19
18
20
diff --git a/COPYING.PYTHON b/COPYING.PYTHON
19
diff --git a/block/Makefile.objs b/block/Makefile.objs
20
index XXXXXXX..XXXXXXX 100644
21
--- a/block/Makefile.objs
22
+++ b/block/Makefile.objs
23
@@ -XXX,XX +XXX,XX @@ block-obj-$(CONFIG_BOCHS) += bochs.o
24
block-obj-$(CONFIG_VVFAT) += vvfat.o
25
block-obj-$(CONFIG_DMG) += dmg.o
26
27
-block-obj-y += qcow2.o qcow2-refcount.o qcow2-cluster.o qcow2-snapshot.o qcow2-cache.o qcow2-bitmap.o
28
+block-obj-y += qcow2.o qcow2-refcount.o qcow2-cluster.o qcow2-snapshot.o qcow2-cache.o qcow2-bitmap.o qcow2-threads.o
29
block-obj-$(CONFIG_QED) += qed.o qed-l2-cache.o qed-table.o qed-cluster.o
30
block-obj-$(CONFIG_QED) += qed-check.o
31
block-obj-y += vhdx.o vhdx-endian.o vhdx-log.o
32
diff --git a/block/qcow2.h b/block/qcow2.h
33
index XXXXXXX..XXXXXXX 100644
34
--- a/block/qcow2.h
35
+++ b/block/qcow2.h
36
@@ -XXX,XX +XXX,XX @@ void qcow2_remove_persistent_dirty_bitmap(BlockDriverState *bs,
37
const char *name,
38
Error **errp);
39
40
+ssize_t coroutine_fn
41
+qcow2_co_compress(BlockDriverState *bs, void *dest, size_t dest_size,
42
+ const void *src, size_t src_size);
43
+ssize_t coroutine_fn
44
+qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size,
45
+ const void *src, size_t src_size);
46
+
47
#endif
48
diff --git a/block/qcow2-threads.c b/block/qcow2-threads.c
21
new file mode 100644
49
new file mode 100644
22
index XXXXXXX..XXXXXXX
50
index XXXXXXX..XXXXXXX
23
--- /dev/null
51
--- /dev/null
24
+++ b/COPYING.PYTHON
52
+++ b/block/qcow2-threads.c
25
@@ -XXX,XX +XXX,XX @@
53
@@ -XXX,XX +XXX,XX @@
26
+A. HISTORY OF THE SOFTWARE
54
+/*
27
+==========================
55
+ * Threaded data processing for Qcow2: compression, encryption
28
+
56
+ *
29
+Python was created in the early 1990s by Guido van Rossum at Stichting
57
+ * Copyright (c) 2004-2006 Fabrice Bellard
30
+Mathematisch Centrum (CWI, see http://www.cwi.nl) in the Netherlands
58
+ * Copyright (c) 2018 Virtuozzo International GmbH. All rights reserved.
31
+as a successor of a language called ABC. Guido remains Python's
59
+ *
32
+principal author, although it includes many contributions from others.
60
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
33
+
61
+ * of this software and associated documentation files (the "Software"), to deal
34
+In 1995, Guido continued his work on Python at the Corporation for
62
+ * in the Software without restriction, including without limitation the rights
35
+National Research Initiatives (CNRI, see http://www.cnri.reston.va.us)
63
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
36
+in Reston, Virginia where he released several versions of the
64
+ * copies of the Software, and to permit persons to whom the Software is
37
+software.
65
+ * furnished to do so, subject to the following conditions:
38
+
66
+ *
39
+In May 2000, Guido and the Python core development team moved to
67
+ * The above copyright notice and this permission notice shall be included in
40
+BeOpen.com to form the BeOpen PythonLabs team. In October of the same
68
+ * all copies or substantial portions of the Software.
41
+year, the PythonLabs team moved to Digital Creations (now Zope
69
+ *
42
+Corporation, see http://www.zope.com). In 2001, the Python Software
70
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43
+Foundation (PSF, see http://www.python.org/psf/) was formed, a
71
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
44
+non-profit organization created specifically to own Python-related
72
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
45
+Intellectual Property. Zope Corporation is a sponsoring member of
73
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
46
+the PSF.
74
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
47
+
75
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
48
+All Python releases are Open Source (see http://www.opensource.org for
76
+ * THE SOFTWARE.
49
+the Open Source Definition). Historically, most, but not all, Python
77
+ */
50
+releases have also been GPL-compatible; the table below summarizes
78
+
51
+the various releases.
79
+#include "qemu/osdep.h"
52
+
80
+
53
+ Release Derived Year Owner GPL-
81
+#define ZLIB_CONST
54
+ from compatible? (1)
82
+#include <zlib.h>
55
+
83
+
56
+ 0.9.0 thru 1.2 1991-1995 CWI yes
84
+#include "qcow2.h"
57
+ 1.3 thru 1.5.2 1.2 1995-1999 CNRI yes
85
+#include "block/thread-pool.h"
58
+ 1.6 1.5.2 2000 CNRI no
86
+
59
+ 2.0 1.6 2000 BeOpen.com no
87
+#define MAX_COMPRESS_THREADS 4
60
+ 1.6.1 1.6 2001 CNRI yes (2)
88
+
61
+ 2.1 2.0+1.6.1 2001 PSF no
89
+typedef ssize_t (*Qcow2CompressFunc)(void *dest, size_t dest_size,
62
+ 2.0.1 2.0+1.6.1 2001 PSF yes
90
+ const void *src, size_t src_size);
63
+ 2.1.1 2.1+2.0.1 2001 PSF yes
91
+typedef struct Qcow2CompressData {
64
+ 2.2 2.1.1 2001 PSF yes
92
+ void *dest;
65
+ 2.1.2 2.1.1 2002 PSF yes
93
+ size_t dest_size;
66
+ 2.1.3 2.1.2 2002 PSF yes
94
+ const void *src;
67
+ 2.2.1 2.2 2002 PSF yes
95
+ size_t src_size;
68
+ 2.2.2 2.2.1 2002 PSF yes
96
+ ssize_t ret;
69
+ 2.2.3 2.2.2 2003 PSF yes
97
+
70
+ 2.3 2.2.2 2002-2003 PSF yes
98
+ Qcow2CompressFunc func;
71
+ 2.3.1 2.3 2002-2003 PSF yes
99
+} Qcow2CompressData;
72
+ 2.3.2 2.3.1 2002-2003 PSF yes
100
+
73
+ 2.3.3 2.3.2 2002-2003 PSF yes
101
+/*
74
+ 2.3.4 2.3.3 2004 PSF yes
102
+ * qcow2_compress()
75
+ 2.3.5 2.3.4 2005 PSF yes
103
+ *
76
+ 2.4 2.3 2004 PSF yes
104
+ * @dest - destination buffer, @dest_size bytes
77
+ 2.4.1 2.4 2005 PSF yes
105
+ * @src - source buffer, @src_size bytes
78
+ 2.4.2 2.4.1 2005 PSF yes
106
+ *
79
+ 2.4.3 2.4.2 2006 PSF yes
107
+ * Returns: compressed size on success
80
+ 2.5 2.4 2006 PSF yes
108
+ * -ENOMEM destination buffer is not enough to store compressed data
81
+ 2.7 2.6 2010 PSF yes
109
+ * -EIO on any other error
82
+
110
+ */
83
+Footnotes:
111
+static ssize_t qcow2_compress(void *dest, size_t dest_size,
84
+
112
+ const void *src, size_t src_size)
85
+(1) GPL-compatible doesn't mean that we're distributing Python under
113
+{
86
+ the GPL. All Python licenses, unlike the GPL, let you distribute
114
+ ssize_t ret;
87
+ a modified version without making your changes open source. The
115
+ z_stream strm;
88
+ GPL-compatible licenses make it possible to combine Python with
116
+
89
+ other software that is released under the GPL; the others don't.
117
+ /* best compression, small window, no zlib header */
90
+
118
+ memset(&strm, 0, sizeof(strm));
91
+(2) According to Richard Stallman, 1.6.1 is not GPL-compatible,
119
+ ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED,
92
+ because its license has a choice of law clause. According to
120
+ -12, 9, Z_DEFAULT_STRATEGY);
93
+ CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1
121
+ if (ret != Z_OK) {
94
+ is "not incompatible" with the GPL.
122
+ return -EIO;
95
+
123
+ }
96
+Thanks to the many outside volunteers who have worked under Guido's
124
+
97
+direction to make these releases possible.
125
+ /*
98
+
126
+ * strm.next_in is not const in old zlib versions, such as those used on
99
+
127
+ * OpenBSD/NetBSD, so cast the const away
100
+B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON
128
+ */
101
+===============================================================
129
+ strm.avail_in = src_size;
102
+
130
+ strm.next_in = (void *) src;
103
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
131
+ strm.avail_out = dest_size;
104
+--------------------------------------------
132
+ strm.next_out = dest;
105
+
133
+
106
+1. This LICENSE AGREEMENT is between the Python Software Foundation
134
+ ret = deflate(&strm, Z_FINISH);
107
+("PSF"), and the Individual or Organization ("Licensee") accessing and
135
+ if (ret == Z_STREAM_END) {
108
+otherwise using this software ("Python") in source or binary form and
136
+ ret = dest_size - strm.avail_out;
109
+its associated documentation.
137
+ } else {
110
+
138
+ ret = (ret == Z_OK ? -ENOMEM : -EIO);
111
+2. Subject to the terms and conditions of this License Agreement, PSF
139
+ }
112
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
140
+
113
+license to reproduce, analyze, test, perform and/or display publicly,
141
+ deflateEnd(&strm);
114
+prepare derivative works, distribute, and otherwise use Python
142
+
115
+alone or in any derivative version, provided, however, that PSF's
143
+ return ret;
116
+License Agreement and PSF's notice of copyright, i.e., "Copyright (c)
144
+}
117
+2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights
145
+
118
+Reserved" are retained in Python alone or in any derivative version
146
+/*
119
+prepared by Licensee.
147
+ * qcow2_decompress()
120
+
148
+ *
121
+3. In the event Licensee prepares a derivative work that is based on
149
+ * Decompress some data (not more than @src_size bytes) to produce exactly
122
+or incorporates Python or any part thereof, and wants to make
150
+ * @dest_size bytes.
123
+the derivative work available to others as provided herein, then
151
+ *
124
+Licensee hereby agrees to include in any such work a brief summary of
152
+ * @dest - destination buffer, @dest_size bytes
125
+the changes made to Python.
153
+ * @src - source buffer, @src_size bytes
126
+
154
+ *
127
+4. PSF is making Python available to Licensee on an "AS IS"
155
+ * Returns: 0 on success
128
+basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
156
+ * -1 on fail
129
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
157
+ */
130
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
158
+static ssize_t qcow2_decompress(void *dest, size_t dest_size,
131
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
159
+ const void *src, size_t src_size)
132
+INFRINGE ANY THIRD PARTY RIGHTS.
160
+{
133
+
161
+ int ret = 0;
134
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
162
+ z_stream strm;
135
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
163
+
136
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
164
+ memset(&strm, 0, sizeof(strm));
137
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
165
+ strm.avail_in = src_size;
138
+
166
+ strm.next_in = (void *) src;
139
+6. This License Agreement will automatically terminate upon a material
167
+ strm.avail_out = dest_size;
140
+breach of its terms and conditions.
168
+ strm.next_out = dest;
141
+
169
+
142
+7. Nothing in this License Agreement shall be deemed to create any
170
+ ret = inflateInit2(&strm, -12);
143
+relationship of agency, partnership, or joint venture between PSF and
171
+ if (ret != Z_OK) {
144
+Licensee. This License Agreement does not grant permission to use PSF
172
+ return -1;
145
+trademarks or trade name in a trademark sense to endorse or promote
173
+ }
146
+products or services of Licensee, or any third party.
174
+
147
+
175
+ ret = inflate(&strm, Z_FINISH);
148
+8. By copying, installing or otherwise using Python, Licensee
176
+ if ((ret != Z_STREAM_END && ret != Z_BUF_ERROR) || strm.avail_out != 0) {
149
+agrees to be bound by the terms and conditions of this License
177
+ /*
150
+Agreement.
178
+ * We approve Z_BUF_ERROR because we need @dest buffer to be filled, but
151
+
179
+ * @src buffer may be processed partly (because in qcow2 we know size of
152
+
180
+ * compressed data with precision of one sector)
153
+BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
181
+ */
154
+-------------------------------------------
182
+ ret = -1;
155
+
183
+ }
156
+BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
184
+
157
+
185
+ inflateEnd(&strm);
158
+1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
186
+
159
+office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
187
+ return ret;
160
+Individual or Organization ("Licensee") accessing and otherwise using
188
+}
161
+this software in source or binary form and its associated
189
+
162
+documentation ("the Software").
190
+static int qcow2_compress_pool_func(void *opaque)
163
+
191
+{
164
+2. Subject to the terms and conditions of this BeOpen Python License
192
+ Qcow2CompressData *data = opaque;
165
+Agreement, BeOpen hereby grants Licensee a non-exclusive,
193
+
166
+royalty-free, world-wide license to reproduce, analyze, test, perform
194
+ data->ret = data->func(data->dest, data->dest_size,
167
+and/or display publicly, prepare derivative works, distribute, and
195
+ data->src, data->src_size);
168
+otherwise use the Software alone or in any derivative version,
196
+
169
+provided, however, that the BeOpen Python License is retained in the
197
+ return 0;
170
+Software, alone or in any derivative version prepared by Licensee.
198
+}
171
+
199
+
172
+3. BeOpen is making the Software available to Licensee on an "AS IS"
200
+static void qcow2_compress_complete(void *opaque, int ret)
173
+basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
201
+{
174
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
202
+ qemu_coroutine_enter(opaque);
175
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
203
+}
176
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
204
+
177
+INFRINGE ANY THIRD PARTY RIGHTS.
205
+static ssize_t coroutine_fn
178
+
206
+qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
179
+4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
207
+ const void *src, size_t src_size, Qcow2CompressFunc func)
180
+SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
208
+{
181
+AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
209
+ BDRVQcow2State *s = bs->opaque;
182
+DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
210
+ BlockAIOCB *acb;
183
+
211
+ ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
184
+5. This License Agreement will automatically terminate upon a material
212
+ Qcow2CompressData arg = {
185
+breach of its terms and conditions.
213
+ .dest = dest,
186
+
214
+ .dest_size = dest_size,
187
+6. This License Agreement shall be governed by and interpreted in all
215
+ .src = src,
188
+respects by the law of the State of California, excluding conflict of
216
+ .src_size = src_size,
189
+law provisions. Nothing in this License Agreement shall be deemed to
217
+ .func = func,
190
+create any relationship of agency, partnership, or joint venture
218
+ };
191
+between BeOpen and Licensee. This License Agreement does not grant
219
+
192
+permission to use BeOpen trademarks or trade names in a trademark
220
+ while (s->nb_compress_threads >= MAX_COMPRESS_THREADS) {
193
+sense to endorse or promote products or services of Licensee, or any
221
+ qemu_co_queue_wait(&s->compress_wait_queue, NULL);
194
+third party. As an exception, the "BeOpen Python" logos available at
222
+ }
195
+http://www.pythonlabs.com/logos.html may be used according to the
223
+
196
+permissions granted on that web page.
224
+ s->nb_compress_threads++;
197
+
225
+ acb = thread_pool_submit_aio(pool, qcow2_compress_pool_func, &arg,
198
+7. By copying, installing or otherwise using the software, Licensee
226
+ qcow2_compress_complete,
199
+agrees to be bound by the terms and conditions of this License
227
+ qemu_coroutine_self());
200
+Agreement.
228
+
201
+
229
+ if (!acb) {
202
+
230
+ s->nb_compress_threads--;
203
+CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
231
+ return -EINVAL;
204
+---------------------------------------
232
+ }
205
+
233
+ qemu_coroutine_yield();
206
+1. This LICENSE AGREEMENT is between the Corporation for National
234
+ s->nb_compress_threads--;
207
+Research Initiatives, having an office at 1895 Preston White Drive,
235
+ qemu_co_queue_next(&s->compress_wait_queue);
208
+Reston, VA 20191 ("CNRI"), and the Individual or Organization
236
+
209
+("Licensee") accessing and otherwise using Python 1.6.1 software in
237
+ return arg.ret;
210
+source or binary form and its associated documentation.
238
+}
211
+
239
+
212
+2. Subject to the terms and conditions of this License Agreement, CNRI
240
+ssize_t coroutine_fn
213
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
241
+qcow2_co_compress(BlockDriverState *bs, void *dest, size_t dest_size,
214
+license to reproduce, analyze, test, perform and/or display publicly,
242
+ const void *src, size_t src_size)
215
+prepare derivative works, distribute, and otherwise use Python 1.6.1
243
+{
216
+alone or in any derivative version, provided, however, that CNRI's
244
+ return qcow2_co_do_compress(bs, dest, dest_size, src, src_size,
217
+License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
245
+ qcow2_compress);
218
+1995-2001 Corporation for National Research Initiatives; All Rights
246
+}
219
+Reserved" are retained in Python 1.6.1 alone or in any derivative
247
+
220
+version prepared by Licensee. Alternately, in lieu of CNRI's License
248
+ssize_t coroutine_fn
221
+Agreement, Licensee may substitute the following text (omitting the
249
+qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size,
222
+quotes): "Python 1.6.1 is made available subject to the terms and
250
+ const void *src, size_t src_size)
223
+conditions in CNRI's License Agreement. This Agreement together with
251
+{
224
+Python 1.6.1 may be located on the Internet using the following
252
+ return qcow2_co_do_compress(bs, dest, dest_size, src, src_size,
225
+unique, persistent identifier (known as a handle): 1895.22/1013. This
253
+ qcow2_decompress);
226
+Agreement may also be obtained from a proxy server on the Internet
254
+}
227
+using the following URL: http://hdl.handle.net/1895.22/1013".
255
diff --git a/block/qcow2.c b/block/qcow2.c
228
+
256
index XXXXXXX..XXXXXXX 100644
229
+3. In the event Licensee prepares a derivative work that is based on
257
--- a/block/qcow2.c
230
+or incorporates Python 1.6.1 or any part thereof, and wants to make
258
+++ b/block/qcow2.c
231
+the derivative work available to others as provided herein, then
232
+Licensee hereby agrees to include in any such work a brief summary of
233
+the changes made to Python 1.6.1.
234
+
235
+4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
236
+basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
237
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
238
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
239
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
240
+INFRINGE ANY THIRD PARTY RIGHTS.
241
+
242
+5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
243
+1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
244
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
245
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
246
+
247
+6. This License Agreement will automatically terminate upon a material
248
+breach of its terms and conditions.
249
+
250
+7. This License Agreement shall be governed by the federal
251
+intellectual property law of the United States, including without
252
+limitation the federal copyright law, and, to the extent such
253
+U.S. federal law does not apply, by the law of the Commonwealth of
254
+Virginia, excluding Virginia's conflict of law provisions.
255
+Notwithstanding the foregoing, with regard to derivative works based
256
+on Python 1.6.1 that incorporate non-separable material that was
257
+previously distributed under the GNU General Public License (GPL), the
258
+law of the Commonwealth of Virginia shall govern this License
259
+Agreement only as to issues arising under or with respect to
260
+Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this
261
+License Agreement shall be deemed to create any relationship of
262
+agency, partnership, or joint venture between CNRI and Licensee. This
263
+License Agreement does not grant permission to use CNRI trademarks or
264
+trade name in a trademark sense to endorse or promote products or
265
+services of Licensee, or any third party.
266
+
267
+8. By clicking on the "ACCEPT" button where indicated, or by copying,
268
+installing or otherwise using Python 1.6.1, Licensee agrees to be
269
+bound by the terms and conditions of this License Agreement.
270
+
271
+ ACCEPT
272
+
273
+
274
+CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
275
+--------------------------------------------------
276
+
277
+Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
278
+The Netherlands. All rights reserved.
279
+
280
+Permission to use, copy, modify, and distribute this software and its
281
+documentation for any purpose and without fee is hereby granted,
282
+provided that the above copyright notice appear in all copies and that
283
+both that copyright notice and this permission notice appear in
284
+supporting documentation, and that the name of Stichting Mathematisch
285
+Centrum or CWI not be used in advertising or publicity pertaining to
286
+distribution of the software without specific, written prior
287
+permission.
288
+
289
+STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
290
+THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
291
+FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
292
+FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
293
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
294
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
295
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
296
diff --git a/scripts/argparse.py b/scripts/argparse.py
297
new file mode 100644
298
index XXXXXXX..XXXXXXX
299
--- /dev/null
300
+++ b/scripts/argparse.py
301
@@ -XXX,XX +XXX,XX @@
259
@@ -XXX,XX +XXX,XX @@
302
+# This is a local copy of the standard library argparse module taken from PyPI.
260
303
+# It is licensed under the Python Software Foundation License. This is a
261
#include "qemu/osdep.h"
304
+# fallback for Python 2.6 which does not include this module. Python 2.7+ and
262
305
+# 3+ will never load this module because built-in modules are loaded before
263
-#define ZLIB_CONST
306
+# anything in sys.path.
264
-#include <zlib.h>
307
+#
265
-
308
+# If your script is not located in the same directory as this file, import it
266
#include "block/qdict.h"
309
+# like this:
267
#include "sysemu/block-backend.h"
310
+#
268
#include "qemu/module.h"
311
+# import os
269
@@ -XXX,XX +XXX,XX @@
312
+# import sys
270
#include "qapi/qobject-input-visitor.h"
313
+# sys.path.append(os.path.join(os.path.dirname(__file__), ..., 'scripts'))
271
#include "qapi/qapi-visit-block-core.h"
314
+# import argparse
272
#include "crypto.h"
315
+
273
-#include "block/thread-pool.h"
316
+# Author: Steven J. Bethard <steven.bethard@gmail.com>.
274
317
+# Maintainer: Thomas Waldmann <tw@waldmann-edv.de>
275
/*
318
+
276
Differences with QCOW:
319
+"""Command-line parsing library
277
@@ -XXX,XX +XXX,XX @@ fail:
320
+
278
return ret;
321
+This module is an optparse-inspired command-line parsing library that:
279
}
322
+
280
323
+ - handles both optional and positional arguments
281
-/*
324
+ - produces highly informative usage messages
282
- * qcow2_compress()
325
+ - supports parsers that dispatch to sub-parsers
283
- *
326
+
284
- * @dest - destination buffer, @dest_size bytes
327
+The following is a simple usage example that sums integers from the
285
- * @src - source buffer, @src_size bytes
328
+command-line and writes the result to a file::
286
- *
329
+
287
- * Returns: compressed size on success
330
+ parser = argparse.ArgumentParser(
288
- * -ENOMEM destination buffer is not enough to store compressed data
331
+ description='sum the integers at the command line')
289
- * -EIO on any other error
332
+ parser.add_argument(
290
- */
333
+ 'integers', metavar='int', nargs='+', type=int,
291
-static ssize_t qcow2_compress(void *dest, size_t dest_size,
334
+ help='an integer to be summed')
292
- const void *src, size_t src_size)
335
+ parser.add_argument(
293
-{
336
+ '--log', default=sys.stdout, type=argparse.FileType('w'),
294
- ssize_t ret;
337
+ help='the file where the sum should be written')
295
- z_stream strm;
338
+ args = parser.parse_args()
296
-
339
+ args.log.write('%s' % sum(args.integers))
297
- /* best compression, small window, no zlib header */
340
+ args.log.close()
298
- memset(&strm, 0, sizeof(strm));
341
+
299
- ret = deflateInit2(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED,
342
+The module contains the following public classes:
300
- -12, 9, Z_DEFAULT_STRATEGY);
343
+
301
- if (ret != Z_OK) {
344
+ - ArgumentParser -- The main entry point for command-line parsing. As the
302
- return -EIO;
345
+ example above shows, the add_argument() method is used to populate
303
- }
346
+ the parser with actions for optional and positional arguments. Then
304
-
347
+ the parse_args() method is invoked to convert the args at the
305
- /* strm.next_in is not const in old zlib versions, such as those used on
348
+ command-line into an object with attributes.
306
- * OpenBSD/NetBSD, so cast the const away */
349
+
307
- strm.avail_in = src_size;
350
+ - ArgumentError -- The exception raised by ArgumentParser objects when
308
- strm.next_in = (void *) src;
351
+ there are errors with the parser's actions. Errors raised while
309
- strm.avail_out = dest_size;
352
+ parsing the command-line are caught by ArgumentParser and emitted
310
- strm.next_out = dest;
353
+ as command-line messages.
311
-
354
+
312
- ret = deflate(&strm, Z_FINISH);
355
+ - FileType -- A factory for defining types of files to be created. As the
313
- if (ret == Z_STREAM_END) {
356
+ example above shows, instances of FileType are typically passed as
314
- ret = dest_size - strm.avail_out;
357
+ the type= argument of add_argument() calls.
315
- } else {
358
+
316
- ret = (ret == Z_OK ? -ENOMEM : -EIO);
359
+ - Action -- The base class for parser actions. Typically actions are
317
- }
360
+ selected by passing strings like 'store_true' or 'append_const' to
318
-
361
+ the action= argument of add_argument(). However, for greater
319
- deflateEnd(&strm);
362
+ customization of ArgumentParser actions, subclasses of Action may
320
-
363
+ be defined and passed as the action= argument.
321
- return ret;
364
+
322
-}
365
+ - HelpFormatter, RawDescriptionHelpFormatter, RawTextHelpFormatter,
323
-
366
+ ArgumentDefaultsHelpFormatter -- Formatter classes which
324
-/*
367
+ may be passed as the formatter_class= argument to the
325
- * qcow2_decompress()
368
+ ArgumentParser constructor. HelpFormatter is the default,
326
- *
369
+ RawDescriptionHelpFormatter and RawTextHelpFormatter tell the parser
327
- * Decompress some data (not more than @src_size bytes) to produce exactly
370
+ not to change the formatting for help text, and
328
- * @dest_size bytes.
371
+ ArgumentDefaultsHelpFormatter adds information about argument defaults
329
- *
372
+ to the help.
330
- * @dest - destination buffer, @dest_size bytes
373
+
331
- * @src - source buffer, @src_size bytes
374
+All other classes in this module are considered implementation details.
332
- *
375
+(Also note that HelpFormatter and RawDescriptionHelpFormatter are only
333
- * Returns: 0 on success
376
+considered public as object names -- the API of the formatter objects is
334
- * -1 on fail
377
+still considered an implementation detail.)
335
- */
378
+"""
336
-static ssize_t qcow2_decompress(void *dest, size_t dest_size,
379
+
337
- const void *src, size_t src_size)
380
+__version__ = '1.4.0' # we use our own version number independant of the
338
-{
381
+ # one in stdlib and we release this on pypi.
339
- int ret = 0;
382
+
340
- z_stream strm;
383
+__external_lib__ = True # to make sure the tests really test THIS lib,
341
-
384
+ # not the builtin one in Python stdlib
342
- memset(&strm, 0, sizeof(strm));
385
+
343
- strm.avail_in = src_size;
386
+__all__ = [
344
- strm.next_in = (void *) src;
387
+ 'ArgumentParser',
345
- strm.avail_out = dest_size;
388
+ 'ArgumentError',
346
- strm.next_out = dest;
389
+ 'ArgumentTypeError',
347
-
390
+ 'FileType',
348
- ret = inflateInit2(&strm, -12);
391
+ 'HelpFormatter',
349
- if (ret != Z_OK) {
392
+ 'ArgumentDefaultsHelpFormatter',
350
- return -1;
393
+ 'RawDescriptionHelpFormatter',
351
- }
394
+ 'RawTextHelpFormatter',
352
-
395
+ 'Namespace',
353
- ret = inflate(&strm, Z_FINISH);
396
+ 'Action',
354
- if ((ret != Z_STREAM_END && ret != Z_BUF_ERROR) || strm.avail_out != 0) {
397
+ 'ONE_OR_MORE',
355
- /* We approve Z_BUF_ERROR because we need @dest buffer to be filled, but
398
+ 'OPTIONAL',
356
- * @src buffer may be processed partly (because in qcow2 we know size of
399
+ 'PARSER',
357
- * compressed data with precision of one sector) */
400
+ 'REMAINDER',
358
- ret = -1;
401
+ 'SUPPRESS',
359
- }
402
+ 'ZERO_OR_MORE',
360
-
403
+]
361
- inflateEnd(&strm);
404
+
362
-
405
+
363
- return ret;
406
+import copy as _copy
364
-}
407
+import os as _os
365
-
408
+import re as _re
366
-#define MAX_COMPRESS_THREADS 4
409
+import sys as _sys
367
-
410
+import textwrap as _textwrap
368
-typedef ssize_t (*Qcow2CompressFunc)(void *dest, size_t dest_size,
411
+
369
- const void *src, size_t src_size);
412
+from gettext import gettext as _
370
-typedef struct Qcow2CompressData {
413
+
371
- void *dest;
414
+try:
372
- size_t dest_size;
415
+ set
373
- const void *src;
416
+except NameError:
374
- size_t src_size;
417
+ # for python < 2.4 compatibility (sets module is there since 2.3):
375
- ssize_t ret;
418
+ from sets import Set as set
376
-
419
+
377
- Qcow2CompressFunc func;
420
+try:
378
-} Qcow2CompressData;
421
+ basestring
379
-
422
+except NameError:
380
-static int qcow2_compress_pool_func(void *opaque)
423
+ basestring = str
381
-{
424
+
382
- Qcow2CompressData *data = opaque;
425
+try:
383
-
426
+ sorted
384
- data->ret = data->func(data->dest, data->dest_size,
427
+except NameError:
385
- data->src, data->src_size);
428
+ # for python < 2.4 compatibility:
386
-
429
+ def sorted(iterable, reverse=False):
387
- return 0;
430
+ result = list(iterable)
388
-}
431
+ result.sort()
389
-
432
+ if reverse:
390
-static void qcow2_compress_complete(void *opaque, int ret)
433
+ result.reverse()
391
-{
434
+ return result
392
- qemu_coroutine_enter(opaque);
435
+
393
-}
436
+
394
-
437
+def _callable(obj):
395
-static ssize_t coroutine_fn
438
+ return hasattr(obj, '__call__') or hasattr(obj, '__bases__')
396
-qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
439
+
397
- const void *src, size_t src_size, Qcow2CompressFunc func)
440
+
398
-{
441
+SUPPRESS = '==SUPPRESS=='
399
- BDRVQcow2State *s = bs->opaque;
442
+
400
- BlockAIOCB *acb;
443
+OPTIONAL = '?'
401
- ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
444
+ZERO_OR_MORE = '*'
402
- Qcow2CompressData arg = {
445
+ONE_OR_MORE = '+'
403
- .dest = dest,
446
+PARSER = 'A...'
404
- .dest_size = dest_size,
447
+REMAINDER = '...'
405
- .src = src,
448
+_UNRECOGNIZED_ARGS_ATTR = '_unrecognized_args'
406
- .src_size = src_size,
449
+
407
- .func = func,
450
+# =============================
408
- };
451
+# Utility functions and classes
409
-
452
+# =============================
410
- while (s->nb_compress_threads >= MAX_COMPRESS_THREADS) {
453
+
411
- qemu_co_queue_wait(&s->compress_wait_queue, NULL);
454
+class _AttributeHolder(object):
412
- }
455
+ """Abstract base class that provides __repr__.
413
-
456
+
414
- s->nb_compress_threads++;
457
+ The __repr__ method returns a string in the format::
415
- acb = thread_pool_submit_aio(pool, qcow2_compress_pool_func, &arg,
458
+ ClassName(attr=name, attr=name, ...)
416
- qcow2_compress_complete,
459
+ The attributes are determined either by a class-level attribute,
417
- qemu_coroutine_self());
460
+ '_kwarg_names', or by inspecting the instance __dict__.
418
-
461
+ """
419
- if (!acb) {
462
+
420
- s->nb_compress_threads--;
463
+ def __repr__(self):
421
- return -EINVAL;
464
+ type_name = type(self).__name__
422
- }
465
+ arg_strings = []
423
- qemu_coroutine_yield();
466
+ for arg in self._get_args():
424
- s->nb_compress_threads--;
467
+ arg_strings.append(repr(arg))
425
- qemu_co_queue_next(&s->compress_wait_queue);
468
+ for name, value in self._get_kwargs():
426
-
469
+ arg_strings.append('%s=%r' % (name, value))
427
- return arg.ret;
470
+ return '%s(%s)' % (type_name, ', '.join(arg_strings))
428
-}
471
+
429
-
472
+ def _get_kwargs(self):
430
-static ssize_t coroutine_fn
473
+ return sorted(self.__dict__.items())
431
-qcow2_co_compress(BlockDriverState *bs, void *dest, size_t dest_size,
474
+
432
- const void *src, size_t src_size)
475
+ def _get_args(self):
433
-{
476
+ return []
434
- return qcow2_co_do_compress(bs, dest, dest_size, src, src_size,
477
+
435
- qcow2_compress);
478
+
436
-}
479
+def _ensure_value(namespace, name, value):
437
-
480
+ if getattr(namespace, name, None) is None:
438
-static ssize_t coroutine_fn
481
+ setattr(namespace, name, value)
439
-qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size,
482
+ return getattr(namespace, name)
440
- const void *src, size_t src_size)
483
+
441
-{
484
+
442
- return qcow2_co_do_compress(bs, dest, dest_size, src, src_size,
485
+# ===============
443
- qcow2_decompress);
486
+# Formatting Help
444
-}
487
+# ===============
445
-
488
+
446
/* XXX: put compressed sectors first, then all the cluster aligned
489
+class HelpFormatter(object):
447
tables to avoid losing bytes in alignment */
490
+ """Formatter for generating usage messages and argument help strings.
448
static coroutine_fn int
491
+
492
+ Only the name of this class is considered a public API. All the methods
493
+ provided by the class are considered an implementation detail.
494
+ """
495
+
496
+ def __init__(self,
497
+ prog,
498
+ indent_increment=2,
499
+ max_help_position=24,
500
+ width=None):
501
+
502
+ # default setting for width
503
+ if width is None:
504
+ try:
505
+ width = int(_os.environ['COLUMNS'])
506
+ except (KeyError, ValueError):
507
+ width = 80
508
+ width -= 2
509
+
510
+ self._prog = prog
511
+ self._indent_increment = indent_increment
512
+ self._max_help_position = max_help_position
513
+ self._width = width
514
+
515
+ self._current_indent = 0
516
+ self._level = 0
517
+ self._action_max_length = 0
518
+
519
+ self._root_section = self._Section(self, None)
520
+ self._current_section = self._root_section
521
+
522
+ self._whitespace_matcher = _re.compile(r'\s+')
523
+ self._long_break_matcher = _re.compile(r'\n\n\n+')
524
+
525
+ # ===============================
526
+ # Section and indentation methods
527
+ # ===============================
528
+ def _indent(self):
529
+ self._current_indent += self._indent_increment
530
+ self._level += 1
531
+
532
+ def _dedent(self):
533
+ self._current_indent -= self._indent_increment
534
+ assert self._current_indent >= 0, 'Indent decreased below 0.'
535
+ self._level -= 1
536
+
537
+ class _Section(object):
538
+
539
+ def __init__(self, formatter, parent, heading=None):
540
+ self.formatter = formatter
541
+ self.parent = parent
542
+ self.heading = heading
543
+ self.items = []
544
+
545
+ def format_help(self):
546
+ # format the indented section
547
+ if self.parent is not None:
548
+ self.formatter._indent()
549
+ join = self.formatter._join_parts
550
+ for func, args in self.items:
551
+ func(*args)
552
+ item_help = join([func(*args) for func, args in self.items])
553
+ if self.parent is not None:
554
+ self.formatter._dedent()
555
+
556
+ # return nothing if the section was empty
557
+ if not item_help:
558
+ return ''
559
+
560
+ # add the heading if the section was non-empty
561
+ if self.heading is not SUPPRESS and self.heading is not None:
562
+ current_indent = self.formatter._current_indent
563
+ heading = '%*s%s:\n' % (current_indent, '', self.heading)
564
+ else:
565
+ heading = ''
566
+
567
+ # join the section-initial newline, the heading and the help
568
+ return join(['\n', heading, item_help, '\n'])
569
+
570
+ def _add_item(self, func, args):
571
+ self._current_section.items.append((func, args))
572
+
573
+ # ========================
574
+ # Message building methods
575
+ # ========================
576
+ def start_section(self, heading):
577
+ self._indent()
578
+ section = self._Section(self, self._current_section, heading)
579
+ self._add_item(section.format_help, [])
580
+ self._current_section = section
581
+
582
+ def end_section(self):
583
+ self._current_section = self._current_section.parent
584
+ self._dedent()
585
+
586
+ def add_text(self, text):
587
+ if text is not SUPPRESS and text is not None:
588
+ self._add_item(self._format_text, [text])
589
+
590
+ def add_usage(self, usage, actions, groups, prefix=None):
591
+ if usage is not SUPPRESS:
592
+ args = usage, actions, groups, prefix
593
+ self._add_item(self._format_usage, args)
594
+
595
+ def add_argument(self, action):
596
+ if action.help is not SUPPRESS:
597
+
598
+ # find all invocations
599
+ get_invocation = self._format_action_invocation
600
+ invocations = [get_invocation(action)]
601
+ for subaction in self._iter_indented_subactions(action):
602
+ invocations.append(get_invocation(subaction))
603
+
604
+ # update the maximum item length
605
+ invocation_length = max([len(s) for s in invocations])
606
+ action_length = invocation_length + self._current_indent
607
+ self._action_max_length = max(self._action_max_length,
608
+ action_length)
609
+
610
+ # add the item to the list
611
+ self._add_item(self._format_action, [action])
612
+
613
+ def add_arguments(self, actions):
614
+ for action in actions:
615
+ self.add_argument(action)
616
+
617
+ # =======================
618
+ # Help-formatting methods
619
+ # =======================
620
+ def format_help(self):
621
+ help = self._root_section.format_help()
622
+ if help:
623
+ help = self._long_break_matcher.sub('\n\n', help)
624
+ help = help.strip('\n') + '\n'
625
+ return help
626
+
627
+ def _join_parts(self, part_strings):
628
+ return ''.join([part
629
+ for part in part_strings
630
+ if part and part is not SUPPRESS])
631
+
632
+ def _format_usage(self, usage, actions, groups, prefix):
633
+ if prefix is None:
634
+ prefix = _('usage: ')
635
+
636
+ # if usage is specified, use that
637
+ if usage is not None:
638
+ usage = usage % dict(prog=self._prog)
639
+
640
+ # if no optionals or positionals are available, usage is just prog
641
+ elif usage is None and not actions:
642
+ usage = '%(prog)s' % dict(prog=self._prog)
643
+
644
+ # if optionals and positionals are available, calculate usage
645
+ elif usage is None:
646
+ prog = '%(prog)s' % dict(prog=self._prog)
647
+
648
+ # split optionals from positionals
649
+ optionals = []
650
+ positionals = []
651
+ for action in actions:
652
+ if action.option_strings:
653
+ optionals.append(action)
654
+ else:
655
+ positionals.append(action)
656
+
657
+ # build full usage string
658
+ format = self._format_actions_usage
659
+ action_usage = format(optionals + positionals, groups)
660
+ usage = ' '.join([s for s in [prog, action_usage] if s])
661
+
662
+ # wrap the usage parts if it's too long
663
+ text_width = self._width - self._current_indent
664
+ if len(prefix) + len(usage) > text_width:
665
+
666
+ # break usage into wrappable parts
667
+ part_regexp = r'\(.*?\)+|\[.*?\]+|\S+'
668
+ opt_usage = format(optionals, groups)
669
+ pos_usage = format(positionals, groups)
670
+ opt_parts = _re.findall(part_regexp, opt_usage)
671
+ pos_parts = _re.findall(part_regexp, pos_usage)
672
+ assert ' '.join(opt_parts) == opt_usage
673
+ assert ' '.join(pos_parts) == pos_usage
674
+
675
+ # helper for wrapping lines
676
+ def get_lines(parts, indent, prefix=None):
677
+ lines = []
678
+ line = []
679
+ if prefix is not None:
680
+ line_len = len(prefix) - 1
681
+ else:
682
+ line_len = len(indent) - 1
683
+ for part in parts:
684
+ if line_len + 1 + len(part) > text_width:
685
+ lines.append(indent + ' '.join(line))
686
+ line = []
687
+ line_len = len(indent) - 1
688
+ line.append(part)
689
+ line_len += len(part) + 1
690
+ if line:
691
+ lines.append(indent + ' '.join(line))
692
+ if prefix is not None:
693
+ lines[0] = lines[0][len(indent):]
694
+ return lines
695
+
696
+ # if prog is short, follow it with optionals or positionals
697
+ if len(prefix) + len(prog) <= 0.75 * text_width:
698
+ indent = ' ' * (len(prefix) + len(prog) + 1)
699
+ if opt_parts:
700
+ lines = get_lines([prog] + opt_parts, indent, prefix)
701
+ lines.extend(get_lines(pos_parts, indent))
702
+ elif pos_parts:
703
+ lines = get_lines([prog] + pos_parts, indent, prefix)
704
+ else:
705
+ lines = [prog]
706
+
707
+ # if prog is long, put it on its own line
708
+ else:
709
+ indent = ' ' * len(prefix)
710
+ parts = opt_parts + pos_parts
711
+ lines = get_lines(parts, indent)
712
+ if len(lines) > 1:
713
+ lines = []
714
+ lines.extend(get_lines(opt_parts, indent))
715
+ lines.extend(get_lines(pos_parts, indent))
716
+ lines = [prog] + lines
717
+
718
+ # join lines into usage
719
+ usage = '\n'.join(lines)
720
+
721
+ # prefix with 'usage:'
722
+ return '%s%s\n\n' % (prefix, usage)
723
+
724
+ def _format_actions_usage(self, actions, groups):
725
+ # find group indices and identify actions in groups
726
+ group_actions = set()
727
+ inserts = {}
728
+ for group in groups:
729
+ try:
730
+ start = actions.index(group._group_actions[0])
731
+ except ValueError:
732
+ continue
733
+ else:
734
+ end = start + len(group._group_actions)
735
+ if actions[start:end] == group._group_actions:
736
+ for action in group._group_actions:
737
+ group_actions.add(action)
738
+ if not group.required:
739
+ if start in inserts:
740
+ inserts[start] += ' ['
741
+ else:
742
+ inserts[start] = '['
743
+ inserts[end] = ']'
744
+ else:
745
+ if start in inserts:
746
+ inserts[start] += ' ('
747
+ else:
748
+ inserts[start] = '('
749
+ inserts[end] = ')'
750
+ for i in range(start + 1, end):
751
+ inserts[i] = '|'
752
+
753
+ # collect all actions format strings
754
+ parts = []
755
+ for i, action in enumerate(actions):
756
+
757
+ # suppressed arguments are marked with None
758
+ # remove | separators for suppressed arguments
759
+ if action.help is SUPPRESS:
760
+ parts.append(None)
761
+ if inserts.get(i) == '|':
762
+ inserts.pop(i)
763
+ elif inserts.get(i + 1) == '|':
764
+ inserts.pop(i + 1)
765
+
766
+ # produce all arg strings
767
+ elif not action.option_strings:
768
+ part = self._format_args(action, action.dest)
769
+
770
+ # if it's in a group, strip the outer []
771
+ if action in group_actions:
772
+ if part[0] == '[' and part[-1] == ']':
773
+ part = part[1:-1]
774
+
775
+ # add the action string to the list
776
+ parts.append(part)
777
+
778
+ # produce the first way to invoke the option in brackets
779
+ else:
780
+ option_string = action.option_strings[0]
781
+
782
+ # if the Optional doesn't take a value, format is:
783
+ # -s or --long
784
+ if action.nargs == 0:
785
+ part = '%s' % option_string
786
+
787
+ # if the Optional takes a value, format is:
788
+ # -s ARGS or --long ARGS
789
+ else:
790
+ default = action.dest.upper()
791
+ args_string = self._format_args(action, default)
792
+ part = '%s %s' % (option_string, args_string)
793
+
794
+ # make it look optional if it's not required or in a group
795
+ if not action.required and action not in group_actions:
796
+ part = '[%s]' % part
797
+
798
+ # add the action string to the list
799
+ parts.append(part)
800
+
801
+ # insert things at the necessary indices
802
+ for i in sorted(inserts, reverse=True):
803
+ parts[i:i] = [inserts[i]]
804
+
805
+ # join all the action items with spaces
806
+ text = ' '.join([item for item in parts if item is not None])
807
+
808
+ # clean up separators for mutually exclusive groups
809
+ open = r'[\[(]'
810
+ close = r'[\])]'
811
+ text = _re.sub(r'(%s) ' % open, r'\1', text)
812
+ text = _re.sub(r' (%s)' % close, r'\1', text)
813
+ text = _re.sub(r'%s *%s' % (open, close), r'', text)
814
+ text = _re.sub(r'\(([^|]*)\)', r'\1', text)
815
+ text = text.strip()
816
+
817
+ # return the text
818
+ return text
819
+
820
+ def _format_text(self, text):
821
+ if '%(prog)' in text:
822
+ text = text % dict(prog=self._prog)
823
+ text_width = self._width - self._current_indent
824
+ indent = ' ' * self._current_indent
825
+ return self._fill_text(text, text_width, indent) + '\n\n'
826
+
827
+ def _format_action(self, action):
828
+ # determine the required width and the entry label
829
+ help_position = min(self._action_max_length + 2,
830
+ self._max_help_position)
831
+ help_width = self._width - help_position
832
+ action_width = help_position - self._current_indent - 2
833
+ action_header = self._format_action_invocation(action)
834
+
835
+ # ho nelp; start on same line and add a final newline
836
+ if not action.help:
837
+ tup = self._current_indent, '', action_header
838
+ action_header = '%*s%s\n' % tup
839
+
840
+ # short action name; start on the same line and pad two spaces
841
+ elif len(action_header) <= action_width:
842
+ tup = self._current_indent, '', action_width, action_header
843
+ action_header = '%*s%-*s ' % tup
844
+ indent_first = 0
845
+
846
+ # long action name; start on the next line
847
+ else:
848
+ tup = self._current_indent, '', action_header
849
+ action_header = '%*s%s\n' % tup
850
+ indent_first = help_position
851
+
852
+ # collect the pieces of the action help
853
+ parts = [action_header]
854
+
855
+ # if there was help for the action, add lines of help text
856
+ if action.help:
857
+ help_text = self._expand_help(action)
858
+ help_lines = self._split_lines(help_text, help_width)
859
+ parts.append('%*s%s\n' % (indent_first, '', help_lines[0]))
860
+ for line in help_lines[1:]:
861
+ parts.append('%*s%s\n' % (help_position, '', line))
862
+
863
+ # or add a newline if the description doesn't end with one
864
+ elif not action_header.endswith('\n'):
865
+ parts.append('\n')
866
+
867
+ # if there are any sub-actions, add their help as well
868
+ for subaction in self._iter_indented_subactions(action):
869
+ parts.append(self._format_action(subaction))
870
+
871
+ # return a single string
872
+ return self._join_parts(parts)
873
+
874
+ def _format_action_invocation(self, action):
875
+ if not action.option_strings:
876
+ metavar, = self._metavar_formatter(action, action.dest)(1)
877
+ return metavar
878
+
879
+ else:
880
+ parts = []
881
+
882
+ # if the Optional doesn't take a value, format is:
883
+ # -s, --long
884
+ if action.nargs == 0:
885
+ parts.extend(action.option_strings)
886
+
887
+ # if the Optional takes a value, format is:
888
+ # -s ARGS, --long ARGS
889
+ else:
890
+ default = action.dest.upper()
891
+ args_string = self._format_args(action, default)
892
+ for option_string in action.option_strings:
893
+ parts.append('%s %s' % (option_string, args_string))
894
+
895
+ return ', '.join(parts)
896
+
897
+ def _metavar_formatter(self, action, default_metavar):
898
+ if action.metavar is not None:
899
+ result = action.metavar
900
+ elif action.choices is not None:
901
+ choice_strs = [str(choice) for choice in action.choices]
902
+ result = '{%s}' % ','.join(choice_strs)
903
+ else:
904
+ result = default_metavar
905
+
906
+ def format(tuple_size):
907
+ if isinstance(result, tuple):
908
+ return result
909
+ else:
910
+ return (result, ) * tuple_size
911
+ return format
912
+
913
+ def _format_args(self, action, default_metavar):
914
+ get_metavar = self._metavar_formatter(action, default_metavar)
915
+ if action.nargs is None:
916
+ result = '%s' % get_metavar(1)
917
+ elif action.nargs == OPTIONAL:
918
+ result = '[%s]' % get_metavar(1)
919
+ elif action.nargs == ZERO_OR_MORE:
920
+ result = '[%s [%s ...]]' % get_metavar(2)
921
+ elif action.nargs == ONE_OR_MORE:
922
+ result = '%s [%s ...]' % get_metavar(2)
923
+ elif action.nargs == REMAINDER:
924
+ result = '...'
925
+ elif action.nargs == PARSER:
926
+ result = '%s ...' % get_metavar(1)
927
+ else:
928
+ formats = ['%s' for _ in range(action.nargs)]
929
+ result = ' '.join(formats) % get_metavar(action.nargs)
930
+ return result
931
+
932
+ def _expand_help(self, action):
933
+ params = dict(vars(action), prog=self._prog)
934
+ for name in list(params):
935
+ if params[name] is SUPPRESS:
936
+ del params[name]
937
+ for name in list(params):
938
+ if hasattr(params[name], '__name__'):
939
+ params[name] = params[name].__name__
940
+ if params.get('choices') is not None:
941
+ choices_str = ', '.join([str(c) for c in params['choices']])
942
+ params['choices'] = choices_str
943
+ return self._get_help_string(action) % params
944
+
945
+ def _iter_indented_subactions(self, action):
946
+ try:
947
+ get_subactions = action._get_subactions
948
+ except AttributeError:
949
+ pass
950
+ else:
951
+ self._indent()
952
+ for subaction in get_subactions():
953
+ yield subaction
954
+ self._dedent()
955
+
956
+ def _split_lines(self, text, width):
957
+ text = self._whitespace_matcher.sub(' ', text).strip()
958
+ return _textwrap.wrap(text, width)
959
+
960
+ def _fill_text(self, text, width, indent):
961
+ text = self._whitespace_matcher.sub(' ', text).strip()
962
+ return _textwrap.fill(text, width, initial_indent=indent,
963
+ subsequent_indent=indent)
964
+
965
+ def _get_help_string(self, action):
966
+ return action.help
967
+
968
+
969
+class RawDescriptionHelpFormatter(HelpFormatter):
970
+ """Help message formatter which retains any formatting in descriptions.
971
+
972
+ Only the name of this class is considered a public API. All the methods
973
+ provided by the class are considered an implementation detail.
974
+ """
975
+
976
+ def _fill_text(self, text, width, indent):
977
+ return ''.join([indent + line for line in text.splitlines(True)])
978
+
979
+
980
+class RawTextHelpFormatter(RawDescriptionHelpFormatter):
981
+ """Help message formatter which retains formatting of all help text.
982
+
983
+ Only the name of this class is considered a public API. All the methods
984
+ provided by the class are considered an implementation detail.
985
+ """
986
+
987
+ def _split_lines(self, text, width):
988
+ return text.splitlines()
989
+
990
+
991
+class ArgumentDefaultsHelpFormatter(HelpFormatter):
992
+ """Help message formatter which adds default values to argument help.
993
+
994
+ Only the name of this class is considered a public API. All the methods
995
+ provided by the class are considered an implementation detail.
996
+ """
997
+
998
+ def _get_help_string(self, action):
999
+ help = action.help
1000
+ if '%(default)' not in action.help:
1001
+ if action.default is not SUPPRESS:
1002
+ defaulting_nargs = [OPTIONAL, ZERO_OR_MORE]
1003
+ if action.option_strings or action.nargs in defaulting_nargs:
1004
+ help += ' (default: %(default)s)'
1005
+ return help
1006
+
1007
+
1008
+# =====================
1009
+# Options and Arguments
1010
+# =====================
1011
+
1012
+def _get_action_name(argument):
1013
+ if argument is None:
1014
+ return None
1015
+ elif argument.option_strings:
1016
+ return '/'.join(argument.option_strings)
1017
+ elif argument.metavar not in (None, SUPPRESS):
1018
+ return argument.metavar
1019
+ elif argument.dest not in (None, SUPPRESS):
1020
+ return argument.dest
1021
+ else:
1022
+ return None
1023
+
1024
+
1025
+class ArgumentError(Exception):
1026
+ """An error from creating or using an argument (optional or positional).
1027
+
1028
+ The string value of this exception is the message, augmented with
1029
+ information about the argument that caused it.
1030
+ """
1031
+
1032
+ def __init__(self, argument, message):
1033
+ self.argument_name = _get_action_name(argument)
1034
+ self.message = message
1035
+
1036
+ def __str__(self):
1037
+ if self.argument_name is None:
1038
+ format = '%(message)s'
1039
+ else:
1040
+ format = 'argument %(argument_name)s: %(message)s'
1041
+ return format % dict(message=self.message,
1042
+ argument_name=self.argument_name)
1043
+
1044
+
1045
+class ArgumentTypeError(Exception):
1046
+ """An error from trying to convert a command line string to a type."""
1047
+ pass
1048
+
1049
+
1050
+# ==============
1051
+# Action classes
1052
+# ==============
1053
+
1054
+class Action(_AttributeHolder):
1055
+ """Information about how to convert command line strings to Python objects.
1056
+
1057
+ Action objects are used by an ArgumentParser to represent the information
1058
+ needed to parse a single argument from one or more strings from the
1059
+ command line. The keyword arguments to the Action constructor are also
1060
+ all attributes of Action instances.
1061
+
1062
+ Keyword Arguments:
1063
+
1064
+ - option_strings -- A list of command-line option strings which
1065
+ should be associated with this action.
1066
+
1067
+ - dest -- The name of the attribute to hold the created object(s)
1068
+
1069
+ - nargs -- The number of command-line arguments that should be
1070
+ consumed. By default, one argument will be consumed and a single
1071
+ value will be produced. Other values include:
1072
+ - N (an integer) consumes N arguments (and produces a list)
1073
+ - '?' consumes zero or one arguments
1074
+ - '*' consumes zero or more arguments (and produces a list)
1075
+ - '+' consumes one or more arguments (and produces a list)
1076
+ Note that the difference between the default and nargs=1 is that
1077
+ with the default, a single value will be produced, while with
1078
+ nargs=1, a list containing a single value will be produced.
1079
+
1080
+ - const -- The value to be produced if the option is specified and the
1081
+ option uses an action that takes no values.
1082
+
1083
+ - default -- The value to be produced if the option is not specified.
1084
+
1085
+ - type -- The type which the command-line arguments should be converted
1086
+ to, should be one of 'string', 'int', 'float', 'complex' or a
1087
+ callable object that accepts a single string argument. If None,
1088
+ 'string' is assumed.
1089
+
1090
+ - choices -- A container of values that should be allowed. If not None,
1091
+ after a command-line argument has been converted to the appropriate
1092
+ type, an exception will be raised if it is not a member of this
1093
+ collection.
1094
+
1095
+ - required -- True if the action must always be specified at the
1096
+ command line. This is only meaningful for optional command-line
1097
+ arguments.
1098
+
1099
+ - help -- The help string describing the argument.
1100
+
1101
+ - metavar -- The name to be used for the option's argument with the
1102
+ help string. If None, the 'dest' value will be used as the name.
1103
+ """
1104
+
1105
+ def __init__(self,
1106
+ option_strings,
1107
+ dest,
1108
+ nargs=None,
1109
+ const=None,
1110
+ default=None,
1111
+ type=None,
1112
+ choices=None,
1113
+ required=False,
1114
+ help=None,
1115
+ metavar=None):
1116
+ self.option_strings = option_strings
1117
+ self.dest = dest
1118
+ self.nargs = nargs
1119
+ self.const = const
1120
+ self.default = default
1121
+ self.type = type
1122
+ self.choices = choices
1123
+ self.required = required
1124
+ self.help = help
1125
+ self.metavar = metavar
1126
+
1127
+ def _get_kwargs(self):
1128
+ names = [
1129
+ 'option_strings',
1130
+ 'dest',
1131
+ 'nargs',
1132
+ 'const',
1133
+ 'default',
1134
+ 'type',
1135
+ 'choices',
1136
+ 'help',
1137
+ 'metavar',
1138
+ ]
1139
+ return [(name, getattr(self, name)) for name in names]
1140
+
1141
+ def __call__(self, parser, namespace, values, option_string=None):
1142
+ raise NotImplementedError(_('.__call__() not defined'))
1143
+
1144
+
1145
+class _StoreAction(Action):
1146
+
1147
+ def __init__(self,
1148
+ option_strings,
1149
+ dest,
1150
+ nargs=None,
1151
+ const=None,
1152
+ default=None,
1153
+ type=None,
1154
+ choices=None,
1155
+ required=False,
1156
+ help=None,
1157
+ metavar=None):
1158
+ if nargs == 0:
1159
+ raise ValueError('nargs for store actions must be > 0; if you '
1160
+ 'have nothing to store, actions such as store '
1161
+ 'true or store const may be more appropriate')
1162
+ if const is not None and nargs != OPTIONAL:
1163
+ raise ValueError('nargs must be %r to supply const' % OPTIONAL)
1164
+ super(_StoreAction, self).__init__(
1165
+ option_strings=option_strings,
1166
+ dest=dest,
1167
+ nargs=nargs,
1168
+ const=const,
1169
+ default=default,
1170
+ type=type,
1171
+ choices=choices,
1172
+ required=required,
1173
+ help=help,
1174
+ metavar=metavar)
1175
+
1176
+ def __call__(self, parser, namespace, values, option_string=None):
1177
+ setattr(namespace, self.dest, values)
1178
+
1179
+
1180
+class _StoreConstAction(Action):
1181
+
1182
+ def __init__(self,
1183
+ option_strings,
1184
+ dest,
1185
+ const,
1186
+ default=None,
1187
+ required=False,
1188
+ help=None,
1189
+ metavar=None):
1190
+ super(_StoreConstAction, self).__init__(
1191
+ option_strings=option_strings,
1192
+ dest=dest,
1193
+ nargs=0,
1194
+ const=const,
1195
+ default=default,
1196
+ required=required,
1197
+ help=help)
1198
+
1199
+ def __call__(self, parser, namespace, values, option_string=None):
1200
+ setattr(namespace, self.dest, self.const)
1201
+
1202
+
1203
+class _StoreTrueAction(_StoreConstAction):
1204
+
1205
+ def __init__(self,
1206
+ option_strings,
1207
+ dest,
1208
+ default=False,
1209
+ required=False,
1210
+ help=None):
1211
+ super(_StoreTrueAction, self).__init__(
1212
+ option_strings=option_strings,
1213
+ dest=dest,
1214
+ const=True,
1215
+ default=default,
1216
+ required=required,
1217
+ help=help)
1218
+
1219
+
1220
+class _StoreFalseAction(_StoreConstAction):
1221
+
1222
+ def __init__(self,
1223
+ option_strings,
1224
+ dest,
1225
+ default=True,
1226
+ required=False,
1227
+ help=None):
1228
+ super(_StoreFalseAction, self).__init__(
1229
+ option_strings=option_strings,
1230
+ dest=dest,
1231
+ const=False,
1232
+ default=default,
1233
+ required=required,
1234
+ help=help)
1235
+
1236
+
1237
+class _AppendAction(Action):
1238
+
1239
+ def __init__(self,
1240
+ option_strings,
1241
+ dest,
1242
+ nargs=None,
1243
+ const=None,
1244
+ default=None,
1245
+ type=None,
1246
+ choices=None,
1247
+ required=False,
1248
+ help=None,
1249
+ metavar=None):
1250
+ if nargs == 0:
1251
+ raise ValueError('nargs for append actions must be > 0; if arg '
1252
+ 'strings are not supplying the value to append, '
1253
+ 'the append const action may be more appropriate')
1254
+ if const is not None and nargs != OPTIONAL:
1255
+ raise ValueError('nargs must be %r to supply const' % OPTIONAL)
1256
+ super(_AppendAction, self).__init__(
1257
+ option_strings=option_strings,
1258
+ dest=dest,
1259
+ nargs=nargs,
1260
+ const=const,
1261
+ default=default,
1262
+ type=type,
1263
+ choices=choices,
1264
+ required=required,
1265
+ help=help,
1266
+ metavar=metavar)
1267
+
1268
+ def __call__(self, parser, namespace, values, option_string=None):
1269
+ items = _copy.copy(_ensure_value(namespace, self.dest, []))
1270
+ items.append(values)
1271
+ setattr(namespace, self.dest, items)
1272
+
1273
+
1274
+class _AppendConstAction(Action):
1275
+
1276
+ def __init__(self,
1277
+ option_strings,
1278
+ dest,
1279
+ const,
1280
+ default=None,
1281
+ required=False,
1282
+ help=None,
1283
+ metavar=None):
1284
+ super(_AppendConstAction, self).__init__(
1285
+ option_strings=option_strings,
1286
+ dest=dest,
1287
+ nargs=0,
1288
+ const=const,
1289
+ default=default,
1290
+ required=required,
1291
+ help=help,
1292
+ metavar=metavar)
1293
+
1294
+ def __call__(self, parser, namespace, values, option_string=None):
1295
+ items = _copy.copy(_ensure_value(namespace, self.dest, []))
1296
+ items.append(self.const)
1297
+ setattr(namespace, self.dest, items)
1298
+
1299
+
1300
+class _CountAction(Action):
1301
+
1302
+ def __init__(self,
1303
+ option_strings,
1304
+ dest,
1305
+ default=None,
1306
+ required=False,
1307
+ help=None):
1308
+ super(_CountAction, self).__init__(
1309
+ option_strings=option_strings,
1310
+ dest=dest,
1311
+ nargs=0,
1312
+ default=default,
1313
+ required=required,
1314
+ help=help)
1315
+
1316
+ def __call__(self, parser, namespace, values, option_string=None):
1317
+ new_count = _ensure_value(namespace, self.dest, 0) + 1
1318
+ setattr(namespace, self.dest, new_count)
1319
+
1320
+
1321
+class _HelpAction(Action):
1322
+
1323
+ def __init__(self,
1324
+ option_strings,
1325
+ dest=SUPPRESS,
1326
+ default=SUPPRESS,
1327
+ help=None):
1328
+ super(_HelpAction, self).__init__(
1329
+ option_strings=option_strings,
1330
+ dest=dest,
1331
+ default=default,
1332
+ nargs=0,
1333
+ help=help)
1334
+
1335
+ def __call__(self, parser, namespace, values, option_string=None):
1336
+ parser.print_help()
1337
+ parser.exit()
1338
+
1339
+
1340
+class _VersionAction(Action):
1341
+
1342
+ def __init__(self,
1343
+ option_strings,
1344
+ version=None,
1345
+ dest=SUPPRESS,
1346
+ default=SUPPRESS,
1347
+ help="show program's version number and exit"):
1348
+ super(_VersionAction, self).__init__(
1349
+ option_strings=option_strings,
1350
+ dest=dest,
1351
+ default=default,
1352
+ nargs=0,
1353
+ help=help)
1354
+ self.version = version
1355
+
1356
+ def __call__(self, parser, namespace, values, option_string=None):
1357
+ version = self.version
1358
+ if version is None:
1359
+ version = parser.version
1360
+ formatter = parser._get_formatter()
1361
+ formatter.add_text(version)
1362
+ parser.exit(message=formatter.format_help())
1363
+
1364
+
1365
+class _SubParsersAction(Action):
1366
+
1367
+ class _ChoicesPseudoAction(Action):
1368
+
1369
+ def __init__(self, name, aliases, help):
1370
+ metavar = dest = name
1371
+ if aliases:
1372
+ metavar += ' (%s)' % ', '.join(aliases)
1373
+ sup = super(_SubParsersAction._ChoicesPseudoAction, self)
1374
+ sup.__init__(option_strings=[], dest=dest, help=help,
1375
+ metavar=metavar)
1376
+
1377
+ def __init__(self,
1378
+ option_strings,
1379
+ prog,
1380
+ parser_class,
1381
+ dest=SUPPRESS,
1382
+ help=None,
1383
+ metavar=None):
1384
+
1385
+ self._prog_prefix = prog
1386
+ self._parser_class = parser_class
1387
+ self._name_parser_map = {}
1388
+ self._choices_actions = []
1389
+
1390
+ super(_SubParsersAction, self).__init__(
1391
+ option_strings=option_strings,
1392
+ dest=dest,
1393
+ nargs=PARSER,
1394
+ choices=self._name_parser_map,
1395
+ help=help,
1396
+ metavar=metavar)
1397
+
1398
+ def add_parser(self, name, **kwargs):
1399
+ # set prog from the existing prefix
1400
+ if kwargs.get('prog') is None:
1401
+ kwargs['prog'] = '%s %s' % (self._prog_prefix, name)
1402
+
1403
+ aliases = kwargs.pop('aliases', ())
1404
+
1405
+ # create a pseudo-action to hold the choice help
1406
+ if 'help' in kwargs:
1407
+ help = kwargs.pop('help')
1408
+ choice_action = self._ChoicesPseudoAction(name, aliases, help)
1409
+ self._choices_actions.append(choice_action)
1410
+
1411
+ # create the parser and add it to the map
1412
+ parser = self._parser_class(**kwargs)
1413
+ self._name_parser_map[name] = parser
1414
+
1415
+ # make parser available under aliases also
1416
+ for alias in aliases:
1417
+ self._name_parser_map[alias] = parser
1418
+
1419
+ return parser
1420
+
1421
+ def _get_subactions(self):
1422
+ return self._choices_actions
1423
+
1424
+ def __call__(self, parser, namespace, values, option_string=None):
1425
+ parser_name = values[0]
1426
+ arg_strings = values[1:]
1427
+
1428
+ # set the parser name if requested
1429
+ if self.dest is not SUPPRESS:
1430
+ setattr(namespace, self.dest, parser_name)
1431
+
1432
+ # select the parser
1433
+ try:
1434
+ parser = self._name_parser_map[parser_name]
1435
+ except KeyError:
1436
+ tup = parser_name, ', '.join(self._name_parser_map)
1437
+ msg = _('unknown parser %r (choices: %s)' % tup)
1438
+ raise ArgumentError(self, msg)
1439
+
1440
+ # parse all the remaining options into the namespace
1441
+ # store any unrecognized options on the object, so that the top
1442
+ # level parser can decide what to do with them
1443
+ namespace, arg_strings = parser.parse_known_args(arg_strings, namespace)
1444
+ if arg_strings:
1445
+ vars(namespace).setdefault(_UNRECOGNIZED_ARGS_ATTR, [])
1446
+ getattr(namespace, _UNRECOGNIZED_ARGS_ATTR).extend(arg_strings)
1447
+
1448
+
1449
+# ==============
1450
+# Type classes
1451
+# ==============
1452
+
1453
+class FileType(object):
1454
+ """Factory for creating file object types
1455
+
1456
+ Instances of FileType are typically passed as type= arguments to the
1457
+ ArgumentParser add_argument() method.
1458
+
1459
+ Keyword Arguments:
1460
+ - mode -- A string indicating how the file is to be opened. Accepts the
1461
+ same values as the builtin open() function.
1462
+ - bufsize -- The file's desired buffer size. Accepts the same values as
1463
+ the builtin open() function.
1464
+ """
1465
+
1466
+ def __init__(self, mode='r', bufsize=None):
1467
+ self._mode = mode
1468
+ self._bufsize = bufsize
1469
+
1470
+ def __call__(self, string):
1471
+ # the special argument "-" means sys.std{in,out}
1472
+ if string == '-':
1473
+ if 'r' in self._mode:
1474
+ return _sys.stdin
1475
+ elif 'w' in self._mode:
1476
+ return _sys.stdout
1477
+ else:
1478
+ msg = _('argument "-" with mode %r' % self._mode)
1479
+ raise ValueError(msg)
1480
+
1481
+ try:
1482
+ # all other arguments are used as file names
1483
+ if self._bufsize:
1484
+ return open(string, self._mode, self._bufsize)
1485
+ else:
1486
+ return open(string, self._mode)
1487
+ except IOError:
1488
+ err = _sys.exc_info()[1]
1489
+ message = _("can't open '%s': %s")
1490
+ raise ArgumentTypeError(message % (string, err))
1491
+
1492
+ def __repr__(self):
1493
+ args = [self._mode, self._bufsize]
1494
+ args_str = ', '.join([repr(arg) for arg in args if arg is not None])
1495
+ return '%s(%s)' % (type(self).__name__, args_str)
1496
+
1497
+# ===========================
1498
+# Optional and Positional Parsing
1499
+# ===========================
1500
+
1501
+class Namespace(_AttributeHolder):
1502
+ """Simple object for storing attributes.
1503
+
1504
+ Implements equality by attribute names and values, and provides a simple
1505
+ string representation.
1506
+ """
1507
+
1508
+ def __init__(self, **kwargs):
1509
+ for name in kwargs:
1510
+ setattr(self, name, kwargs[name])
1511
+
1512
+ __hash__ = None
1513
+
1514
+ def __eq__(self, other):
1515
+ return vars(self) == vars(other)
1516
+
1517
+ def __ne__(self, other):
1518
+ return not (self == other)
1519
+
1520
+ def __contains__(self, key):
1521
+ return key in self.__dict__
1522
+
1523
+
1524
+class _ActionsContainer(object):
1525
+
1526
+ def __init__(self,
1527
+ description,
1528
+ prefix_chars,
1529
+ argument_default,
1530
+ conflict_handler):
1531
+ super(_ActionsContainer, self).__init__()
1532
+
1533
+ self.description = description
1534
+ self.argument_default = argument_default
1535
+ self.prefix_chars = prefix_chars
1536
+ self.conflict_handler = conflict_handler
1537
+
1538
+ # set up registries
1539
+ self._registries = {}
1540
+
1541
+ # register actions
1542
+ self.register('action', None, _StoreAction)
1543
+ self.register('action', 'store', _StoreAction)
1544
+ self.register('action', 'store_const', _StoreConstAction)
1545
+ self.register('action', 'store_true', _StoreTrueAction)
1546
+ self.register('action', 'store_false', _StoreFalseAction)
1547
+ self.register('action', 'append', _AppendAction)
1548
+ self.register('action', 'append_const', _AppendConstAction)
1549
+ self.register('action', 'count', _CountAction)
1550
+ self.register('action', 'help', _HelpAction)
1551
+ self.register('action', 'version', _VersionAction)
1552
+ self.register('action', 'parsers', _SubParsersAction)
1553
+
1554
+ # raise an exception if the conflict handler is invalid
1555
+ self._get_handler()
1556
+
1557
+ # action storage
1558
+ self._actions = []
1559
+ self._option_string_actions = {}
1560
+
1561
+ # groups
1562
+ self._action_groups = []
1563
+ self._mutually_exclusive_groups = []
1564
+
1565
+ # defaults storage
1566
+ self._defaults = {}
1567
+
1568
+ # determines whether an "option" looks like a negative number
1569
+ self._negative_number_matcher = _re.compile(r'^-\d+$|^-\d*\.\d+$')
1570
+
1571
+ # whether or not there are any optionals that look like negative
1572
+ # numbers -- uses a list so it can be shared and edited
1573
+ self._has_negative_number_optionals = []
1574
+
1575
+ # ====================
1576
+ # Registration methods
1577
+ # ====================
1578
+ def register(self, registry_name, value, object):
1579
+ registry = self._registries.setdefault(registry_name, {})
1580
+ registry[value] = object
1581
+
1582
+ def _registry_get(self, registry_name, value, default=None):
1583
+ return self._registries[registry_name].get(value, default)
1584
+
1585
+ # ==================================
1586
+ # Namespace default accessor methods
1587
+ # ==================================
1588
+ def set_defaults(self, **kwargs):
1589
+ self._defaults.update(kwargs)
1590
+
1591
+ # if these defaults match any existing arguments, replace
1592
+ # the previous default on the object with the new one
1593
+ for action in self._actions:
1594
+ if action.dest in kwargs:
1595
+ action.default = kwargs[action.dest]
1596
+
1597
+ def get_default(self, dest):
1598
+ for action in self._actions:
1599
+ if action.dest == dest and action.default is not None:
1600
+ return action.default
1601
+ return self._defaults.get(dest, None)
1602
+
1603
+
1604
+ # =======================
1605
+ # Adding argument actions
1606
+ # =======================
1607
+ def add_argument(self, *args, **kwargs):
1608
+ """
1609
+ add_argument(dest, ..., name=value, ...)
1610
+ add_argument(option_string, option_string, ..., name=value, ...)
1611
+ """
1612
+
1613
+ # if no positional args are supplied or only one is supplied and
1614
+ # it doesn't look like an option string, parse a positional
1615
+ # argument
1616
+ chars = self.prefix_chars
1617
+ if not args or len(args) == 1 and args[0][0] not in chars:
1618
+ if args and 'dest' in kwargs:
1619
+ raise ValueError('dest supplied twice for positional argument')
1620
+ kwargs = self._get_positional_kwargs(*args, **kwargs)
1621
+
1622
+ # otherwise, we're adding an optional argument
1623
+ else:
1624
+ kwargs = self._get_optional_kwargs(*args, **kwargs)
1625
+
1626
+ # if no default was supplied, use the parser-level default
1627
+ if 'default' not in kwargs:
1628
+ dest = kwargs['dest']
1629
+ if dest in self._defaults:
1630
+ kwargs['default'] = self._defaults[dest]
1631
+ elif self.argument_default is not None:
1632
+ kwargs['default'] = self.argument_default
1633
+
1634
+ # create the action object, and add it to the parser
1635
+ action_class = self._pop_action_class(kwargs)
1636
+ if not _callable(action_class):
1637
+ raise ValueError('unknown action "%s"' % action_class)
1638
+ action = action_class(**kwargs)
1639
+
1640
+ # raise an error if the action type is not callable
1641
+ type_func = self._registry_get('type', action.type, action.type)
1642
+ if not _callable(type_func):
1643
+ raise ValueError('%r is not callable' % type_func)
1644
+
1645
+ return self._add_action(action)
1646
+
1647
+ def add_argument_group(self, *args, **kwargs):
1648
+ group = _ArgumentGroup(self, *args, **kwargs)
1649
+ self._action_groups.append(group)
1650
+ return group
1651
+
1652
+ def add_mutually_exclusive_group(self, **kwargs):
1653
+ group = _MutuallyExclusiveGroup(self, **kwargs)
1654
+ self._mutually_exclusive_groups.append(group)
1655
+ return group
1656
+
1657
+ def _add_action(self, action):
1658
+ # resolve any conflicts
1659
+ self._check_conflict(action)
1660
+
1661
+ # add to actions list
1662
+ self._actions.append(action)
1663
+ action.container = self
1664
+
1665
+ # index the action by any option strings it has
1666
+ for option_string in action.option_strings:
1667
+ self._option_string_actions[option_string] = action
1668
+
1669
+ # set the flag if any option strings look like negative numbers
1670
+ for option_string in action.option_strings:
1671
+ if self._negative_number_matcher.match(option_string):
1672
+ if not self._has_negative_number_optionals:
1673
+ self._has_negative_number_optionals.append(True)
1674
+
1675
+ # return the created action
1676
+ return action
1677
+
1678
+ def _remove_action(self, action):
1679
+ self._actions.remove(action)
1680
+
1681
+ def _add_container_actions(self, container):
1682
+ # collect groups by titles
1683
+ title_group_map = {}
1684
+ for group in self._action_groups:
1685
+ if group.title in title_group_map:
1686
+ msg = _('cannot merge actions - two groups are named %r')
1687
+ raise ValueError(msg % (group.title))
1688
+ title_group_map[group.title] = group
1689
+
1690
+ # map each action to its group
1691
+ group_map = {}
1692
+ for group in container._action_groups:
1693
+
1694
+ # if a group with the title exists, use that, otherwise
1695
+ # create a new group matching the container's group
1696
+ if group.title not in title_group_map:
1697
+ title_group_map[group.title] = self.add_argument_group(
1698
+ title=group.title,
1699
+ description=group.description,
1700
+ conflict_handler=group.conflict_handler)
1701
+
1702
+ # map the actions to their new group
1703
+ for action in group._group_actions:
1704
+ group_map[action] = title_group_map[group.title]
1705
+
1706
+ # add container's mutually exclusive groups
1707
+ # NOTE: if add_mutually_exclusive_group ever gains title= and
1708
+ # description= then this code will need to be expanded as above
1709
+ for group in container._mutually_exclusive_groups:
1710
+ mutex_group = self.add_mutually_exclusive_group(
1711
+ required=group.required)
1712
+
1713
+ # map the actions to their new mutex group
1714
+ for action in group._group_actions:
1715
+ group_map[action] = mutex_group
1716
+
1717
+ # add all actions to this container or their group
1718
+ for action in container._actions:
1719
+ group_map.get(action, self)._add_action(action)
1720
+
1721
+ def _get_positional_kwargs(self, dest, **kwargs):
1722
+ # make sure required is not specified
1723
+ if 'required' in kwargs:
1724
+ msg = _("'required' is an invalid argument for positionals")
1725
+ raise TypeError(msg)
1726
+
1727
+ # mark positional arguments as required if at least one is
1728
+ # always required
1729
+ if kwargs.get('nargs') not in [OPTIONAL, ZERO_OR_MORE]:
1730
+ kwargs['required'] = True
1731
+ if kwargs.get('nargs') == ZERO_OR_MORE and 'default' not in kwargs:
1732
+ kwargs['required'] = True
1733
+
1734
+ # return the keyword arguments with no option strings
1735
+ return dict(kwargs, dest=dest, option_strings=[])
1736
+
1737
+ def _get_optional_kwargs(self, *args, **kwargs):
1738
+ # determine short and long option strings
1739
+ option_strings = []
1740
+ long_option_strings = []
1741
+ for option_string in args:
1742
+ # error on strings that don't start with an appropriate prefix
1743
+ if not option_string[0] in self.prefix_chars:
1744
+ msg = _('invalid option string %r: '
1745
+ 'must start with a character %r')
1746
+ tup = option_string, self.prefix_chars
1747
+ raise ValueError(msg % tup)
1748
+
1749
+ # strings starting with two prefix characters are long options
1750
+ option_strings.append(option_string)
1751
+ if option_string[0] in self.prefix_chars:
1752
+ if len(option_string) > 1:
1753
+ if option_string[1] in self.prefix_chars:
1754
+ long_option_strings.append(option_string)
1755
+
1756
+ # infer destination, '--foo-bar' -> 'foo_bar' and '-x' -> 'x'
1757
+ dest = kwargs.pop('dest', None)
1758
+ if dest is None:
1759
+ if long_option_strings:
1760
+ dest_option_string = long_option_strings[0]
1761
+ else:
1762
+ dest_option_string = option_strings[0]
1763
+ dest = dest_option_string.lstrip(self.prefix_chars)
1764
+ if not dest:
1765
+ msg = _('dest= is required for options like %r')
1766
+ raise ValueError(msg % option_string)
1767
+ dest = dest.replace('-', '_')
1768
+
1769
+ # return the updated keyword arguments
1770
+ return dict(kwargs, dest=dest, option_strings=option_strings)
1771
+
1772
+ def _pop_action_class(self, kwargs, default=None):
1773
+ action = kwargs.pop('action', default)
1774
+ return self._registry_get('action', action, action)
1775
+
1776
+ def _get_handler(self):
1777
+ # determine function from conflict handler string
1778
+ handler_func_name = '_handle_conflict_%s' % self.conflict_handler
1779
+ try:
1780
+ return getattr(self, handler_func_name)
1781
+ except AttributeError:
1782
+ msg = _('invalid conflict_resolution value: %r')
1783
+ raise ValueError(msg % self.conflict_handler)
1784
+
1785
+ def _check_conflict(self, action):
1786
+
1787
+ # find all options that conflict with this option
1788
+ confl_optionals = []
1789
+ for option_string in action.option_strings:
1790
+ if option_string in self._option_string_actions:
1791
+ confl_optional = self._option_string_actions[option_string]
1792
+ confl_optionals.append((option_string, confl_optional))
1793
+
1794
+ # resolve any conflicts
1795
+ if confl_optionals:
1796
+ conflict_handler = self._get_handler()
1797
+ conflict_handler(action, confl_optionals)
1798
+
1799
+ def _handle_conflict_error(self, action, conflicting_actions):
1800
+ message = _('conflicting option string(s): %s')
1801
+ conflict_string = ', '.join([option_string
1802
+ for option_string, action
1803
+ in conflicting_actions])
1804
+ raise ArgumentError(action, message % conflict_string)
1805
+
1806
+ def _handle_conflict_resolve(self, action, conflicting_actions):
1807
+
1808
+ # remove all conflicting options
1809
+ for option_string, action in conflicting_actions:
1810
+
1811
+ # remove the conflicting option
1812
+ action.option_strings.remove(option_string)
1813
+ self._option_string_actions.pop(option_string, None)
1814
+
1815
+ # if the option now has no option string, remove it from the
1816
+ # container holding it
1817
+ if not action.option_strings:
1818
+ action.container._remove_action(action)
1819
+
1820
+
1821
+class _ArgumentGroup(_ActionsContainer):
1822
+
1823
+ def __init__(self, container, title=None, description=None, **kwargs):
1824
+ # add any missing keyword arguments by checking the container
1825
+ update = kwargs.setdefault
1826
+ update('conflict_handler', container.conflict_handler)
1827
+ update('prefix_chars', container.prefix_chars)
1828
+ update('argument_default', container.argument_default)
1829
+ super_init = super(_ArgumentGroup, self).__init__
1830
+ super_init(description=description, **kwargs)
1831
+
1832
+ # group attributes
1833
+ self.title = title
1834
+ self._group_actions = []
1835
+
1836
+ # share most attributes with the container
1837
+ self._registries = container._registries
1838
+ self._actions = container._actions
1839
+ self._option_string_actions = container._option_string_actions
1840
+ self._defaults = container._defaults
1841
+ self._has_negative_number_optionals = \
1842
+ container._has_negative_number_optionals
1843
+
1844
+ def _add_action(self, action):
1845
+ action = super(_ArgumentGroup, self)._add_action(action)
1846
+ self._group_actions.append(action)
1847
+ return action
1848
+
1849
+ def _remove_action(self, action):
1850
+ super(_ArgumentGroup, self)._remove_action(action)
1851
+ self._group_actions.remove(action)
1852
+
1853
+
1854
+class _MutuallyExclusiveGroup(_ArgumentGroup):
1855
+
1856
+ def __init__(self, container, required=False):
1857
+ super(_MutuallyExclusiveGroup, self).__init__(container)
1858
+ self.required = required
1859
+ self._container = container
1860
+
1861
+ def _add_action(self, action):
1862
+ if action.required:
1863
+ msg = _('mutually exclusive arguments must be optional')
1864
+ raise ValueError(msg)
1865
+ action = self._container._add_action(action)
1866
+ self._group_actions.append(action)
1867
+ return action
1868
+
1869
+ def _remove_action(self, action):
1870
+ self._container._remove_action(action)
1871
+ self._group_actions.remove(action)
1872
+
1873
+
1874
+class ArgumentParser(_AttributeHolder, _ActionsContainer):
1875
+ """Object for parsing command line strings into Python objects.
1876
+
1877
+ Keyword Arguments:
1878
+ - prog -- The name of the program (default: sys.argv[0])
1879
+ - usage -- A usage message (default: auto-generated from arguments)
1880
+ - description -- A description of what the program does
1881
+ - epilog -- Text following the argument descriptions
1882
+ - parents -- Parsers whose arguments should be copied into this one
1883
+ - formatter_class -- HelpFormatter class for printing help messages
1884
+ - prefix_chars -- Characters that prefix optional arguments
1885
+ - fromfile_prefix_chars -- Characters that prefix files containing
1886
+ additional arguments
1887
+ - argument_default -- The default value for all arguments
1888
+ - conflict_handler -- String indicating how to handle conflicts
1889
+ - add_help -- Add a -h/-help option
1890
+ """
1891
+
1892
+ def __init__(self,
1893
+ prog=None,
1894
+ usage=None,
1895
+ description=None,
1896
+ epilog=None,
1897
+ version=None,
1898
+ parents=[],
1899
+ formatter_class=HelpFormatter,
1900
+ prefix_chars='-',
1901
+ fromfile_prefix_chars=None,
1902
+ argument_default=None,
1903
+ conflict_handler='error',
1904
+ add_help=True):
1905
+
1906
+ if version is not None:
1907
+ import warnings
1908
+ warnings.warn(
1909
+ """The "version" argument to ArgumentParser is deprecated. """
1910
+ """Please use """
1911
+ """"add_argument(..., action='version', version="N", ...)" """
1912
+ """instead""", DeprecationWarning)
1913
+
1914
+ superinit = super(ArgumentParser, self).__init__
1915
+ superinit(description=description,
1916
+ prefix_chars=prefix_chars,
1917
+ argument_default=argument_default,
1918
+ conflict_handler=conflict_handler)
1919
+
1920
+ # default setting for prog
1921
+ if prog is None:
1922
+ prog = _os.path.basename(_sys.argv[0])
1923
+
1924
+ self.prog = prog
1925
+ self.usage = usage
1926
+ self.epilog = epilog
1927
+ self.version = version
1928
+ self.formatter_class = formatter_class
1929
+ self.fromfile_prefix_chars = fromfile_prefix_chars
1930
+ self.add_help = add_help
1931
+
1932
+ add_group = self.add_argument_group
1933
+ self._positionals = add_group(_('positional arguments'))
1934
+ self._optionals = add_group(_('optional arguments'))
1935
+ self._subparsers = None
1936
+
1937
+ # register types
1938
+ def identity(string):
1939
+ return string
1940
+ self.register('type', None, identity)
1941
+
1942
+ # add help and version arguments if necessary
1943
+ # (using explicit default to override global argument_default)
1944
+ if '-' in prefix_chars:
1945
+ default_prefix = '-'
1946
+ else:
1947
+ default_prefix = prefix_chars[0]
1948
+ if self.add_help:
1949
+ self.add_argument(
1950
+ default_prefix+'h', default_prefix*2+'help',
1951
+ action='help', default=SUPPRESS,
1952
+ help=_('show this help message and exit'))
1953
+ if self.version:
1954
+ self.add_argument(
1955
+ default_prefix+'v', default_prefix*2+'version',
1956
+ action='version', default=SUPPRESS,
1957
+ version=self.version,
1958
+ help=_("show program's version number and exit"))
1959
+
1960
+ # add parent arguments and defaults
1961
+ for parent in parents:
1962
+ self._add_container_actions(parent)
1963
+ try:
1964
+ defaults = parent._defaults
1965
+ except AttributeError:
1966
+ pass
1967
+ else:
1968
+ self._defaults.update(defaults)
1969
+
1970
+ # =======================
1971
+ # Pretty __repr__ methods
1972
+ # =======================
1973
+ def _get_kwargs(self):
1974
+ names = [
1975
+ 'prog',
1976
+ 'usage',
1977
+ 'description',
1978
+ 'version',
1979
+ 'formatter_class',
1980
+ 'conflict_handler',
1981
+ 'add_help',
1982
+ ]
1983
+ return [(name, getattr(self, name)) for name in names]
1984
+
1985
+ # ==================================
1986
+ # Optional/Positional adding methods
1987
+ # ==================================
1988
+ def add_subparsers(self, **kwargs):
1989
+ if self._subparsers is not None:
1990
+ self.error(_('cannot have multiple subparser arguments'))
1991
+
1992
+ # add the parser class to the arguments if it's not present
1993
+ kwargs.setdefault('parser_class', type(self))
1994
+
1995
+ if 'title' in kwargs or 'description' in kwargs:
1996
+ title = _(kwargs.pop('title', 'subcommands'))
1997
+ description = _(kwargs.pop('description', None))
1998
+ self._subparsers = self.add_argument_group(title, description)
1999
+ else:
2000
+ self._subparsers = self._positionals
2001
+
2002
+ # prog defaults to the usage message of this parser, skipping
2003
+ # optional arguments and with no "usage:" prefix
2004
+ if kwargs.get('prog') is None:
2005
+ formatter = self._get_formatter()
2006
+ positionals = self._get_positional_actions()
2007
+ groups = self._mutually_exclusive_groups
2008
+ formatter.add_usage(self.usage, positionals, groups, '')
2009
+ kwargs['prog'] = formatter.format_help().strip()
2010
+
2011
+ # create the parsers action and add it to the positionals list
2012
+ parsers_class = self._pop_action_class(kwargs, 'parsers')
2013
+ action = parsers_class(option_strings=[], **kwargs)
2014
+ self._subparsers._add_action(action)
2015
+
2016
+ # return the created parsers action
2017
+ return action
2018
+
2019
+ def _add_action(self, action):
2020
+ if action.option_strings:
2021
+ self._optionals._add_action(action)
2022
+ else:
2023
+ self._positionals._add_action(action)
2024
+ return action
2025
+
2026
+ def _get_optional_actions(self):
2027
+ return [action
2028
+ for action in self._actions
2029
+ if action.option_strings]
2030
+
2031
+ def _get_positional_actions(self):
2032
+ return [action
2033
+ for action in self._actions
2034
+ if not action.option_strings]
2035
+
2036
+ # =====================================
2037
+ # Command line argument parsing methods
2038
+ # =====================================
2039
+ def parse_args(self, args=None, namespace=None):
2040
+ args, argv = self.parse_known_args(args, namespace)
2041
+ if argv:
2042
+ msg = _('unrecognized arguments: %s')
2043
+ self.error(msg % ' '.join(argv))
2044
+ return args
2045
+
2046
+ def parse_known_args(self, args=None, namespace=None):
2047
+ # args default to the system args
2048
+ if args is None:
2049
+ args = _sys.argv[1:]
2050
+
2051
+ # default Namespace built from parser defaults
2052
+ if namespace is None:
2053
+ namespace = Namespace()
2054
+
2055
+ # add any action defaults that aren't present
2056
+ for action in self._actions:
2057
+ if action.dest is not SUPPRESS:
2058
+ if not hasattr(namespace, action.dest):
2059
+ if action.default is not SUPPRESS:
2060
+ setattr(namespace, action.dest, action.default)
2061
+
2062
+ # add any parser defaults that aren't present
2063
+ for dest in self._defaults:
2064
+ if not hasattr(namespace, dest):
2065
+ setattr(namespace, dest, self._defaults[dest])
2066
+
2067
+ # parse the arguments and exit if there are any errors
2068
+ try:
2069
+ namespace, args = self._parse_known_args(args, namespace)
2070
+ if hasattr(namespace, _UNRECOGNIZED_ARGS_ATTR):
2071
+ args.extend(getattr(namespace, _UNRECOGNIZED_ARGS_ATTR))
2072
+ delattr(namespace, _UNRECOGNIZED_ARGS_ATTR)
2073
+ return namespace, args
2074
+ except ArgumentError:
2075
+ err = _sys.exc_info()[1]
2076
+ self.error(str(err))
2077
+
2078
+ def _parse_known_args(self, arg_strings, namespace):
2079
+ # replace arg strings that are file references
2080
+ if self.fromfile_prefix_chars is not None:
2081
+ arg_strings = self._read_args_from_files(arg_strings)
2082
+
2083
+ # map all mutually exclusive arguments to the other arguments
2084
+ # they can't occur with
2085
+ action_conflicts = {}
2086
+ for mutex_group in self._mutually_exclusive_groups:
2087
+ group_actions = mutex_group._group_actions
2088
+ for i, mutex_action in enumerate(mutex_group._group_actions):
2089
+ conflicts = action_conflicts.setdefault(mutex_action, [])
2090
+ conflicts.extend(group_actions[:i])
2091
+ conflicts.extend(group_actions[i + 1:])
2092
+
2093
+ # find all option indices, and determine the arg_string_pattern
2094
+ # which has an 'O' if there is an option at an index,
2095
+ # an 'A' if there is an argument, or a '-' if there is a '--'
2096
+ option_string_indices = {}
2097
+ arg_string_pattern_parts = []
2098
+ arg_strings_iter = iter(arg_strings)
2099
+ for i, arg_string in enumerate(arg_strings_iter):
2100
+
2101
+ # all args after -- are non-options
2102
+ if arg_string == '--':
2103
+ arg_string_pattern_parts.append('-')
2104
+ for arg_string in arg_strings_iter:
2105
+ arg_string_pattern_parts.append('A')
2106
+
2107
+ # otherwise, add the arg to the arg strings
2108
+ # and note the index if it was an option
2109
+ else:
2110
+ option_tuple = self._parse_optional(arg_string)
2111
+ if option_tuple is None:
2112
+ pattern = 'A'
2113
+ else:
2114
+ option_string_indices[i] = option_tuple
2115
+ pattern = 'O'
2116
+ arg_string_pattern_parts.append(pattern)
2117
+
2118
+ # join the pieces together to form the pattern
2119
+ arg_strings_pattern = ''.join(arg_string_pattern_parts)
2120
+
2121
+ # converts arg strings to the appropriate and then takes the action
2122
+ seen_actions = set()
2123
+ seen_non_default_actions = set()
2124
+
2125
+ def take_action(action, argument_strings, option_string=None):
2126
+ seen_actions.add(action)
2127
+ argument_values = self._get_values(action, argument_strings)
2128
+
2129
+ # error if this argument is not allowed with other previously
2130
+ # seen arguments, assuming that actions that use the default
2131
+ # value don't really count as "present"
2132
+ if argument_values is not action.default:
2133
+ seen_non_default_actions.add(action)
2134
+ for conflict_action in action_conflicts.get(action, []):
2135
+ if conflict_action in seen_non_default_actions:
2136
+ msg = _('not allowed with argument %s')
2137
+ action_name = _get_action_name(conflict_action)
2138
+ raise ArgumentError(action, msg % action_name)
2139
+
2140
+ # take the action if we didn't receive a SUPPRESS value
2141
+ # (e.g. from a default)
2142
+ if argument_values is not SUPPRESS:
2143
+ action(self, namespace, argument_values, option_string)
2144
+
2145
+ # function to convert arg_strings into an optional action
2146
+ def consume_optional(start_index):
2147
+
2148
+ # get the optional identified at this index
2149
+ option_tuple = option_string_indices[start_index]
2150
+ action, option_string, explicit_arg = option_tuple
2151
+
2152
+ # identify additional optionals in the same arg string
2153
+ # (e.g. -xyz is the same as -x -y -z if no args are required)
2154
+ match_argument = self._match_argument
2155
+ action_tuples = []
2156
+ while True:
2157
+
2158
+ # if we found no optional action, skip it
2159
+ if action is None:
2160
+ extras.append(arg_strings[start_index])
2161
+ return start_index + 1
2162
+
2163
+ # if there is an explicit argument, try to match the
2164
+ # optional's string arguments to only this
2165
+ if explicit_arg is not None:
2166
+ arg_count = match_argument(action, 'A')
2167
+
2168
+ # if the action is a single-dash option and takes no
2169
+ # arguments, try to parse more single-dash options out
2170
+ # of the tail of the option string
2171
+ chars = self.prefix_chars
2172
+ if arg_count == 0 and option_string[1] not in chars:
2173
+ action_tuples.append((action, [], option_string))
2174
+ char = option_string[0]
2175
+ option_string = char + explicit_arg[0]
2176
+ new_explicit_arg = explicit_arg[1:] or None
2177
+ optionals_map = self._option_string_actions
2178
+ if option_string in optionals_map:
2179
+ action = optionals_map[option_string]
2180
+ explicit_arg = new_explicit_arg
2181
+ else:
2182
+ msg = _('ignored explicit argument %r')
2183
+ raise ArgumentError(action, msg % explicit_arg)
2184
+
2185
+ # if the action expect exactly one argument, we've
2186
+ # successfully matched the option; exit the loop
2187
+ elif arg_count == 1:
2188
+ stop = start_index + 1
2189
+ args = [explicit_arg]
2190
+ action_tuples.append((action, args, option_string))
2191
+ break
2192
+
2193
+ # error if a double-dash option did not use the
2194
+ # explicit argument
2195
+ else:
2196
+ msg = _('ignored explicit argument %r')
2197
+ raise ArgumentError(action, msg % explicit_arg)
2198
+
2199
+ # if there is no explicit argument, try to match the
2200
+ # optional's string arguments with the following strings
2201
+ # if successful, exit the loop
2202
+ else:
2203
+ start = start_index + 1
2204
+ selected_patterns = arg_strings_pattern[start:]
2205
+ arg_count = match_argument(action, selected_patterns)
2206
+ stop = start + arg_count
2207
+ args = arg_strings[start:stop]
2208
+ action_tuples.append((action, args, option_string))
2209
+ break
2210
+
2211
+ # add the Optional to the list and return the index at which
2212
+ # the Optional's string args stopped
2213
+ assert action_tuples
2214
+ for action, args, option_string in action_tuples:
2215
+ take_action(action, args, option_string)
2216
+ return stop
2217
+
2218
+ # the list of Positionals left to be parsed; this is modified
2219
+ # by consume_positionals()
2220
+ positionals = self._get_positional_actions()
2221
+
2222
+ # function to convert arg_strings into positional actions
2223
+ def consume_positionals(start_index):
2224
+ # match as many Positionals as possible
2225
+ match_partial = self._match_arguments_partial
2226
+ selected_pattern = arg_strings_pattern[start_index:]
2227
+ arg_counts = match_partial(positionals, selected_pattern)
2228
+
2229
+ # slice off the appropriate arg strings for each Positional
2230
+ # and add the Positional and its args to the list
2231
+ for action, arg_count in zip(positionals, arg_counts):
2232
+ args = arg_strings[start_index: start_index + arg_count]
2233
+ start_index += arg_count
2234
+ take_action(action, args)
2235
+
2236
+ # slice off the Positionals that we just parsed and return the
2237
+ # index at which the Positionals' string args stopped
2238
+ positionals[:] = positionals[len(arg_counts):]
2239
+ return start_index
2240
+
2241
+ # consume Positionals and Optionals alternately, until we have
2242
+ # passed the last option string
2243
+ extras = []
2244
+ start_index = 0
2245
+ if option_string_indices:
2246
+ max_option_string_index = max(option_string_indices)
2247
+ else:
2248
+ max_option_string_index = -1
2249
+ while start_index <= max_option_string_index:
2250
+
2251
+ # consume any Positionals preceding the next option
2252
+ next_option_string_index = min([
2253
+ index
2254
+ for index in option_string_indices
2255
+ if index >= start_index])
2256
+ if start_index != next_option_string_index:
2257
+ positionals_end_index = consume_positionals(start_index)
2258
+
2259
+ # only try to parse the next optional if we didn't consume
2260
+ # the option string during the positionals parsing
2261
+ if positionals_end_index > start_index:
2262
+ start_index = positionals_end_index
2263
+ continue
2264
+ else:
2265
+ start_index = positionals_end_index
2266
+
2267
+ # if we consumed all the positionals we could and we're not
2268
+ # at the index of an option string, there were extra arguments
2269
+ if start_index not in option_string_indices:
2270
+ strings = arg_strings[start_index:next_option_string_index]
2271
+ extras.extend(strings)
2272
+ start_index = next_option_string_index
2273
+
2274
+ # consume the next optional and any arguments for it
2275
+ start_index = consume_optional(start_index)
2276
+
2277
+ # consume any positionals following the last Optional
2278
+ stop_index = consume_positionals(start_index)
2279
+
2280
+ # if we didn't consume all the argument strings, there were extras
2281
+ extras.extend(arg_strings[stop_index:])
2282
+
2283
+ # if we didn't use all the Positional objects, there were too few
2284
+ # arg strings supplied.
2285
+ if positionals:
2286
+ self.error(_('too few arguments'))
2287
+
2288
+ # make sure all required actions were present, and convert defaults.
2289
+ for action in self._actions:
2290
+ if action not in seen_actions:
2291
+ if action.required:
2292
+ name = _get_action_name(action)
2293
+ self.error(_('argument %s is required') % name)
2294
+ else:
2295
+ # Convert action default now instead of doing it before
2296
+ # parsing arguments to avoid calling convert functions
2297
+ # twice (which may fail) if the argument was given, but
2298
+ # only if it was defined already in the namespace
2299
+ if (action.default is not None and
2300
+ isinstance(action.default, basestring) and
2301
+ hasattr(namespace, action.dest) and
2302
+ action.default is getattr(namespace, action.dest)):
2303
+ setattr(namespace, action.dest,
2304
+ self._get_value(action, action.default))
2305
+
2306
+ # make sure all required groups had one option present
2307
+ for group in self._mutually_exclusive_groups:
2308
+ if group.required:
2309
+ for action in group._group_actions:
2310
+ if action in seen_non_default_actions:
2311
+ break
2312
+
2313
+ # if no actions were used, report the error
2314
+ else:
2315
+ names = [_get_action_name(action)
2316
+ for action in group._group_actions
2317
+ if action.help is not SUPPRESS]
2318
+ msg = _('one of the arguments %s is required')
2319
+ self.error(msg % ' '.join(names))
2320
+
2321
+ # return the updated namespace and the extra arguments
2322
+ return namespace, extras
2323
+
2324
+ def _read_args_from_files(self, arg_strings):
2325
+ # expand arguments referencing files
2326
+ new_arg_strings = []
2327
+ for arg_string in arg_strings:
2328
+
2329
+ # for regular arguments, just add them back into the list
2330
+ if arg_string[0] not in self.fromfile_prefix_chars:
2331
+ new_arg_strings.append(arg_string)
2332
+
2333
+ # replace arguments referencing files with the file content
2334
+ else:
2335
+ try:
2336
+ args_file = open(arg_string[1:])
2337
+ try:
2338
+ arg_strings = []
2339
+ for arg_line in args_file.read().splitlines():
2340
+ for arg in self.convert_arg_line_to_args(arg_line):
2341
+ arg_strings.append(arg)
2342
+ arg_strings = self._read_args_from_files(arg_strings)
2343
+ new_arg_strings.extend(arg_strings)
2344
+ finally:
2345
+ args_file.close()
2346
+ except IOError:
2347
+ err = _sys.exc_info()[1]
2348
+ self.error(str(err))
2349
+
2350
+ # return the modified argument list
2351
+ return new_arg_strings
2352
+
2353
+ def convert_arg_line_to_args(self, arg_line):
2354
+ return [arg_line]
2355
+
2356
+ def _match_argument(self, action, arg_strings_pattern):
2357
+ # match the pattern for this action to the arg strings
2358
+ nargs_pattern = self._get_nargs_pattern(action)
2359
+ match = _re.match(nargs_pattern, arg_strings_pattern)
2360
+
2361
+ # raise an exception if we weren't able to find a match
2362
+ if match is None:
2363
+ nargs_errors = {
2364
+ None: _('expected one argument'),
2365
+ OPTIONAL: _('expected at most one argument'),
2366
+ ONE_OR_MORE: _('expected at least one argument'),
2367
+ }
2368
+ default = _('expected %s argument(s)') % action.nargs
2369
+ msg = nargs_errors.get(action.nargs, default)
2370
+ raise ArgumentError(action, msg)
2371
+
2372
+ # return the number of arguments matched
2373
+ return len(match.group(1))
2374
+
2375
+ def _match_arguments_partial(self, actions, arg_strings_pattern):
2376
+ # progressively shorten the actions list by slicing off the
2377
+ # final actions until we find a match
2378
+ result = []
2379
+ for i in range(len(actions), 0, -1):
2380
+ actions_slice = actions[:i]
2381
+ pattern = ''.join([self._get_nargs_pattern(action)
2382
+ for action in actions_slice])
2383
+ match = _re.match(pattern, arg_strings_pattern)
2384
+ if match is not None:
2385
+ result.extend([len(string) for string in match.groups()])
2386
+ break
2387
+
2388
+ # return the list of arg string counts
2389
+ return result
2390
+
2391
+ def _parse_optional(self, arg_string):
2392
+ # if it's an empty string, it was meant to be a positional
2393
+ if not arg_string:
2394
+ return None
2395
+
2396
+ # if it doesn't start with a prefix, it was meant to be positional
2397
+ if not arg_string[0] in self.prefix_chars:
2398
+ return None
2399
+
2400
+ # if the option string is present in the parser, return the action
2401
+ if arg_string in self._option_string_actions:
2402
+ action = self._option_string_actions[arg_string]
2403
+ return action, arg_string, None
2404
+
2405
+ # if it's just a single character, it was meant to be positional
2406
+ if len(arg_string) == 1:
2407
+ return None
2408
+
2409
+ # if the option string before the "=" is present, return the action
2410
+ if '=' in arg_string:
2411
+ option_string, explicit_arg = arg_string.split('=', 1)
2412
+ if option_string in self._option_string_actions:
2413
+ action = self._option_string_actions[option_string]
2414
+ return action, option_string, explicit_arg
2415
+
2416
+ # search through all possible prefixes of the option string
2417
+ # and all actions in the parser for possible interpretations
2418
+ option_tuples = self._get_option_tuples(arg_string)
2419
+
2420
+ # if multiple actions match, the option string was ambiguous
2421
+ if len(option_tuples) > 1:
2422
+ options = ', '.join([option_string
2423
+ for action, option_string, explicit_arg in option_tuples])
2424
+ tup = arg_string, options
2425
+ self.error(_('ambiguous option: %s could match %s') % tup)
2426
+
2427
+ # if exactly one action matched, this segmentation is good,
2428
+ # so return the parsed action
2429
+ elif len(option_tuples) == 1:
2430
+ option_tuple, = option_tuples
2431
+ return option_tuple
2432
+
2433
+ # if it was not found as an option, but it looks like a negative
2434
+ # number, it was meant to be positional
2435
+ # unless there are negative-number-like options
2436
+ if self._negative_number_matcher.match(arg_string):
2437
+ if not self._has_negative_number_optionals:
2438
+ return None
2439
+
2440
+ # if it contains a space, it was meant to be a positional
2441
+ if ' ' in arg_string:
2442
+ return None
2443
+
2444
+ # it was meant to be an optional but there is no such option
2445
+ # in this parser (though it might be a valid option in a subparser)
2446
+ return None, arg_string, None
2447
+
2448
+ def _get_option_tuples(self, option_string):
2449
+ result = []
2450
+
2451
+ # option strings starting with two prefix characters are only
2452
+ # split at the '='
2453
+ chars = self.prefix_chars
2454
+ if option_string[0] in chars and option_string[1] in chars:
2455
+ if '=' in option_string:
2456
+ option_prefix, explicit_arg = option_string.split('=', 1)
2457
+ else:
2458
+ option_prefix = option_string
2459
+ explicit_arg = None
2460
+ for option_string in self._option_string_actions:
2461
+ if option_string.startswith(option_prefix):
2462
+ action = self._option_string_actions[option_string]
2463
+ tup = action, option_string, explicit_arg
2464
+ result.append(tup)
2465
+
2466
+ # single character options can be concatenated with their arguments
2467
+ # but multiple character options always have to have their argument
2468
+ # separate
2469
+ elif option_string[0] in chars and option_string[1] not in chars:
2470
+ option_prefix = option_string
2471
+ explicit_arg = None
2472
+ short_option_prefix = option_string[:2]
2473
+ short_explicit_arg = option_string[2:]
2474
+
2475
+ for option_string in self._option_string_actions:
2476
+ if option_string == short_option_prefix:
2477
+ action = self._option_string_actions[option_string]
2478
+ tup = action, option_string, short_explicit_arg
2479
+ result.append(tup)
2480
+ elif option_string.startswith(option_prefix):
2481
+ action = self._option_string_actions[option_string]
2482
+ tup = action, option_string, explicit_arg
2483
+ result.append(tup)
2484
+
2485
+ # shouldn't ever get here
2486
+ else:
2487
+ self.error(_('unexpected option string: %s') % option_string)
2488
+
2489
+ # return the collected option tuples
2490
+ return result
2491
+
2492
+ def _get_nargs_pattern(self, action):
2493
+ # in all examples below, we have to allow for '--' args
2494
+ # which are represented as '-' in the pattern
2495
+ nargs = action.nargs
2496
+
2497
+ # the default (None) is assumed to be a single argument
2498
+ if nargs is None:
2499
+ nargs_pattern = '(-*A-*)'
2500
+
2501
+ # allow zero or one arguments
2502
+ elif nargs == OPTIONAL:
2503
+ nargs_pattern = '(-*A?-*)'
2504
+
2505
+ # allow zero or more arguments
2506
+ elif nargs == ZERO_OR_MORE:
2507
+ nargs_pattern = '(-*[A-]*)'
2508
+
2509
+ # allow one or more arguments
2510
+ elif nargs == ONE_OR_MORE:
2511
+ nargs_pattern = '(-*A[A-]*)'
2512
+
2513
+ # allow any number of options or arguments
2514
+ elif nargs == REMAINDER:
2515
+ nargs_pattern = '([-AO]*)'
2516
+
2517
+ # allow one argument followed by any number of options or arguments
2518
+ elif nargs == PARSER:
2519
+ nargs_pattern = '(-*A[-AO]*)'
2520
+
2521
+ # all others should be integers
2522
+ else:
2523
+ nargs_pattern = '(-*%s-*)' % '-*'.join('A' * nargs)
2524
+
2525
+ # if this is an optional action, -- is not allowed
2526
+ if action.option_strings:
2527
+ nargs_pattern = nargs_pattern.replace('-*', '')
2528
+ nargs_pattern = nargs_pattern.replace('-', '')
2529
+
2530
+ # return the pattern
2531
+ return nargs_pattern
2532
+
2533
+ # ========================
2534
+ # Value conversion methods
2535
+ # ========================
2536
+ def _get_values(self, action, arg_strings):
2537
+ # for everything but PARSER args, strip out '--'
2538
+ if action.nargs not in [PARSER, REMAINDER]:
2539
+ arg_strings = [s for s in arg_strings if s != '--']
2540
+
2541
+ # optional argument produces a default when not present
2542
+ if not arg_strings and action.nargs == OPTIONAL:
2543
+ if action.option_strings:
2544
+ value = action.const
2545
+ else:
2546
+ value = action.default
2547
+ if isinstance(value, basestring):
2548
+ value = self._get_value(action, value)
2549
+ self._check_value(action, value)
2550
+
2551
+ # when nargs='*' on a positional, if there were no command-line
2552
+ # args, use the default if it is anything other than None
2553
+ elif (not arg_strings and action.nargs == ZERO_OR_MORE and
2554
+ not action.option_strings):
2555
+ if action.default is not None:
2556
+ value = action.default
2557
+ else:
2558
+ value = arg_strings
2559
+ self._check_value(action, value)
2560
+
2561
+ # single argument or optional argument produces a single value
2562
+ elif len(arg_strings) == 1 and action.nargs in [None, OPTIONAL]:
2563
+ arg_string, = arg_strings
2564
+ value = self._get_value(action, arg_string)
2565
+ self._check_value(action, value)
2566
+
2567
+ # REMAINDER arguments convert all values, checking none
2568
+ elif action.nargs == REMAINDER:
2569
+ value = [self._get_value(action, v) for v in arg_strings]
2570
+
2571
+ # PARSER arguments convert all values, but check only the first
2572
+ elif action.nargs == PARSER:
2573
+ value = [self._get_value(action, v) for v in arg_strings]
2574
+ self._check_value(action, value[0])
2575
+
2576
+ # all other types of nargs produce a list
2577
+ else:
2578
+ value = [self._get_value(action, v) for v in arg_strings]
2579
+ for v in value:
2580
+ self._check_value(action, v)
2581
+
2582
+ # return the converted value
2583
+ return value
2584
+
2585
+ def _get_value(self, action, arg_string):
2586
+ type_func = self._registry_get('type', action.type, action.type)
2587
+ if not _callable(type_func):
2588
+ msg = _('%r is not callable')
2589
+ raise ArgumentError(action, msg % type_func)
2590
+
2591
+ # convert the value to the appropriate type
2592
+ try:
2593
+ result = type_func(arg_string)
2594
+
2595
+ # ArgumentTypeErrors indicate errors
2596
+ except ArgumentTypeError:
2597
+ name = getattr(action.type, '__name__', repr(action.type))
2598
+ msg = str(_sys.exc_info()[1])
2599
+ raise ArgumentError(action, msg)
2600
+
2601
+ # TypeErrors or ValueErrors also indicate errors
2602
+ except (TypeError, ValueError):
2603
+ name = getattr(action.type, '__name__', repr(action.type))
2604
+ msg = _('invalid %s value: %r')
2605
+ raise ArgumentError(action, msg % (name, arg_string))
2606
+
2607
+ # return the converted value
2608
+ return result
2609
+
2610
+ def _check_value(self, action, value):
2611
+ # converted value must be one of the choices (if specified)
2612
+ if action.choices is not None and value not in action.choices:
2613
+ tup = value, ', '.join(map(repr, action.choices))
2614
+ msg = _('invalid choice: %r (choose from %s)') % tup
2615
+ raise ArgumentError(action, msg)
2616
+
2617
+ # =======================
2618
+ # Help-formatting methods
2619
+ # =======================
2620
+ def format_usage(self):
2621
+ formatter = self._get_formatter()
2622
+ formatter.add_usage(self.usage, self._actions,
2623
+ self._mutually_exclusive_groups)
2624
+ return formatter.format_help()
2625
+
2626
+ def format_help(self):
2627
+ formatter = self._get_formatter()
2628
+
2629
+ # usage
2630
+ formatter.add_usage(self.usage, self._actions,
2631
+ self._mutually_exclusive_groups)
2632
+
2633
+ # description
2634
+ formatter.add_text(self.description)
2635
+
2636
+ # positionals, optionals and user-defined groups
2637
+ for action_group in self._action_groups:
2638
+ formatter.start_section(action_group.title)
2639
+ formatter.add_text(action_group.description)
2640
+ formatter.add_arguments(action_group._group_actions)
2641
+ formatter.end_section()
2642
+
2643
+ # epilog
2644
+ formatter.add_text(self.epilog)
2645
+
2646
+ # determine help from format above
2647
+ return formatter.format_help()
2648
+
2649
+ def format_version(self):
2650
+ import warnings
2651
+ warnings.warn(
2652
+ 'The format_version method is deprecated -- the "version" '
2653
+ 'argument to ArgumentParser is no longer supported.',
2654
+ DeprecationWarning)
2655
+ formatter = self._get_formatter()
2656
+ formatter.add_text(self.version)
2657
+ return formatter.format_help()
2658
+
2659
+ def _get_formatter(self):
2660
+ return self.formatter_class(prog=self.prog)
2661
+
2662
+ # =====================
2663
+ # Help-printing methods
2664
+ # =====================
2665
+ def print_usage(self, file=None):
2666
+ if file is None:
2667
+ file = _sys.stdout
2668
+ self._print_message(self.format_usage(), file)
2669
+
2670
+ def print_help(self, file=None):
2671
+ if file is None:
2672
+ file = _sys.stdout
2673
+ self._print_message(self.format_help(), file)
2674
+
2675
+ def print_version(self, file=None):
2676
+ import warnings
2677
+ warnings.warn(
2678
+ 'The print_version method is deprecated -- the "version" '
2679
+ 'argument to ArgumentParser is no longer supported.',
2680
+ DeprecationWarning)
2681
+ self._print_message(self.format_version(), file)
2682
+
2683
+ def _print_message(self, message, file=None):
2684
+ if message:
2685
+ if file is None:
2686
+ file = _sys.stderr
2687
+ file.write(message)
2688
+
2689
+ # ===============
2690
+ # Exiting methods
2691
+ # ===============
2692
+ def exit(self, status=0, message=None):
2693
+ if message:
2694
+ self._print_message(message, _sys.stderr)
2695
+ _sys.exit(status)
2696
+
2697
+ def error(self, message):
2698
+ """error(message: string)
2699
+
2700
+ Prints a usage message incorporating the message to stderr and
2701
+ exits.
2702
+
2703
+ If you override this in a subclass, it should not return -- it
2704
+ should either exit or raise an exception.
2705
+ """
2706
+ self.print_usage(_sys.stderr)
2707
+ self.exit(2, _('%s: error: %s\n') % (self.prog, message))
2708
--
449
--
2709
2.13.5
450
2.21.0
2710
451
2711
452
diff view generated by jsdifflib
New patch
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
1
2
3
Use thread_pool_submit_co, instead of reinventing it here. Note, that
4
thread_pool_submit_aio() never returns NULL, so checking it was an
5
extra thing.
6
7
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
8
Reviewed-by: Alberto Garcia <berto@igalia.com>
9
Reviewed-by: Max Reitz <mreitz@redhat.com>
10
Message-id: 20190506142741.41731-4-vsementsov@virtuozzo.com
11
Signed-off-by: Max Reitz <mreitz@redhat.com>
12
---
13
block/qcow2-threads.c | 17 ++---------------
14
1 file changed, 2 insertions(+), 15 deletions(-)
15
16
diff --git a/block/qcow2-threads.c b/block/qcow2-threads.c
17
index XXXXXXX..XXXXXXX 100644
18
--- a/block/qcow2-threads.c
19
+++ b/block/qcow2-threads.c
20
@@ -XXX,XX +XXX,XX @@ static int qcow2_compress_pool_func(void *opaque)
21
return 0;
22
}
23
24
-static void qcow2_compress_complete(void *opaque, int ret)
25
-{
26
- qemu_coroutine_enter(opaque);
27
-}
28
-
29
static ssize_t coroutine_fn
30
qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
31
const void *src, size_t src_size, Qcow2CompressFunc func)
32
{
33
BDRVQcow2State *s = bs->opaque;
34
- BlockAIOCB *acb;
35
ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
36
Qcow2CompressData arg = {
37
.dest = dest,
38
@@ -XXX,XX +XXX,XX @@ qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
39
}
40
41
s->nb_compress_threads++;
42
- acb = thread_pool_submit_aio(pool, qcow2_compress_pool_func, &arg,
43
- qcow2_compress_complete,
44
- qemu_coroutine_self());
45
-
46
- if (!acb) {
47
- s->nb_compress_threads--;
48
- return -EINVAL;
49
- }
50
- qemu_coroutine_yield();
51
+ thread_pool_submit_co(pool, qcow2_compress_pool_func, &arg);
52
s->nb_compress_threads--;
53
+
54
qemu_co_queue_next(&s->compress_wait_queue);
55
56
return arg.ret;
57
--
58
2.21.0
59
60
diff view generated by jsdifflib
New patch
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
1
2
3
Drop dependence on AioContext lock.
4
5
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
6
Reviewed-by: Alberto Garcia <berto@igalia.com>
7
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
8
Reviewed-by: Max Reitz <mreitz@redhat.com>
9
Message-id: 20190506142741.41731-5-vsementsov@virtuozzo.com
10
Signed-off-by: Max Reitz <mreitz@redhat.com>
11
---
12
block/qcow2-threads.c | 10 +++++++---
13
1 file changed, 7 insertions(+), 3 deletions(-)
14
15
diff --git a/block/qcow2-threads.c b/block/qcow2-threads.c
16
index XXXXXXX..XXXXXXX 100644
17
--- a/block/qcow2-threads.c
18
+++ b/block/qcow2-threads.c
19
@@ -XXX,XX +XXX,XX @@ qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
20
.func = func,
21
};
22
23
+ qemu_co_mutex_lock(&s->lock);
24
while (s->nb_compress_threads >= MAX_COMPRESS_THREADS) {
25
- qemu_co_queue_wait(&s->compress_wait_queue, NULL);
26
+ qemu_co_queue_wait(&s->compress_wait_queue, &s->lock);
27
}
28
-
29
s->nb_compress_threads++;
30
+ qemu_co_mutex_unlock(&s->lock);
31
+
32
thread_pool_submit_co(pool, qcow2_compress_pool_func, &arg);
33
- s->nb_compress_threads--;
34
35
+ qemu_co_mutex_lock(&s->lock);
36
+ s->nb_compress_threads--;
37
qemu_co_queue_next(&s->compress_wait_queue);
38
+ qemu_co_mutex_unlock(&s->lock);
39
40
return arg.ret;
41
}
42
--
43
2.21.0
44
45
diff view generated by jsdifflib
New patch
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
1
2
3
Move generic part out of qcow2_co_do_compress, to reuse it for
4
encryption and rename things that would be shared with encryption path.
5
6
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
7
Reviewed-by: Alberto Garcia <berto@igalia.com>
8
Reviewed-by: Max Reitz <mreitz@redhat.com>
9
Message-id: 20190506142741.41731-6-vsementsov@virtuozzo.com
10
Signed-off-by: Max Reitz <mreitz@redhat.com>
11
---
12
block/qcow2.h | 4 ++--
13
block/qcow2-threads.c | 47 ++++++++++++++++++++++++++++---------------
14
block/qcow2.c | 2 +-
15
3 files changed, 34 insertions(+), 19 deletions(-)
16
17
diff --git a/block/qcow2.h b/block/qcow2.h
18
index XXXXXXX..XXXXXXX 100644
19
--- a/block/qcow2.h
20
+++ b/block/qcow2.h
21
@@ -XXX,XX +XXX,XX @@ typedef struct BDRVQcow2State {
22
char *image_backing_format;
23
char *image_data_file;
24
25
- CoQueue compress_wait_queue;
26
- int nb_compress_threads;
27
+ CoQueue thread_task_queue;
28
+ int nb_threads;
29
30
BdrvChild *data_file;
31
} BDRVQcow2State;
32
diff --git a/block/qcow2-threads.c b/block/qcow2-threads.c
33
index XXXXXXX..XXXXXXX 100644
34
--- a/block/qcow2-threads.c
35
+++ b/block/qcow2-threads.c
36
@@ -XXX,XX +XXX,XX @@
37
#include "qcow2.h"
38
#include "block/thread-pool.h"
39
40
-#define MAX_COMPRESS_THREADS 4
41
+#define QCOW2_MAX_THREADS 4
42
+
43
+static int coroutine_fn
44
+qcow2_co_process(BlockDriverState *bs, ThreadPoolFunc *func, void *arg)
45
+{
46
+ int ret;
47
+ BDRVQcow2State *s = bs->opaque;
48
+ ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
49
+
50
+ qemu_co_mutex_lock(&s->lock);
51
+ while (s->nb_threads >= QCOW2_MAX_THREADS) {
52
+ qemu_co_queue_wait(&s->thread_task_queue, &s->lock);
53
+ }
54
+ s->nb_threads++;
55
+ qemu_co_mutex_unlock(&s->lock);
56
+
57
+ ret = thread_pool_submit_co(pool, func, arg);
58
+
59
+ qemu_co_mutex_lock(&s->lock);
60
+ s->nb_threads--;
61
+ qemu_co_queue_next(&s->thread_task_queue);
62
+ qemu_co_mutex_unlock(&s->lock);
63
+
64
+ return ret;
65
+}
66
+
67
+
68
+/*
69
+ * Compression
70
+ */
71
72
typedef ssize_t (*Qcow2CompressFunc)(void *dest, size_t dest_size,
73
const void *src, size_t src_size);
74
@@ -XXX,XX +XXX,XX @@ static ssize_t coroutine_fn
75
qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
76
const void *src, size_t src_size, Qcow2CompressFunc func)
77
{
78
- BDRVQcow2State *s = bs->opaque;
79
- ThreadPool *pool = aio_get_thread_pool(bdrv_get_aio_context(bs));
80
Qcow2CompressData arg = {
81
.dest = dest,
82
.dest_size = dest_size,
83
@@ -XXX,XX +XXX,XX @@ qcow2_co_do_compress(BlockDriverState *bs, void *dest, size_t dest_size,
84
.func = func,
85
};
86
87
- qemu_co_mutex_lock(&s->lock);
88
- while (s->nb_compress_threads >= MAX_COMPRESS_THREADS) {
89
- qemu_co_queue_wait(&s->compress_wait_queue, &s->lock);
90
- }
91
- s->nb_compress_threads++;
92
- qemu_co_mutex_unlock(&s->lock);
93
-
94
- thread_pool_submit_co(pool, qcow2_compress_pool_func, &arg);
95
-
96
- qemu_co_mutex_lock(&s->lock);
97
- s->nb_compress_threads--;
98
- qemu_co_queue_next(&s->compress_wait_queue);
99
- qemu_co_mutex_unlock(&s->lock);
100
+ qcow2_co_process(bs, qcow2_compress_pool_func, &arg);
101
102
return arg.ret;
103
}
104
diff --git a/block/qcow2.c b/block/qcow2.c
105
index XXXXXXX..XXXXXXX 100644
106
--- a/block/qcow2.c
107
+++ b/block/qcow2.c
108
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn qcow2_do_open(BlockDriverState *bs, QDict *options,
109
}
110
#endif
111
112
- qemu_co_queue_init(&s->compress_wait_queue);
113
+ qemu_co_queue_init(&s->thread_task_queue);
114
115
return ret;
116
117
--
118
2.21.0
119
120
diff view generated by jsdifflib
New patch
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
1
2
3
Background: decryption will be done in threads, to take benefit of it,
4
we should move it out of the lock first.
5
6
But let's go further: it turns out, that only
7
qcow2_get_cluster_offset() needs locking, so reduce locking to it.
8
9
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
10
Message-id: 20190506142741.41731-7-vsementsov@virtuozzo.com
11
Reviewed-by: Alberto Garcia <berto@igalia.com>
12
Signed-off-by: Max Reitz <mreitz@redhat.com>
13
---
14
block/qcow2.c | 12 ++----------
15
1 file changed, 2 insertions(+), 10 deletions(-)
16
17
diff --git a/block/qcow2.c b/block/qcow2.c
18
index XXXXXXX..XXXXXXX 100644
19
--- a/block/qcow2.c
20
+++ b/block/qcow2.c
21
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
22
23
qemu_iovec_init(&hd_qiov, qiov->niov);
24
25
- qemu_co_mutex_lock(&s->lock);
26
-
27
while (bytes != 0) {
28
29
/* prepare next request */
30
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
31
QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
32
}
33
34
+ qemu_co_mutex_lock(&s->lock);
35
ret = qcow2_get_cluster_offset(bs, offset, &cur_bytes, &cluster_offset);
36
+ qemu_co_mutex_unlock(&s->lock);
37
if (ret < 0) {
38
goto fail;
39
}
40
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
41
42
if (bs->backing) {
43
BLKDBG_EVENT(bs->file, BLKDBG_READ_BACKING_AIO);
44
- qemu_co_mutex_unlock(&s->lock);
45
ret = bdrv_co_preadv(bs->backing, offset, cur_bytes,
46
&hd_qiov, 0);
47
- qemu_co_mutex_lock(&s->lock);
48
if (ret < 0) {
49
goto fail;
50
}
51
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
52
break;
53
54
case QCOW2_CLUSTER_COMPRESSED:
55
- qemu_co_mutex_unlock(&s->lock);
56
ret = qcow2_co_preadv_compressed(bs, cluster_offset,
57
offset, cur_bytes,
58
&hd_qiov);
59
- qemu_co_mutex_lock(&s->lock);
60
if (ret < 0) {
61
goto fail;
62
}
63
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
64
}
65
66
BLKDBG_EVENT(bs->file, BLKDBG_READ_AIO);
67
- qemu_co_mutex_unlock(&s->lock);
68
ret = bdrv_co_preadv(s->data_file,
69
cluster_offset + offset_in_cluster,
70
cur_bytes, &hd_qiov, 0);
71
- qemu_co_mutex_lock(&s->lock);
72
if (ret < 0) {
73
goto fail;
74
}
75
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
76
ret = 0;
77
78
fail:
79
- qemu_co_mutex_unlock(&s->lock);
80
-
81
qemu_iovec_destroy(&hd_qiov);
82
qemu_vfree(cluster_data);
83
84
--
85
2.21.0
86
87
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
2
3
LeakyBucket.burst_length is defined as an unsigned integer but the
3
Encryption will be done in threads, to take benefit of it, we should
4
code never checks for overflows and it only makes sure that the value
4
move it out of the lock first.
5
is not 0.
6
5
7
In practice this means that the user can set something like
6
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
8
throttling.iops-total-max-length=4294967300 despite being larger than
7
Reviewed-by: Alberto Garcia <berto@igalia.com>
9
UINT_MAX and the final value after casting to unsigned int will be 4.
8
Reviewed-by: Max Reitz <mreitz@redhat.com>
9
Message-id: 20190506142741.41731-8-vsementsov@virtuozzo.com
10
Signed-off-by: Max Reitz <mreitz@redhat.com>
11
---
12
block/qcow2.c | 35 +++++++++++++++++++++--------------
13
1 file changed, 21 insertions(+), 14 deletions(-)
10
14
11
This patch changes the data type to uint64_t. This does not increase
15
diff --git a/block/qcow2.c b/block/qcow2.c
12
the storage size of LeakyBucket, and allows us to assign the value
13
directly from qemu_opt_get_number() or BlockIOThrottle and then do the
14
checks directly in throttle_is_valid().
15
16
The value of burst_length does not have a specific upper limit,
17
but since the bucket size is defined by max * burst_length we have
18
to prevent overflows. Instead of going for UINT64_MAX or something
19
similar this patch reuses THROTTLE_VALUE_MAX, which allows I/O bursts
20
of 1 GiB/s for 10 days in a row.
21
22
Signed-off-by: Alberto Garcia <berto@igalia.com>
23
Message-id: 1b2e3049803f71cafb2e1fa1be4fb47147a0d398.1503580370.git.berto@igalia.com
24
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
25
---
26
include/qemu/throttle.h | 2 +-
27
util/throttle.c | 5 +++++
28
2 files changed, 6 insertions(+), 1 deletion(-)
29
30
diff --git a/include/qemu/throttle.h b/include/qemu/throttle.h
31
index XXXXXXX..XXXXXXX 100644
16
index XXXXXXX..XXXXXXX 100644
32
--- a/include/qemu/throttle.h
17
--- a/block/qcow2.c
33
+++ b/include/qemu/throttle.h
18
+++ b/block/qcow2.c
34
@@ -XXX,XX +XXX,XX @@ typedef struct LeakyBucket {
19
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
35
uint64_t max; /* leaky bucket max burst in units */
20
ret = qcow2_alloc_cluster_offset(bs, offset, &cur_bytes,
36
double level; /* bucket level in units */
21
&cluster_offset, &l2meta);
37
double burst_level; /* bucket level in units (for computing bursts) */
22
if (ret < 0) {
38
- unsigned burst_length; /* max length of the burst period, in seconds */
23
- goto fail;
39
+ uint64_t burst_length; /* max length of the burst period, in seconds */
24
+ goto out_locked;
40
} LeakyBucket;
41
42
/* The following structure is used to configure a ThrottleState
43
diff --git a/util/throttle.c b/util/throttle.c
44
index XXXXXXX..XXXXXXX 100644
45
--- a/util/throttle.c
46
+++ b/util/throttle.c
47
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
48
return false;
49
}
25
}
50
26
51
+ if (bkt->max && bkt->burst_length > THROTTLE_VALUE_MAX / bkt->max) {
27
assert((cluster_offset & 511) == 0);
52
+ error_setg(errp, "burst length too high for this burst rate");
28
53
+ return false;
29
+ ret = qcow2_pre_write_overlap_check(bs, 0,
30
+ cluster_offset + offset_in_cluster,
31
+ cur_bytes, true);
32
+ if (ret < 0) {
33
+ goto out_locked;
54
+ }
34
+ }
55
+
35
+
56
if (bkt->max && !bkt->avg) {
36
+ qemu_co_mutex_unlock(&s->lock);
57
error_setg(errp, "bps_max/iops_max require corresponding"
37
+
58
" bps/iops values");
38
qemu_iovec_reset(&hd_qiov);
39
qemu_iovec_concat(&hd_qiov, qiov, bytes_done, cur_bytes);
40
41
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
42
* s->cluster_size);
43
if (cluster_data == NULL) {
44
ret = -ENOMEM;
45
- goto fail;
46
+ goto out_unlocked;
47
}
48
}
49
50
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
51
cluster_data,
52
cur_bytes, NULL) < 0) {
53
ret = -EIO;
54
- goto fail;
55
+ goto out_unlocked;
56
}
57
58
qemu_iovec_reset(&hd_qiov);
59
qemu_iovec_add(&hd_qiov, cluster_data, cur_bytes);
60
}
61
62
- ret = qcow2_pre_write_overlap_check(bs, 0,
63
- cluster_offset + offset_in_cluster, cur_bytes, true);
64
- if (ret < 0) {
65
- goto fail;
66
- }
67
-
68
/* If we need to do COW, check if it's possible to merge the
69
* writing of the guest data together with that of the COW regions.
70
* If it's not possible (or not necessary) then write the
71
* guest data now. */
72
if (!merge_cow(offset, cur_bytes, &hd_qiov, l2meta)) {
73
- qemu_co_mutex_unlock(&s->lock);
74
BLKDBG_EVENT(bs->file, BLKDBG_WRITE_AIO);
75
trace_qcow2_writev_data(qemu_coroutine_self(),
76
cluster_offset + offset_in_cluster);
77
ret = bdrv_co_pwritev(s->data_file,
78
cluster_offset + offset_in_cluster,
79
cur_bytes, &hd_qiov, 0);
80
- qemu_co_mutex_lock(&s->lock);
81
if (ret < 0) {
82
- goto fail;
83
+ goto out_unlocked;
84
}
85
}
86
87
+ qemu_co_mutex_lock(&s->lock);
88
+
89
ret = qcow2_handle_l2meta(bs, &l2meta, true);
90
if (ret) {
91
- goto fail;
92
+ goto out_locked;
93
}
94
95
bytes -= cur_bytes;
96
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
97
trace_qcow2_writev_done_part(qemu_coroutine_self(), cur_bytes);
98
}
99
ret = 0;
100
+ goto out_locked;
101
102
-fail:
103
+out_unlocked:
104
+ qemu_co_mutex_lock(&s->lock);
105
+
106
+out_locked:
107
qcow2_handle_l2meta(bs, &l2meta, false);
108
109
qemu_co_mutex_unlock(&s->lock);
59
--
110
--
60
2.13.5
111
2.21.0
61
112
62
113
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
2
3
There's a few cases which we're passing an Error pointer to a function
3
Do encryption/decryption in threads, like it is already done for
4
only to discard it immediately afterwards without checking it. In
4
compression. This improves asynchronous encrypted io.
5
these cases we can simply remove the variable and pass NULL instead.
5
6
6
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
7
Signed-off-by: Alberto Garcia <berto@igalia.com>
7
Reviewed-by: Alberto Garcia <berto@igalia.com>
8
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
8
Reviewed-by: Max Reitz <mreitz@redhat.com>
9
Reviewed-by: Eric Blake <eblake@redhat.com>
9
Message-id: 20190506142741.41731-9-vsementsov@virtuozzo.com
10
Message-id: 20170829120836.16091-1-berto@igalia.com
10
Signed-off-by: Max Reitz <mreitz@redhat.com>
11
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
12
---
11
---
13
block/qcow.c | 12 +++---------
12
block/qcow2.h | 8 ++++++
14
block/qcow2.c | 8 ++------
13
block/qcow2-cluster.c | 7 ++---
15
dump.c | 4 +---
14
block/qcow2-threads.c | 65 +++++++++++++++++++++++++++++++++++++++++--
16
3 files changed, 6 insertions(+), 18 deletions(-)
15
block/qcow2.c | 22 +++++----------
17
16
4 files changed, 81 insertions(+), 21 deletions(-)
18
diff --git a/block/qcow.c b/block/qcow.c
17
19
index XXXXXXX..XXXXXXX 100644
18
diff --git a/block/qcow2.h b/block/qcow2.h
20
--- a/block/qcow.c
19
index XXXXXXX..XXXXXXX 100644
21
+++ b/block/qcow.c
20
--- a/block/qcow2.h
22
@@ -XXX,XX +XXX,XX @@ static uint64_t get_cluster_offset(BlockDriverState *bs,
21
+++ b/block/qcow2.h
23
start_sect = (offset & ~(s->cluster_size - 1)) >> 9;
22
@@ -XXX,XX +XXX,XX @@ typedef struct Qcow2BitmapHeaderExt {
24
for(i = 0; i < s->cluster_sectors; i++) {
23
uint64_t bitmap_directory_offset;
25
if (i < n_start || i >= n_end) {
24
} QEMU_PACKED Qcow2BitmapHeaderExt;
26
- Error *err = NULL;
25
27
memset(s->cluster_data, 0x00, 512);
26
+#define QCOW2_MAX_THREADS 4
28
if (qcrypto_block_encrypt(s->crypto, start_sect + i,
27
+
29
s->cluster_data,
28
typedef struct BDRVQcow2State {
30
BDRV_SECTOR_SIZE,
29
int cluster_bits;
31
- &err) < 0) {
30
int cluster_size;
32
- error_free(err);
31
@@ -XXX,XX +XXX,XX @@ qcow2_co_compress(BlockDriverState *bs, void *dest, size_t dest_size,
33
+ NULL) < 0) {
32
ssize_t coroutine_fn
34
errno = EIO;
33
qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size,
35
return -1;
34
const void *src, size_t src_size);
36
}
35
+int coroutine_fn
37
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
36
+qcow2_co_encrypt(BlockDriverState *bs, uint64_t file_cluster_offset,
38
QEMUIOVector hd_qiov;
37
+ uint64_t offset, void *buf, size_t len);
39
uint8_t *buf;
38
+int coroutine_fn
40
void *orig_buf;
39
+qcow2_co_decrypt(BlockDriverState *bs, uint64_t file_cluster_offset,
41
- Error *err = NULL;
40
+ uint64_t offset, void *buf, size_t len);
42
41
43
if (qiov->niov > 1) {
42
#endif
44
buf = orig_buf = qemu_try_blockalign(bs, qiov->size);
43
diff --git a/block/qcow2-cluster.c b/block/qcow2-cluster.c
45
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
44
index XXXXXXX..XXXXXXX 100644
46
if (bs->encrypted) {
45
--- a/block/qcow2-cluster.c
47
assert(s->crypto);
46
+++ b/block/qcow2-cluster.c
48
if (qcrypto_block_decrypt(s->crypto, sector_num, buf,
47
@@ -XXX,XX +XXX,XX @@ static bool coroutine_fn do_perform_cow_encrypt(BlockDriverState *bs,
49
- n * BDRV_SECTOR_SIZE, &err) < 0) {
48
{
50
+ n * BDRV_SECTOR_SIZE, NULL) < 0) {
49
if (bytes && bs->encrypted) {
51
goto fail;
50
BDRVQcow2State *s = bs->opaque;
52
}
51
- int64_t offset = (s->crypt_physical_offset ?
53
}
52
- (cluster_offset + offset_in_cluster) :
54
@@ -XXX,XX +XXX,XX @@ done:
53
- (src_cluster_offset + offset_in_cluster));
55
return ret;
54
assert((offset_in_cluster & ~BDRV_SECTOR_MASK) == 0);
56
55
assert((bytes & ~BDRV_SECTOR_MASK) == 0);
57
fail:
56
assert(s->crypto);
58
- error_free(err);
57
- if (qcrypto_block_encrypt(s->crypto, offset, buffer, bytes, NULL) < 0) {
59
ret = -EIO;
58
+ if (qcow2_co_encrypt(bs, cluster_offset,
60
goto done;
59
+ src_cluster_offset + offset_in_cluster,
60
+ buffer, bytes) < 0) {
61
return false;
62
}
63
}
64
diff --git a/block/qcow2-threads.c b/block/qcow2-threads.c
65
index XXXXXXX..XXXXXXX 100644
66
--- a/block/qcow2-threads.c
67
+++ b/block/qcow2-threads.c
68
@@ -XXX,XX +XXX,XX @@
69
70
#include "qcow2.h"
71
#include "block/thread-pool.h"
72
-
73
-#define QCOW2_MAX_THREADS 4
74
+#include "crypto.h"
75
76
static int coroutine_fn
77
qcow2_co_process(BlockDriverState *bs, ThreadPoolFunc *func, void *arg)
78
@@ -XXX,XX +XXX,XX @@ qcow2_co_decompress(BlockDriverState *bs, void *dest, size_t dest_size,
79
return qcow2_co_do_compress(bs, dest, dest_size, src, src_size,
80
qcow2_decompress);
61
}
81
}
62
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_writev(BlockDriverState *bs, int64_t sector_num,
82
+
63
break;
83
+
64
}
84
+/*
65
if (bs->encrypted) {
85
+ * Cryptography
66
- Error *err = NULL;
86
+ */
67
assert(s->crypto);
87
+
68
if (qcrypto_block_encrypt(s->crypto, sector_num, buf,
88
+/*
69
- n * BDRV_SECTOR_SIZE, &err) < 0) {
89
+ * Qcow2EncDecFunc: common prototype of qcrypto_block_encrypt() and
70
- error_free(err);
90
+ * qcrypto_block_decrypt() functions.
71
+ n * BDRV_SECTOR_SIZE, NULL) < 0) {
91
+ */
72
ret = -EIO;
92
+typedef int (*Qcow2EncDecFunc)(QCryptoBlock *block, uint64_t offset,
73
break;
93
+ uint8_t *buf, size_t len, Error **errp);
74
}
94
+
95
+typedef struct Qcow2EncDecData {
96
+ QCryptoBlock *block;
97
+ uint64_t offset;
98
+ uint8_t *buf;
99
+ size_t len;
100
+
101
+ Qcow2EncDecFunc func;
102
+} Qcow2EncDecData;
103
+
104
+static int qcow2_encdec_pool_func(void *opaque)
105
+{
106
+ Qcow2EncDecData *data = opaque;
107
+
108
+ return data->func(data->block, data->offset, data->buf, data->len, NULL);
109
+}
110
+
111
+static int coroutine_fn
112
+qcow2_co_encdec(BlockDriverState *bs, uint64_t file_cluster_offset,
113
+ uint64_t offset, void *buf, size_t len, Qcow2EncDecFunc func)
114
+{
115
+ BDRVQcow2State *s = bs->opaque;
116
+ Qcow2EncDecData arg = {
117
+ .block = s->crypto,
118
+ .offset = s->crypt_physical_offset ?
119
+ file_cluster_offset + offset_into_cluster(s, offset) :
120
+ offset,
121
+ .buf = buf,
122
+ .len = len,
123
+ .func = func,
124
+ };
125
+
126
+ return qcow2_co_process(bs, qcow2_encdec_pool_func, &arg);
127
+}
128
+
129
+int coroutine_fn
130
+qcow2_co_encrypt(BlockDriverState *bs, uint64_t file_cluster_offset,
131
+ uint64_t offset, void *buf, size_t len)
132
+{
133
+ return qcow2_co_encdec(bs, file_cluster_offset, offset, buf, len,
134
+ qcrypto_block_encrypt);
135
+}
136
+
137
+int coroutine_fn
138
+qcow2_co_decrypt(BlockDriverState *bs, uint64_t file_cluster_offset,
139
+ uint64_t offset, void *buf, size_t len)
140
+{
141
+ return qcow2_co_encdec(bs, file_cluster_offset, offset, buf, len,
142
+ qcrypto_block_decrypt);
143
+}
75
diff --git a/block/qcow2.c b/block/qcow2.c
144
diff --git a/block/qcow2.c b/block/qcow2.c
76
index XXXXXXX..XXXXXXX 100644
145
index XXXXXXX..XXXXXXX 100644
77
--- a/block/qcow2.c
146
--- a/block/qcow2.c
78
+++ b/block/qcow2.c
147
+++ b/block/qcow2.c
148
@@ -XXX,XX +XXX,XX @@ static int qcow2_read_extensions(BlockDriverState *bs, uint64_t start_offset,
149
}
150
s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.",
151
qcow2_crypto_hdr_read_func,
152
- bs, cflags, 1, errp);
153
+ bs, cflags, QCOW2_MAX_THREADS, errp);
154
if (!s->crypto) {
155
return -EINVAL;
156
}
157
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn qcow2_do_open(BlockDriverState *bs, QDict *options,
158
cflags |= QCRYPTO_BLOCK_OPEN_NO_IO;
159
}
160
s->crypto = qcrypto_block_open(s->crypto_opts, "encrypt.",
161
- NULL, NULL, cflags, 1, errp);
162
+ NULL, NULL, cflags,
163
+ QCOW2_MAX_THREADS, errp);
164
if (!s->crypto) {
165
ret = -EINVAL;
166
goto fail;
79
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
167
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
80
assert(s->crypto);
168
assert(s->crypto);
81
assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
169
assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
82
assert((cur_bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
170
assert((cur_bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
83
- Error *err = NULL;
171
- if (qcrypto_block_decrypt(s->crypto,
84
if (qcrypto_block_decrypt(s->crypto,
172
- (s->crypt_physical_offset ?
85
(s->crypt_physical_offset ?
173
- cluster_offset + offset_in_cluster :
86
cluster_offset + offset_in_cluster :
174
- offset),
87
offset) >> BDRV_SECTOR_BITS,
175
- cluster_data,
88
cluster_data,
176
- cur_bytes,
89
cur_bytes,
177
- NULL) < 0) {
90
- &err) < 0) {
178
+ if (qcow2_co_decrypt(bs, cluster_offset, offset,
91
- error_free(err);
179
+ cluster_data, cur_bytes) < 0) {
92
+ NULL) < 0) {
93
ret = -EIO;
180
ret = -EIO;
94
goto fail;
181
goto fail;
95
}
182
}
96
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
183
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
97
qemu_iovec_concat(&hd_qiov, qiov, bytes_done, cur_bytes);
184
QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size);
98
185
qemu_iovec_to_buf(&hd_qiov, 0, cluster_data, hd_qiov.size);
99
if (bs->encrypted) {
186
100
- Error *err = NULL;
187
- if (qcrypto_block_encrypt(s->crypto,
101
assert(s->crypto);
188
- (s->crypt_physical_offset ?
102
if (!cluster_data) {
189
- cluster_offset + offset_in_cluster :
103
cluster_data = qemu_try_blockalign(bs->file->bs,
190
- offset),
104
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
191
- cluster_data,
105
cluster_offset + offset_in_cluster :
192
- cur_bytes, NULL) < 0) {
106
offset) >> BDRV_SECTOR_BITS,
193
+ if (qcow2_co_encrypt(bs, cluster_offset, offset,
107
cluster_data,
194
+ cluster_data, cur_bytes) < 0) {
108
- cur_bytes, &err) < 0) {
109
- error_free(err);
110
+ cur_bytes, NULL) < 0) {
111
ret = -EIO;
195
ret = -EIO;
112
goto fail;
196
goto out_unlocked;
113
}
197
}
114
diff --git a/dump.c b/dump.c
115
index XXXXXXX..XXXXXXX 100644
116
--- a/dump.c
117
+++ b/dump.c
118
@@ -XXX,XX +XXX,XX @@ static void dump_process(DumpState *s, Error **errp)
119
120
static void *dump_thread(void *data)
121
{
122
- Error *err = NULL;
123
DumpState *s = (DumpState *)data;
124
- dump_process(s, &err);
125
- error_free(err);
126
+ dump_process(s, NULL);
127
return NULL;
128
}
129
130
--
198
--
131
2.13.5
199
2.21.0
132
200
133
201
diff view generated by jsdifflib
New patch
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
1
2
3
Simplify backup_incremental_init_copy_bitmap using the function
4
bdrv_dirty_bitmap_next_dirty_area.
5
6
Note: move to job->len instead of bitmap size: it should not matter but
7
less code.
8
9
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
10
Reviewed-by: Max Reitz <mreitz@redhat.com>
11
Message-id: 20190429090842.57910-2-vsementsov@virtuozzo.com
12
Signed-off-by: Max Reitz <mreitz@redhat.com>
13
---
14
block/backup.c | 40 ++++++++++++----------------------------
15
1 file changed, 12 insertions(+), 28 deletions(-)
16
17
diff --git a/block/backup.c b/block/backup.c
18
index XXXXXXX..XXXXXXX 100644
19
--- a/block/backup.c
20
+++ b/block/backup.c
21
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_run_incremental(BackupBlockJob *job)
22
/* init copy_bitmap from sync_bitmap */
23
static void backup_incremental_init_copy_bitmap(BackupBlockJob *job)
24
{
25
- BdrvDirtyBitmapIter *dbi;
26
- int64_t offset;
27
- int64_t end = DIV_ROUND_UP(bdrv_dirty_bitmap_size(job->sync_bitmap),
28
- job->cluster_size);
29
-
30
- dbi = bdrv_dirty_iter_new(job->sync_bitmap);
31
- while ((offset = bdrv_dirty_iter_next(dbi)) != -1) {
32
- int64_t cluster = offset / job->cluster_size;
33
- int64_t next_cluster;
34
-
35
- offset += bdrv_dirty_bitmap_granularity(job->sync_bitmap);
36
- if (offset >= bdrv_dirty_bitmap_size(job->sync_bitmap)) {
37
- hbitmap_set(job->copy_bitmap, cluster, end - cluster);
38
- break;
39
- }
40
+ uint64_t offset = 0;
41
+ uint64_t bytes = job->len;
42
43
- offset = bdrv_dirty_bitmap_next_zero(job->sync_bitmap, offset,
44
- UINT64_MAX);
45
- if (offset == -1) {
46
- hbitmap_set(job->copy_bitmap, cluster, end - cluster);
47
- break;
48
- }
49
+ while (bdrv_dirty_bitmap_next_dirty_area(job->sync_bitmap,
50
+ &offset, &bytes))
51
+ {
52
+ uint64_t cluster = offset / job->cluster_size;
53
+ uint64_t end_cluster = DIV_ROUND_UP(offset + bytes, job->cluster_size);
54
55
- next_cluster = DIV_ROUND_UP(offset, job->cluster_size);
56
- hbitmap_set(job->copy_bitmap, cluster, next_cluster - cluster);
57
- if (next_cluster >= end) {
58
+ hbitmap_set(job->copy_bitmap, cluster, end_cluster - cluster);
59
+
60
+ offset = end_cluster * job->cluster_size;
61
+ if (offset >= job->len) {
62
break;
63
}
64
-
65
- bdrv_set_dirty_iter(dbi, next_cluster * job->cluster_size);
66
+ bytes = job->len - offset;
67
}
68
69
/* TODO job_progress_set_remaining() would make more sense */
70
job_progress_update(&job->common.job,
71
job->len - hbitmap_count(job->copy_bitmap) * job->cluster_size);
72
-
73
- bdrv_dirty_iter_free(dbi);
74
}
75
76
static int coroutine_fn backup_run(Job *job, Error **errp)
77
--
78
2.21.0
79
80
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
2
3
Both the throttling limits set with the throttling.iops-* and
3
We are going to share this bitmap between backup and backup-top filter
4
throttling.bps-* options and their QMP equivalents defined in the
4
driver, so let's share something more meaningful. It also simplifies
5
BlockIOThrottle struct are integer values.
5
some calculations.
6
6
7
Those limits are also reported in the BlockDeviceInfo struct and they
7
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
8
are integers there as well.
8
Reviewed-by: Max Reitz <mreitz@redhat.com>
9
Message-id: 20190429090842.57910-3-vsementsov@virtuozzo.com
10
Signed-off-by: Max Reitz <mreitz@redhat.com>
11
---
12
block/backup.c | 48 +++++++++++++++++++++++-------------------------
13
1 file changed, 23 insertions(+), 25 deletions(-)
9
14
10
Therefore there's no reason to store them internally as double and do
15
diff --git a/block/backup.c b/block/backup.c
11
the conversion everytime we're setting or querying them, so this patch
12
uses uint64_t for those types. Let's also use an unsigned type because
13
we don't allow negative values anyway.
14
15
LeakyBucket.level and LeakyBucket.burst_level do however remain double
16
because their value changes depending on the fraction of time elapsed
17
since the previous I/O operation.
18
19
Signed-off-by: Alberto Garcia <berto@igalia.com>
20
Message-id: f29b840422767b5be2c41c2dfdbbbf6c5f8fedf8.1503580370.git.berto@igalia.com
21
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
22
---
23
include/qemu/throttle.h | 4 ++--
24
tests/test-throttle.c | 3 ++-
25
util/throttle.c | 7 +++----
26
3 files changed, 7 insertions(+), 7 deletions(-)
27
28
diff --git a/include/qemu/throttle.h b/include/qemu/throttle.h
29
index XXXXXXX..XXXXXXX 100644
16
index XXXXXXX..XXXXXXX 100644
30
--- a/include/qemu/throttle.h
17
--- a/block/backup.c
31
+++ b/include/qemu/throttle.h
18
+++ b/block/backup.c
32
@@ -XXX,XX +XXX,XX @@ typedef enum {
19
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_cow_with_bounce_buffer(BackupBlockJob *job,
33
*/
20
int read_flags = is_write_notifier ? BDRV_REQ_NO_SERIALISING : 0;
34
21
int write_flags = job->serialize_target_writes ? BDRV_REQ_SERIALISING : 0;
35
typedef struct LeakyBucket {
22
36
- double avg; /* average goal in units per second */
23
- hbitmap_reset(job->copy_bitmap, start / job->cluster_size, 1);
37
- double max; /* leaky bucket max burst in units */
24
+ assert(QEMU_IS_ALIGNED(start, job->cluster_size));
38
+ uint64_t avg; /* average goal in units per second */
25
+ hbitmap_reset(job->copy_bitmap, start, job->cluster_size);
39
+ uint64_t max; /* leaky bucket max burst in units */
26
nbytes = MIN(job->cluster_size, job->len - start);
40
double level; /* bucket level in units */
27
if (!*bounce_buffer) {
41
double burst_level; /* bucket level in units (for computing bursts) */
28
*bounce_buffer = blk_blockalign(blk, job->cluster_size);
42
unsigned burst_length; /* max length of the burst period, in seconds */
29
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_cow_with_bounce_buffer(BackupBlockJob *job,
43
diff --git a/tests/test-throttle.c b/tests/test-throttle.c
30
44
index XXXXXXX..XXXXXXX 100644
31
return nbytes;
45
--- a/tests/test-throttle.c
32
fail:
46
+++ b/tests/test-throttle.c
33
- hbitmap_set(job->copy_bitmap, start / job->cluster_size, 1);
47
@@ -XXX,XX +XXX,XX @@ static void test_enabled(void)
34
+ hbitmap_set(job->copy_bitmap, start, job->cluster_size);
48
for (i = 0; i < BUCKETS_COUNT; i++) {
35
return ret;
49
throttle_config_init(&cfg);
36
50
set_cfg_value(false, i, 150);
37
}
51
+ g_assert(throttle_is_valid(&cfg, NULL));
38
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_cow_with_offload(BackupBlockJob *job,
52
g_assert(throttle_enabled(&cfg));
39
int write_flags = job->serialize_target_writes ? BDRV_REQ_SERIALISING : 0;
40
41
assert(QEMU_IS_ALIGNED(job->copy_range_size, job->cluster_size));
42
+ assert(QEMU_IS_ALIGNED(start, job->cluster_size));
43
nbytes = MIN(job->copy_range_size, end - start);
44
nr_clusters = DIV_ROUND_UP(nbytes, job->cluster_size);
45
- hbitmap_reset(job->copy_bitmap, start / job->cluster_size,
46
- nr_clusters);
47
+ hbitmap_reset(job->copy_bitmap, start, job->cluster_size * nr_clusters);
48
ret = blk_co_copy_range(blk, start, job->target, start, nbytes,
49
read_flags, write_flags);
50
if (ret < 0) {
51
trace_backup_do_cow_copy_range_fail(job, start, ret);
52
- hbitmap_set(job->copy_bitmap, start / job->cluster_size,
53
- nr_clusters);
54
+ hbitmap_set(job->copy_bitmap, start, job->cluster_size * nr_clusters);
55
return ret;
53
}
56
}
54
57
55
for (i = 0; i < BUCKETS_COUNT; i++) {
58
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_do_cow(BackupBlockJob *job,
56
throttle_config_init(&cfg);
59
cow_request_begin(&cow_request, job, start, end);
57
set_cfg_value(false, i, -150);
60
58
- g_assert(!throttle_enabled(&cfg));
61
while (start < end) {
59
+ g_assert(!throttle_is_valid(&cfg, NULL));
62
- if (!hbitmap_get(job->copy_bitmap, start / job->cluster_size)) {
63
+ if (!hbitmap_get(job->copy_bitmap, start)) {
64
trace_backup_do_cow_skip(job, start);
65
start += job->cluster_size;
66
continue; /* already copied */
67
@@ -XXX,XX +XXX,XX @@ static void backup_clean(Job *job)
68
assert(s->target);
69
blk_unref(s->target);
70
s->target = NULL;
71
+
72
+ if (s->copy_bitmap) {
73
+ hbitmap_free(s->copy_bitmap);
74
+ s->copy_bitmap = NULL;
75
+ }
76
}
77
78
void backup_do_checkpoint(BlockJob *job, Error **errp)
79
{
80
BackupBlockJob *backup_job = container_of(job, BackupBlockJob, common);
81
- int64_t len;
82
83
assert(block_job_driver(job) == &backup_job_driver);
84
85
@@ -XXX,XX +XXX,XX @@ void backup_do_checkpoint(BlockJob *job, Error **errp)
86
return;
60
}
87
}
88
89
- len = DIV_ROUND_UP(backup_job->len, backup_job->cluster_size);
90
- hbitmap_set(backup_job->copy_bitmap, 0, len);
91
+ hbitmap_set(backup_job->copy_bitmap, 0, backup_job->len);
61
}
92
}
62
93
63
diff --git a/util/throttle.c b/util/throttle.c
94
static void backup_drain(BlockJob *job)
64
index XXXXXXX..XXXXXXX 100644
95
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_run_incremental(BackupBlockJob *job)
65
--- a/util/throttle.c
96
{
66
+++ b/util/throttle.c
97
int ret;
67
@@ -XXX,XX +XXX,XX @@ int64_t throttle_compute_wait(LeakyBucket *bkt)
98
bool error_is_read;
68
/* If bkt->max is 0 we still want to allow short bursts of I/O
99
- int64_t cluster;
69
* from the guest, otherwise every other request will be throttled
100
+ int64_t offset;
70
* and performance will suffer considerably. */
101
HBitmapIter hbi;
71
- bucket_size = bkt->avg / 10;
102
72
+ bucket_size = (double) bkt->avg / 10;
103
hbitmap_iter_init(&hbi, job->copy_bitmap, 0);
73
burst_bucket_size = 0;
104
- while ((cluster = hbitmap_iter_next(&hbi)) != -1) {
105
+ while ((offset = hbitmap_iter_next(&hbi)) != -1) {
106
do {
107
if (yield_and_check(job)) {
108
return 0;
109
}
110
- ret = backup_do_cow(job, cluster * job->cluster_size,
111
+ ret = backup_do_cow(job, offset,
112
job->cluster_size, &error_is_read, false);
113
if (ret < 0 && backup_error_action(job, error_is_read, -ret) ==
114
BLOCK_ERROR_ACTION_REPORT)
115
@@ -XXX,XX +XXX,XX @@ static void backup_incremental_init_copy_bitmap(BackupBlockJob *job)
116
while (bdrv_dirty_bitmap_next_dirty_area(job->sync_bitmap,
117
&offset, &bytes))
118
{
119
- uint64_t cluster = offset / job->cluster_size;
120
- uint64_t end_cluster = DIV_ROUND_UP(offset + bytes, job->cluster_size);
121
+ hbitmap_set(job->copy_bitmap, offset, bytes);
122
123
- hbitmap_set(job->copy_bitmap, cluster, end_cluster - cluster);
124
-
125
- offset = end_cluster * job->cluster_size;
126
+ offset += bytes;
127
if (offset >= job->len) {
128
break;
129
}
130
@@ -XXX,XX +XXX,XX @@ static void backup_incremental_init_copy_bitmap(BackupBlockJob *job)
131
132
/* TODO job_progress_set_remaining() would make more sense */
133
job_progress_update(&job->common.job,
134
- job->len - hbitmap_count(job->copy_bitmap) * job->cluster_size);
135
+ job->len - hbitmap_count(job->copy_bitmap));
136
}
137
138
static int coroutine_fn backup_run(Job *job, Error **errp)
139
{
140
BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
141
BlockDriverState *bs = blk_bs(s->common.blk);
142
- int64_t offset, nb_clusters;
143
+ int64_t offset;
144
int ret = 0;
145
146
QLIST_INIT(&s->inflight_reqs);
147
qemu_co_rwlock_init(&s->flush_rwlock);
148
149
- nb_clusters = DIV_ROUND_UP(s->len, s->cluster_size);
150
job_progress_set_remaining(job, s->len);
151
152
- s->copy_bitmap = hbitmap_alloc(nb_clusters, 0);
153
if (s->sync_mode == MIRROR_SYNC_MODE_INCREMENTAL) {
154
backup_incremental_init_copy_bitmap(s);
74
} else {
155
} else {
75
/* If we have a burst limit then we have to wait until all I/O
156
- hbitmap_set(s->copy_bitmap, 0, nb_clusters);
76
* at burst rate has finished before throttling to bkt->avg */
157
+ hbitmap_set(s->copy_bitmap, 0, s->len);
77
bucket_size = bkt->max * bkt->burst_length;
78
- burst_bucket_size = bkt->max / 10;
79
+ burst_bucket_size = (double) bkt->max / 10;
80
}
158
}
81
159
82
/* If the main bucket is full then we have to wait */
160
-
83
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
161
s->before_write.notify = backup_before_write_notify;
84
162
bdrv_add_before_write_notifier(bs, &s->before_write);
85
for (i = 0; i < BUCKETS_COUNT; i++) {
163
86
LeakyBucket *bkt = &cfg->buckets[i];
164
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_run(Job *job, Error **errp)
87
- if (bkt->avg < 0 || bkt->max < 0 ||
165
/* wait until pending backup_do_cow() calls have completed */
88
- bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
166
qemu_co_rwlock_wrlock(&s->flush_rwlock);
89
+ if (bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
167
qemu_co_rwlock_unlock(&s->flush_rwlock);
90
error_setg(errp, "bps/iops/max values must be within [0, %lld]",
168
- hbitmap_free(s->copy_bitmap);
91
THROTTLE_VALUE_MAX);
169
92
return false;
170
return ret;
171
}
172
@@ -XXX,XX +XXX,XX @@ BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
173
} else {
174
job->cluster_size = MAX(BACKUP_CLUSTER_SIZE_DEFAULT, bdi.cluster_size);
175
}
176
+
177
+ job->copy_bitmap = hbitmap_alloc(len, ctz32(job->cluster_size));
178
job->use_copy_range = true;
179
job->copy_range_size = MIN_NON_ZERO(blk_get_max_transfer(job->common.blk),
180
blk_get_max_transfer(job->target));
93
--
181
--
94
2.13.5
182
2.21.0
95
183
96
184
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
2
3
Signed-off-by: Alberto Garcia <berto@igalia.com>
3
Split allocation checking to separate function and reduce nesting.
4
Message-id: a57dd6274e1b6dc9c28769fec4c7ea543be5c5e3.1503580370.git.berto@igalia.com
4
Consider bdrv_is_allocated() fail as allocated area, as copying more
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
5
than needed is not wrong (and we do it anyway) and seems better than
6
fail the whole job. And, most probably we will fail on the next read,
7
if there are real problem with source.
8
9
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
10
Reviewed-by: Max Reitz <mreitz@redhat.com>
11
Message-id: 20190429090842.57910-4-vsementsov@virtuozzo.com
12
Signed-off-by: Max Reitz <mreitz@redhat.com>
6
---
13
---
7
tests/test-throttle.c | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++
14
block/backup.c | 60 +++++++++++++++++++-------------------------------
8
1 file changed, 77 insertions(+)
15
1 file changed, 23 insertions(+), 37 deletions(-)
9
16
10
diff --git a/tests/test-throttle.c b/tests/test-throttle.c
17
diff --git a/block/backup.c b/block/backup.c
11
index XXXXXXX..XXXXXXX 100644
18
index XXXXXXX..XXXXXXX 100644
12
--- a/tests/test-throttle.c
19
--- a/block/backup.c
13
+++ b/tests/test-throttle.c
20
+++ b/block/backup.c
14
@@ -XXX,XX +XXX,XX @@ static void test_is_valid(void)
21
@@ -XXX,XX +XXX,XX @@ static bool coroutine_fn yield_and_check(BackupBlockJob *job)
15
test_is_valid_for_value(1, true);
22
return false;
16
}
23
}
17
24
18
+static void test_ranges(void)
25
+static bool bdrv_is_unallocated_range(BlockDriverState *bs,
26
+ int64_t offset, int64_t bytes)
19
+{
27
+{
20
+ int i;
28
+ int64_t end = offset + bytes;
21
+
29
+
22
+ for (i = 0; i < BUCKETS_COUNT; i++) {
30
+ while (offset < end && !bdrv_is_allocated(bs, offset, bytes, &bytes)) {
23
+ LeakyBucket *b = &cfg.buckets[i];
31
+ if (bytes == 0) {
24
+ throttle_config_init(&cfg);
32
+ return true;
33
+ }
34
+ offset += bytes;
35
+ bytes = end - offset;
36
+ }
25
+
37
+
26
+ /* avg = 0 means throttling is disabled, but the config is valid */
38
+ return offset >= end;
27
+ b->avg = 0;
28
+ g_assert(throttle_is_valid(&cfg, NULL));
29
+ g_assert(!throttle_enabled(&cfg));
30
+
31
+ /* These are valid configurations (values <= THROTTLE_VALUE_MAX) */
32
+ b->avg = 1;
33
+ g_assert(throttle_is_valid(&cfg, NULL));
34
+
35
+ b->avg = THROTTLE_VALUE_MAX;
36
+ g_assert(throttle_is_valid(&cfg, NULL));
37
+
38
+ b->avg = THROTTLE_VALUE_MAX;
39
+ b->max = THROTTLE_VALUE_MAX;
40
+ g_assert(throttle_is_valid(&cfg, NULL));
41
+
42
+ /* Values over THROTTLE_VALUE_MAX are not allowed */
43
+ b->avg = THROTTLE_VALUE_MAX + 1;
44
+ g_assert(!throttle_is_valid(&cfg, NULL));
45
+
46
+ b->avg = THROTTLE_VALUE_MAX;
47
+ b->max = THROTTLE_VALUE_MAX + 1;
48
+ g_assert(!throttle_is_valid(&cfg, NULL));
49
+
50
+ /* burst_length must be between 1 and THROTTLE_VALUE_MAX */
51
+ b->avg = 1;
52
+ b->max = 1;
53
+ b->burst_length = 0;
54
+ g_assert(!throttle_is_valid(&cfg, NULL));
55
+
56
+ b->avg = 1;
57
+ b->max = 1;
58
+ b->burst_length = 1;
59
+ g_assert(throttle_is_valid(&cfg, NULL));
60
+
61
+ b->avg = 1;
62
+ b->max = 1;
63
+ b->burst_length = THROTTLE_VALUE_MAX;
64
+ g_assert(throttle_is_valid(&cfg, NULL));
65
+
66
+ b->avg = 1;
67
+ b->max = 1;
68
+ b->burst_length = THROTTLE_VALUE_MAX + 1;
69
+ g_assert(!throttle_is_valid(&cfg, NULL));
70
+
71
+ /* burst_length * max cannot exceed THROTTLE_VALUE_MAX */
72
+ b->avg = 1;
73
+ b->max = 2;
74
+ b->burst_length = THROTTLE_VALUE_MAX / 2;
75
+ g_assert(throttle_is_valid(&cfg, NULL));
76
+
77
+ b->avg = 1;
78
+ b->max = 3;
79
+ b->burst_length = THROTTLE_VALUE_MAX / 2;
80
+ g_assert(!throttle_is_valid(&cfg, NULL));
81
+
82
+ b->avg = 1;
83
+ b->max = THROTTLE_VALUE_MAX;
84
+ b->burst_length = 1;
85
+ g_assert(throttle_is_valid(&cfg, NULL));
86
+
87
+ b->avg = 1;
88
+ b->max = THROTTLE_VALUE_MAX;
89
+ b->burst_length = 2;
90
+ g_assert(!throttle_is_valid(&cfg, NULL));
91
+ }
92
+}
39
+}
93
+
40
+
94
static void test_max_is_missing_limit(void)
41
static int coroutine_fn backup_run_incremental(BackupBlockJob *job)
95
{
42
{
96
int i;
43
int ret;
97
@@ -XXX,XX +XXX,XX @@ int main(int argc, char **argv)
44
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_run(Job *job, Error **errp)
98
g_test_add_func("/throttle/config/enabled", test_enabled);
45
for (offset = 0; offset < s->len;
99
g_test_add_func("/throttle/config/conflicting", test_conflicting_config);
46
offset += s->cluster_size) {
100
g_test_add_func("/throttle/config/is_valid", test_is_valid);
47
bool error_is_read;
101
+ g_test_add_func("/throttle/config/ranges", test_ranges);
48
- int alloced = 0;
102
g_test_add_func("/throttle/config/max", test_max_is_missing_limit);
49
103
g_test_add_func("/throttle/config/iops_size",
50
if (yield_and_check(s)) {
104
test_iops_size_is_missing_limit);
51
break;
52
}
53
54
- if (s->sync_mode == MIRROR_SYNC_MODE_TOP) {
55
- int i;
56
- int64_t n;
57
-
58
- /* Check to see if these blocks are already in the
59
- * backing file. */
60
-
61
- for (i = 0; i < s->cluster_size;) {
62
- /* bdrv_is_allocated() only returns true/false based
63
- * on the first set of sectors it comes across that
64
- * are are all in the same state.
65
- * For that reason we must verify each sector in the
66
- * backup cluster length. We end up copying more than
67
- * needed but at some point that is always the case. */
68
- alloced =
69
- bdrv_is_allocated(bs, offset + i,
70
- s->cluster_size - i, &n);
71
- i += n;
72
-
73
- if (alloced || n == 0) {
74
- break;
75
- }
76
- }
77
-
78
- /* If the above loop never found any sectors that are in
79
- * the topmost image, skip this backup. */
80
- if (alloced == 0) {
81
- continue;
82
- }
83
- }
84
- /* FULL sync mode we copy the whole drive. */
85
- if (alloced < 0) {
86
- ret = alloced;
87
- } else {
88
- ret = backup_do_cow(s, offset, s->cluster_size,
89
- &error_is_read, false);
90
+ if (s->sync_mode == MIRROR_SYNC_MODE_TOP &&
91
+ bdrv_is_unallocated_range(bs, offset, s->cluster_size))
92
+ {
93
+ continue;
94
}
95
+
96
+ ret = backup_do_cow(s, offset, s->cluster_size,
97
+ &error_is_read, false);
98
if (ret < 0) {
99
/* Depending on error action, fail now or retry cluster */
100
BlockErrorAction action =
105
--
101
--
106
2.13.5
102
2.21.0
107
103
108
104
diff view generated by jsdifflib
New patch
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
1
2
3
Do full, top and incremental mode copying all in one place. This
4
unifies the code path and helps further improvements.
5
6
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
7
Reviewed-by: Max Reitz <mreitz@redhat.com>
8
Message-id: 20190429090842.57910-5-vsementsov@virtuozzo.com
9
Signed-off-by: Max Reitz <mreitz@redhat.com>
10
---
11
block/backup.c | 43 ++++++++++---------------------------------
12
1 file changed, 10 insertions(+), 33 deletions(-)
13
14
diff --git a/block/backup.c b/block/backup.c
15
index XXXXXXX..XXXXXXX 100644
16
--- a/block/backup.c
17
+++ b/block/backup.c
18
@@ -XXX,XX +XXX,XX @@ static bool bdrv_is_unallocated_range(BlockDriverState *bs,
19
return offset >= end;
20
}
21
22
-static int coroutine_fn backup_run_incremental(BackupBlockJob *job)
23
+static int coroutine_fn backup_loop(BackupBlockJob *job)
24
{
25
int ret;
26
bool error_is_read;
27
int64_t offset;
28
HBitmapIter hbi;
29
+ BlockDriverState *bs = blk_bs(job->common.blk);
30
31
hbitmap_iter_init(&hbi, job->copy_bitmap, 0);
32
while ((offset = hbitmap_iter_next(&hbi)) != -1) {
33
+ if (job->sync_mode == MIRROR_SYNC_MODE_TOP &&
34
+ bdrv_is_unallocated_range(bs, offset, job->cluster_size))
35
+ {
36
+ hbitmap_reset(job->copy_bitmap, offset, job->cluster_size);
37
+ continue;
38
+ }
39
+
40
do {
41
if (yield_and_check(job)) {
42
return 0;
43
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_run(Job *job, Error **errp)
44
{
45
BackupBlockJob *s = container_of(job, BackupBlockJob, common.job);
46
BlockDriverState *bs = blk_bs(s->common.blk);
47
- int64_t offset;
48
int ret = 0;
49
50
QLIST_INIT(&s->inflight_reqs);
51
@@ -XXX,XX +XXX,XX @@ static int coroutine_fn backup_run(Job *job, Error **errp)
52
* notify callback service CoW requests. */
53
job_yield(job);
54
}
55
- } else if (s->sync_mode == MIRROR_SYNC_MODE_INCREMENTAL) {
56
- ret = backup_run_incremental(s);
57
} else {
58
- /* Both FULL and TOP SYNC_MODE's require copying.. */
59
- for (offset = 0; offset < s->len;
60
- offset += s->cluster_size) {
61
- bool error_is_read;
62
-
63
- if (yield_and_check(s)) {
64
- break;
65
- }
66
-
67
- if (s->sync_mode == MIRROR_SYNC_MODE_TOP &&
68
- bdrv_is_unallocated_range(bs, offset, s->cluster_size))
69
- {
70
- continue;
71
- }
72
-
73
- ret = backup_do_cow(s, offset, s->cluster_size,
74
- &error_is_read, false);
75
- if (ret < 0) {
76
- /* Depending on error action, fail now or retry cluster */
77
- BlockErrorAction action =
78
- backup_error_action(s, error_is_read, -ret);
79
- if (action == BLOCK_ERROR_ACTION_REPORT) {
80
- break;
81
- } else {
82
- offset -= s->cluster_size;
83
- continue;
84
- }
85
- }
86
- }
87
+ ret = backup_loop(s);
88
}
89
90
notifier_with_return_remove(&s->before_write);
91
--
92
2.21.0
93
94
diff view generated by jsdifflib
1
From: Fred Rolland <rollandf@gmail.com>
1
From: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
2
3
Update doc with the usage of UUID for initiator name.
3
Split out cluster_size calculation. Move copy-bitmap creation above
4
block-job creation, as we are going to share it with upcoming
5
backup-top filter, which also should be created before actual block job
6
creation.
4
7
5
Related-To: https://bugzilla.redhat.com/1006468
8
Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
6
Signed-off-by: Fred Rolland <frolland@redhat.com>
9
Message-id: 20190429090842.57910-6-vsementsov@virtuozzo.com
7
Message-id: 20170823084830.30500-1-frolland@redhat.com
10
[mreitz: Dropped a paragraph from the commit message that was left over
8
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
11
from a previous version]
12
Signed-off-by: Max Reitz <mreitz@redhat.com>
9
---
13
---
10
qemu-doc.texi | 5 +++--
14
block/backup.c | 82 ++++++++++++++++++++++++++++++++------------------
11
1 file changed, 3 insertions(+), 2 deletions(-)
15
1 file changed, 52 insertions(+), 30 deletions(-)
12
16
13
diff --git a/qemu-doc.texi b/qemu-doc.texi
17
diff --git a/block/backup.c b/block/backup.c
14
index XXXXXXX..XXXXXXX 100644
18
index XXXXXXX..XXXXXXX 100644
15
--- a/qemu-doc.texi
19
--- a/block/backup.c
16
+++ b/qemu-doc.texi
20
+++ b/block/backup.c
17
@@ -XXX,XX +XXX,XX @@ in a configuration file provided via '-readconfig' or directly on the
21
@@ -XXX,XX +XXX,XX @@ static const BlockJobDriver backup_job_driver = {
18
command line.
22
.drain = backup_drain,
19
23
};
20
If the initiator-name is not specified qemu will use a default name
24
21
-of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
25
+static int64_t backup_calculate_cluster_size(BlockDriverState *target,
22
+of 'iqn.2008-11.org.linux-kvm[:<uuid>'] where <uuid> is the UUID of the
26
+ Error **errp)
23
+virtual machine. If the UUID is not specified qemu will use
27
+{
24
+'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
28
+ int ret;
25
virtual machine.
29
+ BlockDriverInfo bdi;
26
30
+
31
+ /*
32
+ * If there is no backing file on the target, we cannot rely on COW if our
33
+ * backup cluster size is smaller than the target cluster size. Even for
34
+ * targets with a backing file, try to avoid COW if possible.
35
+ */
36
+ ret = bdrv_get_info(target, &bdi);
37
+ if (ret == -ENOTSUP && !target->backing) {
38
+ /* Cluster size is not defined */
39
+ warn_report("The target block device doesn't provide "
40
+ "information about the block size and it doesn't have a "
41
+ "backing file. The default block size of %u bytes is "
42
+ "used. If the actual block size of the target exceeds "
43
+ "this default, the backup may be unusable",
44
+ BACKUP_CLUSTER_SIZE_DEFAULT);
45
+ return BACKUP_CLUSTER_SIZE_DEFAULT;
46
+ } else if (ret < 0 && !target->backing) {
47
+ error_setg_errno(errp, -ret,
48
+ "Couldn't determine the cluster size of the target image, "
49
+ "which has no backing file");
50
+ error_append_hint(errp,
51
+ "Aborting, since this may create an unusable destination image\n");
52
+ return ret;
53
+ } else if (ret < 0 && target->backing) {
54
+ /* Not fatal; just trudge on ahead. */
55
+ return BACKUP_CLUSTER_SIZE_DEFAULT;
56
+ }
57
+
58
+ return MAX(BACKUP_CLUSTER_SIZE_DEFAULT, bdi.cluster_size);
59
+}
60
+
61
BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
62
BlockDriverState *target, int64_t speed,
63
MirrorSyncMode sync_mode, BdrvDirtyBitmap *sync_bitmap,
64
@@ -XXX,XX +XXX,XX @@ BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
65
JobTxn *txn, Error **errp)
66
{
67
int64_t len;
68
- BlockDriverInfo bdi;
69
BackupBlockJob *job = NULL;
70
int ret;
71
+ int64_t cluster_size;
72
+ HBitmap *copy_bitmap = NULL;
73
74
assert(bs);
75
assert(target);
76
@@ -XXX,XX +XXX,XX @@ BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
77
goto error;
78
}
79
80
+ cluster_size = backup_calculate_cluster_size(target, errp);
81
+ if (cluster_size < 0) {
82
+ goto error;
83
+ }
84
+
85
+ copy_bitmap = hbitmap_alloc(len, ctz32(cluster_size));
86
+
87
/* job->len is fixed, so we can't allow resize */
88
job = block_job_create(job_id, &backup_job_driver, txn, bs,
89
BLK_PERM_CONSISTENT_READ,
90
@@ -XXX,XX +XXX,XX @@ BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
91
92
/* Detect image-fleecing (and similar) schemes */
93
job->serialize_target_writes = bdrv_chain_contains(target, bs);
27
-
94
-
28
@example
95
- /* If there is no backing file on the target, we cannot rely on COW if our
29
Setting a specific initiator name to use when logging in to the target
96
- * backup cluster size is smaller than the target cluster size. Even for
30
-iscsi initiator-name=iqn.qemu.test:my-initiator
97
- * targets with a backing file, try to avoid COW if possible. */
98
- ret = bdrv_get_info(target, &bdi);
99
- if (ret == -ENOTSUP && !target->backing) {
100
- /* Cluster size is not defined */
101
- warn_report("The target block device doesn't provide "
102
- "information about the block size and it doesn't have a "
103
- "backing file. The default block size of %u bytes is "
104
- "used. If the actual block size of the target exceeds "
105
- "this default, the backup may be unusable",
106
- BACKUP_CLUSTER_SIZE_DEFAULT);
107
- job->cluster_size = BACKUP_CLUSTER_SIZE_DEFAULT;
108
- } else if (ret < 0 && !target->backing) {
109
- error_setg_errno(errp, -ret,
110
- "Couldn't determine the cluster size of the target image, "
111
- "which has no backing file");
112
- error_append_hint(errp,
113
- "Aborting, since this may create an unusable destination image\n");
114
- goto error;
115
- } else if (ret < 0 && target->backing) {
116
- /* Not fatal; just trudge on ahead. */
117
- job->cluster_size = BACKUP_CLUSTER_SIZE_DEFAULT;
118
- } else {
119
- job->cluster_size = MAX(BACKUP_CLUSTER_SIZE_DEFAULT, bdi.cluster_size);
120
- }
121
-
122
- job->copy_bitmap = hbitmap_alloc(len, ctz32(job->cluster_size));
123
+ job->cluster_size = cluster_size;
124
+ job->copy_bitmap = copy_bitmap;
125
+ copy_bitmap = NULL;
126
job->use_copy_range = true;
127
job->copy_range_size = MIN_NON_ZERO(blk_get_max_transfer(job->common.blk),
128
blk_get_max_transfer(job->target));
129
@@ -XXX,XX +XXX,XX @@ BlockJob *backup_job_create(const char *job_id, BlockDriverState *bs,
130
return &job->common;
131
132
error:
133
+ if (copy_bitmap) {
134
+ assert(!job || !job->copy_bitmap);
135
+ hbitmap_free(copy_bitmap);
136
+ }
137
if (sync_bitmap) {
138
bdrv_reclaim_dirty_bitmap(bs, sync_bitmap, NULL);
139
}
31
--
140
--
32
2.13.5
141
2.21.0
33
142
34
143
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Alberto Garcia <berto@igalia.com>
2
2
3
The throttling code can change internally the value of bkt->max if it
3
bdrv_unref_child() does the following things:
4
hasn't been set by the user. The problem with this is that if we want
4
5
to retrieve the original value we have to undo this change first. This
5
- Updates the child->bs->inherits_from pointer.
6
is ugly and unnecessary: this patch removes the throttle_fix_bucket()
6
- Calls bdrv_detach_child() to remove the BdrvChild from bs->children.
7
and throttle_unfix_bucket() functions completely and moves the logic
7
- Calls bdrv_unref() to unref the child BlockDriverState.
8
to throttle_compute_wait().
8
9
When bdrv_unref_child() was introduced in commit 33a604075c it was not
10
used in bdrv_close() because the drivers that had additional children
11
(like quorum or blkverify) had already called bdrv_unref() on their
12
children during their own close functions.
13
14
This was changed later (in 0bd6e91a7e for quorum, in 3e586be0b2 for
15
blkverify) so there's no reason not to use bdrv_unref_child() in
16
bdrv_close() anymore.
17
18
After this there's also no need to remove bs->backing and bs->file
19
separately from the rest of the children, so bdrv_close() can be
20
simplified.
21
22
Now bdrv_close() unrefs all children (before this patch it was only
23
bs->file and bs->backing). As a result, none of the callers of
24
brvd_attach_child() should remove their reference to child_bs (because
25
this function effectively steals that reference). This patch updates a
26
couple of tests that were doing their own bdrv_unref().
9
27
10
Signed-off-by: Alberto Garcia <berto@igalia.com>
28
Signed-off-by: Alberto Garcia <berto@igalia.com>
11
Reviewed-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
29
Message-id: 6d1d5feaa53aa1ab127adb73d605dc4503e3abd5.1557754872.git.berto@igalia.com
12
Message-id: 5b0b9e1ac6eb208d709eddc7b09e7669a523bff3.1503580370.git.berto@igalia.com
30
[mreitz: s/where/were/]
13
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
31
Signed-off-by: Max Reitz <mreitz@redhat.com>
14
---
32
---
15
util/throttle.c | 62 +++++++++++++++++++++------------------------------------
33
block.c | 16 +++-------------
16
1 file changed, 23 insertions(+), 39 deletions(-)
34
tests/test-bdrv-drain.c | 6 ------
35
tests/test-bdrv-graph-mod.c | 1 -
36
3 files changed, 3 insertions(+), 20 deletions(-)
17
37
18
diff --git a/util/throttle.c b/util/throttle.c
38
diff --git a/block.c b/block.c
19
index XXXXXXX..XXXXXXX 100644
39
index XXXXXXX..XXXXXXX 100644
20
--- a/util/throttle.c
40
--- a/block.c
21
+++ b/util/throttle.c
41
+++ b/block.c
22
@@ -XXX,XX +XXX,XX @@ static int64_t throttle_do_compute_wait(double limit, double extra)
42
@@ -XXX,XX +XXX,XX @@ static void bdrv_close(BlockDriverState *bs)
23
int64_t throttle_compute_wait(LeakyBucket *bkt)
43
bs->drv = NULL;
24
{
25
double extra; /* the number of extra units blocking the io */
26
+ double bucket_size; /* I/O before throttling to bkt->avg */
27
+ double burst_bucket_size; /* Before throttling to bkt->max */
28
29
if (!bkt->avg) {
30
return 0;
31
}
44
}
32
45
33
- /* If the bucket is full then we have to wait */
46
- bdrv_set_backing_hd(bs, NULL, &error_abort);
34
- extra = bkt->level - bkt->max * bkt->burst_length;
47
-
35
+ if (!bkt->max) {
48
- if (bs->file != NULL) {
36
+ /* If bkt->max is 0 we still want to allow short bursts of I/O
49
- bdrv_unref_child(bs, bs->file);
37
+ * from the guest, otherwise every other request will be throttled
50
- bs->file = NULL;
38
+ * and performance will suffer considerably. */
51
- }
39
+ bucket_size = bkt->avg / 10;
52
-
40
+ burst_bucket_size = 0;
53
QLIST_FOREACH_SAFE(child, &bs->children, next, next) {
41
+ } else {
54
- /* TODO Remove bdrv_unref() from drivers' close function and use
42
+ /* If we have a burst limit then we have to wait until all I/O
55
- * bdrv_unref_child() here */
43
+ * at burst rate has finished before throttling to bkt->avg */
56
- if (child->bs->inherits_from == bs) {
44
+ bucket_size = bkt->max * bkt->burst_length;
57
- child->bs->inherits_from = NULL;
45
+ burst_bucket_size = bkt->max / 10;
58
- }
46
+ }
59
- bdrv_detach_child(child);
47
+
60
+ bdrv_unref_child(bs, child);
48
+ /* If the main bucket is full then we have to wait */
49
+ extra = bkt->level - bucket_size;
50
if (extra > 0) {
51
return throttle_do_compute_wait(bkt->avg, extra);
52
}
61
}
53
62
54
- /* If the bucket is not full yet we have to make sure that we
63
+ bs->backing = NULL;
55
- * fulfill the goal of bkt->max units per second. */
64
+ bs->file = NULL;
56
+ /* If the main bucket is not full yet we still have to check the
65
g_free(bs->opaque);
57
+ * burst bucket in order to enforce the burst limit */
66
bs->opaque = NULL;
58
if (bkt->burst_length > 1) {
67
atomic_set(&bs->copy_on_read, 0);
59
- /* We use 1/10 of the max value to smooth the throttling.
68
diff --git a/tests/test-bdrv-drain.c b/tests/test-bdrv-drain.c
60
- * See throttle_fix_bucket() for more details. */
69
index XXXXXXX..XXXXXXX 100644
61
- extra = bkt->burst_level - bkt->max / 10;
70
--- a/tests/test-bdrv-drain.c
62
+ extra = bkt->burst_level - burst_bucket_size;
71
+++ b/tests/test-bdrv-drain.c
63
if (extra > 0) {
72
@@ -XXX,XX +XXX,XX @@ static void test_detach_indirect(bool by_parent_cb)
64
return throttle_do_compute_wait(bkt->max, extra);
73
bdrv_unref(parent_b);
65
}
74
blk_unref(blk);
66
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
75
67
return true;
76
- /* XXX Once bdrv_close() unref's children instead of just detaching them,
77
- * this won't be necessary any more. */
78
- bdrv_unref(a);
79
- bdrv_unref(a);
80
- bdrv_unref(c);
81
-
82
g_assert_cmpint(a->refcnt, ==, 1);
83
g_assert_cmpint(b->refcnt, ==, 1);
84
g_assert_cmpint(c->refcnt, ==, 1);
85
diff --git a/tests/test-bdrv-graph-mod.c b/tests/test-bdrv-graph-mod.c
86
index XXXXXXX..XXXXXXX 100644
87
--- a/tests/test-bdrv-graph-mod.c
88
+++ b/tests/test-bdrv-graph-mod.c
89
@@ -XXX,XX +XXX,XX @@ static void test_update_perm_tree(void)
90
g_assert_nonnull(local_err);
91
error_free(local_err);
92
93
- bdrv_unref(bs);
94
blk_unref(root);
68
}
95
}
69
96
70
-/* fix bucket parameters */
71
-static void throttle_fix_bucket(LeakyBucket *bkt)
72
-{
73
- double min;
74
-
75
- /* zero bucket level */
76
- bkt->level = bkt->burst_level = 0;
77
-
78
- /* If bkt->max is 0 we still want to allow short bursts of I/O
79
- * from the guest, otherwise every other request will be throttled
80
- * and performance will suffer considerably. */
81
- min = bkt->avg / 10;
82
- if (bkt->avg && !bkt->max) {
83
- bkt->max = min;
84
- }
85
-}
86
-
87
-/* undo internal bucket parameter changes (see throttle_fix_bucket()) */
88
-static void throttle_unfix_bucket(LeakyBucket *bkt)
89
-{
90
- if (bkt->max < bkt->avg) {
91
- bkt->max = 0;
92
- }
93
-}
94
-
95
/* Used to configure the throttle
96
*
97
* @ts: the throttle state we are working on
98
@@ -XXX,XX +XXX,XX @@ void throttle_config(ThrottleState *ts,
99
100
ts->cfg = *cfg;
101
102
+ /* Zero bucket level */
103
for (i = 0; i < BUCKETS_COUNT; i++) {
104
- throttle_fix_bucket(&ts->cfg.buckets[i]);
105
+ ts->cfg.buckets[i].level = 0;
106
+ ts->cfg.buckets[i].burst_level = 0;
107
}
108
109
ts->previous_leak = qemu_clock_get_ns(clock_type);
110
@@ -XXX,XX +XXX,XX @@ void throttle_config(ThrottleState *ts,
111
*/
112
void throttle_get_config(ThrottleState *ts, ThrottleConfig *cfg)
113
{
114
- int i;
115
-
116
*cfg = ts->cfg;
117
-
118
- for (i = 0; i < BUCKETS_COUNT; i++) {
119
- throttle_unfix_bucket(&cfg->buckets[i]);
120
- }
121
}
122
123
124
--
97
--
125
2.13.5
98
2.21.0
126
99
127
100
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Alberto Garcia <berto@igalia.com>
2
2
3
The way the throttling algorithm works is that requests start being
3
A consequence of the previous patch is that bdrv_attach_child()
4
throttled once the bucket level exceeds the burst limit. When we get
4
transfers the reference to child_bs from the caller to parent_bs,
5
there the bucket leaks at the level set by the user (bkt->avg), and
5
which will drop it on bdrv_close() or when someone calls
6
that leak rate is what prevents guest I/O from exceeding the desired
6
bdrv_unref_child().
7
limit.
8
7
9
If we don't allow bursts (i.e. bkt->max == 0) then we can start
8
But this only happens when bdrv_attach_child() succeeds. If it fails
10
throttling requests immediately. The problem with keeping the
9
then the caller is responsible for dropping the reference to child_bs.
11
threshold at 0 is that it only allows one request at a time, and as
12
soon as there's a bit of I/O from the guest every other request will
13
be throttled and performance will suffer considerably. That can even
14
make the guest unable to reach the throttle limit if that limit is
15
high enough, and that happens regardless of the block scheduler used
16
by the guest.
17
10
18
Increasing that threshold gives flexibility to the guest, allowing it
11
This patch makes bdrv_attach_child() take the reference also when
19
to perform short bursts of I/O before being throttled. Increasing the
12
there is an error, freeing the caller for having to do it.
20
threshold too much does not make a difference in the long run (because
21
it's the leak rate what defines the actual throughput) but it does
22
allow the guest to perform longer initial bursts and exceed the
23
throttle limit for a short while.
24
13
25
A burst value of bkt->avg / 10 allows the guest to perform 100ms'
14
A similar situation happens with bdrv_root_attach_child(), so the
26
worth of I/O at the target rate without being throttled.
15
changes on this patch affect both functions.
27
16
28
Signed-off-by: Alberto Garcia <berto@igalia.com>
17
Signed-off-by: Alberto Garcia <berto@igalia.com>
29
Message-id: 31aae6645f0d1fbf3860fb2b528b757236f0c0a7.1503580370.git.berto@igalia.com
18
Message-id: 20dfb3d9ccec559cdd1a9690146abad5d204a186.1557754872.git.berto@igalia.com
30
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
19
[mreitz: Removed now superfluous BdrvChild * variable in
20
bdrv_open_child()]
21
Signed-off-by: Max Reitz <mreitz@redhat.com>
31
---
22
---
32
util/throttle.c | 11 +++--------
23
block.c | 30 ++++++++++++++++++------------
33
1 file changed, 3 insertions(+), 8 deletions(-)
24
block/block-backend.c | 3 +--
25
block/quorum.c | 1 -
26
blockjob.c | 2 +-
27
4 files changed, 20 insertions(+), 16 deletions(-)
34
28
35
diff --git a/util/throttle.c b/util/throttle.c
29
diff --git a/block.c b/block.c
36
index XXXXXXX..XXXXXXX 100644
30
index XXXXXXX..XXXXXXX 100644
37
--- a/util/throttle.c
31
--- a/block.c
38
+++ b/util/throttle.c
32
+++ b/block.c
39
@@ -XXX,XX +XXX,XX @@ static void throttle_fix_bucket(LeakyBucket *bkt)
33
@@ -XXX,XX +XXX,XX @@ static void bdrv_replace_child(BdrvChild *child, BlockDriverState *new_bs)
40
/* zero bucket level */
34
}
41
bkt->level = bkt->burst_level = 0;
35
}
42
36
43
- /* The following is done to cope with the Linux CFQ block scheduler
37
+/*
44
- * which regroup reads and writes by block of 100ms in the guest.
38
+ * This function steals the reference to child_bs from the caller.
45
- * When they are two process one making reads and one making writes cfq
39
+ * That reference is later dropped by bdrv_root_unref_child().
46
- * make a pattern looking like the following:
40
+ *
47
- * WWWWWWWWWWWRRRRRRRRRRRRRRWWWWWWWWWWWWWwRRRRRRRRRRRRRRRRR
41
+ * On failure NULL is returned, errp is set and the reference to
48
- * Having a max burst value of 100ms of the average will help smooth the
42
+ * child_bs is also dropped.
49
- * throttling
43
+ */
50
- */
44
BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs,
51
+ /* If bkt->max is 0 we still want to allow short bursts of I/O
45
const char *child_name,
52
+ * from the guest, otherwise every other request will be throttled
46
const BdrvChildRole *child_role,
53
+ * and performance will suffer considerably. */
47
@@ -XXX,XX +XXX,XX @@ BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs,
54
min = bkt->avg / 10;
48
ret = bdrv_check_update_perm(child_bs, NULL, perm, shared_perm, NULL, errp);
55
if (bkt->avg && !bkt->max) {
49
if (ret < 0) {
56
bkt->max = min;
50
bdrv_abort_perm_update(child_bs);
51
+ bdrv_unref(child_bs);
52
return NULL;
53
}
54
55
@@ -XXX,XX +XXX,XX @@ BdrvChild *bdrv_root_attach_child(BlockDriverState *child_bs,
56
return child;
57
}
58
59
+/*
60
+ * This function transfers the reference to child_bs from the caller
61
+ * to parent_bs. That reference is later dropped by parent_bs on
62
+ * bdrv_close() or if someone calls bdrv_unref_child().
63
+ *
64
+ * On failure NULL is returned, errp is set and the reference to
65
+ * child_bs is also dropped.
66
+ */
67
BdrvChild *bdrv_attach_child(BlockDriverState *parent_bs,
68
BlockDriverState *child_bs,
69
const char *child_name,
70
@@ -XXX,XX +XXX,XX @@ void bdrv_set_backing_hd(BlockDriverState *bs, BlockDriverState *backing_hd,
71
/* If backing_hd was already part of bs's backing chain, and
72
* inherits_from pointed recursively to bs then let's update it to
73
* point directly to bs (else it will become NULL). */
74
- if (update_inherits_from) {
75
+ if (bs->backing && update_inherits_from) {
76
backing_hd->inherits_from = bs;
77
}
78
- if (!bs->backing) {
79
- bdrv_unref(backing_hd);
80
- }
81
82
out:
83
bdrv_refresh_limits(bs, NULL);
84
@@ -XXX,XX +XXX,XX @@ BdrvChild *bdrv_open_child(const char *filename,
85
const BdrvChildRole *child_role,
86
bool allow_none, Error **errp)
87
{
88
- BdrvChild *c;
89
BlockDriverState *bs;
90
91
bs = bdrv_open_child_bs(filename, options, bdref_key, parent, child_role,
92
@@ -XXX,XX +XXX,XX @@ BdrvChild *bdrv_open_child(const char *filename,
93
return NULL;
94
}
95
96
- c = bdrv_attach_child(parent, bs, bdref_key, child_role, errp);
97
- if (!c) {
98
- bdrv_unref(bs);
99
- return NULL;
100
- }
101
-
102
- return c;
103
+ return bdrv_attach_child(parent, bs, bdref_key, child_role, errp);
104
}
105
106
/* TODO Future callers may need to specify parent/child_role in order for
107
diff --git a/block/block-backend.c b/block/block-backend.c
108
index XXXXXXX..XXXXXXX 100644
109
--- a/block/block-backend.c
110
+++ b/block/block-backend.c
111
@@ -XXX,XX +XXX,XX @@ BlockBackend *blk_new_open(const char *filename, const char *reference,
112
blk->root = bdrv_root_attach_child(bs, "root", &child_root,
113
perm, BLK_PERM_ALL, blk, errp);
114
if (!blk->root) {
115
- bdrv_unref(bs);
116
blk_unref(blk);
117
return NULL;
118
}
119
@@ -XXX,XX +XXX,XX @@ void blk_remove_bs(BlockBackend *blk)
120
int blk_insert_bs(BlockBackend *blk, BlockDriverState *bs, Error **errp)
121
{
122
ThrottleGroupMember *tgm = &blk->public.throttle_group_member;
123
+ bdrv_ref(bs);
124
blk->root = bdrv_root_attach_child(bs, "root", &child_root,
125
blk->perm, blk->shared_perm, blk, errp);
126
if (blk->root == NULL) {
127
return -EPERM;
128
}
129
- bdrv_ref(bs);
130
131
notifier_list_notify(&blk->insert_bs_notifiers, blk);
132
if (tgm->throttle_state) {
133
diff --git a/block/quorum.c b/block/quorum.c
134
index XXXXXXX..XXXXXXX 100644
135
--- a/block/quorum.c
136
+++ b/block/quorum.c
137
@@ -XXX,XX +XXX,XX @@ static void quorum_add_child(BlockDriverState *bs, BlockDriverState *child_bs,
138
child = bdrv_attach_child(bs, child_bs, indexstr, &child_format, errp);
139
if (child == NULL) {
140
s->next_child_index--;
141
- bdrv_unref(child_bs);
142
goto out;
143
}
144
s->children = g_renew(BdrvChild *, s->children, s->num_children + 1);
145
diff --git a/blockjob.c b/blockjob.c
146
index XXXXXXX..XXXXXXX 100644
147
--- a/blockjob.c
148
+++ b/blockjob.c
149
@@ -XXX,XX +XXX,XX @@ int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
150
{
151
BdrvChild *c;
152
153
+ bdrv_ref(bs);
154
c = bdrv_root_attach_child(bs, name, &child_job, perm, shared_perm,
155
job, errp);
156
if (c == NULL) {
157
@@ -XXX,XX +XXX,XX @@ int block_job_add_bdrv(BlockJob *job, const char *name, BlockDriverState *bs,
158
}
159
160
job->nodes = g_slist_prepend(job->nodes, c);
161
- bdrv_ref(bs);
162
bdrv_op_block_all(bs, job->blocker);
163
164
return 0;
57
--
165
--
58
2.13.5
166
2.21.0
59
167
60
168
diff view generated by jsdifflib
1
Add the scripts/ directory to sys.path so Python 2.6 will be able to
1
From: Sam Eiderman <shmuel.eiderman@oracle.com>
2
import argparse.
3
2
4
Cc: Daniel P. Berrange <berrange@redhat.com>
3
In safe mode we open the entire chain, including the parent backing
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
4
file of the rebased file.
6
Acked-by: John Snow <jsnow@redhat.com>
5
Do not open a new BlockBackend for the parent backing file, which
7
Acked-by: Fam Zheng <famz@redhat.com>
6
saves opening the rest of the chain twice, which for long chains
8
Message-id: 20170825155732.15665-4-stefanha@redhat.com
7
saves many "pricy" bdrv_open() calls.
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
8
9
Permissions for blk_new() were copied from blk_new_open() when
10
flags = 0.
11
12
Reviewed-by: Karl Heubaum <karl.heubaum@oracle.com>
13
Reviewed-by: Eyal Moscovici <eyal.moscovici@oracle.com>
14
Signed-off-by: Sagi Amit <sagi.amit@oracle.com>
15
Co-developed-by: Sagi Amit <sagi.amit@oracle.com>
16
Signed-off-by: Sam Eiderman <shmuel.eiderman@oracle.com>
17
Message-id: 20190523163337.4497-2-shmuel.eiderman@oracle.com
18
Signed-off-by: Max Reitz <mreitz@redhat.com>
10
---
19
---
11
tests/migration/guestperf/shell.py | 8 +++++---
20
qemu-img.c | 29 +++++++++--------------------
12
1 file changed, 5 insertions(+), 3 deletions(-)
21
1 file changed, 9 insertions(+), 20 deletions(-)
13
22
14
diff --git a/tests/migration/guestperf/shell.py b/tests/migration/guestperf/shell.py
23
diff --git a/qemu-img.c b/qemu-img.c
15
index XXXXXXX..XXXXXXX 100644
24
index XXXXXXX..XXXXXXX 100644
16
--- a/tests/migration/guestperf/shell.py
25
--- a/qemu-img.c
17
+++ b/tests/migration/guestperf/shell.py
26
+++ b/qemu-img.c
18
@@ -XXX,XX +XXX,XX @@
27
@@ -XXX,XX +XXX,XX @@ static int img_rebase(int argc, char **argv)
19
#
28
20
29
/* For safe rebasing we need to compare old and new backing file */
21
30
if (!unsafe) {
22
-import argparse
31
- char backing_name[PATH_MAX];
23
-import fnmatch
32
QDict *options = NULL;
24
import os
33
+ BlockDriverState *base_bs = backing_bs(bs);
25
import os.path
34
26
-import platform
35
- if (bs->backing) {
27
import sys
36
- if (bs->backing_format[0] != '\0') {
28
+sys.path.append(os.path.join(os.path.dirname(__file__),
37
- options = qdict_new();
29
+ '..', '..', '..', 'scripts'))
38
- qdict_put_str(options, "driver", bs->backing_format);
30
+import argparse
39
- }
31
+import fnmatch
40
-
32
+import platform
41
- if (force_share) {
33
42
- if (!options) {
34
from guestperf.hardware import Hardware
43
- options = qdict_new();
35
from guestperf.engine import Engine
44
- }
45
- qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
46
- }
47
- bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
48
- blk_old_backing = blk_new_open(backing_name, NULL,
49
- options, src_flags, &local_err);
50
- if (!blk_old_backing) {
51
+ if (base_bs) {
52
+ blk_old_backing = blk_new(BLK_PERM_CONSISTENT_READ,
53
+ BLK_PERM_ALL);
54
+ ret = blk_insert_bs(blk_old_backing, base_bs,
55
+ &local_err);
56
+ if (ret < 0) {
57
error_reportf_err(local_err,
58
- "Could not open old backing file '%s': ",
59
- backing_name);
60
- ret = -1;
61
+ "Could not reuse old backing file '%s': ",
62
+ base_bs->filename);
63
goto out;
64
}
65
} else {
36
--
66
--
37
2.13.5
67
2.21.0
38
68
39
69
diff view generated by jsdifflib
1
Add the scripts/ directory to sys.path so Python 2.6 will be able to
1
From: Sam Eiderman <shmuel.eiderman@oracle.com>
2
import argparse.
3
2
4
Cc: Fam Zheng <famz@redhat.com>
3
In the following case:
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
4
6
Acked-by: John Snow <jsnow@redhat.com>
5
(base) A <- B <- C (tip)
7
Acked-by: Fam Zheng <famz@redhat.com>
6
8
Message-id: 20170825155732.15665-3-stefanha@redhat.com
7
when running:
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
8
9
qemu-img rebase -b A C
10
11
QEMU would read all sectors not allocated in the file being rebased (C)
12
and compare them to the new base image (A), regardless of whether they
13
were changed or even allocated anywhere along the chain between the new
14
base and the top image (B). This causes many unneeded reads when
15
rebasing an image which represents a small diff of a large disk, as it
16
would read most of the disk's sectors.
17
18
Instead, use bdrv_is_allocated_above() to reduce the number of
19
unnecessary reads.
20
21
Reviewed-by: Karl Heubaum <karl.heubaum@oracle.com>
22
Signed-off-by: Sam Eiderman <shmuel.eiderman@oracle.com>
23
Signed-off-by: Eyal Moscovici <eyal.moscovici@oracle.com>
24
Message-id: 20190523163337.4497-3-shmuel.eiderman@oracle.com
25
Signed-off-by: Max Reitz <mreitz@redhat.com>
10
---
26
---
11
tests/docker/docker.py | 4 +++-
27
qemu-img.c | 25 ++++++++++++++++++++++++-
12
1 file changed, 3 insertions(+), 1 deletion(-)
28
1 file changed, 24 insertions(+), 1 deletion(-)
13
29
14
diff --git a/tests/docker/docker.py b/tests/docker/docker.py
30
diff --git a/qemu-img.c b/qemu-img.c
15
index XXXXXXX..XXXXXXX 100755
31
index XXXXXXX..XXXXXXX 100644
16
--- a/tests/docker/docker.py
32
--- a/qemu-img.c
17
+++ b/tests/docker/docker.py
33
+++ b/qemu-img.c
18
@@ -XXX,XX +XXX,XX @@
34
@@ -XXX,XX +XXX,XX @@ static int img_rebase(int argc, char **argv)
19
35
BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
20
import os
36
uint8_t *buf_old = NULL;
21
import sys
37
uint8_t *buf_new = NULL;
22
+sys.path.append(os.path.join(os.path.dirname(__file__),
38
- BlockDriverState *bs = NULL;
23
+ '..', '..', 'scripts'))
39
+ BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
24
+import argparse
40
char *filename;
25
import subprocess
41
const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
26
import json
42
int c, flags, src_flags, ret;
27
import hashlib
43
@@ -XXX,XX +XXX,XX @@ static int img_rebase(int argc, char **argv)
28
import atexit
44
goto out;
29
import uuid
45
}
30
-import argparse
46
31
import tempfile
47
+ /*
32
import re
48
+ * Find out whether we rebase an image on top of a previous image
33
import signal
49
+ * in its chain.
50
+ */
51
+ prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
52
+
53
blk_new_backing = blk_new_open(out_real_path, NULL,
54
options, src_flags, &local_err);
55
g_free(out_real_path);
56
@@ -XXX,XX +XXX,XX @@ static int img_rebase(int argc, char **argv)
57
continue;
58
}
59
60
+ if (prefix_chain_bs) {
61
+ /*
62
+ * If cluster wasn't changed since prefix_chain, we don't need
63
+ * to take action
64
+ */
65
+ ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
66
+ offset, n, &n);
67
+ if (ret < 0) {
68
+ error_report("error while reading image metadata: %s",
69
+ strerror(-ret));
70
+ goto out;
71
+ }
72
+ if (!ret) {
73
+ continue;
74
+ }
75
+ }
76
+
77
/*
78
* Read old and new backing file and take into consideration that
79
* backing files may be smaller than the COW image.
34
--
80
--
35
2.13.5
81
2.21.0
36
82
37
83
diff view generated by jsdifflib
1
From: Dan Aloni <dan@kernelim.com>
1
From: Sam Eiderman <shmuel.eiderman@oracle.com>
2
2
3
The number of queues that should be return by the admin command should:
3
If a chain was detected, don't open a new BlockBackend from the target
4
backing file which will create a new BlockDriverState. Instead, create
5
an empty BlockBackend and attach the already open BlockDriverState.
4
6
5
1) Only mention the number of non-admin queues.
7
Permissions for blk_new() were copied from blk_new_open() when
6
2) It is zero-based, meaning that '0 == one non-admin queue',
8
flags = 0.
7
'1 == two non-admin queues', and so forth.
8
9
9
Because our `num_queues` means the number of queues _plus_ the admin
10
Reviewed-by: Karl Heubaum <karl.heubaum@oracle.com>
10
queue, then the right calculation for the number returned from the admin
11
Reviewed-by: Eyal Moscovici <eyal.moscovici@oracle.com>
11
command is `num_queues - 2`, combining the two requirements mentioned.
12
Signed-off-by: Sagi Amit <sagi.amit@oracle.com>
13
Co-developed-by: Sagi Amit <sagi.amit@oracle.com>
14
Signed-off-by: Sam Eiderman <shmuel.eiderman@oracle.com>
15
Message-id: 20190523163337.4497-4-shmuel.eiderman@oracle.com
16
Signed-off-by: Max Reitz <mreitz@redhat.com>
17
---
18
qemu-img.c | 33 +++++++++++++++++++++++----------
19
1 file changed, 23 insertions(+), 10 deletions(-)
12
20
13
The issue was discovered by reducing num_queues from 64 to 8 and running
21
diff --git a/qemu-img.c b/qemu-img.c
14
a Linux VM with an SMP parameter larger than that (e.g. 22). It tries to
15
utilize all queues, and therefore fails with an invalid queue number
16
when trying to queue I/Os on the last queue.
17
18
Signed-off-by: Dan Aloni <dan@kernelim.com>
19
CC: Alex Friedman <alex@e8storage.com>
20
CC: Keith Busch <keith.busch@intel.com>
21
CC: Stefan Hajnoczi <stefanha@redhat.com>
22
Reviewed-by: Keith Busch <keith.busch@intel.com>
23
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
24
---
25
hw/block/nvme.c | 4 ++--
26
1 file changed, 2 insertions(+), 2 deletions(-)
27
28
diff --git a/hw/block/nvme.c b/hw/block/nvme.c
29
index XXXXXXX..XXXXXXX 100644
22
index XXXXXXX..XXXXXXX 100644
30
--- a/hw/block/nvme.c
23
--- a/qemu-img.c
31
+++ b/hw/block/nvme.c
24
+++ b/qemu-img.c
32
@@ -XXX,XX +XXX,XX @@ static uint16_t nvme_get_feature(NvmeCtrl *n, NvmeCmd *cmd, NvmeRequest *req)
25
@@ -XXX,XX +XXX,XX @@ static int img_rebase(int argc, char **argv)
33
result = blk_enable_write_cache(n->conf.blk);
26
* in its chain.
34
break;
27
*/
35
case NVME_NUMBER_OF_QUEUES:
28
prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
36
- result = cpu_to_le32((n->num_queues - 1) | ((n->num_queues - 1) << 16));
29
-
37
+ result = cpu_to_le32((n->num_queues - 2) | ((n->num_queues - 2) << 16));
30
- blk_new_backing = blk_new_open(out_real_path, NULL,
38
break;
31
- options, src_flags, &local_err);
39
default:
32
- g_free(out_real_path);
40
return NVME_INVALID_FIELD | NVME_DNR;
33
- if (!blk_new_backing) {
41
@@ -XXX,XX +XXX,XX @@ static uint16_t nvme_set_feature(NvmeCtrl *n, NvmeCmd *cmd, NvmeRequest *req)
34
- error_reportf_err(local_err,
42
break;
35
- "Could not open new backing file '%s': ",
43
case NVME_NUMBER_OF_QUEUES:
36
- out_baseimg);
44
req->cqe.result =
37
- ret = -1;
45
- cpu_to_le32((n->num_queues - 1) | ((n->num_queues - 1) << 16));
38
- goto out;
46
+ cpu_to_le32((n->num_queues - 2) | ((n->num_queues - 2) << 16));
39
+ if (prefix_chain_bs) {
47
break;
40
+ g_free(out_real_path);
48
default:
41
+ blk_new_backing = blk_new(BLK_PERM_CONSISTENT_READ,
49
return NVME_INVALID_FIELD | NVME_DNR;
42
+ BLK_PERM_ALL);
43
+ ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
44
+ &local_err);
45
+ if (ret < 0) {
46
+ error_reportf_err(local_err,
47
+ "Could not reuse backing file '%s': ",
48
+ out_baseimg);
49
+ goto out;
50
+ }
51
+ } else {
52
+ blk_new_backing = blk_new_open(out_real_path, NULL,
53
+ options, src_flags, &local_err);
54
+ g_free(out_real_path);
55
+ if (!blk_new_backing) {
56
+ error_reportf_err(local_err,
57
+ "Could not open new backing file '%s': ",
58
+ out_baseimg);
59
+ ret = -1;
60
+ goto out;
61
+ }
62
}
63
}
64
}
50
--
65
--
51
2.13.5
66
2.21.0
52
67
53
68
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Anton Nefedov <anton.nefedov@virtuozzo.com>
2
2
3
Use a pointer to the bucket instead of repeating cfg->buckets[i] all
3
If COW areas of the newly allocated clusters are zeroes on the backing
4
the time. This makes the code more concise and will help us expand the
4
image, efficient bdrv_write_zeroes(flags=BDRV_REQ_NO_FALLBACK) can be
5
checks later and save a few line breaks.
5
used on the whole cluster instead of writing explicit zero buffers later
6
6
in perform_cow().
7
Signed-off-by: Alberto Garcia <berto@igalia.com>
7
8
Message-id: 763ffc40a26b17d54cf93f5a999e4656049fcf0c.1503580370.git.berto@igalia.com
8
iotest 060:
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
9
write to the discarded cluster does not trigger COW anymore.
10
Use a backing image instead.
11
12
Signed-off-by: Anton Nefedov <anton.nefedov@virtuozzo.com>
13
Message-id: 20190516142749.81019-2-anton.nefedov@virtuozzo.com
14
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
15
Reviewed-by: Alberto Garcia <berto@igalia.com>
16
Signed-off-by: Max Reitz <mreitz@redhat.com>
10
---
17
---
11
util/throttle.c | 15 +++++++--------
18
qapi/block-core.json | 4 +-
12
1 file changed, 7 insertions(+), 8 deletions(-)
19
block/qcow2.h | 6 +++
13
20
block/qcow2-cluster.c | 2 +-
14
diff --git a/util/throttle.c b/util/throttle.c
21
block/qcow2.c | 85 ++++++++++++++++++++++++++++++++++++++
15
index XXXXXXX..XXXXXXX 100644
22
block/trace-events | 1 +
16
--- a/util/throttle.c
23
tests/qemu-iotests/060 | 7 +++-
17
+++ b/util/throttle.c
24
tests/qemu-iotests/060.out | 5 ++-
18
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
25
7 files changed, 106 insertions(+), 4 deletions(-)
26
27
diff --git a/qapi/block-core.json b/qapi/block-core.json
28
index XXXXXXX..XXXXXXX 100644
29
--- a/qapi/block-core.json
30
+++ b/qapi/block-core.json
31
@@ -XXX,XX +XXX,XX @@
32
#
33
# @cor_write: a write due to copy-on-read (since 2.11)
34
#
35
+# @cluster_alloc_space: an allocation of file space for a cluster (since 4.1)
36
+#
37
# Since: 2.9
38
##
39
{ 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
40
@@ -XXX,XX +XXX,XX @@
41
'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
42
'pwritev_zero', 'pwritev_done', 'empty_image_prepare',
43
'l1_shrink_write_table', 'l1_shrink_free_l2_clusters',
44
- 'cor_write'] }
45
+ 'cor_write', 'cluster_alloc_space'] }
46
47
##
48
# @BlkdebugInjectErrorOptions:
49
diff --git a/block/qcow2.h b/block/qcow2.h
50
index XXXXXXX..XXXXXXX 100644
51
--- a/block/qcow2.h
52
+++ b/block/qcow2.h
53
@@ -XXX,XX +XXX,XX @@ typedef struct QCowL2Meta
54
*/
55
Qcow2COWRegion cow_end;
56
57
+ /*
58
+ * Indicates that COW regions are already handled and do not require
59
+ * any more processing.
60
+ */
61
+ bool skip_cow;
62
+
63
/**
64
* The I/O vector with the data from the actual guest write request.
65
* If non-NULL, this is meant to be merged together with the data
66
diff --git a/block/qcow2-cluster.c b/block/qcow2-cluster.c
67
index XXXXXXX..XXXXXXX 100644
68
--- a/block/qcow2-cluster.c
69
+++ b/block/qcow2-cluster.c
70
@@ -XXX,XX +XXX,XX @@ static int perform_cow(BlockDriverState *bs, QCowL2Meta *m)
71
assert(start->offset + start->nb_bytes <= end->offset);
72
assert(!m->data_qiov || m->data_qiov->size == data_bytes);
73
74
- if (start->nb_bytes == 0 && end->nb_bytes == 0) {
75
+ if ((start->nb_bytes == 0 && end->nb_bytes == 0) || m->skip_cow) {
76
return 0;
19
}
77
}
20
78
21
for (i = 0; i < BUCKETS_COUNT; i++) {
79
diff --git a/block/qcow2.c b/block/qcow2.c
22
- if (cfg->buckets[i].avg < 0 ||
80
index XXXXXXX..XXXXXXX 100644
23
- cfg->buckets[i].max < 0 ||
81
--- a/block/qcow2.c
24
- cfg->buckets[i].avg > THROTTLE_VALUE_MAX ||
82
+++ b/block/qcow2.c
25
- cfg->buckets[i].max > THROTTLE_VALUE_MAX) {
83
@@ -XXX,XX +XXX,XX @@ static bool merge_cow(uint64_t offset, unsigned bytes,
26
+ LeakyBucket *bkt = &cfg->buckets[i];
84
continue;
27
+ if (bkt->avg < 0 || bkt->max < 0 ||
28
+ bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
29
error_setg(errp, "bps/iops/max values must be within [0, %lld]",
30
THROTTLE_VALUE_MAX);
31
return false;
32
}
85
}
33
86
34
- if (!cfg->buckets[i].burst_length) {
87
+ /* If COW regions are handled already, skip this too */
35
+ if (!bkt->burst_length) {
88
+ if (m->skip_cow) {
36
error_setg(errp, "the burst length cannot be 0");
89
+ continue;
37
return false;
90
+ }
91
+
92
/* The data (middle) region must be immediately after the
93
* start region */
94
if (l2meta_cow_start(m) + m->cow_start.nb_bytes != offset) {
95
@@ -XXX,XX +XXX,XX @@ static bool merge_cow(uint64_t offset, unsigned bytes,
96
return false;
97
}
98
99
+static bool is_unallocated(BlockDriverState *bs, int64_t offset, int64_t bytes)
100
+{
101
+ int64_t nr;
102
+ return !bytes ||
103
+ (!bdrv_is_allocated_above(bs, NULL, offset, bytes, &nr) && nr == bytes);
104
+}
105
+
106
+static bool is_zero_cow(BlockDriverState *bs, QCowL2Meta *m)
107
+{
108
+ /*
109
+ * This check is designed for optimization shortcut so it must be
110
+ * efficient.
111
+ * Instead of is_zero(), use is_unallocated() as it is faster (but not
112
+ * as accurate and can result in false negatives).
113
+ */
114
+ return is_unallocated(bs, m->offset + m->cow_start.offset,
115
+ m->cow_start.nb_bytes) &&
116
+ is_unallocated(bs, m->offset + m->cow_end.offset,
117
+ m->cow_end.nb_bytes);
118
+}
119
+
120
+static int handle_alloc_space(BlockDriverState *bs, QCowL2Meta *l2meta)
121
+{
122
+ BDRVQcow2State *s = bs->opaque;
123
+ QCowL2Meta *m;
124
+
125
+ if (!(s->data_file->bs->supported_zero_flags & BDRV_REQ_NO_FALLBACK)) {
126
+ return 0;
127
+ }
128
+
129
+ if (bs->encrypted) {
130
+ return 0;
131
+ }
132
+
133
+ for (m = l2meta; m != NULL; m = m->next) {
134
+ int ret;
135
+
136
+ if (!m->cow_start.nb_bytes && !m->cow_end.nb_bytes) {
137
+ continue;
138
+ }
139
+
140
+ if (!is_zero_cow(bs, m)) {
141
+ continue;
142
+ }
143
+
144
+ /*
145
+ * instead of writing zero COW buffers,
146
+ * efficiently zero out the whole clusters
147
+ */
148
+
149
+ ret = qcow2_pre_write_overlap_check(bs, 0, m->alloc_offset,
150
+ m->nb_clusters * s->cluster_size,
151
+ true);
152
+ if (ret < 0) {
153
+ return ret;
154
+ }
155
+
156
+ BLKDBG_EVENT(bs->file, BLKDBG_CLUSTER_ALLOC_SPACE);
157
+ ret = bdrv_co_pwrite_zeroes(s->data_file, m->alloc_offset,
158
+ m->nb_clusters * s->cluster_size,
159
+ BDRV_REQ_NO_FALLBACK);
160
+ if (ret < 0) {
161
+ if (ret != -ENOTSUP && ret != -EAGAIN) {
162
+ return ret;
163
+ }
164
+ continue;
165
+ }
166
+
167
+ trace_qcow2_skip_cow(qemu_coroutine_self(), m->offset, m->nb_clusters);
168
+ m->skip_cow = true;
169
+ }
170
+ return 0;
171
+}
172
+
173
static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
174
uint64_t bytes, QEMUIOVector *qiov,
175
int flags)
176
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
177
qemu_iovec_add(&hd_qiov, cluster_data, cur_bytes);
38
}
178
}
39
179
40
- if (cfg->buckets[i].burst_length > 1 && !cfg->buckets[i].max) {
180
+ /* Try to efficiently initialize the physical space with zeroes */
41
+ if (bkt->burst_length > 1 && !bkt->max) {
181
+ ret = handle_alloc_space(bs, l2meta);
42
error_setg(errp, "burst length set without burst rate");
182
+ if (ret < 0) {
43
return false;
183
+ goto out_unlocked;
44
}
184
+ }
45
185
+
46
- if (cfg->buckets[i].max && !cfg->buckets[i].avg) {
186
/* If we need to do COW, check if it's possible to merge the
47
+ if (bkt->max && !bkt->avg) {
187
* writing of the guest data together with that of the COW regions.
48
error_setg(errp, "bps_max/iops_max require corresponding"
188
* If it's not possible (or not necessary) then write the
49
" bps/iops values");
189
diff --git a/block/trace-events b/block/trace-events
50
return false;
190
index XXXXXXX..XXXXXXX 100644
51
}
191
--- a/block/trace-events
52
192
+++ b/block/trace-events
53
- if (cfg->buckets[i].max && cfg->buckets[i].max < cfg->buckets[i].avg) {
193
@@ -XXX,XX +XXX,XX @@ qcow2_writev_done_part(void *co, int cur_bytes) "co %p cur_bytes %d"
54
+ if (bkt->max && bkt->max < bkt->avg) {
194
qcow2_writev_data(void *co, uint64_t offset) "co %p offset 0x%" PRIx64
55
error_setg(errp, "bps_max/iops_max cannot be lower than bps/iops");
195
qcow2_pwrite_zeroes_start_req(void *co, int64_t offset, int count) "co %p offset 0x%" PRIx64 " count %d"
56
return false;
196
qcow2_pwrite_zeroes(void *co, int64_t offset, int count) "co %p offset 0x%" PRIx64 " count %d"
57
}
197
+qcow2_skip_cow(void *co, uint64_t offset, int nb_clusters) "co %p offset 0x%" PRIx64 " nb_clusters %d"
198
199
# qcow2-cluster.c
200
qcow2_alloc_clusters_offset(void *co, uint64_t offset, int bytes) "co %p offset 0x%" PRIx64 " bytes %d"
201
diff --git a/tests/qemu-iotests/060 b/tests/qemu-iotests/060
202
index XXXXXXX..XXXXXXX 100755
203
--- a/tests/qemu-iotests/060
204
+++ b/tests/qemu-iotests/060
205
@@ -XXX,XX +XXX,XX @@ $QEMU_IO -c "$OPEN_RO" -c "read -P 1 0 512" | _filter_qemu_io
206
echo
207
echo "=== Testing overlap while COW is in flight ==="
208
echo
209
+BACKING_IMG=$TEST_IMG.base
210
+TEST_IMG=$BACKING_IMG _make_test_img 1G
211
+
212
+$QEMU_IO -c 'write 0k 64k' "$BACKING_IMG" | _filter_qemu_io
213
+
214
# compat=0.10 is required in order to make the following discard actually
215
# unallocate the sector rather than make it a zero sector - we want COW, after
216
# all.
217
-IMGOPTS='compat=0.10' _make_test_img 1G
218
+IMGOPTS='compat=0.10' _make_test_img -b "$BACKING_IMG" 1G
219
# Write two clusters, the second one enforces creation of an L2 table after
220
# the first data cluster.
221
$QEMU_IO -c 'write 0k 64k' -c 'write 512M 64k' "$TEST_IMG" | _filter_qemu_io
222
diff --git a/tests/qemu-iotests/060.out b/tests/qemu-iotests/060.out
223
index XXXXXXX..XXXXXXX 100644
224
--- a/tests/qemu-iotests/060.out
225
+++ b/tests/qemu-iotests/060.out
226
@@ -XXX,XX +XXX,XX @@ read 512/512 bytes at offset 0
227
228
=== Testing overlap while COW is in flight ===
229
230
-Formatting 'TEST_DIR/t.IMGFMT', fmt=IMGFMT size=1073741824
231
+Formatting 'TEST_DIR/t.IMGFMT.base', fmt=IMGFMT size=1073741824
232
+wrote 65536/65536 bytes at offset 0
233
+64 KiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
234
+Formatting 'TEST_DIR/t.IMGFMT', fmt=IMGFMT size=1073741824 backing_file=TEST_DIR/t.IMGFMT.base
235
wrote 65536/65536 bytes at offset 0
236
64 KiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
237
wrote 65536/65536 bytes at offset 536870912
58
--
238
--
59
2.13.5
239
2.21.0
60
240
61
241
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Andrey Shinkevich <andrey.shinkevich@virtuozzo.com>
2
2
3
The level of the burst bucket is stored in bkt.burst_level, not
3
Valgrind detects multiple issues in QEMU iotests when the memory is
4
bkt.burst_length.
4
used without being initialized. Valgrind may dump lots of unnecessary
5
reports what makes the memory issue analysis harder. Particularly,
6
that is true for the aligned bitmap directory and can be seen while
7
running the iotest #169. Padding the aligned space with zeros eases
8
the pain.
5
9
6
Signed-off-by: Alberto Garcia <berto@igalia.com>
10
Signed-off-by: Andrey Shinkevich <andrey.shinkevich@virtuozzo.com>
7
Reviewed-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
11
Message-id: 1558961521-131620-1-git-send-email-andrey.shinkevich@virtuozzo.com
8
Message-id: 49aab2711d02f285567f3b3b13a113847af33812.1503580370.git.berto@igalia.com
12
Signed-off-by: Max Reitz <mreitz@redhat.com>
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
---
13
---
11
include/qemu/throttle.h | 2 +-
14
block/qcow2-bitmap.c | 2 +-
12
1 file changed, 1 insertion(+), 1 deletion(-)
15
1 file changed, 1 insertion(+), 1 deletion(-)
13
16
14
diff --git a/include/qemu/throttle.h b/include/qemu/throttle.h
17
diff --git a/block/qcow2-bitmap.c b/block/qcow2-bitmap.c
15
index XXXXXXX..XXXXXXX 100644
18
index XXXXXXX..XXXXXXX 100644
16
--- a/include/qemu/throttle.h
19
--- a/block/qcow2-bitmap.c
17
+++ b/include/qemu/throttle.h
20
+++ b/block/qcow2-bitmap.c
18
@@ -XXX,XX +XXX,XX @@ typedef enum {
21
@@ -XXX,XX +XXX,XX @@ static int bitmap_list_store(BlockDriverState *bs, Qcow2BitmapList *bm_list,
19
* - The bkt.avg rate does not apply until the bucket is full,
22
dir_offset = *offset;
20
* allowing the user to do bursts until then. The I/O limit during
23
}
21
* bursts is bkt.max. To enforce this limit we keep an additional
24
22
- * bucket in bkt.burst_length that leaks at a rate of bkt.max units
25
- dir = g_try_malloc(dir_size);
23
+ * bucket in bkt.burst_level that leaks at a rate of bkt.max units
26
+ dir = g_try_malloc0(dir_size);
24
* per second.
27
if (dir == NULL) {
25
*
28
return -ENOMEM;
26
* - Because of all of the above, the user can perform I/O at a
29
}
27
--
30
--
28
2.13.5
31
2.21.0
29
32
30
33
diff view generated by jsdifflib
1
From: Eduardo Habkost <ehabkost@redhat.com>
1
From: John Snow <jsnow@redhat.com>
2
2
3
If QEMU is running on a system that's out of memory and mmap()
3
We mandate that the source node must be a root node; but there's no reason
4
fails, QEMU aborts with no error message at all, making it hard
4
I am aware of that it needs to be restricted to such. In some cases, we need
5
to debug the reason for the failure.
5
to make sure that there's a medium present, but in the general case we can
6
allow the backup job itself to do the graph checking.
6
7
7
Add perror() calls that will print error information before
8
This patch helps improve the error message when you try to backup from
8
aborting.
9
the same node more than once, which is reflected in the change to test
10
056.
9
11
10
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
12
For backups with bitmaps, it will also show a better error message that
11
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
13
the bitmap is in use instead of giving you something cryptic like "need
12
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
14
a root node."
13
Message-id: 20170829212053.6003-1-ehabkost@redhat.com
15
14
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
16
Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1707303
17
Signed-off-by: John Snow <jsnow@redhat.com>
18
Message-id: 20190521210053.8864-1-jsnow@redhat.com
19
Signed-off-by: Max Reitz <mreitz@redhat.com>
15
---
20
---
16
util/oslib-posix.c | 2 ++
21
blockdev.c | 7 ++++++-
17
1 file changed, 2 insertions(+)
22
tests/qemu-iotests/056 | 2 +-
23
2 files changed, 7 insertions(+), 2 deletions(-)
18
24
19
diff --git a/util/oslib-posix.c b/util/oslib-posix.c
25
diff --git a/blockdev.c b/blockdev.c
20
index XXXXXXX..XXXXXXX 100644
26
index XXXXXXX..XXXXXXX 100644
21
--- a/util/oslib-posix.c
27
--- a/blockdev.c
22
+++ b/util/oslib-posix.c
28
+++ b/blockdev.c
23
@@ -XXX,XX +XXX,XX @@ void *qemu_alloc_stack(size_t *sz)
29
@@ -XXX,XX +XXX,XX @@ static BlockJob *do_drive_backup(DriveBackup *backup, JobTxn *txn,
24
ptr = mmap(NULL, *sz, PROT_READ | PROT_WRITE,
30
backup->compress = false;
25
MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
26
if (ptr == MAP_FAILED) {
27
+ perror("failed to allocate memory for stack");
28
abort();
29
}
31
}
30
32
31
@@ -XXX,XX +XXX,XX @@ void *qemu_alloc_stack(size_t *sz)
33
- bs = qmp_get_root_bs(backup->device, errp);
32
guardpage = ptr;
34
+ bs = bdrv_lookup_bs(backup->device, backup->device, errp);
33
#endif
35
if (!bs) {
34
if (mprotect(guardpage, pagesz, PROT_NONE) != 0) {
36
return NULL;
35
+ perror("failed to set up stack guard page");
36
abort();
37
}
37
}
38
38
39
+ if (!bs->drv) {
40
+ error_setg(errp, "Device has no medium");
41
+ return NULL;
42
+ }
43
+
44
aio_context = bdrv_get_aio_context(bs);
45
aio_context_acquire(aio_context);
46
47
diff --git a/tests/qemu-iotests/056 b/tests/qemu-iotests/056
48
index XXXXXXX..XXXXXXX 100755
49
--- a/tests/qemu-iotests/056
50
+++ b/tests/qemu-iotests/056
51
@@ -XXX,XX +XXX,XX @@ class BackupTest(iotests.QMPTestCase):
52
res = self.vm.qmp('query-block-jobs')
53
self.assert_qmp(res, 'return[0]/status', 'concluded')
54
# Leave zombie job un-dismissed, observe a failure:
55
- res = self.qmp_backup_and_wait(serror='Need a root block node',
56
+ res = self.qmp_backup_and_wait(serror="Node 'drive0' is busy: block device is in use by block job: backup",
57
device='drive0', format=iotests.imgfmt,
58
sync='full', target=self.dest_img,
59
auto_dismiss=False)
39
--
60
--
40
2.13.5
61
2.21.0
41
62
42
63
diff view generated by jsdifflib