1
The following changes since commit 248b23735645f7cbb503d9be6f5bf825f2a603ab:
1
The following changes since commit 1be5a765c08cee3a9587c8a8d3fc2ea247b13f9c:
2
2
3
Update version for v2.10.0-rc4 release (2017-08-24 17:34:26 +0100)
3
Merge tag 'for-upstream' of https://gitlab.com/bonzini/qemu into staging (2022-04-19 18:22:16 -0700)
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://gitlab.com/hreitz/qemu.git tags/pull-block-2022-04-20
8
8
9
for you to fetch changes up to 3e4c705212abfe8c9882a00beb2d1466a8a53cec:
9
for you to fetch changes up to 0423f75351ab83b844a31349218b0eadd830e07a:
10
10
11
qcow2: allocate cluster_cache/cluster_data on demand (2017-08-30 18:02:10 +0100)
11
qcow2: Add errp to rebuild_refcount_structure() (2022-04-20 12:09:17 +0200)
12
12
13
----------------------------------------------------------------
13
----------------------------------------------------------------
14
Block patches:
15
- Some changes for qcow2's refcount repair algorithm to make it work for
16
qcow2 images stored on block devices
17
- Skip test cases that require zstd when support for it is missing
18
- Some refactoring in the iotests' meson.build
14
19
15
----------------------------------------------------------------
20
----------------------------------------------------------------
21
Hanna Reitz (6):
22
iotests.py: Add supports_qcow2_zstd_compression()
23
iotests/065: Check for zstd support
24
iotests/303: Check for zstd support
25
qcow2: Improve refcount structure rebuilding
26
iotests/108: Test new refcount rebuild algorithm
27
qcow2: Add errp to rebuild_refcount_structure()
16
28
17
Alberto Garcia (8):
29
Thomas Huth (2):
18
throttle: Fix wrong variable name in the header documentation
30
tests/qemu-iotests/meson.build: Improve the indentation
19
throttle: Update the throttle_fix_bucket() documentation
31
tests/qemu-iotests: Move the bash and sanitizer checks to meson.build
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
32
27
Dan Aloni (1):
33
block/qcow2-refcount.c | 353 +++++++++++++++++++++++----------
28
nvme: Fix get/set number of queues feature, again
34
tests/check-block.sh | 26 ---
29
35
tests/qemu-iotests/065 | 24 ++-
30
Eduardo Habkost (1):
36
tests/qemu-iotests/108 | 259 +++++++++++++++++++++++-
31
oslib-posix: Print errors before aborting on qemu_alloc_stack()
37
tests/qemu-iotests/108.out | 81 ++++++++
32
38
tests/qemu-iotests/303 | 4 +-
33
Fred Rolland (1):
39
tests/qemu-iotests/iotests.py | 20 ++
34
qemu-doc: Add UUID support in initiator name
40
tests/qemu-iotests/meson.build | 73 ++++---
35
41
8 files changed, 673 insertions(+), 167 deletions(-)
36
Stefan Hajnoczi (4):
37
scripts: add argparse module for Python 2.6 compatibility
38
docker.py: Python 2.6 argparse compatibility
39
tests: migration/guestperf Python 2.6 argparse compatibility
40
qcow2: allocate cluster_cache/cluster_data on demand
41
42
include/qemu/throttle.h | 8 +-
43
block/qcow.c | 12 +-
44
block/qcow2-cluster.c | 17 +
45
block/qcow2.c | 20 +-
46
dump.c | 4 +-
47
hw/block/nvme.c | 4 +-
48
tests/test-throttle.c | 80 +-
49
util/oslib-posix.c | 2 +
50
util/throttle.c | 86 +-
51
COPYING.PYTHON | 270 ++++
52
qemu-doc.texi | 5 +-
53
scripts/argparse.py | 2406 ++++++++++++++++++++++++++++++++++++
54
tests/docker/docker.py | 4 +-
55
tests/migration/guestperf/shell.py | 8 +-
56
14 files changed, 2831 insertions(+), 95 deletions(-)
57
create mode 100644 COPYING.PYTHON
58
create mode 100644 scripts/argparse.py
59
42
60
--
43
--
61
2.13.5
44
2.35.1
62
63
diff view generated by jsdifflib
Deleted patch
1
From: Dan Aloni <dan@kernelim.com>
2
1
3
The number of queues that should be return by the admin command should:
4
5
1) Only mention the number of non-admin queues.
6
2) It is zero-based, meaning that '0 == one non-admin queue',
7
'1 == two non-admin queues', and so forth.
8
9
Because our `num_queues` means the number of queues _plus_ the admin
10
queue, then the right calculation for the number returned from the admin
11
command is `num_queues - 2`, combining the two requirements mentioned.
12
13
The issue was discovered by reducing num_queues from 64 to 8 and running
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
30
--- a/hw/block/nvme.c
31
+++ b/hw/block/nvme.c
32
@@ -XXX,XX +XXX,XX @@ static uint16_t nvme_get_feature(NvmeCtrl *n, NvmeCmd *cmd, NvmeRequest *req)
33
result = blk_enable_write_cache(n->conf.blk);
34
break;
35
case NVME_NUMBER_OF_QUEUES:
36
- result = cpu_to_le32((n->num_queues - 1) | ((n->num_queues - 1) << 16));
37
+ result = cpu_to_le32((n->num_queues - 2) | ((n->num_queues - 2) << 16));
38
break;
39
default:
40
return NVME_INVALID_FIELD | NVME_DNR;
41
@@ -XXX,XX +XXX,XX @@ static uint16_t nvme_set_feature(NvmeCtrl *n, NvmeCmd *cmd, NvmeRequest *req)
42
break;
43
case NVME_NUMBER_OF_QUEUES:
44
req->cqe.result =
45
- cpu_to_le32((n->num_queues - 1) | ((n->num_queues - 1) << 16));
46
+ cpu_to_le32((n->num_queues - 2) | ((n->num_queues - 2) << 16));
47
break;
48
default:
49
return NVME_INVALID_FIELD | NVME_DNR;
50
--
51
2.13.5
52
53
diff view generated by jsdifflib
Deleted patch
1
From: Alberto Garcia <berto@igalia.com>
2
1
3
The level of the burst bucket is stored in bkt.burst_level, not
4
bkt.burst_length.
5
6
Signed-off-by: Alberto Garcia <berto@igalia.com>
7
Reviewed-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
8
Message-id: 49aab2711d02f285567f3b3b13a113847af33812.1503580370.git.berto@igalia.com
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
---
11
include/qemu/throttle.h | 2 +-
12
1 file changed, 1 insertion(+), 1 deletion(-)
13
14
diff --git a/include/qemu/throttle.h b/include/qemu/throttle.h
15
index XXXXXXX..XXXXXXX 100644
16
--- a/include/qemu/throttle.h
17
+++ b/include/qemu/throttle.h
18
@@ -XXX,XX +XXX,XX @@ typedef enum {
19
* - The bkt.avg rate does not apply until the bucket is full,
20
* allowing the user to do bursts until then. The I/O limit during
21
* bursts is bkt.max. To enforce this limit we keep an additional
22
- * bucket in bkt.burst_length that leaks at a rate of bkt.max units
23
+ * bucket in bkt.burst_level that leaks at a rate of bkt.max units
24
* per second.
25
*
26
* - Because of all of the above, the user can perform I/O at a
27
--
28
2.13.5
29
30
diff view generated by jsdifflib
Deleted patch
1
From: Alberto Garcia <berto@igalia.com>
2
1
3
The way the throttling algorithm works is that requests start being
4
throttled once the bucket level exceeds the burst limit. When we get
5
there the bucket leaks at the level set by the user (bkt->avg), and
6
that leak rate is what prevents guest I/O from exceeding the desired
7
limit.
8
9
If we don't allow bursts (i.e. bkt->max == 0) then we can start
10
throttling requests immediately. The problem with keeping the
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
18
Increasing that threshold gives flexibility to the guest, allowing it
19
to perform short bursts of I/O before being throttled. Increasing the
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
25
A burst value of bkt->avg / 10 allows the guest to perform 100ms'
26
worth of I/O at the target rate without being throttled.
27
28
Signed-off-by: Alberto Garcia <berto@igalia.com>
29
Message-id: 31aae6645f0d1fbf3860fb2b528b757236f0c0a7.1503580370.git.berto@igalia.com
30
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
31
---
32
util/throttle.c | 11 +++--------
33
1 file changed, 3 insertions(+), 8 deletions(-)
34
35
diff --git a/util/throttle.c b/util/throttle.c
36
index XXXXXXX..XXXXXXX 100644
37
--- a/util/throttle.c
38
+++ b/util/throttle.c
39
@@ -XXX,XX +XXX,XX @@ static void throttle_fix_bucket(LeakyBucket *bkt)
40
/* zero bucket level */
41
bkt->level = bkt->burst_level = 0;
42
43
- /* The following is done to cope with the Linux CFQ block scheduler
44
- * which regroup reads and writes by block of 100ms in the guest.
45
- * When they are two process one making reads and one making writes cfq
46
- * make a pattern looking like the following:
47
- * WWWWWWWWWWWRRRRRRRRRRRRRRWWWWWWWWWWWWWwRRRRRRRRRRRRRRRRR
48
- * Having a max burst value of 100ms of the average will help smooth the
49
- * throttling
50
- */
51
+ /* If bkt->max is 0 we still want to allow short bursts of I/O
52
+ * from the guest, otherwise every other request will be throttled
53
+ * and performance will suffer considerably. */
54
min = bkt->avg / 10;
55
if (bkt->avg && !bkt->max) {
56
bkt->max = min;
57
--
58
2.13.5
59
60
diff view generated by jsdifflib
Deleted patch
1
From: Alberto Garcia <berto@igalia.com>
2
1
3
Use a pointer to the bucket instead of repeating cfg->buckets[i] all
4
the time. This makes the code more concise and will help us expand the
5
checks later and save a few line breaks.
6
7
Signed-off-by: Alberto Garcia <berto@igalia.com>
8
Message-id: 763ffc40a26b17d54cf93f5a999e4656049fcf0c.1503580370.git.berto@igalia.com
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
---
11
util/throttle.c | 15 +++++++--------
12
1 file changed, 7 insertions(+), 8 deletions(-)
13
14
diff --git a/util/throttle.c b/util/throttle.c
15
index XXXXXXX..XXXXXXX 100644
16
--- a/util/throttle.c
17
+++ b/util/throttle.c
18
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
19
}
20
21
for (i = 0; i < BUCKETS_COUNT; i++) {
22
- if (cfg->buckets[i].avg < 0 ||
23
- cfg->buckets[i].max < 0 ||
24
- cfg->buckets[i].avg > THROTTLE_VALUE_MAX ||
25
- cfg->buckets[i].max > THROTTLE_VALUE_MAX) {
26
+ LeakyBucket *bkt = &cfg->buckets[i];
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
}
33
34
- if (!cfg->buckets[i].burst_length) {
35
+ if (!bkt->burst_length) {
36
error_setg(errp, "the burst length cannot be 0");
37
return false;
38
}
39
40
- if (cfg->buckets[i].burst_length > 1 && !cfg->buckets[i].max) {
41
+ if (bkt->burst_length > 1 && !bkt->max) {
42
error_setg(errp, "burst length set without burst rate");
43
return false;
44
}
45
46
- if (cfg->buckets[i].max && !cfg->buckets[i].avg) {
47
+ if (bkt->max && !bkt->avg) {
48
error_setg(errp, "bps_max/iops_max require corresponding"
49
" bps/iops values");
50
return false;
51
}
52
53
- if (cfg->buckets[i].max && cfg->buckets[i].max < cfg->buckets[i].avg) {
54
+ if (bkt->max && bkt->max < bkt->avg) {
55
error_setg(errp, "bps_max/iops_max cannot be lower than bps/iops");
56
return false;
57
}
58
--
59
2.13.5
60
61
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
From: Thomas Huth <thuth@redhat.com>
2
2
3
Signed-off-by: Alberto Garcia <berto@igalia.com>
3
By using subdir_done(), we can get rid of one level of indentation
4
Message-id: a57dd6274e1b6dc9c28769fec4c7ea543be5c5e3.1503580370.git.berto@igalia.com
4
in this file. This will make it easier to add more conditions to
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
5
skip the iotests in future patches.
6
7
Reviewed-by: Hanna Reitz <hreitz@redhat.com>
8
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
9
Signed-off-by: Thomas Huth <thuth@redhat.com>
10
Message-Id: <20220223093840.2515281-3-thuth@redhat.com>
11
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
6
---
12
---
7
tests/test-throttle.c | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++
13
tests/qemu-iotests/meson.build | 61 ++++++++++++++++++----------------
8
1 file changed, 77 insertions(+)
14
1 file changed, 32 insertions(+), 29 deletions(-)
9
15
10
diff --git a/tests/test-throttle.c b/tests/test-throttle.c
16
diff --git a/tests/qemu-iotests/meson.build b/tests/qemu-iotests/meson.build
11
index XXXXXXX..XXXXXXX 100644
17
index XXXXXXX..XXXXXXX 100644
12
--- a/tests/test-throttle.c
18
--- a/tests/qemu-iotests/meson.build
13
+++ b/tests/test-throttle.c
19
+++ b/tests/qemu-iotests/meson.build
14
@@ -XXX,XX +XXX,XX @@ static void test_is_valid(void)
20
@@ -XXX,XX +XXX,XX @@
15
test_is_valid_for_value(1, true);
21
-if have_tools and targetos != 'windows' and not get_option('gprof')
16
}
22
- qemu_iotests_binaries = [qemu_img, qemu_io, qemu_nbd, qsd]
17
23
- qemu_iotests_env = {'PYTHON': python.full_path()}
18
+static void test_ranges(void)
24
- qemu_iotests_formats = {
19
+{
25
- 'qcow2': 'quick',
20
+ int i;
26
- 'raw': 'slow',
27
- 'qed': 'thorough',
28
- 'vmdk': 'thorough',
29
- 'vpc': 'thorough'
30
- }
31
-
32
- foreach k, v : emulators
33
- if k.startswith('qemu-system-')
34
- qemu_iotests_binaries += v
35
- endif
36
- endforeach
37
- foreach format, speed: qemu_iotests_formats
38
- if speed == 'quick'
39
- suites = 'block'
40
- else
41
- suites = ['block-' + speed, speed]
42
- endif
43
- test('qemu-iotests ' + format, sh, args: [files('../check-block.sh'), format],
44
- depends: qemu_iotests_binaries, env: qemu_iotests_env,
45
- protocol: 'tap',
46
- suite: suites,
47
- timeout: 0,
48
- is_parallel: false)
49
- endforeach
50
+if not have_tools or targetos == 'windows' or get_option('gprof')
51
+ subdir_done()
52
endif
21
+
53
+
22
+ for (i = 0; i < BUCKETS_COUNT; i++) {
54
+qemu_iotests_binaries = [qemu_img, qemu_io, qemu_nbd, qsd]
23
+ LeakyBucket *b = &cfg.buckets[i];
55
+qemu_iotests_env = {'PYTHON': python.full_path()}
24
+ throttle_config_init(&cfg);
56
+qemu_iotests_formats = {
25
+
57
+ 'qcow2': 'quick',
26
+ /* avg = 0 means throttling is disabled, but the config is valid */
58
+ 'raw': 'slow',
27
+ b->avg = 0;
59
+ 'qed': 'thorough',
28
+ g_assert(throttle_is_valid(&cfg, NULL));
60
+ 'vmdk': 'thorough',
29
+ g_assert(!throttle_enabled(&cfg));
61
+ 'vpc': 'thorough'
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
+}
62
+}
93
+
63
+
94
static void test_max_is_missing_limit(void)
64
+foreach k, v : emulators
95
{
65
+ if k.startswith('qemu-system-')
96
int i;
66
+ qemu_iotests_binaries += v
97
@@ -XXX,XX +XXX,XX @@ int main(int argc, char **argv)
67
+ endif
98
g_test_add_func("/throttle/config/enabled", test_enabled);
68
+endforeach
99
g_test_add_func("/throttle/config/conflicting", test_conflicting_config);
69
+
100
g_test_add_func("/throttle/config/is_valid", test_is_valid);
70
+foreach format, speed: qemu_iotests_formats
101
+ g_test_add_func("/throttle/config/ranges", test_ranges);
71
+ if speed == 'quick'
102
g_test_add_func("/throttle/config/max", test_max_is_missing_limit);
72
+ suites = 'block'
103
g_test_add_func("/throttle/config/iops_size",
73
+ else
104
test_iops_size_is_missing_limit);
74
+ suites = ['block-' + speed, speed]
75
+ endif
76
+ test('qemu-iotests ' + format, sh, args: [files('../check-block.sh'), format],
77
+ depends: qemu_iotests_binaries, env: qemu_iotests_env,
78
+ protocol: 'tap',
79
+ suite: suites,
80
+ timeout: 0,
81
+ is_parallel: false)
82
+endforeach
105
--
83
--
106
2.13.5
84
2.35.1
107
85
108
86
diff view generated by jsdifflib
1
Most qcow2 files are uncompressed so it is wasteful to allocate (32 + 1)
1
From: Thomas Huth <thuth@redhat.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
We want to get rid of check-block.sh in the long run, so let's move
7
code paths that can allocate these buffers, so remove the free functions
4
the checks for the bash version and sanitizers from check-block.sh
8
in the error code path.
5
into the meson.build file instead.
9
6
10
This patch can result in significant memory savings when many qcow2
7
Signed-off-by: Thomas Huth <thuth@redhat.com>
11
disks are attached or backing file chains are long:
8
Message-Id: <20220223093840.2515281-4-thuth@redhat.com>
9
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
10
---
11
tests/check-block.sh | 26 --------------------------
12
tests/qemu-iotests/meson.build | 14 ++++++++++++++
13
2 files changed, 14 insertions(+), 26 deletions(-)
12
14
13
Before 12.81% (1,023,193,088B)
15
diff --git a/tests/check-block.sh b/tests/check-block.sh
14
After 5.36% (393,893,888B)
16
index XXXXXXX..XXXXXXX 100755
15
17
--- a/tests/check-block.sh
16
Reported-by: Alexey Kardashevskiy <aik@ozlabs.ru>
18
+++ b/tests/check-block.sh
17
Tested-by: Alexey Kardashevskiy <aik@ozlabs.ru>
19
@@ -XXX,XX +XXX,XX @@ skip() {
18
Reviewed-by: Eric Blake <eblake@redhat.com>
20
exit 0
19
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
21
}
20
Message-id: 20170821135530.32344-1-stefanha@redhat.com
22
21
Cc: Kevin Wolf <kwolf@redhat.com>
23
-# Disable tests with any sanitizer except for specific ones
22
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
24
-SANITIZE_FLAGS=$( grep "CFLAGS.*-fsanitize" config-host.mak 2>/dev/null )
23
---
25
-ALLOWED_SANITIZE_FLAGS="safe-stack cfi-icall"
24
block/qcow2-cluster.c | 17 +++++++++++++++++
26
-#Remove all occurrencies of allowed Sanitize flags
25
block/qcow2.c | 12 ------------
27
-for j in ${ALLOWED_SANITIZE_FLAGS}; do
26
2 files changed, 17 insertions(+), 12 deletions(-)
28
- TMP_FLAGS=${SANITIZE_FLAGS}
27
29
- SANITIZE_FLAGS=""
28
diff --git a/block/qcow2-cluster.c b/block/qcow2-cluster.c
30
- for i in ${TMP_FLAGS}; do
31
- if ! echo ${i} | grep -q "${j}" 2>/dev/null; then
32
- SANITIZE_FLAGS="${SANITIZE_FLAGS} ${i}"
33
- fi
34
- done
35
-done
36
-if echo ${SANITIZE_FLAGS} | grep -q "\-fsanitize" 2>/dev/null; then
37
- # Have a sanitize flag that is not allowed, stop
38
- skip "Sanitizers are enabled ==> Not running the qemu-iotests."
39
-fi
40
-
41
if [ -z "$(find . -name 'qemu-system-*' -print)" ]; then
42
skip "No qemu-system binary available ==> Not running the qemu-iotests."
43
fi
44
45
-if ! command -v bash >/dev/null 2>&1 ; then
46
- skip "bash not available ==> Not running the qemu-iotests."
47
-fi
48
-
49
-if LANG=C bash --version | grep -q 'GNU bash, version [123]' ; then
50
- skip "bash version too old ==> Not running the qemu-iotests."
51
-fi
52
-
53
cd tests/qemu-iotests
54
55
# QEMU_CHECK_BLOCK_AUTO is used to disable some unstable sub-tests
56
diff --git a/tests/qemu-iotests/meson.build b/tests/qemu-iotests/meson.build
29
index XXXXXXX..XXXXXXX 100644
57
index XXXXXXX..XXXXXXX 100644
30
--- a/block/qcow2-cluster.c
58
--- a/tests/qemu-iotests/meson.build
31
+++ b/block/qcow2-cluster.c
59
+++ b/tests/qemu-iotests/meson.build
32
@@ -XXX,XX +XXX,XX @@ int qcow2_decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset)
60
@@ -XXX,XX +XXX,XX @@ if not have_tools or targetos == 'windows' or get_option('gprof')
33
nb_csectors = ((cluster_offset >> s->csize_shift) & s->csize_mask) + 1;
61
subdir_done()
34
sector_offset = coffset & 511;
62
endif
35
csize = nb_csectors * 512 - sector_offset;
63
64
+foreach cflag: config_host['QEMU_CFLAGS'].split()
65
+ if cflag.startswith('-fsanitize') and \
66
+ not cflag.contains('safe-stack') and not cflag.contains('cfi-icall')
67
+ message('Sanitizers are enabled ==> Disabled the qemu-iotests.')
68
+ subdir_done()
69
+ endif
70
+endforeach
36
+
71
+
37
+ /* Allocate buffers on first decompress operation, most images are
72
+bash = find_program('bash', required: false, version: '>= 4.0')
38
+ * uncompressed and the memory overhead can be avoided. The buffers
73
+if not bash.found()
39
+ * are freed in .bdrv_close().
74
+ message('bash >= v4.0 not available ==> Disabled the qemu-iotests.')
40
+ */
75
+ subdir_done()
41
+ if (!s->cluster_data) {
76
+endif
42
+ /* one more sector for decompressed data alignment */
43
+ s->cluster_data = qemu_try_blockalign(bs->file->bs,
44
+ QCOW_MAX_CRYPT_CLUSTERS * s->cluster_size + 512);
45
+ if (!s->cluster_data) {
46
+ return -ENOMEM;
47
+ }
48
+ }
49
+ if (!s->cluster_cache) {
50
+ s->cluster_cache = g_malloc(s->cluster_size);
51
+ }
52
+
77
+
53
BLKDBG_EVENT(bs->file, BLKDBG_READ_COMPRESSED);
78
qemu_iotests_binaries = [qemu_img, qemu_io, qemu_nbd, qsd]
54
ret = bdrv_read(bs->file, coffset >> 9, s->cluster_data,
79
qemu_iotests_env = {'PYTHON': python.full_path()}
55
nb_csectors);
80
qemu_iotests_formats = {
56
diff --git a/block/qcow2.c b/block/qcow2.c
57
index XXXXXXX..XXXXXXX 100644
58
--- a/block/qcow2.c
59
+++ b/block/qcow2.c
60
@@ -XXX,XX +XXX,XX @@ static int qcow2_do_open(BlockDriverState *bs, QDict *options, int flags,
61
goto fail;
62
}
63
64
- s->cluster_cache = g_malloc(s->cluster_size);
65
- /* one more sector for decompressed data alignment */
66
- s->cluster_data = qemu_try_blockalign(bs->file->bs, QCOW_MAX_CRYPT_CLUSTERS
67
- * s->cluster_size + 512);
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
--
81
--
87
2.13.5
82
2.35.1
88
89
diff view generated by jsdifflib
1
From: Fred Rolland <rollandf@gmail.com>
1
Suggested-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
3
Message-Id: <20220323105522.53660-2-hreitz@redhat.com>
4
Reviewed-by: Vladimir Sementsov-Ogievskiy <v.sementsov-og@mail.ru>
5
---
6
tests/qemu-iotests/iotests.py | 20 ++++++++++++++++++++
7
1 file changed, 20 insertions(+)
2
8
3
Update doc with the usage of UUID for initiator name.
9
diff --git a/tests/qemu-iotests/iotests.py b/tests/qemu-iotests/iotests.py
4
5
Related-To: https://bugzilla.redhat.com/1006468
6
Signed-off-by: Fred Rolland <frolland@redhat.com>
7
Message-id: 20170823084830.30500-1-frolland@redhat.com
8
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
9
---
10
qemu-doc.texi | 5 +++--
11
1 file changed, 3 insertions(+), 2 deletions(-)
12
13
diff --git a/qemu-doc.texi b/qemu-doc.texi
14
index XXXXXXX..XXXXXXX 100644
10
index XXXXXXX..XXXXXXX 100644
15
--- a/qemu-doc.texi
11
--- a/tests/qemu-iotests/iotests.py
16
+++ b/qemu-doc.texi
12
+++ b/tests/qemu-iotests/iotests.py
17
@@ -XXX,XX +XXX,XX @@ in a configuration file provided via '-readconfig' or directly on the
13
@@ -XXX,XX +XXX,XX @@ def verify_working_luks():
18
command line.
14
if not working:
19
15
notrun(reason)
20
If the initiator-name is not specified qemu will use a default name
16
21
-of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
17
+def supports_qcow2_zstd_compression() -> bool:
22
+of 'iqn.2008-11.org.linux-kvm[:<uuid>'] where <uuid> is the UUID of the
18
+ img_file = f'{test_dir}/qcow2-zstd-test.qcow2'
23
+virtual machine. If the UUID is not specified qemu will use
19
+ res = qemu_img('create', '-f', 'qcow2', '-o', 'compression_type=zstd',
24
+'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
20
+ img_file, '0',
25
virtual machine.
21
+ check=False)
26
22
+ try:
27
-
23
+ os.remove(img_file)
28
@example
24
+ except OSError:
29
Setting a specific initiator name to use when logging in to the target
25
+ pass
30
-iscsi initiator-name=iqn.qemu.test:my-initiator
26
+
27
+ if res.returncode == 1 and \
28
+ "'compression-type' does not accept value 'zstd'" in res.stdout:
29
+ return False
30
+ else:
31
+ return True
32
+
33
+def verify_qcow2_zstd_compression():
34
+ if not supports_qcow2_zstd_compression():
35
+ notrun('zstd compression not supported')
36
+
37
def qemu_pipe(*args: str) -> str:
38
"""
39
Run qemu with an option to print something and exit (e.g. a help option).
31
--
40
--
32
2.13.5
41
2.35.1
33
34
diff view generated by jsdifflib
1
Add the scripts/ directory to sys.path so Python 2.6 will be able to
1
Some test cases run in iotest 065 want to run with zstd compression just
2
import argparse.
2
for added coverage. Run them with zlib if there is no zstd support
3
compiled in.
3
4
4
Cc: Daniel P. Berrange <berrange@redhat.com>
5
Reported-by: Thomas Huth <thuth@redhat.com>
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
6
Fixes: 12a936171d71f839dc907ff ("iotest 065: explicit compression type")
6
Acked-by: John Snow <jsnow@redhat.com>
7
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
7
Acked-by: Fam Zheng <famz@redhat.com>
8
Message-Id: <20220323105522.53660-3-hreitz@redhat.com>
8
Message-id: 20170825155732.15665-4-stefanha@redhat.com
9
Reviewed-by: Vladimir Sementsov-Ogievskiy <v.sementsov-og@mail.ru>
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
---
10
---
11
tests/migration/guestperf/shell.py | 8 +++++---
11
tests/qemu-iotests/065 | 24 ++++++++++++++++++------
12
1 file changed, 5 insertions(+), 3 deletions(-)
12
1 file changed, 18 insertions(+), 6 deletions(-)
13
13
14
diff --git a/tests/migration/guestperf/shell.py b/tests/migration/guestperf/shell.py
14
diff --git a/tests/qemu-iotests/065 b/tests/qemu-iotests/065
15
index XXXXXXX..XXXXXXX 100644
15
index XXXXXXX..XXXXXXX 100755
16
--- a/tests/migration/guestperf/shell.py
16
--- a/tests/qemu-iotests/065
17
+++ b/tests/migration/guestperf/shell.py
17
+++ b/tests/qemu-iotests/065
18
@@ -XXX,XX +XXX,XX @@
18
@@ -XXX,XX +XXX,XX @@ import os
19
#
19
import re
20
20
import json
21
21
import iotests
22
-import argparse
22
-from iotests import qemu_img, qemu_img_info
23
-import fnmatch
23
+from iotests import qemu_img, qemu_img_info, supports_qcow2_zstd_compression
24
import os
24
import unittest
25
import os.path
25
26
-import platform
26
test_img = os.path.join(iotests.test_dir, 'test.img')
27
import sys
27
@@ -XXX,XX +XXX,XX @@ class TestQCow2(TestQemuImgInfo):
28
+sys.path.append(os.path.join(os.path.dirname(__file__),
28
29
+ '..', '..', '..', 'scripts'))
29
class TestQCow3NotLazy(TestQemuImgInfo):
30
+import argparse
30
'''Testing a qcow2 version 3 image with lazy refcounts disabled'''
31
+import fnmatch
31
- img_options = 'compat=1.1,lazy_refcounts=off,compression_type=zstd'
32
+import platform
32
+ if supports_qcow2_zstd_compression():
33
33
+ compression_type = 'zstd'
34
from guestperf.hardware import Hardware
34
+ else:
35
from guestperf.engine import Engine
35
+ compression_type = 'zlib'
36
+
37
+ img_options = 'compat=1.1,lazy_refcounts=off'
38
+ img_options += f',compression_type={compression_type}'
39
json_compare = { 'compat': '1.1', 'lazy-refcounts': False,
40
'refcount-bits': 16, 'corrupt': False,
41
- 'compression-type': 'zstd', 'extended-l2': False }
42
- human_compare = [ 'compat: 1.1', 'compression type: zstd',
43
+ 'compression-type': compression_type, 'extended-l2': False }
44
+ human_compare = [ 'compat: 1.1', f'compression type: {compression_type}',
45
'lazy refcounts: false', 'refcount bits: 16',
46
'corrupt: false', 'extended l2: false' ]
47
48
@@ -XXX,XX +XXX,XX @@ class TestQCow3NotLazyQMP(TestQMP):
49
class TestQCow3LazyQMP(TestQMP):
50
'''Testing a qcow2 version 3 image with lazy refcounts enabled, opening
51
with lazy refcounts disabled'''
52
- img_options = 'compat=1.1,lazy_refcounts=on,compression_type=zstd'
53
+ if supports_qcow2_zstd_compression():
54
+ compression_type = 'zstd'
55
+ else:
56
+ compression_type = 'zlib'
57
+
58
+ img_options = 'compat=1.1,lazy_refcounts=on'
59
+ img_options += f',compression_type={compression_type}'
60
qemu_options = 'lazy-refcounts=off'
61
compare = { 'compat': '1.1', 'lazy-refcounts': True,
62
'refcount-bits': 16, 'corrupt': False,
63
- 'compression-type': 'zstd', 'extended-l2': False }
64
+ 'compression-type': compression_type, 'extended-l2': False }
65
66
TestImageInfoSpecific = None
67
TestQemuImgInfo = None
36
--
68
--
37
2.13.5
69
2.35.1
38
39
diff view generated by jsdifflib
1
Add the scripts/ directory to sys.path so Python 2.6 will be able to
1
303 runs two test cases, one of which requires zstd support.
2
import argparse.
2
Unfortunately, given that this is not a unittest-style test, we cannot
3
easily skip that single case, and instead can only skip the whole test.
3
4
4
Cc: Fam Zheng <famz@redhat.com>
5
(Alternatively, we could split this test into a zlib and a zstd part,
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
6
but that seems excessive, given that this test is not in auto and thus
6
Acked-by: John Snow <jsnow@redhat.com>
7
likely only run by developers who have zstd support compiled in.)
7
Acked-by: Fam Zheng <famz@redhat.com>
8
8
Message-id: 20170825155732.15665-3-stefanha@redhat.com
9
Fixes: 677e0bae686e7c670a71d1f ("iotest 303: explicit compression type")
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
11
Reviewed-by: Vladimir Sementsov-Ogievskiy <v.sementsov-og@mail.ru>
12
Message-Id: <20220323105522.53660-4-hreitz@redhat.com>
10
---
13
---
11
tests/docker/docker.py | 4 +++-
14
tests/qemu-iotests/303 | 4 +++-
12
1 file changed, 3 insertions(+), 1 deletion(-)
15
1 file changed, 3 insertions(+), 1 deletion(-)
13
16
14
diff --git a/tests/docker/docker.py b/tests/docker/docker.py
17
diff --git a/tests/qemu-iotests/303 b/tests/qemu-iotests/303
15
index XXXXXXX..XXXXXXX 100755
18
index XXXXXXX..XXXXXXX 100755
16
--- a/tests/docker/docker.py
19
--- a/tests/qemu-iotests/303
17
+++ b/tests/docker/docker.py
20
+++ b/tests/qemu-iotests/303
18
@@ -XXX,XX +XXX,XX @@
21
@@ -XXX,XX +XXX,XX @@
19
22
20
import os
23
import iotests
21
import sys
22
+sys.path.append(os.path.join(os.path.dirname(__file__),
23
+ '..', '..', 'scripts'))
24
+import argparse
25
import subprocess
24
import subprocess
26
import json
25
-from iotests import qemu_img_create, qemu_io, file_path, log, filter_qemu_io
27
import hashlib
26
+from iotests import qemu_img_create, qemu_io, file_path, log, filter_qemu_io, \
28
import atexit
27
+ verify_qcow2_zstd_compression
29
import uuid
28
30
-import argparse
29
iotests.script_initialize(supported_fmts=['qcow2'],
31
import tempfile
30
unsupported_imgopts=['refcount_bits', 'compat'])
32
import re
31
+verify_qcow2_zstd_compression()
33
import signal
32
33
disk = file_path('disk')
34
chunk = 1024 * 1024
34
--
35
--
35
2.13.5
36
2.35.1
36
37
diff view generated by jsdifflib
1
From: Alberto Garcia <berto@igalia.com>
1
When rebuilding the refcount structures (when qemu-img check -r found
2
errors with refcount = 0, but reference count > 0), the new refcount
3
table defaults to being put at the image file end[1]. There is no good
4
reason for that except that it means we will not have to rewrite any
5
refblocks we already wrote to disk.
2
6
3
The throttling code can change internally the value of bkt->max if it
7
Changing the code to rewrite those refblocks is not too difficult,
4
hasn't been set by the user. The problem with this is that if we want
8
though, so let us do that. That is beneficial for images on block
5
to retrieve the original value we have to undo this change first. This
9
devices, where we cannot really write beyond the end of the image file.
6
is ugly and unnecessary: this patch removes the throttle_fix_bucket()
7
and throttle_unfix_bucket() functions completely and moves the logic
8
to throttle_compute_wait().
9
10
10
Signed-off-by: Alberto Garcia <berto@igalia.com>
11
Use this opportunity to add extensive comments to the code, and refactor
11
Reviewed-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
12
it a bit, getting rid of the backwards-jumping goto.
12
Message-id: 5b0b9e1ac6eb208d709eddc7b09e7669a523bff3.1503580370.git.berto@igalia.com
13
13
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
14
[1] Unless there is something allocated in the area pointed to by the
15
last refblock, so we have to write that refblock. In that case, we
16
try to put the reftable in there.
17
18
Buglink: https://bugzilla.redhat.com/show_bug.cgi?id=1519071
19
Closes: https://gitlab.com/qemu-project/qemu/-/issues/941
20
Reviewed-by: Eric Blake <eblake@redhat.com>
21
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
22
Message-Id: <20220405134652.19278-2-hreitz@redhat.com>
14
---
23
---
15
util/throttle.c | 62 +++++++++++++++++++++------------------------------------
24
block/qcow2-refcount.c | 332 +++++++++++++++++++++++++++++------------
16
1 file changed, 23 insertions(+), 39 deletions(-)
25
1 file changed, 235 insertions(+), 97 deletions(-)
17
26
18
diff --git a/util/throttle.c b/util/throttle.c
27
diff --git a/block/qcow2-refcount.c b/block/qcow2-refcount.c
19
index XXXXXXX..XXXXXXX 100644
28
index XXXXXXX..XXXXXXX 100644
20
--- a/util/throttle.c
29
--- a/block/qcow2-refcount.c
21
+++ b/util/throttle.c
30
+++ b/block/qcow2-refcount.c
22
@@ -XXX,XX +XXX,XX @@ static int64_t throttle_do_compute_wait(double limit, double extra)
31
@@ -XXX,XX +XXX,XX @@ static int64_t alloc_clusters_imrt(BlockDriverState *bs,
23
int64_t throttle_compute_wait(LeakyBucket *bkt)
32
}
33
34
/*
35
- * Creates a new refcount structure based solely on the in-memory information
36
- * given through *refcount_table. All necessary allocations will be reflected
37
- * in that array.
38
+ * Helper function for rebuild_refcount_structure().
39
*
40
- * On success, the old refcount structure is leaked (it will be covered by the
41
- * new refcount structure).
42
+ * Scan the range of clusters [first_cluster, end_cluster) for allocated
43
+ * clusters and write all corresponding refblocks to disk. The refblock
44
+ * and allocation data is taken from the in-memory refcount table
45
+ * *refcount_table[] (of size *nb_clusters), which is basically one big
46
+ * (unlimited size) refblock for the whole image.
47
+ *
48
+ * For these refblocks, clusters are allocated using said in-memory
49
+ * refcount table. Care is taken that these allocations are reflected
50
+ * in the refblocks written to disk.
51
+ *
52
+ * The refblocks' offsets are written into a reftable, which is
53
+ * *on_disk_reftable_ptr[] (of size *on_disk_reftable_entries_ptr). If
54
+ * that reftable is of insufficient size, it will be resized to fit.
55
+ * This reftable is not written to disk.
56
+ *
57
+ * (If *on_disk_reftable_ptr is not NULL, the entries within are assumed
58
+ * to point to existing valid refblocks that do not need to be allocated
59
+ * again.)
60
+ *
61
+ * Return whether the on-disk reftable array was resized (true/false),
62
+ * or -errno on error.
63
*/
64
-static int rebuild_refcount_structure(BlockDriverState *bs,
65
- BdrvCheckResult *res,
66
- void **refcount_table,
67
- int64_t *nb_clusters)
68
+static int rebuild_refcounts_write_refblocks(
69
+ BlockDriverState *bs, void **refcount_table, int64_t *nb_clusters,
70
+ int64_t first_cluster, int64_t end_cluster,
71
+ uint64_t **on_disk_reftable_ptr, uint32_t *on_disk_reftable_entries_ptr
72
+ )
24
{
73
{
25
double extra; /* the number of extra units blocking the io */
74
BDRVQcow2State *s = bs->opaque;
26
+ double bucket_size; /* I/O before throttling to bkt->avg */
75
- int64_t first_free_cluster = 0, reftable_offset = -1, cluster = 0;
27
+ double burst_bucket_size; /* Before throttling to bkt->max */
76
+ int64_t cluster;
28
77
int64_t refblock_offset, refblock_start, refblock_index;
29
if (!bkt->avg) {
78
- uint32_t reftable_size = 0;
30
return 0;
79
- uint64_t *on_disk_reftable = NULL;
80
+ int64_t first_free_cluster = 0;
81
+ uint64_t *on_disk_reftable = *on_disk_reftable_ptr;
82
+ uint32_t on_disk_reftable_entries = *on_disk_reftable_entries_ptr;
83
void *on_disk_refblock;
84
- int ret = 0;
85
- struct {
86
- uint64_t reftable_offset;
87
- uint32_t reftable_clusters;
88
- } QEMU_PACKED reftable_offset_and_clusters;
89
-
90
- qcow2_cache_empty(bs, s->refcount_block_cache);
91
+ bool reftable_grown = false;
92
+ int ret;
93
94
-write_refblocks:
95
- for (; cluster < *nb_clusters; cluster++) {
96
+ for (cluster = first_cluster; cluster < end_cluster; cluster++) {
97
+ /* Check all clusters to find refblocks that contain non-zero entries */
98
if (!s->get_refcount(*refcount_table, cluster)) {
99
continue;
100
}
101
102
+ /*
103
+ * This cluster is allocated, so we need to create a refblock
104
+ * for it. The data we will write to disk is just the
105
+ * respective slice from *refcount_table, so it will contain
106
+ * accurate refcounts for all clusters belonging to this
107
+ * refblock. After we have written it, we will therefore skip
108
+ * all remaining clusters in this refblock.
109
+ */
110
+
111
refblock_index = cluster >> s->refcount_block_bits;
112
refblock_start = refblock_index << s->refcount_block_bits;
113
114
- /* Don't allocate a cluster in a refblock already written to disk */
115
- if (first_free_cluster < refblock_start) {
116
- first_free_cluster = refblock_start;
117
- }
118
- refblock_offset = alloc_clusters_imrt(bs, 1, refcount_table,
119
- nb_clusters, &first_free_cluster);
120
- if (refblock_offset < 0) {
121
- fprintf(stderr, "ERROR allocating refblock: %s\n",
122
- strerror(-refblock_offset));
123
- res->check_errors++;
124
- ret = refblock_offset;
125
- goto fail;
126
- }
127
+ if (on_disk_reftable_entries > refblock_index &&
128
+ on_disk_reftable[refblock_index])
129
+ {
130
+ /*
131
+ * We can get here after a `goto write_refblocks`: We have a
132
+ * reftable from a previous run, and the refblock is already
133
+ * allocated. No need to allocate it again.
134
+ */
135
+ refblock_offset = on_disk_reftable[refblock_index];
136
+ } else {
137
+ int64_t refblock_cluster_index;
138
139
- if (reftable_size <= refblock_index) {
140
- uint32_t old_reftable_size = reftable_size;
141
- uint64_t *new_on_disk_reftable;
142
+ /* Don't allocate a cluster in a refblock already written to disk */
143
+ if (first_free_cluster < refblock_start) {
144
+ first_free_cluster = refblock_start;
145
+ }
146
+ refblock_offset = alloc_clusters_imrt(bs, 1, refcount_table,
147
+ nb_clusters,
148
+ &first_free_cluster);
149
+ if (refblock_offset < 0) {
150
+ fprintf(stderr, "ERROR allocating refblock: %s\n",
151
+ strerror(-refblock_offset));
152
+ return refblock_offset;
153
+ }
154
155
- reftable_size = ROUND_UP((refblock_index + 1) * REFTABLE_ENTRY_SIZE,
156
- s->cluster_size) / REFTABLE_ENTRY_SIZE;
157
- new_on_disk_reftable = g_try_realloc(on_disk_reftable,
158
- reftable_size *
159
- REFTABLE_ENTRY_SIZE);
160
- if (!new_on_disk_reftable) {
161
- res->check_errors++;
162
- ret = -ENOMEM;
163
- goto fail;
164
+ refblock_cluster_index = refblock_offset / s->cluster_size;
165
+ if (refblock_cluster_index >= end_cluster) {
166
+ /*
167
+ * We must write the refblock that holds this refblock's
168
+ * refcount
169
+ */
170
+ end_cluster = refblock_cluster_index + 1;
171
}
172
- on_disk_reftable = new_on_disk_reftable;
173
174
- memset(on_disk_reftable + old_reftable_size, 0,
175
- (reftable_size - old_reftable_size) * REFTABLE_ENTRY_SIZE);
176
+ if (on_disk_reftable_entries <= refblock_index) {
177
+ on_disk_reftable_entries =
178
+ ROUND_UP((refblock_index + 1) * REFTABLE_ENTRY_SIZE,
179
+ s->cluster_size) / REFTABLE_ENTRY_SIZE;
180
+ on_disk_reftable =
181
+ g_try_realloc(on_disk_reftable,
182
+ on_disk_reftable_entries *
183
+ REFTABLE_ENTRY_SIZE);
184
+ if (!on_disk_reftable) {
185
+ return -ENOMEM;
186
+ }
187
188
- /* The offset we have for the reftable is now no longer valid;
189
- * this will leak that range, but we can easily fix that by running
190
- * a leak-fixing check after this rebuild operation */
191
- reftable_offset = -1;
192
- } else {
193
- assert(on_disk_reftable);
194
- }
195
- on_disk_reftable[refblock_index] = refblock_offset;
196
+ memset(on_disk_reftable + *on_disk_reftable_entries_ptr, 0,
197
+ (on_disk_reftable_entries -
198
+ *on_disk_reftable_entries_ptr) *
199
+ REFTABLE_ENTRY_SIZE);
200
201
- /* If this is apparently the last refblock (for now), try to squeeze the
202
- * reftable in */
203
- if (refblock_index == (*nb_clusters - 1) >> s->refcount_block_bits &&
204
- reftable_offset < 0)
205
- {
206
- uint64_t reftable_clusters = size_to_clusters(s, reftable_size *
207
- REFTABLE_ENTRY_SIZE);
208
- reftable_offset = alloc_clusters_imrt(bs, reftable_clusters,
209
- refcount_table, nb_clusters,
210
- &first_free_cluster);
211
- if (reftable_offset < 0) {
212
- fprintf(stderr, "ERROR allocating reftable: %s\n",
213
- strerror(-reftable_offset));
214
- res->check_errors++;
215
- ret = reftable_offset;
216
- goto fail;
217
+ *on_disk_reftable_ptr = on_disk_reftable;
218
+ *on_disk_reftable_entries_ptr = on_disk_reftable_entries;
219
+
220
+ reftable_grown = true;
221
+ } else {
222
+ assert(on_disk_reftable);
223
}
224
+ on_disk_reftable[refblock_index] = refblock_offset;
225
}
226
227
+ /* Refblock is allocated, write it to disk */
228
+
229
ret = qcow2_pre_write_overlap_check(bs, 0, refblock_offset,
230
s->cluster_size, false);
231
if (ret < 0) {
232
fprintf(stderr, "ERROR writing refblock: %s\n", strerror(-ret));
233
- goto fail;
234
+ return ret;
235
}
236
237
- /* The size of *refcount_table is always cluster-aligned, therefore the
238
- * write operation will not overflow */
239
+ /*
240
+ * The refblock is simply a slice of *refcount_table.
241
+ * Note that the size of *refcount_table is always aligned to
242
+ * whole clusters, so the write operation will not result in
243
+ * out-of-bounds accesses.
244
+ */
245
on_disk_refblock = (void *)((char *) *refcount_table +
246
refblock_index * s->cluster_size);
247
248
@@ -XXX,XX +XXX,XX @@ write_refblocks:
249
s->cluster_size);
250
if (ret < 0) {
251
fprintf(stderr, "ERROR writing refblock: %s\n", strerror(-ret));
252
- goto fail;
253
+ return ret;
254
}
255
256
- /* Go to the end of this refblock */
257
+ /* This refblock is done, skip to its end */
258
cluster = refblock_start + s->refcount_block_size - 1;
31
}
259
}
32
260
33
- /* If the bucket is full then we have to wait */
261
- if (reftable_offset < 0) {
34
- extra = bkt->level - bkt->max * bkt->burst_length;
262
- uint64_t post_refblock_start, reftable_clusters;
35
+ if (!bkt->max) {
263
+ return reftable_grown;
36
+ /* If bkt->max is 0 we still want to allow short bursts of I/O
264
+}
37
+ * from the guest, otherwise every other request will be throttled
265
+
38
+ * and performance will suffer considerably. */
266
+/*
39
+ bucket_size = bkt->avg / 10;
267
+ * Creates a new refcount structure based solely on the in-memory information
40
+ burst_bucket_size = 0;
268
+ * given through *refcount_table (this in-memory information is basically just
41
+ } else {
269
+ * the concatenation of all refblocks). All necessary allocations will be
42
+ /* If we have a burst limit then we have to wait until all I/O
270
+ * reflected in that array.
43
+ * at burst rate has finished before throttling to bkt->avg */
271
+ *
44
+ bucket_size = bkt->max * bkt->burst_length;
272
+ * On success, the old refcount structure is leaked (it will be covered by the
45
+ burst_bucket_size = bkt->max / 10;
273
+ * new refcount structure).
274
+ */
275
+static int rebuild_refcount_structure(BlockDriverState *bs,
276
+ BdrvCheckResult *res,
277
+ void **refcount_table,
278
+ int64_t *nb_clusters)
279
+{
280
+ BDRVQcow2State *s = bs->opaque;
281
+ int64_t reftable_offset = -1;
282
+ int64_t reftable_length = 0;
283
+ int64_t reftable_clusters;
284
+ int64_t refblock_index;
285
+ uint32_t on_disk_reftable_entries = 0;
286
+ uint64_t *on_disk_reftable = NULL;
287
+ int ret = 0;
288
+ int reftable_size_changed = 0;
289
+ struct {
290
+ uint64_t reftable_offset;
291
+ uint32_t reftable_clusters;
292
+ } QEMU_PACKED reftable_offset_and_clusters;
293
+
294
+ qcow2_cache_empty(bs, s->refcount_block_cache);
295
+
296
+ /*
297
+ * For each refblock containing entries, we try to allocate a
298
+ * cluster (in the in-memory refcount table) and write its offset
299
+ * into on_disk_reftable[]. We then write the whole refblock to
300
+ * disk (as a slice of the in-memory refcount table).
301
+ * This is done by rebuild_refcounts_write_refblocks().
302
+ *
303
+ * Once we have scanned all clusters, we try to find space for the
304
+ * reftable. This will dirty the in-memory refcount table (i.e.
305
+ * make it differ from the refblocks we have already written), so we
306
+ * need to run rebuild_refcounts_write_refblocks() again for the
307
+ * range of clusters where the reftable has been allocated.
308
+ *
309
+ * This second run might make the reftable grow again, in which case
310
+ * we will need to allocate another space for it, which is why we
311
+ * repeat all this until the reftable stops growing.
312
+ *
313
+ * (This loop will terminate, because with every cluster the
314
+ * reftable grows, it can accomodate a multitude of more refcounts,
315
+ * so that at some point this must be able to cover the reftable
316
+ * and all refblocks describing it.)
317
+ *
318
+ * We then convert the reftable to big-endian and write it to disk.
319
+ *
320
+ * Note that we never free any reftable allocations. Doing so would
321
+ * needlessly complicate the algorithm: The eventual second check
322
+ * run we do will clean up all leaks we have caused.
323
+ */
324
+
325
+ reftable_size_changed =
326
+ rebuild_refcounts_write_refblocks(bs, refcount_table, nb_clusters,
327
+ 0, *nb_clusters,
328
+ &on_disk_reftable,
329
+ &on_disk_reftable_entries);
330
+ if (reftable_size_changed < 0) {
331
+ res->check_errors++;
332
+ ret = reftable_size_changed;
333
+ goto fail;
46
+ }
334
+ }
47
+
335
+
48
+ /* If the main bucket is full then we have to wait */
336
+ /*
49
+ extra = bkt->level - bucket_size;
337
+ * There was no reftable before, so rebuild_refcounts_write_refblocks()
50
if (extra > 0) {
338
+ * must have increased its size (from 0 to something).
51
return throttle_do_compute_wait(bkt->avg, extra);
339
+ */
340
+ assert(reftable_size_changed);
341
+
342
+ do {
343
+ int64_t reftable_start_cluster, reftable_end_cluster;
344
+ int64_t first_free_cluster = 0;
345
+
346
+ reftable_length = on_disk_reftable_entries * REFTABLE_ENTRY_SIZE;
347
+ reftable_clusters = size_to_clusters(s, reftable_length);
348
349
- post_refblock_start = ROUND_UP(*nb_clusters, s->refcount_block_size);
350
- reftable_clusters =
351
- size_to_clusters(s, reftable_size * REFTABLE_ENTRY_SIZE);
352
- /* Not pretty but simple */
353
- if (first_free_cluster < post_refblock_start) {
354
- first_free_cluster = post_refblock_start;
355
- }
356
reftable_offset = alloc_clusters_imrt(bs, reftable_clusters,
357
refcount_table, nb_clusters,
358
&first_free_cluster);
359
@@ -XXX,XX +XXX,XX @@ write_refblocks:
360
goto fail;
361
}
362
363
- goto write_refblocks;
364
- }
365
+ /*
366
+ * We need to update the affected refblocks, so re-run the
367
+ * write_refblocks loop for the reftable's range of clusters.
368
+ */
369
+ assert(offset_into_cluster(s, reftable_offset) == 0);
370
+ reftable_start_cluster = reftable_offset / s->cluster_size;
371
+ reftable_end_cluster = reftable_start_cluster + reftable_clusters;
372
+ reftable_size_changed =
373
+ rebuild_refcounts_write_refblocks(bs, refcount_table, nb_clusters,
374
+ reftable_start_cluster,
375
+ reftable_end_cluster,
376
+ &on_disk_reftable,
377
+ &on_disk_reftable_entries);
378
+ if (reftable_size_changed < 0) {
379
+ res->check_errors++;
380
+ ret = reftable_size_changed;
381
+ goto fail;
382
+ }
383
+
384
+ /*
385
+ * If the reftable size has changed, we will need to find a new
386
+ * allocation, repeating the loop.
387
+ */
388
+ } while (reftable_size_changed);
389
390
- for (refblock_index = 0; refblock_index < reftable_size; refblock_index++) {
391
+ /* The above loop must have run at least once */
392
+ assert(reftable_offset >= 0);
393
+
394
+ /*
395
+ * All allocations are done, all refblocks are written, convert the
396
+ * reftable to big-endian and write it to disk.
397
+ */
398
+
399
+ for (refblock_index = 0; refblock_index < on_disk_reftable_entries;
400
+ refblock_index++)
401
+ {
402
cpu_to_be64s(&on_disk_reftable[refblock_index]);
52
}
403
}
53
404
54
- /* If the bucket is not full yet we have to make sure that we
405
- ret = qcow2_pre_write_overlap_check(bs, 0, reftable_offset,
55
- * fulfill the goal of bkt->max units per second. */
406
- reftable_size * REFTABLE_ENTRY_SIZE,
56
+ /* If the main bucket is not full yet we still have to check the
407
+ ret = qcow2_pre_write_overlap_check(bs, 0, reftable_offset, reftable_length,
57
+ * burst bucket in order to enforce the burst limit */
408
false);
58
if (bkt->burst_length > 1) {
409
if (ret < 0) {
59
- /* We use 1/10 of the max value to smooth the throttling.
410
fprintf(stderr, "ERROR writing reftable: %s\n", strerror(-ret));
60
- * See throttle_fix_bucket() for more details. */
411
goto fail;
61
- extra = bkt->burst_level - bkt->max / 10;
62
+ extra = bkt->burst_level - burst_bucket_size;
63
if (extra > 0) {
64
return throttle_do_compute_wait(bkt->max, extra);
65
}
66
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
67
return true;
68
}
69
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
}
412
}
108
413
109
ts->previous_leak = qemu_clock_get_ns(clock_type);
414
- assert(reftable_size < INT_MAX / REFTABLE_ENTRY_SIZE);
110
@@ -XXX,XX +XXX,XX @@ void throttle_config(ThrottleState *ts,
415
+ assert(reftable_length < INT_MAX);
111
*/
416
ret = bdrv_pwrite(bs->file, reftable_offset, on_disk_reftable,
112
void throttle_get_config(ThrottleState *ts, ThrottleConfig *cfg)
417
- reftable_size * REFTABLE_ENTRY_SIZE);
113
{
418
+ reftable_length);
114
- int i;
419
if (ret < 0) {
115
-
420
fprintf(stderr, "ERROR writing reftable: %s\n", strerror(-ret));
116
*cfg = ts->cfg;
421
goto fail;
117
-
422
@@ -XXX,XX +XXX,XX @@ write_refblocks:
118
- for (i = 0; i < BUCKETS_COUNT; i++) {
423
/* Enter new reftable into the image header */
119
- throttle_unfix_bucket(&cfg->buckets[i]);
424
reftable_offset_and_clusters.reftable_offset = cpu_to_be64(reftable_offset);
120
- }
425
reftable_offset_and_clusters.reftable_clusters =
121
}
426
- cpu_to_be32(size_to_clusters(s, reftable_size * REFTABLE_ENTRY_SIZE));
122
427
+ cpu_to_be32(reftable_clusters);
123
428
ret = bdrv_pwrite_sync(bs->file,
429
offsetof(QCowHeader, refcount_table_offset),
430
&reftable_offset_and_clusters,
431
@@ -XXX,XX +XXX,XX @@ write_refblocks:
432
goto fail;
433
}
434
435
- for (refblock_index = 0; refblock_index < reftable_size; refblock_index++) {
436
+ for (refblock_index = 0; refblock_index < on_disk_reftable_entries;
437
+ refblock_index++)
438
+ {
439
be64_to_cpus(&on_disk_reftable[refblock_index]);
440
}
441
s->refcount_table = on_disk_reftable;
442
s->refcount_table_offset = reftable_offset;
443
- s->refcount_table_size = reftable_size;
444
+ s->refcount_table_size = on_disk_reftable_entries;
445
update_max_refcount_table_index(s);
446
447
return 0;
124
--
448
--
125
2.13.5
449
2.35.1
126
127
diff view generated by jsdifflib
Deleted patch
1
From: Alberto Garcia <berto@igalia.com>
2
1
3
Both the throttling limits set with the throttling.iops-* and
4
throttling.bps-* options and their QMP equivalents defined in the
5
BlockIOThrottle struct are integer values.
6
7
Those limits are also reported in the BlockDeviceInfo struct and they
8
are integers there as well.
9
10
Therefore there's no reason to store them internally as double and do
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
30
--- a/include/qemu/throttle.h
31
+++ b/include/qemu/throttle.h
32
@@ -XXX,XX +XXX,XX @@ typedef enum {
33
*/
34
35
typedef struct LeakyBucket {
36
- double avg; /* average goal in units per second */
37
- double max; /* leaky bucket max burst in units */
38
+ uint64_t avg; /* average goal in units per second */
39
+ uint64_t max; /* leaky bucket max burst in units */
40
double level; /* bucket level in units */
41
double burst_level; /* bucket level in units (for computing bursts) */
42
unsigned burst_length; /* max length of the burst period, in seconds */
43
diff --git a/tests/test-throttle.c b/tests/test-throttle.c
44
index XXXXXXX..XXXXXXX 100644
45
--- a/tests/test-throttle.c
46
+++ b/tests/test-throttle.c
47
@@ -XXX,XX +XXX,XX @@ static void test_enabled(void)
48
for (i = 0; i < BUCKETS_COUNT; i++) {
49
throttle_config_init(&cfg);
50
set_cfg_value(false, i, 150);
51
+ g_assert(throttle_is_valid(&cfg, NULL));
52
g_assert(throttle_enabled(&cfg));
53
}
54
55
for (i = 0; i < BUCKETS_COUNT; i++) {
56
throttle_config_init(&cfg);
57
set_cfg_value(false, i, -150);
58
- g_assert(!throttle_enabled(&cfg));
59
+ g_assert(!throttle_is_valid(&cfg, NULL));
60
}
61
}
62
63
diff --git a/util/throttle.c b/util/throttle.c
64
index XXXXXXX..XXXXXXX 100644
65
--- a/util/throttle.c
66
+++ b/util/throttle.c
67
@@ -XXX,XX +XXX,XX @@ int64_t throttle_compute_wait(LeakyBucket *bkt)
68
/* If bkt->max is 0 we still want to allow short bursts of I/O
69
* from the guest, otherwise every other request will be throttled
70
* and performance will suffer considerably. */
71
- bucket_size = bkt->avg / 10;
72
+ bucket_size = (double) bkt->avg / 10;
73
burst_bucket_size = 0;
74
} else {
75
/* If we have a burst limit then we have to wait until all I/O
76
* at burst rate has finished before throttling to bkt->avg */
77
bucket_size = bkt->max * bkt->burst_length;
78
- burst_bucket_size = bkt->max / 10;
79
+ burst_bucket_size = (double) bkt->max / 10;
80
}
81
82
/* If the main bucket is full then we have to wait */
83
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
84
85
for (i = 0; i < BUCKETS_COUNT; i++) {
86
LeakyBucket *bkt = &cfg->buckets[i];
87
- if (bkt->avg < 0 || bkt->max < 0 ||
88
- bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
89
+ if (bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
90
error_setg(errp, "bps/iops/max values must be within [0, %lld]",
91
THROTTLE_VALUE_MAX);
92
return false;
93
--
94
2.13.5
95
96
diff view generated by jsdifflib
Deleted patch
1
From: Alberto Garcia <berto@igalia.com>
2
1
3
LeakyBucket.burst_length is defined as an unsigned integer but the
4
code never checks for overflows and it only makes sure that the value
5
is not 0.
6
7
In practice this means that the user can set something like
8
throttling.iops-total-max-length=4294967300 despite being larger than
9
UINT_MAX and the final value after casting to unsigned int will be 4.
10
11
This patch changes the data type to uint64_t. This does not increase
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
32
--- a/include/qemu/throttle.h
33
+++ b/include/qemu/throttle.h
34
@@ -XXX,XX +XXX,XX @@ typedef struct LeakyBucket {
35
uint64_t max; /* leaky bucket max burst in units */
36
double level; /* bucket level in units */
37
double burst_level; /* bucket level in units (for computing bursts) */
38
- unsigned burst_length; /* max length of the burst period, in seconds */
39
+ uint64_t burst_length; /* max length of the burst period, in seconds */
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
}
50
51
+ if (bkt->max && bkt->burst_length > THROTTLE_VALUE_MAX / bkt->max) {
52
+ error_setg(errp, "burst length too high for this burst rate");
53
+ return false;
54
+ }
55
+
56
if (bkt->max && !bkt->avg) {
57
error_setg(errp, "bps_max/iops_max require corresponding"
58
" bps/iops values");
59
--
60
2.13.5
61
62
diff view generated by jsdifflib
1
The minimum Python version supported by QEMU is 2.6. The argparse
1
One clear problem with how qcow2's refcount structure rebuild algorithm
2
standard library module was only added in Python 2.7. Many scripts
2
used to be before "qcow2: Improve refcount structure rebuilding" was
3
would like to use argparse because it supports command-line
3
that it is prone to failure for qcow2 images on block devices: There is
4
sub-commands.
4
generally unused space after the actual image, and if that exceeds what
5
one refblock covers, the old algorithm would invariably write the
6
reftable past the block device's end, which cannot work. The new
7
algorithm does not have this problem.
5
8
6
This patch adds argparse. See the top of argparse.py for details.
9
Test it with three tests:
10
(1) Create an image with more empty space at the end than what one
11
refblock covers, see whether rebuilding the refcount structures
12
results in a change in the image file length. (It should not.)
7
13
8
Suggested-by: Daniel P. Berrange <berrange@redhat.com>
14
(2) Leave precisely enough space somewhere at the beginning of the image
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
15
for the new reftable (and the refblock for that place), see whether
10
Acked-by: John Snow <jsnow@redhat.com>
16
the new algorithm puts the reftable there. (It should.)
11
Message-id: 20170825155732.15665-2-stefanha@redhat.com
17
12
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
18
(3) Test the original problem: Create (something like) a block device
19
with a fixed size, then create a qcow2 image in there, write some
20
data, and then have qemu-img check rebuild the refcount structures.
21
Before HEAD^, the reftable would have been written past the image
22
file end, i.e. outside of what the block device provides, which
23
cannot work. HEAD^ should have fixed that.
24
("Something like a block device" means a loop device if we can use
25
one ("sudo -n losetup" works), or a FUSE block export with
26
growable=false otherwise.)
27
28
Reviewed-by: Eric Blake <eblake@redhat.com>
29
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
30
Message-Id: <20220405134652.19278-3-hreitz@redhat.com>
13
---
31
---
14
COPYING.PYTHON | 270 ++++++
32
tests/qemu-iotests/108 | 259 ++++++++++++++++++++++++++++++++++++-
15
scripts/argparse.py | 2406 +++++++++++++++++++++++++++++++++++++++++++++++++++
33
tests/qemu-iotests/108.out | 81 ++++++++++++
16
2 files changed, 2676 insertions(+)
34
2 files changed, 339 insertions(+), 1 deletion(-)
17
create mode 100644 COPYING.PYTHON
18
create mode 100644 scripts/argparse.py
19
35
20
diff --git a/COPYING.PYTHON b/COPYING.PYTHON
36
diff --git a/tests/qemu-iotests/108 b/tests/qemu-iotests/108
21
new file mode 100644
37
index XXXXXXX..XXXXXXX 100755
22
index XXXXXXX..XXXXXXX
38
--- a/tests/qemu-iotests/108
23
--- /dev/null
39
+++ b/tests/qemu-iotests/108
24
+++ b/COPYING.PYTHON
40
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
25
@@ -XXX,XX +XXX,XX @@
41
26
+A. HISTORY OF THE SOFTWARE
42
_cleanup()
27
+==========================
43
{
28
+
44
-    _cleanup_test_img
29
+Python was created in the early 1990s by Guido van Rossum at Stichting
45
+ _cleanup_test_img
30
+Mathematisch Centrum (CWI, see http://www.cwi.nl) in the Netherlands
46
+ if [ -f "$TEST_DIR/qsd.pid" ]; then
31
+as a successor of a language called ABC. Guido remains Python's
47
+ qsd_pid=$(cat "$TEST_DIR/qsd.pid")
32
+principal author, although it includes many contributions from others.
48
+ kill -KILL "$qsd_pid"
33
+
49
+ fusermount -u "$TEST_DIR/fuse-export" &>/dev/null
34
+In 1995, Guido continued his work on Python at the Corporation for
50
+ fi
35
+National Research Initiatives (CNRI, see http://www.cnri.reston.va.us)
51
+ rm -f "$TEST_DIR/fuse-export"
36
+in Reston, Virginia where he released several versions of the
52
}
37
+software.
53
trap "_cleanup; exit \$status" 0 1 2 3 15
38
+
54
39
+In May 2000, Guido and the Python core development team moved to
55
# get standard environment, filters and checks
40
+BeOpen.com to form the BeOpen PythonLabs team. In October of the same
56
. ./common.rc
41
+year, the PythonLabs team moved to Digital Creations (now Zope
57
. ./common.filter
42
+Corporation, see http://www.zope.com). In 2001, the Python Software
58
+. ./common.qemu
43
+Foundation (PSF, see http://www.python.org/psf/) was formed, a
59
44
+non-profit organization created specifically to own Python-related
60
# This tests qcow2-specific low-level functionality
45
+Intellectual Property. Zope Corporation is a sponsoring member of
61
_supported_fmt qcow2
46
+the PSF.
62
@@ -XXX,XX +XXX,XX @@ _supported_os Linux
47
+
63
# files
48
+All Python releases are Open Source (see http://www.opensource.org for
64
_unsupported_imgopts 'refcount_bits=\([^1]\|.\([^6]\|$\)\)' data_file
49
+the Open Source Definition). Historically, most, but not all, Python
65
50
+releases have also been GPL-compatible; the table below summarizes
66
+# This test either needs sudo -n losetup or FUSE exports to work
51
+the various releases.
67
+if sudo -n losetup &>/dev/null; then
52
+
68
+ loopdev=true
53
+ Release Derived Year Owner GPL-
69
+else
54
+ from compatible? (1)
70
+ loopdev=false
55
+
71
+
56
+ 0.9.0 thru 1.2 1991-1995 CWI yes
72
+ # QSD --export fuse will either yield "Parameter 'id' is missing"
57
+ 1.3 thru 1.5.2 1.2 1995-1999 CNRI yes
73
+ # or "Invalid parameter 'fuse'", depending on whether there is
58
+ 1.6 1.5.2 2000 CNRI no
74
+ # FUSE support or not.
59
+ 2.0 1.6 2000 BeOpen.com no
75
+ error=$($QSD --export fuse 2>&1)
60
+ 1.6.1 1.6 2001 CNRI yes (2)
76
+ if [[ $error = *"'fuse'"* ]]; then
61
+ 2.1 2.0+1.6.1 2001 PSF no
77
+ _notrun 'Passwordless sudo for losetup or FUSE support required, but' \
62
+ 2.0.1 2.0+1.6.1 2001 PSF yes
78
+ 'neither is available'
63
+ 2.1.1 2.1+2.0.1 2001 PSF yes
79
+ fi
64
+ 2.2 2.1.1 2001 PSF yes
80
+fi
65
+ 2.1.2 2.1.1 2002 PSF yes
81
+
66
+ 2.1.3 2.1.2 2002 PSF yes
82
echo
67
+ 2.2.1 2.2 2002 PSF yes
83
echo '=== Repairing an image without any refcount table ==='
68
+ 2.2.2 2.2.1 2002 PSF yes
84
echo
69
+ 2.2.3 2.2.2 2003 PSF yes
85
@@ -XXX,XX +XXX,XX @@ _make_test_img 64M
70
+ 2.3 2.2.2 2002-2003 PSF yes
86
poke_file "$TEST_IMG" $((0x10008)) "\xff\xff\xff\xff\xff\xff\x00\x00"
71
+ 2.3.1 2.3 2002-2003 PSF yes
87
_check_test_img -r all
72
+ 2.3.2 2.3.1 2002-2003 PSF yes
88
73
+ 2.3.3 2.3.2 2002-2003 PSF yes
89
+echo
74
+ 2.3.4 2.3.3 2004 PSF yes
90
+echo '=== Check rebuilt reftable location ==='
75
+ 2.3.5 2.3.4 2005 PSF yes
91
+
76
+ 2.4 2.3 2004 PSF yes
92
+# In an earlier version of the refcount rebuild algorithm, the
77
+ 2.4.1 2.4 2005 PSF yes
93
+# reftable was generally placed at the image end (unless something was
78
+ 2.4.2 2.4.1 2005 PSF yes
94
+# allocated in the area covered by the refblock right before the image
79
+ 2.4.3 2.4.2 2006 PSF yes
95
+# file end, then we would try to place the reftable in that refblock).
80
+ 2.5 2.4 2006 PSF yes
96
+# This was later changed so the reftable would be placed in the
81
+ 2.7 2.6 2010 PSF yes
97
+# earliest possible location. Test this.
82
+
98
+
83
+Footnotes:
99
+echo
84
+
100
+echo '--- Does the image size increase? ---'
85
+(1) GPL-compatible doesn't mean that we're distributing Python under
101
+echo
86
+ the GPL. All Python licenses, unlike the GPL, let you distribute
102
+
87
+ a modified version without making your changes open source. The
103
+# First test: Just create some image, write some data to it, and
88
+ GPL-compatible licenses make it possible to combine Python with
104
+# resize it so there is free space at the end of the image (enough
89
+ other software that is released under the GPL; the others don't.
105
+# that it spans at least one full refblock, which for cluster_size=512
90
+
106
+# images, spans 128k). With the old algorithm, the reftable would
91
+(2) According to Richard Stallman, 1.6.1 is not GPL-compatible,
107
+# have then been placed at the end of the image file, but with the new
92
+ because its license has a choice of law clause. According to
108
+# one, it will be put in that free space.
93
+ CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1
109
+# We want to check whether the size of the image file increases due to
94
+ is "not incompatible" with the GPL.
110
+# rebuilding the refcount structures (it should not).
95
+
111
+
96
+Thanks to the many outside volunteers who have worked under Guido's
112
+_make_test_img -o 'cluster_size=512' 1M
97
+direction to make these releases possible.
113
+# Write something
98
+
114
+$QEMU_IO -c 'write 0 64k' "$TEST_IMG" | _filter_qemu_io
99
+
115
+
100
+B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON
116
+# Add free space
101
+===============================================================
117
+file_len=$(stat -c '%s' "$TEST_IMG")
102
+
118
+truncate -s $((file_len + 256 * 1024)) "$TEST_IMG"
103
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
119
+
104
+--------------------------------------------
120
+# Corrupt the image by saying the image header was not allocated
105
+
121
+rt_offset=$(peek_file_be "$TEST_IMG" 48 8)
106
+1. This LICENSE AGREEMENT is between the Python Software Foundation
122
+rb_offset=$(peek_file_be "$TEST_IMG" $rt_offset 8)
107
+("PSF"), and the Individual or Organization ("Licensee") accessing and
123
+poke_file "$TEST_IMG" $rb_offset "\x00\x00"
108
+otherwise using this software ("Python") in source or binary form and
124
+
109
+its associated documentation.
125
+# Check whether rebuilding the refcount structures increases the image
110
+
126
+# file size
111
+2. Subject to the terms and conditions of this License Agreement, PSF
127
+file_len=$(stat -c '%s' "$TEST_IMG")
112
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
128
+echo
113
+license to reproduce, analyze, test, perform and/or display publicly,
129
+# The only leaks there can be are the old refcount structures that are
114
+prepare derivative works, distribute, and otherwise use Python
130
+# leaked during rebuilding, no need to clutter the output with them
115
+alone or in any derivative version, provided, however, that PSF's
131
+_check_test_img -r all | grep -v '^Repairing cluster.*refcount=1 reference=0'
116
+License Agreement and PSF's notice of copyright, i.e., "Copyright (c)
132
+echo
117
+2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights
133
+post_repair_file_len=$(stat -c '%s' "$TEST_IMG")
118
+Reserved" are retained in Python alone or in any derivative version
134
+
119
+prepared by Licensee.
135
+if [[ $file_len -eq $post_repair_file_len ]]; then
120
+
136
+ echo 'OK: Image size did not change'
121
+3. In the event Licensee prepares a derivative work that is based on
137
+else
122
+or incorporates Python or any part thereof, and wants to make
138
+ echo 'ERROR: Image size differs' \
123
+the derivative work available to others as provided herein, then
139
+ "($file_len before, $post_repair_file_len after)"
124
+Licensee hereby agrees to include in any such work a brief summary of
140
+fi
125
+the changes made to Python.
141
+
126
+
142
+echo
127
+4. PSF is making Python available to Licensee on an "AS IS"
143
+echo '--- Will the reftable occupy a hole specifically left for it? ---'
128
+basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
144
+echo
129
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
145
+
130
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
146
+# Note: With cluster_size=512, every refblock covers 128k.
131
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
147
+# The reftable covers 8M per reftable cluster.
132
+INFRINGE ANY THIRD PARTY RIGHTS.
148
+
133
+
149
+# Create an image that requires two reftable clusters (just because
134
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
150
+# this is more interesting than a single-clustered reftable).
135
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
151
+_make_test_img -o 'cluster_size=512' 9M
136
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
152
+$QEMU_IO -c 'write 0 8M' "$TEST_IMG" | _filter_qemu_io
137
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
153
+
138
+
154
+# Writing 8M will have resized the reftable. Unfortunately, doing so
139
+6. This License Agreement will automatically terminate upon a material
155
+# will leave holes in the file, so we need to fill them up so we can
140
+breach of its terms and conditions.
156
+# be sure the whole file is allocated. Do that by writing
141
+
157
+# consecutively smaller chunks starting from 8 MB, until the file
142
+7. Nothing in this License Agreement shall be deemed to create any
158
+# length increases even with a chunk size of 512. Then we must have
143
+relationship of agency, partnership, or joint venture between PSF and
159
+# filled all holes.
144
+Licensee. This License Agreement does not grant permission to use PSF
160
+ofs=$((8 * 1024 * 1024))
145
+trademarks or trade name in a trademark sense to endorse or promote
161
+block_len=$((16 * 1024))
146
+products or services of Licensee, or any third party.
162
+while [[ $block_len -ge 512 ]]; do
147
+
163
+ file_len=$(stat -c '%s' "$TEST_IMG")
148
+8. By copying, installing or otherwise using Python, Licensee
164
+ while [[ $(stat -c '%s' "$TEST_IMG") -eq $file_len ]]; do
149
+agrees to be bound by the terms and conditions of this License
165
+ # Do not include this in the reference output, it does not
150
+Agreement.
166
+ # really matter which qemu-io calls we do here exactly
151
+
167
+ $QEMU_IO -c "write $ofs $block_len" "$TEST_IMG" >/dev/null
152
+
168
+ ofs=$((ofs + block_len))
153
+BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
169
+ done
154
+-------------------------------------------
170
+ block_len=$((block_len / 2))
155
+
171
+done
156
+BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
172
+
157
+
173
+# Fill up to 9M (do not include this in the reference output either,
158
+1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
174
+# $ofs is random for all we know)
159
+office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
175
+$QEMU_IO -c "write $ofs $((9 * 1024 * 1024 - ofs))" "$TEST_IMG" >/dev/null
160
+Individual or Organization ("Licensee") accessing and otherwise using
176
+
161
+this software in source or binary form and its associated
177
+# Make space as follows:
162
+documentation ("the Software").
178
+# - For the first refblock: Right at the beginning of the image (this
163
+
179
+# refblock is placed in the first place possible),
164
+2. Subject to the terms and conditions of this BeOpen Python License
180
+# - For the reftable somewhere soon afterwards, still near the
165
+Agreement, BeOpen hereby grants Licensee a non-exclusive,
181
+# beginning of the image (i.e. covered by the first refblock); the
166
+royalty-free, world-wide license to reproduce, analyze, test, perform
182
+# reftable too is placed in the first place possible, but only after
167
+and/or display publicly, prepare derivative works, distribute, and
183
+# all refblocks have been placed)
168
+otherwise use the Software alone or in any derivative version,
184
+# No space is needed for the other refblocks, because no refblock is
169
+provided, however, that the BeOpen Python License is retained in the
185
+# put before the space it covers. In this test case, we do not mind
170
+Software, alone or in any derivative version prepared by Licensee.
186
+# if they are placed at the image file's end.
171
+
187
+
172
+3. BeOpen is making the Software available to Licensee on an "AS IS"
188
+# Before we make that space, we have to find out the host offset of
173
+basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
189
+# the area that belonged to the two data clusters at guest offset 4k,
174
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
190
+# because we expect the reftable to be placed there, and we will have
175
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
191
+# to verify that it is.
176
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
192
+
177
+INFRINGE ANY THIRD PARTY RIGHTS.
193
+l1_offset=$(peek_file_be "$TEST_IMG" 40 8)
178
+
194
+l2_offset=$(peek_file_be "$TEST_IMG" $l1_offset 8)
179
+4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
195
+l2_offset=$((l2_offset & 0x00fffffffffffe00))
180
+SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
196
+data_4k_offset=$(peek_file_be "$TEST_IMG" \
181
+AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
197
+ $((l2_offset + 4096 / 512 * 8)) 8)
182
+DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
198
+data_4k_offset=$((data_4k_offset & 0x00fffffffffffe00))
183
+
199
+
184
+5. This License Agreement will automatically terminate upon a material
200
+$QEMU_IO -c "discard 0 512" -c "discard 4k 1k" "$TEST_IMG" | _filter_qemu_io
185
+breach of its terms and conditions.
201
+
186
+
202
+# Corrupt the image by saying the image header was not allocated
187
+6. This License Agreement shall be governed by and interpreted in all
203
+rt_offset=$(peek_file_be "$TEST_IMG" 48 8)
188
+respects by the law of the State of California, excluding conflict of
204
+rb_offset=$(peek_file_be "$TEST_IMG" $rt_offset 8)
189
+law provisions. Nothing in this License Agreement shall be deemed to
205
+poke_file "$TEST_IMG" $rb_offset "\x00\x00"
190
+create any relationship of agency, partnership, or joint venture
206
+
191
+between BeOpen and Licensee. This License Agreement does not grant
207
+echo
192
+permission to use BeOpen trademarks or trade names in a trademark
208
+# The only leaks there can be are the old refcount structures that are
193
+sense to endorse or promote products or services of Licensee, or any
209
+# leaked during rebuilding, no need to clutter the output with them
194
+third party. As an exception, the "BeOpen Python" logos available at
210
+_check_test_img -r all | grep -v '^Repairing cluster.*refcount=1 reference=0'
195
+http://www.pythonlabs.com/logos.html may be used according to the
211
+echo
196
+permissions granted on that web page.
212
+
197
+
213
+# Check whether the reftable was put where we expected
198
+7. By copying, installing or otherwise using the software, Licensee
214
+rt_offset=$(peek_file_be "$TEST_IMG" 48 8)
199
+agrees to be bound by the terms and conditions of this License
215
+if [[ $rt_offset -eq $data_4k_offset ]]; then
200
+Agreement.
216
+ echo 'OK: Reftable is where we expect it'
201
+
217
+else
202
+
218
+ echo "ERROR: Reftable is at $rt_offset, but was expected at $data_4k_offset"
203
+CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
219
+fi
204
+---------------------------------------
220
+
205
+
221
+echo
206
+1. This LICENSE AGREEMENT is between the Corporation for National
222
+echo '--- Rebuilding refcount structures on block devices ---'
207
+Research Initiatives, having an office at 1895 Preston White Drive,
223
+echo
208
+Reston, VA 20191 ("CNRI"), and the Individual or Organization
224
+
209
+("Licensee") accessing and otherwise using Python 1.6.1 software in
225
+# A block device cannot really grow, at least not during qemu-img
210
+source or binary form and its associated documentation.
226
+# check. As mentioned in the above cases, rebuilding the refcount
211
+
227
+# structure may lead to new refcount structures being written after
212
+2. Subject to the terms and conditions of this License Agreement, CNRI
228
+# the end of the image, and in the past that happened even if there
213
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
229
+# was more than sufficient space in the image. Such post-EOF writes
214
+license to reproduce, analyze, test, perform and/or display publicly,
230
+# will not work on block devices, so test that the new algorithm
215
+prepare derivative works, distribute, and otherwise use Python 1.6.1
231
+# avoids it.
216
+alone or in any derivative version, provided, however, that CNRI's
232
+
217
+License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
233
+# If we have passwordless sudo and losetup, we can use those to create
218
+1995-2001 Corporation for National Research Initiatives; All Rights
234
+# a block device. Otherwise, we can resort to qemu's FUSE export to
219
+Reserved" are retained in Python 1.6.1 alone or in any derivative
235
+# create a file that isn't growable, which effectively tests the same
220
+version prepared by Licensee. Alternately, in lieu of CNRI's License
236
+# thing.
221
+Agreement, Licensee may substitute the following text (omitting the
237
+
222
+quotes): "Python 1.6.1 is made available subject to the terms and
238
+_cleanup_test_img
223
+conditions in CNRI's License Agreement. This Agreement together with
239
+truncate -s $((64 * 1024 * 1024)) "$TEST_IMG"
224
+Python 1.6.1 may be located on the Internet using the following
240
+
225
+unique, persistent identifier (known as a handle): 1895.22/1013. This
241
+if $loopdev; then
226
+Agreement may also be obtained from a proxy server on the Internet
242
+ export_mp=$(sudo -n losetup --show -f "$TEST_IMG")
227
+using the following URL: http://hdl.handle.net/1895.22/1013".
243
+ export_mp_driver=host_device
228
+
244
+ sudo -n chmod go+rw "$export_mp"
229
+3. In the event Licensee prepares a derivative work that is based on
245
+else
230
+or incorporates Python 1.6.1 or any part thereof, and wants to make
246
+ # Create non-growable FUSE export that is a bit like an empty
231
+the derivative work available to others as provided herein, then
247
+ # block device
232
+Licensee hereby agrees to include in any such work a brief summary of
248
+ export_mp="$TEST_DIR/fuse-export"
233
+the changes made to Python 1.6.1.
249
+ export_mp_driver=file
234
+
250
+ touch "$export_mp"
235
+4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
251
+
236
+basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
252
+ $QSD \
237
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
253
+ --blockdev file,node-name=export-node,filename="$TEST_IMG" \
238
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
254
+ --export fuse,id=fuse-export,node-name=export-node,mountpoint="$export_mp",writable=on,growable=off \
239
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
255
+ --pidfile "$TEST_DIR/qsd.pid" \
240
+INFRINGE ANY THIRD PARTY RIGHTS.
256
+ --daemonize
241
+
257
+fi
242
+5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
258
+
243
+1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
259
+# Now create a qcow2 image on the device -- unfortunately, qemu-img
244
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
260
+# create force-creates the file, so we have to resort to the
245
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
261
+# blockdev-create job.
246
+
262
+_launch_qemu \
247
+6. This License Agreement will automatically terminate upon a material
263
+ --blockdev $export_mp_driver,node-name=file,filename="$export_mp"
248
+breach of its terms and conditions.
264
+
249
+
265
+_send_qemu_cmd \
250
+7. This License Agreement shall be governed by the federal
266
+ $QEMU_HANDLE \
251
+intellectual property law of the United States, including without
267
+ '{ "execute": "qmp_capabilities" }' \
252
+limitation the federal copyright law, and, to the extent such
268
+ 'return'
253
+U.S. federal law does not apply, by the law of the Commonwealth of
269
+
254
+Virginia, excluding Virginia's conflict of law provisions.
270
+# Small cluster size again, so the image needs multiple refblocks
255
+Notwithstanding the foregoing, with regard to derivative works based
271
+_send_qemu_cmd \
256
+on Python 1.6.1 that incorporate non-separable material that was
272
+ $QEMU_HANDLE \
257
+previously distributed under the GNU General Public License (GPL), the
273
+ '{ "execute": "blockdev-create",
258
+law of the Commonwealth of Virginia shall govern this License
274
+ "arguments": {
259
+Agreement only as to issues arising under or with respect to
275
+ "job-id": "create",
260
+Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this
276
+ "options": {
261
+License Agreement shall be deemed to create any relationship of
277
+ "driver": "qcow2",
262
+agency, partnership, or joint venture between CNRI and Licensee. This
278
+ "file": "file",
263
+License Agreement does not grant permission to use CNRI trademarks or
279
+ "size": '$((64 * 1024 * 1024))',
264
+trade name in a trademark sense to endorse or promote products or
280
+ "cluster-size": 512
265
+services of Licensee, or any third party.
281
+ } } }' \
266
+
282
+ '"concluded"'
267
+8. By clicking on the "ACCEPT" button where indicated, or by copying,
283
+
268
+installing or otherwise using Python 1.6.1, Licensee agrees to be
284
+_send_qemu_cmd \
269
+bound by the terms and conditions of this License Agreement.
285
+ $QEMU_HANDLE \
270
+
286
+ '{ "execute": "job-dismiss", "arguments": { "id": "create" } }' \
271
+ ACCEPT
287
+ 'return'
272
+
288
+
273
+
289
+_send_qemu_cmd \
274
+CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
290
+ $QEMU_HANDLE \
275
+--------------------------------------------------
291
+ '{ "execute": "quit" }' \
276
+
292
+ 'return'
277
+Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
293
+
278
+The Netherlands. All rights reserved.
294
+wait=y _cleanup_qemu
279
+
295
+echo
280
+Permission to use, copy, modify, and distribute this software and its
296
+
281
+documentation for any purpose and without fee is hereby granted,
297
+# Write some data
282
+provided that the above copyright notice appear in all copies and that
298
+$QEMU_IO -c 'write 0 64k' "$export_mp" | _filter_qemu_io
283
+both that copyright notice and this permission notice appear in
299
+
284
+supporting documentation, and that the name of Stichting Mathematisch
300
+# Corrupt the image by saying the image header was not allocated
285
+Centrum or CWI not be used in advertising or publicity pertaining to
301
+rt_offset=$(peek_file_be "$export_mp" 48 8)
286
+distribution of the software without specific, written prior
302
+rb_offset=$(peek_file_be "$export_mp" $rt_offset 8)
287
+permission.
303
+poke_file "$export_mp" $rb_offset "\x00\x00"
288
+
304
+
289
+STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
305
+# Repairing such a simple case should just work
290
+THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
306
+# (We used to put the reftable at the end of the image file, which can
291
+FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
307
+# never work for non-growable devices.)
292
+FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
308
+echo
293
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
309
+TEST_IMG="$export_mp" _check_test_img -r all \
294
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
310
+ | grep -v '^Repairing cluster.*refcount=1 reference=0'
295
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
311
+
296
diff --git a/scripts/argparse.py b/scripts/argparse.py
312
+if $loopdev; then
297
new file mode 100644
313
+ sudo -n losetup -d "$export_mp"
298
index XXXXXXX..XXXXXXX
314
+else
299
--- /dev/null
315
+ qsd_pid=$(cat "$TEST_DIR/qsd.pid")
300
+++ b/scripts/argparse.py
316
+ kill -TERM "$qsd_pid"
301
@@ -XXX,XX +XXX,XX @@
317
+ # Wait for process to exit (cannot `wait` because the QSD is daemonized)
302
+# This is a local copy of the standard library argparse module taken from PyPI.
318
+ while [ -f "$TEST_DIR/qsd.pid" ]; do
303
+# It is licensed under the Python Software Foundation License. This is a
319
+ true
304
+# fallback for Python 2.6 which does not include this module. Python 2.7+ and
320
+ done
305
+# 3+ will never load this module because built-in modules are loaded before
321
+fi
306
+# anything in sys.path.
322
+
307
+#
323
# success, all done
308
+# If your script is not located in the same directory as this file, import it
324
echo '*** done'
309
+# like this:
325
rm -f $seq.full
310
+#
326
diff --git a/tests/qemu-iotests/108.out b/tests/qemu-iotests/108.out
311
+# import os
327
index XXXXXXX..XXXXXXX 100644
312
+# import sys
328
--- a/tests/qemu-iotests/108.out
313
+# sys.path.append(os.path.join(os.path.dirname(__file__), ..., 'scripts'))
329
+++ b/tests/qemu-iotests/108.out
314
+# import argparse
330
@@ -XXX,XX +XXX,XX @@ The following inconsistencies were found and repaired:
315
+
331
0 leaked clusters
316
+# Author: Steven J. Bethard <steven.bethard@gmail.com>.
332
1 corruptions
317
+# Maintainer: Thomas Waldmann <tw@waldmann-edv.de>
333
318
+
334
+Double checking the fixed image now...
319
+"""Command-line parsing library
335
+No errors were found on the image.
320
+
336
+
321
+This module is an optparse-inspired command-line parsing library that:
337
+=== Check rebuilt reftable location ===
322
+
338
+
323
+ - handles both optional and positional arguments
339
+--- Does the image size increase? ---
324
+ - produces highly informative usage messages
340
+
325
+ - supports parsers that dispatch to sub-parsers
341
+Formatting 'TEST_DIR/t.IMGFMT', fmt=IMGFMT size=1048576
326
+
342
+wrote 65536/65536 bytes at offset 0
327
+The following is a simple usage example that sums integers from the
343
+64 KiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
328
+command-line and writes the result to a file::
344
+
329
+
345
+ERROR cluster 0 refcount=0 reference=1
330
+ parser = argparse.ArgumentParser(
346
+Rebuilding refcount structure
331
+ description='sum the integers at the command line')
347
+The following inconsistencies were found and repaired:
332
+ parser.add_argument(
348
+
333
+ 'integers', metavar='int', nargs='+', type=int,
349
+ 0 leaked clusters
334
+ help='an integer to be summed')
350
+ 1 corruptions
335
+ parser.add_argument(
351
+
336
+ '--log', default=sys.stdout, type=argparse.FileType('w'),
352
+Double checking the fixed image now...
337
+ help='the file where the sum should be written')
353
+No errors were found on the image.
338
+ args = parser.parse_args()
354
+
339
+ args.log.write('%s' % sum(args.integers))
355
+OK: Image size did not change
340
+ args.log.close()
356
+
341
+
357
+--- Will the reftable occupy a hole specifically left for it? ---
342
+The module contains the following public classes:
358
+
343
+
359
+Formatting 'TEST_DIR/t.IMGFMT', fmt=IMGFMT size=9437184
344
+ - ArgumentParser -- The main entry point for command-line parsing. As the
360
+wrote 8388608/8388608 bytes at offset 0
345
+ example above shows, the add_argument() method is used to populate
361
+8 MiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
346
+ the parser with actions for optional and positional arguments. Then
362
+discard 512/512 bytes at offset 0
347
+ the parse_args() method is invoked to convert the args at the
363
+512 bytes, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
348
+ command-line into an object with attributes.
364
+discard 1024/1024 bytes at offset 4096
349
+
365
+1 KiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
350
+ - ArgumentError -- The exception raised by ArgumentParser objects when
366
+
351
+ there are errors with the parser's actions. Errors raised while
367
+ERROR cluster 0 refcount=0 reference=1
352
+ parsing the command-line are caught by ArgumentParser and emitted
368
+Rebuilding refcount structure
353
+ as command-line messages.
369
+The following inconsistencies were found and repaired:
354
+
370
+
355
+ - FileType -- A factory for defining types of files to be created. As the
371
+ 0 leaked clusters
356
+ example above shows, instances of FileType are typically passed as
372
+ 1 corruptions
357
+ the type= argument of add_argument() calls.
373
+
358
+
374
+Double checking the fixed image now...
359
+ - Action -- The base class for parser actions. Typically actions are
375
+No errors were found on the image.
360
+ selected by passing strings like 'store_true' or 'append_const' to
376
+
361
+ the action= argument of add_argument(). However, for greater
377
+OK: Reftable is where we expect it
362
+ customization of ArgumentParser actions, subclasses of Action may
378
+
363
+ be defined and passed as the action= argument.
379
+--- Rebuilding refcount structures on block devices ---
364
+
380
+
365
+ - HelpFormatter, RawDescriptionHelpFormatter, RawTextHelpFormatter,
381
+{ "execute": "qmp_capabilities" }
366
+ ArgumentDefaultsHelpFormatter -- Formatter classes which
382
+{"return": {}}
367
+ may be passed as the formatter_class= argument to the
383
+{ "execute": "blockdev-create",
368
+ ArgumentParser constructor. HelpFormatter is the default,
384
+ "arguments": {
369
+ RawDescriptionHelpFormatter and RawTextHelpFormatter tell the parser
385
+ "job-id": "create",
370
+ not to change the formatting for help text, and
386
+ "options": {
371
+ ArgumentDefaultsHelpFormatter adds information about argument defaults
387
+ "driver": "IMGFMT",
372
+ to the help.
388
+ "file": "file",
373
+
389
+ "size": 67108864,
374
+All other classes in this module are considered implementation details.
390
+ "cluster-size": 512
375
+(Also note that HelpFormatter and RawDescriptionHelpFormatter are only
391
+ } } }
376
+considered public as object names -- the API of the formatter objects is
392
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "JOB_STATUS_CHANGE", "data": {"status": "created", "id": "create"}}
377
+still considered an implementation detail.)
393
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "JOB_STATUS_CHANGE", "data": {"status": "running", "id": "create"}}
378
+"""
394
+{"return": {}}
379
+
395
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "JOB_STATUS_CHANGE", "data": {"status": "waiting", "id": "create"}}
380
+__version__ = '1.4.0' # we use our own version number independant of the
396
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "JOB_STATUS_CHANGE", "data": {"status": "pending", "id": "create"}}
381
+ # one in stdlib and we release this on pypi.
397
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "JOB_STATUS_CHANGE", "data": {"status": "concluded", "id": "create"}}
382
+
398
+{ "execute": "job-dismiss", "arguments": { "id": "create" } }
383
+__external_lib__ = True # to make sure the tests really test THIS lib,
399
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "JOB_STATUS_CHANGE", "data": {"status": "null", "id": "create"}}
384
+ # not the builtin one in Python stdlib
400
+{"return": {}}
385
+
401
+{ "execute": "quit" }
386
+__all__ = [
402
+{"return": {}}
387
+ 'ArgumentParser',
403
+{"timestamp": {"seconds": TIMESTAMP, "microseconds": TIMESTAMP}, "event": "SHUTDOWN", "data": {"guest": false, "reason": "host-qmp-quit"}}
388
+ 'ArgumentError',
404
+
389
+ 'ArgumentTypeError',
405
+wrote 65536/65536 bytes at offset 0
390
+ 'FileType',
406
+64 KiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
391
+ 'HelpFormatter',
407
+
392
+ 'ArgumentDefaultsHelpFormatter',
408
+ERROR cluster 0 refcount=0 reference=1
393
+ 'RawDescriptionHelpFormatter',
409
+Rebuilding refcount structure
394
+ 'RawTextHelpFormatter',
410
+The following inconsistencies were found and repaired:
395
+ 'Namespace',
411
+
396
+ 'Action',
412
+ 0 leaked clusters
397
+ 'ONE_OR_MORE',
413
+ 1 corruptions
398
+ 'OPTIONAL',
414
+
399
+ 'PARSER',
415
Double checking the fixed image now...
400
+ 'REMAINDER',
416
No errors were found on the image.
401
+ 'SUPPRESS',
417
*** done
402
+ 'ZERO_OR_MORE',
403
+]
404
+
405
+
406
+import copy as _copy
407
+import os as _os
408
+import re as _re
409
+import sys as _sys
410
+import textwrap as _textwrap
411
+
412
+from gettext import gettext as _
413
+
414
+try:
415
+ set
416
+except NameError:
417
+ # for python < 2.4 compatibility (sets module is there since 2.3):
418
+ from sets import Set as set
419
+
420
+try:
421
+ basestring
422
+except NameError:
423
+ basestring = str
424
+
425
+try:
426
+ sorted
427
+except NameError:
428
+ # for python < 2.4 compatibility:
429
+ def sorted(iterable, reverse=False):
430
+ result = list(iterable)
431
+ result.sort()
432
+ if reverse:
433
+ result.reverse()
434
+ return result
435
+
436
+
437
+def _callable(obj):
438
+ return hasattr(obj, '__call__') or hasattr(obj, '__bases__')
439
+
440
+
441
+SUPPRESS = '==SUPPRESS=='
442
+
443
+OPTIONAL = '?'
444
+ZERO_OR_MORE = '*'
445
+ONE_OR_MORE = '+'
446
+PARSER = 'A...'
447
+REMAINDER = '...'
448
+_UNRECOGNIZED_ARGS_ATTR = '_unrecognized_args'
449
+
450
+# =============================
451
+# Utility functions and classes
452
+# =============================
453
+
454
+class _AttributeHolder(object):
455
+ """Abstract base class that provides __repr__.
456
+
457
+ The __repr__ method returns a string in the format::
458
+ ClassName(attr=name, attr=name, ...)
459
+ The attributes are determined either by a class-level attribute,
460
+ '_kwarg_names', or by inspecting the instance __dict__.
461
+ """
462
+
463
+ def __repr__(self):
464
+ type_name = type(self).__name__
465
+ arg_strings = []
466
+ for arg in self._get_args():
467
+ arg_strings.append(repr(arg))
468
+ for name, value in self._get_kwargs():
469
+ arg_strings.append('%s=%r' % (name, value))
470
+ return '%s(%s)' % (type_name, ', '.join(arg_strings))
471
+
472
+ def _get_kwargs(self):
473
+ return sorted(self.__dict__.items())
474
+
475
+ def _get_args(self):
476
+ return []
477
+
478
+
479
+def _ensure_value(namespace, name, value):
480
+ if getattr(namespace, name, None) is None:
481
+ setattr(namespace, name, value)
482
+ return getattr(namespace, name)
483
+
484
+
485
+# ===============
486
+# Formatting Help
487
+# ===============
488
+
489
+class HelpFormatter(object):
490
+ """Formatter for generating usage messages and argument help strings.
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
--
418
--
2709
2.13.5
419
2.35.1
2710
2711
diff view generated by jsdifflib
1
From: Eduardo Habkost <ehabkost@redhat.com>
1
Instead of fprint()-ing error messages in rebuild_refcount_structure()
2
and its rebuild_refcounts_write_refblocks() helper, pass them through an
3
Error object to qcow2_check_refcounts() (which will then print it).
2
4
3
If QEMU is running on a system that's out of memory and mmap()
5
Suggested-by: Eric Blake <eblake@redhat.com>
4
fails, QEMU aborts with no error message at all, making it hard
6
Signed-off-by: Hanna Reitz <hreitz@redhat.com>
5
to debug the reason for the failure.
7
Message-Id: <20220405134652.19278-4-hreitz@redhat.com>
8
Reviewed-by: Eric Blake <eblake@redhat.com>
9
---
10
block/qcow2-refcount.c | 33 +++++++++++++++++++--------------
11
1 file changed, 19 insertions(+), 14 deletions(-)
6
12
7
Add perror() calls that will print error information before
13
diff --git a/block/qcow2-refcount.c b/block/qcow2-refcount.c
8
aborting.
9
10
Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
11
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
12
Tested-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
13
Message-id: 20170829212053.6003-1-ehabkost@redhat.com
14
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
15
---
16
util/oslib-posix.c | 2 ++
17
1 file changed, 2 insertions(+)
18
19
diff --git a/util/oslib-posix.c b/util/oslib-posix.c
20
index XXXXXXX..XXXXXXX 100644
14
index XXXXXXX..XXXXXXX 100644
21
--- a/util/oslib-posix.c
15
--- a/block/qcow2-refcount.c
22
+++ b/util/oslib-posix.c
16
+++ b/block/qcow2-refcount.c
23
@@ -XXX,XX +XXX,XX @@ void *qemu_alloc_stack(size_t *sz)
17
@@ -XXX,XX +XXX,XX @@ static int64_t alloc_clusters_imrt(BlockDriverState *bs,
24
ptr = mmap(NULL, *sz, PROT_READ | PROT_WRITE,
18
static int rebuild_refcounts_write_refblocks(
25
MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
19
BlockDriverState *bs, void **refcount_table, int64_t *nb_clusters,
26
if (ptr == MAP_FAILED) {
20
int64_t first_cluster, int64_t end_cluster,
27
+ perror("failed to allocate memory for stack");
21
- uint64_t **on_disk_reftable_ptr, uint32_t *on_disk_reftable_entries_ptr
28
abort();
22
+ uint64_t **on_disk_reftable_ptr, uint32_t *on_disk_reftable_entries_ptr,
23
+ Error **errp
24
)
25
{
26
BDRVQcow2State *s = bs->opaque;
27
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcounts_write_refblocks(
28
nb_clusters,
29
&first_free_cluster);
30
if (refblock_offset < 0) {
31
- fprintf(stderr, "ERROR allocating refblock: %s\n",
32
- strerror(-refblock_offset));
33
+ error_setg_errno(errp, -refblock_offset,
34
+ "ERROR allocating refblock");
35
return refblock_offset;
36
}
37
38
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcounts_write_refblocks(
39
on_disk_reftable_entries *
40
REFTABLE_ENTRY_SIZE);
41
if (!on_disk_reftable) {
42
+ error_setg(errp, "ERROR allocating reftable memory");
43
return -ENOMEM;
44
}
45
46
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcounts_write_refblocks(
47
ret = qcow2_pre_write_overlap_check(bs, 0, refblock_offset,
48
s->cluster_size, false);
49
if (ret < 0) {
50
- fprintf(stderr, "ERROR writing refblock: %s\n", strerror(-ret));
51
+ error_setg_errno(errp, -ret, "ERROR writing refblock");
52
return ret;
53
}
54
55
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcounts_write_refblocks(
56
ret = bdrv_pwrite(bs->file, refblock_offset, on_disk_refblock,
57
s->cluster_size);
58
if (ret < 0) {
59
- fprintf(stderr, "ERROR writing refblock: %s\n", strerror(-ret));
60
+ error_setg_errno(errp, -ret, "ERROR writing refblock");
61
return ret;
62
}
63
64
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcounts_write_refblocks(
65
static int rebuild_refcount_structure(BlockDriverState *bs,
66
BdrvCheckResult *res,
67
void **refcount_table,
68
- int64_t *nb_clusters)
69
+ int64_t *nb_clusters,
70
+ Error **errp)
71
{
72
BDRVQcow2State *s = bs->opaque;
73
int64_t reftable_offset = -1;
74
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcount_structure(BlockDriverState *bs,
75
rebuild_refcounts_write_refblocks(bs, refcount_table, nb_clusters,
76
0, *nb_clusters,
77
&on_disk_reftable,
78
- &on_disk_reftable_entries);
79
+ &on_disk_reftable_entries, errp);
80
if (reftable_size_changed < 0) {
81
res->check_errors++;
82
ret = reftable_size_changed;
83
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcount_structure(BlockDriverState *bs,
84
refcount_table, nb_clusters,
85
&first_free_cluster);
86
if (reftable_offset < 0) {
87
- fprintf(stderr, "ERROR allocating reftable: %s\n",
88
- strerror(-reftable_offset));
89
+ error_setg_errno(errp, -reftable_offset,
90
+ "ERROR allocating reftable");
91
res->check_errors++;
92
ret = reftable_offset;
93
goto fail;
94
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcount_structure(BlockDriverState *bs,
95
reftable_start_cluster,
96
reftable_end_cluster,
97
&on_disk_reftable,
98
- &on_disk_reftable_entries);
99
+ &on_disk_reftable_entries, errp);
100
if (reftable_size_changed < 0) {
101
res->check_errors++;
102
ret = reftable_size_changed;
103
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcount_structure(BlockDriverState *bs,
104
ret = qcow2_pre_write_overlap_check(bs, 0, reftable_offset, reftable_length,
105
false);
106
if (ret < 0) {
107
- fprintf(stderr, "ERROR writing reftable: %s\n", strerror(-ret));
108
+ error_setg_errno(errp, -ret, "ERROR writing reftable");
109
goto fail;
29
}
110
}
30
111
31
@@ -XXX,XX +XXX,XX @@ void *qemu_alloc_stack(size_t *sz)
112
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcount_structure(BlockDriverState *bs,
32
guardpage = ptr;
113
ret = bdrv_pwrite(bs->file, reftable_offset, on_disk_reftable,
33
#endif
114
reftable_length);
34
if (mprotect(guardpage, pagesz, PROT_NONE) != 0) {
115
if (ret < 0) {
35
+ perror("failed to set up stack guard page");
116
- fprintf(stderr, "ERROR writing reftable: %s\n", strerror(-ret));
36
abort();
117
+ error_setg_errno(errp, -ret, "ERROR writing reftable");
118
goto fail;
37
}
119
}
38
120
121
@@ -XXX,XX +XXX,XX @@ static int rebuild_refcount_structure(BlockDriverState *bs,
122
&reftable_offset_and_clusters,
123
sizeof(reftable_offset_and_clusters));
124
if (ret < 0) {
125
- fprintf(stderr, "ERROR setting reftable: %s\n", strerror(-ret));
126
+ error_setg_errno(errp, -ret, "ERROR setting reftable");
127
goto fail;
128
}
129
130
@@ -XXX,XX +XXX,XX @@ int qcow2_check_refcounts(BlockDriverState *bs, BdrvCheckResult *res,
131
if (rebuild && (fix & BDRV_FIX_ERRORS)) {
132
BdrvCheckResult old_res = *res;
133
int fresh_leaks = 0;
134
+ Error *local_err = NULL;
135
136
fprintf(stderr, "Rebuilding refcount structure\n");
137
ret = rebuild_refcount_structure(bs, res, &refcount_table,
138
- &nb_clusters);
139
+ &nb_clusters, &local_err);
140
if (ret < 0) {
141
+ error_report_err(local_err);
142
goto fail;
143
}
144
39
--
145
--
40
2.13.5
146
2.35.1
41
42
diff view generated by jsdifflib
Deleted patch
1
From: Alberto Garcia <berto@igalia.com>
2
1
3
There's a few cases which we're passing an Error pointer to a function
4
only to discard it immediately afterwards without checking it. In
5
these cases we can simply remove the variable and pass NULL instead.
6
7
Signed-off-by: Alberto Garcia <berto@igalia.com>
8
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
9
Reviewed-by: Eric Blake <eblake@redhat.com>
10
Message-id: 20170829120836.16091-1-berto@igalia.com
11
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
12
---
13
block/qcow.c | 12 +++---------
14
block/qcow2.c | 8 ++------
15
dump.c | 4 +---
16
3 files changed, 6 insertions(+), 18 deletions(-)
17
18
diff --git a/block/qcow.c b/block/qcow.c
19
index XXXXXXX..XXXXXXX 100644
20
--- a/block/qcow.c
21
+++ b/block/qcow.c
22
@@ -XXX,XX +XXX,XX @@ static uint64_t get_cluster_offset(BlockDriverState *bs,
23
start_sect = (offset & ~(s->cluster_size - 1)) >> 9;
24
for(i = 0; i < s->cluster_sectors; i++) {
25
if (i < n_start || i >= n_end) {
26
- Error *err = NULL;
27
memset(s->cluster_data, 0x00, 512);
28
if (qcrypto_block_encrypt(s->crypto, start_sect + i,
29
s->cluster_data,
30
BDRV_SECTOR_SIZE,
31
- &err) < 0) {
32
- error_free(err);
33
+ NULL) < 0) {
34
errno = EIO;
35
return -1;
36
}
37
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
38
QEMUIOVector hd_qiov;
39
uint8_t *buf;
40
void *orig_buf;
41
- Error *err = NULL;
42
43
if (qiov->niov > 1) {
44
buf = orig_buf = qemu_try_blockalign(bs, qiov->size);
45
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
46
if (bs->encrypted) {
47
assert(s->crypto);
48
if (qcrypto_block_decrypt(s->crypto, sector_num, buf,
49
- n * BDRV_SECTOR_SIZE, &err) < 0) {
50
+ n * BDRV_SECTOR_SIZE, NULL) < 0) {
51
goto fail;
52
}
53
}
54
@@ -XXX,XX +XXX,XX @@ done:
55
return ret;
56
57
fail:
58
- error_free(err);
59
ret = -EIO;
60
goto done;
61
}
62
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_writev(BlockDriverState *bs, int64_t sector_num,
63
break;
64
}
65
if (bs->encrypted) {
66
- Error *err = NULL;
67
assert(s->crypto);
68
if (qcrypto_block_encrypt(s->crypto, sector_num, buf,
69
- n * BDRV_SECTOR_SIZE, &err) < 0) {
70
- error_free(err);
71
+ n * BDRV_SECTOR_SIZE, NULL) < 0) {
72
ret = -EIO;
73
break;
74
}
75
diff --git a/block/qcow2.c b/block/qcow2.c
76
index XXXXXXX..XXXXXXX 100644
77
--- a/block/qcow2.c
78
+++ b/block/qcow2.c
79
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_preadv(BlockDriverState *bs, uint64_t offset,
80
assert(s->crypto);
81
assert((offset & (BDRV_SECTOR_SIZE - 1)) == 0);
82
assert((cur_bytes & (BDRV_SECTOR_SIZE - 1)) == 0);
83
- Error *err = NULL;
84
if (qcrypto_block_decrypt(s->crypto,
85
(s->crypt_physical_offset ?
86
cluster_offset + offset_in_cluster :
87
offset) >> BDRV_SECTOR_BITS,
88
cluster_data,
89
cur_bytes,
90
- &err) < 0) {
91
- error_free(err);
92
+ NULL) < 0) {
93
ret = -EIO;
94
goto fail;
95
}
96
@@ -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);
98
99
if (bs->encrypted) {
100
- Error *err = NULL;
101
assert(s->crypto);
102
if (!cluster_data) {
103
cluster_data = qemu_try_blockalign(bs->file->bs,
104
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow2_co_pwritev(BlockDriverState *bs, uint64_t offset,
105
cluster_offset + offset_in_cluster :
106
offset) >> BDRV_SECTOR_BITS,
107
cluster_data,
108
- cur_bytes, &err) < 0) {
109
- error_free(err);
110
+ cur_bytes, NULL) < 0) {
111
ret = -EIO;
112
goto fail;
113
}
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
--
131
2.13.5
132
133
diff view generated by jsdifflib