1
The following changes since commit bfec359afba088aaacc7d316f43302f28c6e642a:
1
The following changes since commit 248b23735645f7cbb503d9be6f5bf825f2a603ab:
2
2
3
Merge remote-tracking branch 'remotes/armbru/tags/pull-qdev-2017-04-21' into staging (2017-04-21 11:42:03 +0100)
3
Update version for v2.10.0-rc4 release (2017-08-24 17:34:26 +0100)
4
4
5
are available in the git repository at:
5
are available in the git repository at:
6
6
7
git://github.com/codyprime/qemu-kvm-jtc.git tags/block-pull-request
7
git://github.com/stefanha/qemu.git tags/block-pull-request
8
8
9
for you to fetch changes up to 1507631e438930bc07f776f303af127a9cdb4d41:
9
for you to fetch changes up to 3e4c705212abfe8c9882a00beb2d1466a8a53cec:
10
10
11
qemu-iotests: _cleanup_qemu must be called on exit (2017-04-21 08:32:44 -0400)
11
qcow2: allocate cluster_cache/cluster_data on demand (2017-08-30 18:02:10 +0100)
12
12
13
----------------------------------------------------------------
13
----------------------------------------------------------------
14
14
15
Block patches for 2.10
16
17
----------------------------------------------------------------
15
----------------------------------------------------------------
18
16
19
Ashish Mittal (2):
17
Alberto Garcia (8):
20
block/vxhs.c: Add support for a new block device type called "vxhs"
18
throttle: Fix wrong variable name in the header documentation
21
block/vxhs.c: Add qemu-iotests for new block device type "vxhs"
19
throttle: Update the throttle_fix_bucket() documentation
20
throttle: Make throttle_is_valid() a bit less verbose
21
throttle: Remove throttle_fix_bucket() / throttle_unfix_bucket()
22
throttle: Make LeakyBucket.avg and LeakyBucket.max integer types
23
throttle: Make burst_length 64bit and add range checks
24
throttle: Test the valid range of config values
25
misc: Remove unused Error variables
22
26
23
Jeff Cody (10):
27
Dan Aloni (1):
24
qemu-iotests: exclude vxhs from image creation via protocol
28
nvme: Fix get/set number of queues feature, again
25
block: add bdrv_set_read_only() helper function
26
block: do not set BDS read_only if copy_on_read enabled
27
block: honor BDRV_O_ALLOW_RDWR when clearing bs->read_only
28
block: code movement
29
block: introduce bdrv_can_set_read_only()
30
block: use bdrv_can_set_read_only() during reopen
31
block/rbd - update variable names to more apt names
32
block/rbd: Add support for reopen()
33
qemu-iotests: _cleanup_qemu must be called on exit
34
29
35
block.c | 56 +++-
30
Eduardo Habkost (1):
36
block/Makefile.objs | 2 +
31
oslib-posix: Print errors before aborting on qemu_alloc_stack()
37
block/bochs.c | 5 +-
32
38
block/cloop.c | 5 +-
33
Fred Rolland (1):
39
block/dmg.c | 6 +-
34
qemu-doc: Add UUID support in initiator name
40
block/rbd.c | 65 +++--
35
41
block/trace-events | 17 ++
36
Stefan Hajnoczi (4):
42
block/vvfat.c | 19 +-
37
scripts: add argparse module for Python 2.6 compatibility
43
block/vxhs.c | 575 +++++++++++++++++++++++++++++++++++++++
38
docker.py: Python 2.6 argparse compatibility
44
configure | 39 +++
39
tests: migration/guestperf Python 2.6 argparse compatibility
45
include/block/block.h | 2 +
40
qcow2: allocate cluster_cache/cluster_data on demand
46
qapi/block-core.json | 23 +-
41
47
tests/qemu-iotests/017 | 1 +
42
include/qemu/throttle.h | 8 +-
48
tests/qemu-iotests/020 | 1 +
43
block/qcow.c | 12 +-
49
tests/qemu-iotests/028 | 1 +
44
block/qcow2-cluster.c | 17 +
50
tests/qemu-iotests/029 | 1 +
45
block/qcow2.c | 20 +-
51
tests/qemu-iotests/073 | 1 +
46
dump.c | 4 +-
52
tests/qemu-iotests/094 | 11 +-
47
hw/block/nvme.c | 4 +-
53
tests/qemu-iotests/102 | 5 +-
48
tests/test-throttle.c | 80 +-
54
tests/qemu-iotests/109 | 1 +
49
util/oslib-posix.c | 2 +
55
tests/qemu-iotests/114 | 1 +
50
util/throttle.c | 86 +-
56
tests/qemu-iotests/117 | 1 +
51
COPYING.PYTHON | 270 ++++
57
tests/qemu-iotests/130 | 2 +
52
qemu-doc.texi | 5 +-
58
tests/qemu-iotests/134 | 1 +
53
scripts/argparse.py | 2406 ++++++++++++++++++++++++++++++++++++
59
tests/qemu-iotests/140 | 1 +
54
tests/docker/docker.py | 4 +-
60
tests/qemu-iotests/141 | 1 +
55
tests/migration/guestperf/shell.py | 8 +-
61
tests/qemu-iotests/143 | 1 +
56
14 files changed, 2831 insertions(+), 95 deletions(-)
62
tests/qemu-iotests/156 | 2 +
57
create mode 100644 COPYING.PYTHON
63
tests/qemu-iotests/158 | 1 +
58
create mode 100644 scripts/argparse.py
64
tests/qemu-iotests/common | 6 +
65
tests/qemu-iotests/common.config | 13 +
66
tests/qemu-iotests/common.filter | 1 +
67
tests/qemu-iotests/common.rc | 19 ++
68
33 files changed, 844 insertions(+), 42 deletions(-)
69
create mode 100644 block/vxhs.c
70
59
71
--
60
--
72
2.9.3
61
2.13.5
73
62
74
63
diff view generated by jsdifflib
New patch
1
From: Dan Aloni <dan@kernelim.com>
1
2
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
New patch
1
From: Alberto Garcia <berto@igalia.com>
1
2
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
New patch
1
From: Alberto Garcia <berto@igalia.com>
1
2
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
1
Introduce check function for setting read_only flags. Will return < 0 on
1
From: Alberto Garcia <berto@igalia.com>
2
error, with appropriate Error value set. Does not alter any flags.
3
2
4
Signed-off-by: Jeff Cody <jcody@redhat.com>
3
Use a pointer to the bucket instead of repeating cfg->buckets[i] all
5
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
4
the time. This makes the code more concise and will help us expand the
6
Reviewed-by: John Snow <jsnow@redhat.com>
5
checks later and save a few line breaks.
7
Message-id: e2bba34ac3bc76a0c42adc390413f358ae0566e8.1491597120.git.jcody@redhat.com
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>
8
---
10
---
9
block.c | 14 +++++++++++++-
11
util/throttle.c | 15 +++++++--------
10
include/block/block.h | 1 +
12
1 file changed, 7 insertions(+), 8 deletions(-)
11
2 files changed, 14 insertions(+), 1 deletion(-)
12
13
13
diff --git a/block.c b/block.c
14
diff --git a/util/throttle.c b/util/throttle.c
14
index XXXXXXX..XXXXXXX 100644
15
index XXXXXXX..XXXXXXX 100644
15
--- a/block.c
16
--- a/util/throttle.c
16
+++ b/block.c
17
+++ b/util/throttle.c
17
@@ -XXX,XX +XXX,XX @@ bool bdrv_is_read_only(BlockDriverState *bs)
18
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
18
return bs->read_only;
19
}
20
21
-int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
22
+int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
23
{
24
/* Do not set read_only if copy_on_read is enabled */
25
if (bs->copy_on_read && read_only) {
26
@@ -XXX,XX +XXX,XX @@ int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
27
return -EPERM;
28
}
19
}
29
20
30
+ return 0;
21
for (i = 0; i < BUCKETS_COUNT; i++) {
31
+}
22
- if (cfg->buckets[i].avg < 0 ||
32
+
23
- cfg->buckets[i].max < 0 ||
33
+int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
24
- cfg->buckets[i].avg > THROTTLE_VALUE_MAX ||
34
+{
25
- cfg->buckets[i].max > THROTTLE_VALUE_MAX) {
35
+ int ret = 0;
26
+ LeakyBucket *bkt = &cfg->buckets[i];
36
+
27
+ if (bkt->avg < 0 || bkt->max < 0 ||
37
+ ret = bdrv_can_set_read_only(bs, read_only, errp);
28
+ bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
38
+ if (ret < 0) {
29
error_setg(errp, "bps/iops/max values must be within [0, %lld]",
39
+ return ret;
30
THROTTLE_VALUE_MAX);
40
+ }
31
return false;
41
+
32
}
42
bs->read_only = read_only;
33
43
return 0;
34
- if (!cfg->buckets[i].burst_length) {
44
}
35
+ if (!bkt->burst_length) {
45
diff --git a/include/block/block.h b/include/block/block.h
36
error_setg(errp, "the burst length cannot be 0");
46
index XXXXXXX..XXXXXXX 100644
37
return false;
47
--- a/include/block/block.h
38
}
48
+++ b/include/block/block.h
39
49
@@ -XXX,XX +XXX,XX @@ int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
40
- if (cfg->buckets[i].burst_length > 1 && !cfg->buckets[i].max) {
50
int64_t sector_num, int nb_sectors, int *pnum);
41
+ if (bkt->burst_length > 1 && !bkt->max) {
51
42
error_setg(errp, "burst length set without burst rate");
52
bool bdrv_is_read_only(BlockDriverState *bs);
43
return false;
53
+int bdrv_can_set_read_only(BlockDriverState *bs, bool read_only, Error **errp);
44
}
54
int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp);
45
55
bool bdrv_is_sg(BlockDriverState *bs);
46
- if (cfg->buckets[i].max && !cfg->buckets[i].avg) {
56
bool bdrv_is_inserted(BlockDriverState *bs);
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
}
57
--
58
--
58
2.9.3
59
2.13.5
59
60
60
61
diff view generated by jsdifflib
1
A few block drivers will set the BDS read_only flag from their
1
From: Alberto Garcia <berto@igalia.com>
2
.bdrv_open() function. This means the bs->read_only flag could
3
be set after we enable copy_on_read, as the BDRV_O_COPY_ON_READ
4
flag check occurs prior to the call to bdrv->bdrv_open().
5
2
6
This adds an error return to bdrv_set_read_only(), and an error will be
3
The throttling code can change internally the value of bkt->max if it
7
return if we try to set the BDS to read_only while copy_on_read is
4
hasn't been set by the user. The problem with this is that if we want
8
enabled.
5
to retrieve the original value we have to undo this change first. This
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
9
10
This patch also changes the behavior of vvfat. Before, vvfat could
10
Signed-off-by: Alberto Garcia <berto@igalia.com>
11
override the drive 'readonly' flag with its own, internal 'rw' flag.
11
Reviewed-by: Manos Pitsidianakis <el13635@mail.ntua.gr>
12
Message-id: 5b0b9e1ac6eb208d709eddc7b09e7669a523bff3.1503580370.git.berto@igalia.com
13
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
14
---
15
util/throttle.c | 62 +++++++++++++++++++++------------------------------------
16
1 file changed, 23 insertions(+), 39 deletions(-)
12
17
13
For instance, this -drive parameter would result in a writable image:
18
diff --git a/util/throttle.c b/util/throttle.c
14
15
"-drive format=vvfat,dir=/tmp/vvfat,rw,if=virtio,readonly=on"
16
17
This is not correct. Now, attempting to use the above -drive parameter
18
will result in an error (i.e., 'rw' is incompatible with 'readonly=on').
19
20
Signed-off-by: Jeff Cody <jcody@redhat.com>
21
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
22
Reviewed-by: John Snow <jsnow@redhat.com>
23
Message-id: 0c5b4c1cc2c651471b131f21376dfd5ea24d2196.1491597120.git.jcody@redhat.com
24
---
25
block.c | 10 +++++++++-
26
block/bochs.c | 5 ++++-
27
block/cloop.c | 5 ++++-
28
block/dmg.c | 6 +++++-
29
block/rbd.c | 11 ++++++++++-
30
block/vvfat.c | 19 +++++++++++++++----
31
include/block/block.h | 2 +-
32
7 files changed, 48 insertions(+), 10 deletions(-)
33
34
diff --git a/block.c b/block.c
35
index XXXXXXX..XXXXXXX 100644
19
index XXXXXXX..XXXXXXX 100644
36
--- a/block.c
20
--- a/util/throttle.c
37
+++ b/block.c
21
+++ b/util/throttle.c
38
@@ -XXX,XX +XXX,XX @@ void path_combine(char *dest, int dest_size,
22
@@ -XXX,XX +XXX,XX @@ static int64_t throttle_do_compute_wait(double limit, double extra)
23
int64_t throttle_compute_wait(LeakyBucket *bkt)
24
{
25
double extra; /* the number of extra units blocking the io */
26
+ double bucket_size; /* I/O before throttling to bkt->avg */
27
+ double burst_bucket_size; /* Before throttling to bkt->max */
28
29
if (!bkt->avg) {
30
return 0;
39
}
31
}
40
}
32
41
33
- /* If the bucket is full then we have to wait */
42
-void bdrv_set_read_only(BlockDriverState *bs, bool read_only)
34
- extra = bkt->level - bkt->max * bkt->burst_length;
43
+int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
35
+ if (!bkt->max) {
44
{
36
+ /* If bkt->max is 0 we still want to allow short bursts of I/O
45
+ /* Do not set read_only if copy_on_read is enabled */
37
+ * from the guest, otherwise every other request will be throttled
46
+ if (bs->copy_on_read && read_only) {
38
+ * and performance will suffer considerably. */
47
+ error_setg(errp, "Can't set node '%s' to r/o with copy-on-read enabled",
39
+ bucket_size = bkt->avg / 10;
48
+ bdrv_get_device_or_node_name(bs));
40
+ burst_bucket_size = 0;
49
+ return -EINVAL;
41
+ } else {
42
+ /* If we have a burst limit then we have to wait until all I/O
43
+ * at burst rate has finished before throttling to bkt->avg */
44
+ bucket_size = bkt->max * bkt->burst_length;
45
+ burst_bucket_size = bkt->max / 10;
50
+ }
46
+ }
51
+
47
+
52
bs->read_only = read_only;
48
+ /* If the main bucket is full then we have to wait */
53
+ return 0;
49
+ extra = bkt->level - bucket_size;
50
if (extra > 0) {
51
return throttle_do_compute_wait(bkt->avg, extra);
52
}
53
54
- /* If the bucket is not full yet we have to make sure that we
55
- * fulfill the goal of bkt->max units per second. */
56
+ /* If the main bucket is not full yet we still have to check the
57
+ * burst bucket in order to enforce the burst limit */
58
if (bkt->burst_length > 1) {
59
- /* We use 1/10 of the max value to smooth the throttling.
60
- * See throttle_fix_bucket() for more details. */
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;
54
}
68
}
55
69
56
void bdrv_get_full_backing_filename_from_filename(const char *backed,
70
-/* fix bucket parameters */
57
diff --git a/block/bochs.c b/block/bochs.c
71
-static void throttle_fix_bucket(LeakyBucket *bkt)
58
index XXXXXXX..XXXXXXX 100644
72
-{
59
--- a/block/bochs.c
73
- double min;
60
+++ b/block/bochs.c
74
-
61
@@ -XXX,XX +XXX,XX @@ static int bochs_open(BlockDriverState *bs, QDict *options, int flags,
75
- /* zero bucket level */
62
return -EINVAL;
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;
63
}
107
}
64
108
65
- bdrv_set_read_only(bs, true); /* no write support yet */
109
ts->previous_leak = qemu_clock_get_ns(clock_type);
66
+ ret = bdrv_set_read_only(bs, true, errp); /* no write support yet */
110
@@ -XXX,XX +XXX,XX @@ void throttle_config(ThrottleState *ts,
67
+ if (ret < 0) {
111
*/
68
+ return ret;
112
void throttle_get_config(ThrottleState *ts, ThrottleConfig *cfg)
69
+ }
113
{
70
114
- int i;
71
ret = bdrv_pread(bs->file, 0, &bochs, sizeof(bochs));
115
-
72
if (ret < 0) {
116
*cfg = ts->cfg;
73
diff --git a/block/cloop.c b/block/cloop.c
117
-
74
index XXXXXXX..XXXXXXX 100644
118
- for (i = 0; i < BUCKETS_COUNT; i++) {
75
--- a/block/cloop.c
119
- throttle_unfix_bucket(&cfg->buckets[i]);
76
+++ b/block/cloop.c
120
- }
77
@@ -XXX,XX +XXX,XX @@ static int cloop_open(BlockDriverState *bs, QDict *options, int flags,
121
}
78
return -EINVAL;
122
79
}
123
80
81
- bdrv_set_read_only(bs, true);
82
+ ret = bdrv_set_read_only(bs, true, errp);
83
+ if (ret < 0) {
84
+ return ret;
85
+ }
86
87
/* read header */
88
ret = bdrv_pread(bs->file, 128, &s->block_size, 4);
89
diff --git a/block/dmg.c b/block/dmg.c
90
index XXXXXXX..XXXXXXX 100644
91
--- a/block/dmg.c
92
+++ b/block/dmg.c
93
@@ -XXX,XX +XXX,XX @@ static int dmg_open(BlockDriverState *bs, QDict *options, int flags,
94
return -EINVAL;
95
}
96
97
+ ret = bdrv_set_read_only(bs, true, errp);
98
+ if (ret < 0) {
99
+ return ret;
100
+ }
101
+
102
block_module_load_one("dmg-bz2");
103
- bdrv_set_read_only(bs, true);
104
105
s->n_chunks = 0;
106
s->offsets = s->lengths = s->sectors = s->sectorcounts = NULL;
107
diff --git a/block/rbd.c b/block/rbd.c
108
index XXXXXXX..XXXXXXX 100644
109
--- a/block/rbd.c
110
+++ b/block/rbd.c
111
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_open(BlockDriverState *bs, QDict *options, int flags,
112
goto failed_shutdown;
113
}
114
115
+ /* rbd_open is always r/w */
116
r = rbd_open(s->io_ctx, s->name, &s->image, s->snap);
117
if (r < 0) {
118
error_setg_errno(errp, -r, "error reading header from %s", s->name);
119
goto failed_open;
120
}
121
122
- bdrv_set_read_only(bs, (s->snap != NULL));
123
+ /* If we are using an rbd snapshot, we must be r/o, otherwise
124
+ * leave as-is */
125
+ if (s->snap != NULL) {
126
+ r = bdrv_set_read_only(bs, true, &local_err);
127
+ if (r < 0) {
128
+ error_propagate(errp, local_err);
129
+ goto failed_open;
130
+ }
131
+ }
132
133
qemu_opts_del(opts);
134
return 0;
135
diff --git a/block/vvfat.c b/block/vvfat.c
136
index XXXXXXX..XXXXXXX 100644
137
--- a/block/vvfat.c
138
+++ b/block/vvfat.c
139
@@ -XXX,XX +XXX,XX @@ static int vvfat_open(BlockDriverState *bs, QDict *options, int flags,
140
141
s->current_cluster=0xffffffff;
142
143
- /* read only is the default for safety */
144
- bdrv_set_read_only(bs, true);
145
s->qcow = NULL;
146
s->qcow_filename = NULL;
147
s->fat2 = NULL;
148
@@ -XXX,XX +XXX,XX @@ static int vvfat_open(BlockDriverState *bs, QDict *options, int flags,
149
s->sector_count = cyls * heads * secs - (s->first_sectors_number - 1);
150
151
if (qemu_opt_get_bool(opts, "rw", false)) {
152
- ret = enable_write_target(bs, errp);
153
+ if (!bdrv_is_read_only(bs)) {
154
+ ret = enable_write_target(bs, errp);
155
+ if (ret < 0) {
156
+ goto fail;
157
+ }
158
+ } else {
159
+ ret = -EPERM;
160
+ error_setg(errp,
161
+ "Unable to set VVFAT to 'rw' when drive is read-only");
162
+ goto fail;
163
+ }
164
+ } else {
165
+ /* read only is the default for safety */
166
+ ret = bdrv_set_read_only(bs, true, &local_err);
167
if (ret < 0) {
168
+ error_propagate(errp, local_err);
169
goto fail;
170
}
171
- bdrv_set_read_only(bs, false);
172
}
173
174
bs->total_sectors = cyls * heads * secs;
175
diff --git a/include/block/block.h b/include/block/block.h
176
index XXXXXXX..XXXXXXX 100644
177
--- a/include/block/block.h
178
+++ b/include/block/block.h
179
@@ -XXX,XX +XXX,XX @@ int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
180
int64_t sector_num, int nb_sectors, int *pnum);
181
182
bool bdrv_is_read_only(BlockDriverState *bs);
183
-void bdrv_set_read_only(BlockDriverState *bs, bool read_only);
184
+int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp);
185
bool bdrv_is_sg(BlockDriverState *bs);
186
bool bdrv_is_inserted(BlockDriverState *bs);
187
int bdrv_media_changed(BlockDriverState *bs);
188
--
124
--
189
2.9.3
125
2.13.5
190
126
191
127
diff view generated by jsdifflib
1
We have a helper wrapper for checking for the BDS read_only flag,
1
From: Alberto Garcia <berto@igalia.com>
2
add a helper wrapper to set the read_only flag as well.
3
2
4
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
3
Both the throttling limits set with the throttling.iops-* and
5
Signed-off-by: Jeff Cody <jcody@redhat.com>
4
throttling.bps-* options and their QMP equivalents defined in the
6
Reviewed-by: John Snow <jsnow@redhat.com>
5
BlockIOThrottle struct are integer values.
7
Message-id: 9b18972d05f5fa2ac16c014f0af98d680553048d.1491597120.git.jcody@redhat.com
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>
8
---
22
---
9
block.c | 5 +++++
23
include/qemu/throttle.h | 4 ++--
10
block/bochs.c | 2 +-
24
tests/test-throttle.c | 3 ++-
11
block/cloop.c | 2 +-
25
util/throttle.c | 7 +++----
12
block/dmg.c | 2 +-
26
3 files changed, 7 insertions(+), 7 deletions(-)
13
block/rbd.c | 2 +-
14
block/vvfat.c | 4 ++--
15
include/block/block.h | 1 +
16
7 files changed, 12 insertions(+), 6 deletions(-)
17
27
18
diff --git a/block.c b/block.c
28
diff --git a/include/qemu/throttle.h b/include/qemu/throttle.h
19
index XXXXXXX..XXXXXXX 100644
29
index XXXXXXX..XXXXXXX 100644
20
--- a/block.c
30
--- a/include/qemu/throttle.h
21
+++ b/block.c
31
+++ b/include/qemu/throttle.h
22
@@ -XXX,XX +XXX,XX @@ void path_combine(char *dest, int dest_size,
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));
23
}
60
}
24
}
61
}
25
62
26
+void bdrv_set_read_only(BlockDriverState *bs, bool read_only)
63
diff --git a/util/throttle.c b/util/throttle.c
27
+{
28
+ bs->read_only = read_only;
29
+}
30
+
31
void bdrv_get_full_backing_filename_from_filename(const char *backed,
32
const char *backing,
33
char *dest, size_t sz,
34
diff --git a/block/bochs.c b/block/bochs.c
35
index XXXXXXX..XXXXXXX 100644
64
index XXXXXXX..XXXXXXX 100644
36
--- a/block/bochs.c
65
--- a/util/throttle.c
37
+++ b/block/bochs.c
66
+++ b/util/throttle.c
38
@@ -XXX,XX +XXX,XX @@ static int bochs_open(BlockDriverState *bs, QDict *options, int flags,
67
@@ -XXX,XX +XXX,XX @@ int64_t throttle_compute_wait(LeakyBucket *bkt)
39
return -EINVAL;
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;
40
}
80
}
41
81
42
- bs->read_only = true; /* no write support yet */
82
/* If the main bucket is full then we have to wait */
43
+ bdrv_set_read_only(bs, true); /* no write support yet */
83
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
44
84
45
ret = bdrv_pread(bs->file, 0, &bochs, sizeof(bochs));
85
for (i = 0; i < BUCKETS_COUNT; i++) {
46
if (ret < 0) {
86
LeakyBucket *bkt = &cfg->buckets[i];
47
diff --git a/block/cloop.c b/block/cloop.c
87
- if (bkt->avg < 0 || bkt->max < 0 ||
48
index XXXXXXX..XXXXXXX 100644
88
- bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
49
--- a/block/cloop.c
89
+ if (bkt->avg > THROTTLE_VALUE_MAX || bkt->max > THROTTLE_VALUE_MAX) {
50
+++ b/block/cloop.c
90
error_setg(errp, "bps/iops/max values must be within [0, %lld]",
51
@@ -XXX,XX +XXX,XX @@ static int cloop_open(BlockDriverState *bs, QDict *options, int flags,
91
THROTTLE_VALUE_MAX);
52
return -EINVAL;
92
return false;
53
}
54
55
- bs->read_only = true;
56
+ bdrv_set_read_only(bs, true);
57
58
/* read header */
59
ret = bdrv_pread(bs->file, 128, &s->block_size, 4);
60
diff --git a/block/dmg.c b/block/dmg.c
61
index XXXXXXX..XXXXXXX 100644
62
--- a/block/dmg.c
63
+++ b/block/dmg.c
64
@@ -XXX,XX +XXX,XX @@ static int dmg_open(BlockDriverState *bs, QDict *options, int flags,
65
}
66
67
block_module_load_one("dmg-bz2");
68
- bs->read_only = true;
69
+ bdrv_set_read_only(bs, true);
70
71
s->n_chunks = 0;
72
s->offsets = s->lengths = s->sectors = s->sectorcounts = NULL;
73
diff --git a/block/rbd.c b/block/rbd.c
74
index XXXXXXX..XXXXXXX 100644
75
--- a/block/rbd.c
76
+++ b/block/rbd.c
77
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_open(BlockDriverState *bs, QDict *options, int flags,
78
goto failed_open;
79
}
80
81
- bs->read_only = (s->snap != NULL);
82
+ bdrv_set_read_only(bs, (s->snap != NULL));
83
84
qemu_opts_del(opts);
85
return 0;
86
diff --git a/block/vvfat.c b/block/vvfat.c
87
index XXXXXXX..XXXXXXX 100644
88
--- a/block/vvfat.c
89
+++ b/block/vvfat.c
90
@@ -XXX,XX +XXX,XX @@ static int vvfat_open(BlockDriverState *bs, QDict *options, int flags,
91
s->current_cluster=0xffffffff;
92
93
/* read only is the default for safety */
94
- bs->read_only = true;
95
+ bdrv_set_read_only(bs, true);
96
s->qcow = NULL;
97
s->qcow_filename = NULL;
98
s->fat2 = NULL;
99
@@ -XXX,XX +XXX,XX @@ static int vvfat_open(BlockDriverState *bs, QDict *options, int flags,
100
if (ret < 0) {
101
goto fail;
102
}
103
- bs->read_only = false;
104
+ bdrv_set_read_only(bs, false);
105
}
106
107
bs->total_sectors = cyls * heads * secs;
108
diff --git a/include/block/block.h b/include/block/block.h
109
index XXXXXXX..XXXXXXX 100644
110
--- a/include/block/block.h
111
+++ b/include/block/block.h
112
@@ -XXX,XX +XXX,XX @@ int bdrv_is_allocated_above(BlockDriverState *top, BlockDriverState *base,
113
int64_t sector_num, int nb_sectors, int *pnum);
114
115
bool bdrv_is_read_only(BlockDriverState *bs);
116
+void bdrv_set_read_only(BlockDriverState *bs, bool read_only);
117
bool bdrv_is_sg(BlockDriverState *bs);
118
bool bdrv_is_inserted(BlockDriverState *bs);
119
int bdrv_media_changed(BlockDriverState *bs);
120
--
93
--
121
2.9.3
94
2.13.5
122
95
123
96
diff view generated by jsdifflib
1
For the tests that use the common.qemu functions for running a QEMU
1
From: Alberto Garcia <berto@igalia.com>
2
process, _cleanup_qemu must be called in the exit function.
3
2
4
If it is not, if the qemu process aborts, then not all of the droppings
3
LeakyBucket.burst_length is defined as an unsigned integer but the
5
are cleaned up (e.g. pidfile, fifos).
4
code never checks for overflows and it only makes sure that the value
5
is not 0.
6
6
7
This updates those tests that did not have a cleanup in qemu-iotests.
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.
8
10
9
(I swapped spaces for tabs in test 102 as well)
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().
10
15
11
Reported-by: Eric Blake <eblake@redhat.com>
16
The value of burst_length does not have a specific upper limit,
12
Reviewed-by: Eric Blake <eblake@redhat.com>
17
but since the bucket size is defined by max * burst_length we have
13
Signed-off-by: Jeff Cody <jcody@redhat.com>
18
to prevent overflows. Instead of going for UINT64_MAX or something
14
Message-id: d59c2f6ad6c1da8b9b3c7f357c94a7122ccfc55a.1492544096.git.jcody@redhat.com
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>
15
---
25
---
16
tests/qemu-iotests/028 | 1 +
26
include/qemu/throttle.h | 2 +-
17
tests/qemu-iotests/094 | 11 ++++++++---
27
util/throttle.c | 5 +++++
18
tests/qemu-iotests/102 | 5 +++--
28
2 files changed, 6 insertions(+), 1 deletion(-)
19
tests/qemu-iotests/109 | 1 +
20
tests/qemu-iotests/117 | 1 +
21
tests/qemu-iotests/130 | 1 +
22
tests/qemu-iotests/140 | 1 +
23
tests/qemu-iotests/141 | 1 +
24
tests/qemu-iotests/143 | 1 +
25
tests/qemu-iotests/156 | 1 +
26
10 files changed, 19 insertions(+), 5 deletions(-)
27
29
28
diff --git a/tests/qemu-iotests/028 b/tests/qemu-iotests/028
30
diff --git a/include/qemu/throttle.h b/include/qemu/throttle.h
29
index XXXXXXX..XXXXXXX 100755
31
index XXXXXXX..XXXXXXX 100644
30
--- a/tests/qemu-iotests/028
32
--- a/include/qemu/throttle.h
31
+++ b/tests/qemu-iotests/028
33
+++ b/include/qemu/throttle.h
32
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
34
@@ -XXX,XX +XXX,XX @@ typedef struct LeakyBucket {
33
35
uint64_t max; /* leaky bucket max burst in units */
34
_cleanup()
36
double level; /* bucket level in units */
35
{
37
double burst_level; /* bucket level in units (for computing bursts) */
36
+ _cleanup_qemu
38
- unsigned burst_length; /* max length of the burst period, in seconds */
37
rm -f "${TEST_IMG}.copy"
39
+ uint64_t burst_length; /* max length of the burst period, in seconds */
38
_cleanup_test_img
40
} LeakyBucket;
39
}
41
40
diff --git a/tests/qemu-iotests/094 b/tests/qemu-iotests/094
42
/* The following structure is used to configure a ThrottleState
41
index XXXXXXX..XXXXXXX 100755
43
diff --git a/util/throttle.c b/util/throttle.c
42
--- a/tests/qemu-iotests/094
44
index XXXXXXX..XXXXXXX 100644
43
+++ b/tests/qemu-iotests/094
45
--- a/util/throttle.c
44
@@ -XXX,XX +XXX,XX @@ echo "QA output created by $seq"
46
+++ b/util/throttle.c
45
here="$PWD"
47
@@ -XXX,XX +XXX,XX @@ bool throttle_is_valid(ThrottleConfig *cfg, Error **errp)
46
status=1    # failure is the default!
48
return false;
47
49
}
48
-trap "exit \$status" 0 1 2 3 15
50
49
+_cleanup()
51
+ if (bkt->max && bkt->burst_length > THROTTLE_VALUE_MAX / bkt->max) {
50
+{
52
+ error_setg(errp, "burst length too high for this burst rate");
51
+ _cleanup_qemu
53
+ return false;
52
+ _cleanup_test_img
54
+ }
53
+ rm -f "$TEST_DIR/source.$IMGFMT"
54
+}
55
+
55
+
56
+trap "_cleanup; exit \$status" 0 1 2 3 15
56
if (bkt->max && !bkt->avg) {
57
57
error_setg(errp, "bps_max/iops_max require corresponding"
58
# get standard environment, filters and checks
58
" bps/iops values");
59
. ./common.rc
60
@@ -XXX,XX +XXX,XX @@ _send_qemu_cmd $QEMU_HANDLE \
61
62
wait=1 _cleanup_qemu
63
64
-_cleanup_test_img
65
-rm -f "$TEST_DIR/source.$IMGFMT"
66
67
# success, all done
68
echo '*** done'
69
diff --git a/tests/qemu-iotests/102 b/tests/qemu-iotests/102
70
index XXXXXXX..XXXXXXX 100755
71
--- a/tests/qemu-iotests/102
72
+++ b/tests/qemu-iotests/102
73
@@ -XXX,XX +XXX,XX @@ seq=$(basename $0)
74
echo "QA output created by $seq"
75
76
here=$PWD
77
-status=1    # failure is the default!
78
+status=1 # failure is the default!
79
80
_cleanup()
81
{
82
-    _cleanup_test_img
83
+ _cleanup_qemu
84
+ _cleanup_test_img
85
}
86
trap "_cleanup; exit \$status" 0 1 2 3 15
87
88
diff --git a/tests/qemu-iotests/109 b/tests/qemu-iotests/109
89
index XXXXXXX..XXXXXXX 100755
90
--- a/tests/qemu-iotests/109
91
+++ b/tests/qemu-iotests/109
92
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
93
94
_cleanup()
95
{
96
+ _cleanup_qemu
97
rm -f $TEST_IMG.src
98
    _cleanup_test_img
99
}
100
diff --git a/tests/qemu-iotests/117 b/tests/qemu-iotests/117
101
index XXXXXXX..XXXXXXX 100755
102
--- a/tests/qemu-iotests/117
103
+++ b/tests/qemu-iotests/117
104
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
105
106
_cleanup()
107
{
108
+ _cleanup_qemu
109
    _cleanup_test_img
110
}
111
trap "_cleanup; exit \$status" 0 1 2 3 15
112
diff --git a/tests/qemu-iotests/130 b/tests/qemu-iotests/130
113
index XXXXXXX..XXXXXXX 100755
114
--- a/tests/qemu-iotests/130
115
+++ b/tests/qemu-iotests/130
116
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
117
118
_cleanup()
119
{
120
+ _cleanup_qemu
121
_cleanup_test_img
122
}
123
trap "_cleanup; exit \$status" 0 1 2 3 15
124
diff --git a/tests/qemu-iotests/140 b/tests/qemu-iotests/140
125
index XXXXXXX..XXXXXXX 100755
126
--- a/tests/qemu-iotests/140
127
+++ b/tests/qemu-iotests/140
128
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
129
130
_cleanup()
131
{
132
+ _cleanup_qemu
133
_cleanup_test_img
134
rm -f "$TEST_DIR/nbd"
135
}
136
diff --git a/tests/qemu-iotests/141 b/tests/qemu-iotests/141
137
index XXXXXXX..XXXXXXX 100755
138
--- a/tests/qemu-iotests/141
139
+++ b/tests/qemu-iotests/141
140
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
141
142
_cleanup()
143
{
144
+ _cleanup_qemu
145
_cleanup_test_img
146
rm -f "$TEST_DIR/{b,m,o}.$IMGFMT"
147
}
148
diff --git a/tests/qemu-iotests/143 b/tests/qemu-iotests/143
149
index XXXXXXX..XXXXXXX 100755
150
--- a/tests/qemu-iotests/143
151
+++ b/tests/qemu-iotests/143
152
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
153
154
_cleanup()
155
{
156
+ _cleanup_qemu
157
rm -f "$TEST_DIR/nbd"
158
}
159
trap "_cleanup; exit \$status" 0 1 2 3 15
160
diff --git a/tests/qemu-iotests/156 b/tests/qemu-iotests/156
161
index XXXXXXX..XXXXXXX 100755
162
--- a/tests/qemu-iotests/156
163
+++ b/tests/qemu-iotests/156
164
@@ -XXX,XX +XXX,XX @@ status=1    # failure is the default!
165
166
_cleanup()
167
{
168
+ _cleanup_qemu
169
rm -f "$TEST_IMG{,.target}{,.backing,.overlay}"
170
}
171
trap "_cleanup; exit \$status" 0 1 2 3 15
172
--
59
--
173
2.9.3
60
2.13.5
174
61
175
62
diff view generated by jsdifflib
1
This adds support for reopen in rbd, for changing between r/w and r/o.
1
From: Alberto Garcia <berto@igalia.com>
2
2
3
Note, that this is only a flag change, but we will block a change from
3
Signed-off-by: Alberto Garcia <berto@igalia.com>
4
r/o to r/w if we are using an RBD internal snapshot.
4
Message-id: a57dd6274e1b6dc9c28769fec4c7ea543be5c5e3.1503580370.git.berto@igalia.com
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
6
---
7
tests/test-throttle.c | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++
8
1 file changed, 77 insertions(+)
5
9
6
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
10
diff --git a/tests/test-throttle.c b/tests/test-throttle.c
7
Signed-off-by: Jeff Cody <jcody@redhat.com>
8
Reviewed-by: John Snow <jsnow@redhat.com>
9
Message-id: d4e87539167ec6527d44c97b164eabcccf96e4f3.1491597120.git.jcody@redhat.com
10
---
11
block/rbd.c | 21 +++++++++++++++++++++
12
1 file changed, 21 insertions(+)
13
14
diff --git a/block/rbd.c b/block/rbd.c
15
index XXXXXXX..XXXXXXX 100644
11
index XXXXXXX..XXXXXXX 100644
16
--- a/block/rbd.c
12
--- a/tests/test-throttle.c
17
+++ b/block/rbd.c
13
+++ b/tests/test-throttle.c
18
@@ -XXX,XX +XXX,XX @@ failed_opts:
14
@@ -XXX,XX +XXX,XX @@ static void test_is_valid(void)
19
return r;
15
test_is_valid_for_value(1, true);
20
}
16
}
21
17
18
+static void test_ranges(void)
19
+{
20
+ int i;
22
+
21
+
23
+/* Since RBD is currently always opened R/W via the API,
22
+ for (i = 0; i < BUCKETS_COUNT; i++) {
24
+ * we just need to check if we are using a snapshot or not, in
23
+ LeakyBucket *b = &cfg.buckets[i];
25
+ * order to determine if we will allow it to be R/W */
24
+ throttle_config_init(&cfg);
26
+static int qemu_rbd_reopen_prepare(BDRVReopenState *state,
27
+ BlockReopenQueue *queue, Error **errp)
28
+{
29
+ BDRVRBDState *s = state->bs->opaque;
30
+ int ret = 0;
31
+
25
+
32
+ if (s->snap && state->flags & BDRV_O_RDWR) {
26
+ /* avg = 0 means throttling is disabled, but the config is valid */
33
+ error_setg(errp,
27
+ b->avg = 0;
34
+ "Cannot change node '%s' to r/w when using RBD snapshot",
28
+ g_assert(throttle_is_valid(&cfg, NULL));
35
+ bdrv_get_device_or_node_name(state->bs));
29
+ g_assert(!throttle_enabled(&cfg));
36
+ ret = -EINVAL;
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));
37
+ }
91
+ }
38
+
39
+ return ret;
40
+}
92
+}
41
+
93
+
42
static void qemu_rbd_close(BlockDriverState *bs)
94
static void test_max_is_missing_limit(void)
43
{
95
{
44
BDRVRBDState *s = bs->opaque;
96
int i;
45
@@ -XXX,XX +XXX,XX @@ static BlockDriver bdrv_rbd = {
97
@@ -XXX,XX +XXX,XX @@ int main(int argc, char **argv)
46
.bdrv_parse_filename = qemu_rbd_parse_filename,
98
g_test_add_func("/throttle/config/enabled", test_enabled);
47
.bdrv_file_open = qemu_rbd_open,
99
g_test_add_func("/throttle/config/conflicting", test_conflicting_config);
48
.bdrv_close = qemu_rbd_close,
100
g_test_add_func("/throttle/config/is_valid", test_is_valid);
49
+ .bdrv_reopen_prepare = qemu_rbd_reopen_prepare,
101
+ g_test_add_func("/throttle/config/ranges", test_ranges);
50
.bdrv_create = qemu_rbd_create,
102
g_test_add_func("/throttle/config/max", test_max_is_missing_limit);
51
.bdrv_has_zero_init = bdrv_has_zero_init_1,
103
g_test_add_func("/throttle/config/iops_size",
52
.bdrv_get_info = qemu_rbd_getinfo,
104
test_iops_size_is_missing_limit);
53
--
105
--
54
2.9.3
106
2.13.5
55
107
56
108
diff view generated by jsdifflib
1
Signed-off-by: Jeff Cody <jcody@redhat.com>
1
From: Eduardo Habkost <ehabkost@redhat.com>
2
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
2
3
Reviewed-by: John Snow <jsnow@redhat.com>
3
If QEMU is running on a system that's out of memory and mmap()
4
Message-id: 00aed7ffdd7be4b9ed9ce1007d50028a72b34ebe.1491597120.git.jcody@redhat.com
4
fails, QEMU aborts with no error message at all, making it hard
5
to debug the reason for the failure.
6
7
Add perror() calls that will print error information before
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>
5
---
15
---
6
block.c | 14 ++++++++------
16
util/oslib-posix.c | 2 ++
7
1 file changed, 8 insertions(+), 6 deletions(-)
17
1 file changed, 2 insertions(+)
8
18
9
diff --git a/block.c b/block.c
19
diff --git a/util/oslib-posix.c b/util/oslib-posix.c
10
index XXXXXXX..XXXXXXX 100644
20
index XXXXXXX..XXXXXXX 100644
11
--- a/block.c
21
--- a/util/oslib-posix.c
12
+++ b/block.c
22
+++ b/util/oslib-posix.c
13
@@ -XXX,XX +XXX,XX @@ int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
23
@@ -XXX,XX +XXX,XX @@ void *qemu_alloc_stack(size_t *sz)
14
BlockDriver *drv;
24
ptr = mmap(NULL, *sz, PROT_READ | PROT_WRITE,
15
QemuOpts *opts;
25
MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
16
const char *value;
26
if (ptr == MAP_FAILED) {
17
+ bool read_only;
27
+ perror("failed to allocate memory for stack");
18
28
abort();
19
assert(reopen_state != NULL);
20
assert(reopen_state->bs->drv != NULL);
21
@@ -XXX,XX +XXX,XX @@ int bdrv_reopen_prepare(BDRVReopenState *reopen_state, BlockReopenQueue *queue,
22
qdict_put(reopen_state->options, "driver", qstring_from_str(value));
23
}
29
}
24
30
25
- /* if we are to stay read-only, do not allow permission change
31
@@ -XXX,XX +XXX,XX @@ void *qemu_alloc_stack(size_t *sz)
26
- * to r/w */
32
guardpage = ptr;
27
- if (!(reopen_state->bs->open_flags & BDRV_O_ALLOW_RDWR) &&
33
#endif
28
- reopen_state->flags & BDRV_O_RDWR) {
34
if (mprotect(guardpage, pagesz, PROT_NONE) != 0) {
29
- error_setg(errp, "Node '%s' is read only",
35
+ perror("failed to set up stack guard page");
30
- bdrv_get_device_or_node_name(reopen_state->bs));
36
abort();
31
+ /* If we are to stay read-only, do not allow permission change
32
+ * to r/w. Attempting to set to r/w may fail if either BDRV_O_ALLOW_RDWR is
33
+ * not set, or if the BDS still has copy_on_read enabled */
34
+ read_only = !(reopen_state->flags & BDRV_O_RDWR);
35
+ ret = bdrv_can_set_read_only(reopen_state->bs, read_only, &local_err);
36
+ if (local_err) {
37
+ error_propagate(errp, local_err);
38
goto error;
39
}
37
}
40
38
41
--
39
--
42
2.9.3
40
2.13.5
43
41
44
42
diff view generated by jsdifflib
1
Update 'clientname' to be 'user', which tracks better with both
1
From: Alberto Garcia <berto@igalia.com>
2
the QAPI and rados variable naming.
3
2
4
Update 'name' to be 'image_name', as it indicates the rbd image.
3
There's a few cases which we're passing an Error pointer to a function
5
Naming it 'image' would have been ideal, but we are using that for
4
only to discard it immediately afterwards without checking it. In
6
the rados_image_t value returned by rbd_open().
5
these cases we can simply remove the variable and pass NULL instead.
7
6
8
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
7
Signed-off-by: Alberto Garcia <berto@igalia.com>
9
Signed-off-by: Jeff Cody <jcody@redhat.com>
8
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
10
Reviewed-by: John Snow <jsnow@redhat.com>
9
Reviewed-by: Eric Blake <eblake@redhat.com>
11
Message-id: b7ec1fb2e1cf36f9b6911631447a5b0422590b7d.1491597120.git.jcody@redhat.com
10
Message-id: 20170829120836.16091-1-berto@igalia.com
11
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
12
---
12
---
13
block/rbd.c | 33 +++++++++++++++++----------------
13
block/qcow.c | 12 +++---------
14
1 file changed, 17 insertions(+), 16 deletions(-)
14
block/qcow2.c | 8 ++------
15
dump.c | 4 +---
16
3 files changed, 6 insertions(+), 18 deletions(-)
15
17
16
diff --git a/block/rbd.c b/block/rbd.c
18
diff --git a/block/qcow.c b/block/qcow.c
17
index XXXXXXX..XXXXXXX 100644
19
index XXXXXXX..XXXXXXX 100644
18
--- a/block/rbd.c
20
--- a/block/qcow.c
19
+++ b/block/rbd.c
21
+++ b/block/qcow.c
20
@@ -XXX,XX +XXX,XX @@ typedef struct BDRVRBDState {
22
@@ -XXX,XX +XXX,XX @@ static uint64_t get_cluster_offset(BlockDriverState *bs,
21
rados_t cluster;
23
start_sect = (offset & ~(s->cluster_size - 1)) >> 9;
22
rados_ioctx_t io_ctx;
24
for(i = 0; i < s->cluster_sectors; i++) {
23
rbd_image_t image;
25
if (i < n_start || i >= n_end) {
24
- char *name;
26
- Error *err = NULL;
25
+ char *image_name;
27
memset(s->cluster_data, 0x00, 512);
26
char *snap;
28
if (qcrypto_block_encrypt(s->crypto, start_sect + i,
27
} BDRVRBDState;
29
s->cluster_data,
28
30
BDRV_SECTOR_SIZE,
29
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_create(const char *filename, QemuOpts *opts, Error **errp)
31
- &err) < 0) {
30
int64_t bytes = 0;
32
- error_free(err);
31
int64_t objsize;
33
+ NULL) < 0) {
32
int obj_order = 0;
34
errno = EIO;
33
- const char *pool, *name, *conf, *clientname, *keypairs;
35
return -1;
34
+ const char *pool, *image_name, *conf, *user, *keypairs;
36
}
35
const char *secretid;
37
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
36
rados_t cluster;
38
QEMUIOVector hd_qiov;
37
rados_ioctx_t io_ctx;
39
uint8_t *buf;
38
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_create(const char *filename, QemuOpts *opts, Error **errp)
40
void *orig_buf;
39
*/
41
- Error *err = NULL;
40
pool = qdict_get_try_str(options, "pool");
42
41
conf = qdict_get_try_str(options, "conf");
43
if (qiov->niov > 1) {
42
- clientname = qdict_get_try_str(options, "user");
44
buf = orig_buf = qemu_try_blockalign(bs, qiov->size);
43
- name = qdict_get_try_str(options, "image");
45
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_readv(BlockDriverState *bs, int64_t sector_num,
44
+ user = qdict_get_try_str(options, "user");
46
if (bs->encrypted) {
45
+ image_name = qdict_get_try_str(options, "image");
47
assert(s->crypto);
46
keypairs = qdict_get_try_str(options, "=keyvalue-pairs");
48
if (qcrypto_block_decrypt(s->crypto, sector_num, buf,
47
49
- n * BDRV_SECTOR_SIZE, &err) < 0) {
48
- ret = rados_create(&cluster, clientname);
50
+ n * BDRV_SECTOR_SIZE, NULL) < 0) {
49
+ ret = rados_create(&cluster, user);
51
goto fail;
50
if (ret < 0) {
52
}
51
error_setg_errno(errp, -ret, "error initializing");
53
}
52
goto exit;
54
@@ -XXX,XX +XXX,XX @@ done:
53
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_create(const char *filename, QemuOpts *opts, Error **errp)
55
return ret;
54
goto shutdown;
56
55
}
57
fail:
56
58
- error_free(err);
57
- ret = rbd_create(io_ctx, name, bytes, &obj_order);
59
ret = -EIO;
58
+ ret = rbd_create(io_ctx, image_name, bytes, &obj_order);
60
goto done;
59
if (ret < 0) {
61
}
60
error_setg_errno(errp, -ret, "error rbd create");
62
@@ -XXX,XX +XXX,XX @@ static coroutine_fn int qcow_co_writev(BlockDriverState *bs, int64_t sector_num,
61
}
63
break;
62
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_open(BlockDriverState *bs, QDict *options, int flags,
64
}
63
Error **errp)
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)
64
{
121
{
65
BDRVRBDState *s = bs->opaque;
122
- Error *err = NULL;
66
- const char *pool, *snap, *conf, *clientname, *name, *keypairs;
123
DumpState *s = (DumpState *)data;
67
+ const char *pool, *snap, *conf, *user, *image_name, *keypairs;
124
- dump_process(s, &err);
68
const char *secretid;
125
- error_free(err);
69
QemuOpts *opts;
126
+ dump_process(s, NULL);
70
Error *local_err = NULL;
127
return NULL;
71
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_open(BlockDriverState *bs, QDict *options, int flags,
72
pool = qemu_opt_get(opts, "pool");
73
conf = qemu_opt_get(opts, "conf");
74
snap = qemu_opt_get(opts, "snapshot");
75
- clientname = qemu_opt_get(opts, "user");
76
- name = qemu_opt_get(opts, "image");
77
+ user = qemu_opt_get(opts, "user");
78
+ image_name = qemu_opt_get(opts, "image");
79
keypairs = qemu_opt_get(opts, "=keyvalue-pairs");
80
81
- if (!pool || !name) {
82
+ if (!pool || !image_name) {
83
error_setg(errp, "Parameters 'pool' and 'image' are required");
84
r = -EINVAL;
85
goto failed_opts;
86
}
87
88
- r = rados_create(&s->cluster, clientname);
89
+ r = rados_create(&s->cluster, user);
90
if (r < 0) {
91
error_setg_errno(errp, -r, "error initializing");
92
goto failed_opts;
93
}
94
95
s->snap = g_strdup(snap);
96
- s->name = g_strdup(name);
97
+ s->image_name = g_strdup(image_name);
98
99
/* try default location when conf=NULL, but ignore failure */
100
r = rados_conf_read_file(s->cluster, conf);
101
@@ -XXX,XX +XXX,XX @@ static int qemu_rbd_open(BlockDriverState *bs, QDict *options, int flags,
102
}
103
104
/* rbd_open is always r/w */
105
- r = rbd_open(s->io_ctx, s->name, &s->image, s->snap);
106
+ r = rbd_open(s->io_ctx, s->image_name, &s->image, s->snap);
107
if (r < 0) {
108
- error_setg_errno(errp, -r, "error reading header from %s", s->name);
109
+ error_setg_errno(errp, -r, "error reading header from %s",
110
+ s->image_name);
111
goto failed_open;
112
}
113
114
@@ -XXX,XX +XXX,XX @@ failed_open:
115
failed_shutdown:
116
rados_shutdown(s->cluster);
117
g_free(s->snap);
118
- g_free(s->name);
119
+ g_free(s->image_name);
120
failed_opts:
121
qemu_opts_del(opts);
122
g_free(mon_host);
123
@@ -XXX,XX +XXX,XX @@ static void qemu_rbd_close(BlockDriverState *bs)
124
rbd_close(s->image);
125
rados_ioctx_destroy(s->io_ctx);
126
g_free(s->snap);
127
- g_free(s->name);
128
+ g_free(s->image_name);
129
rados_shutdown(s->cluster);
130
}
128
}
131
129
132
--
130
--
133
2.9.3
131
2.13.5
134
132
135
133
diff view generated by jsdifflib
1
From: Ashish Mittal <ashmit602@gmail.com>
1
The minimum Python version supported by QEMU is 2.6. The argparse
2
standard library module was only added in Python 2.7. Many scripts
3
would like to use argparse because it supports command-line
4
sub-commands.
2
5
3
Source code for the qnio library that this code loads can be downloaded from:
6
This patch adds argparse. See the top of argparse.py for details.
4
https://github.com/VeritasHyperScale/libqnio.git
5
7
6
Sample command line using JSON syntax:
8
Suggested-by: Daniel P. Berrange <berrange@redhat.com>
7
./x86_64-softmmu/qemu-system-x86_64 -name instance-00000008 -S -vnc 0.0.0.0:0
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
8
-k en-us -vga cirrus -device virtio-balloon-pci,id=balloon0,bus=pci.0,addr=0x5
10
Acked-by: John Snow <jsnow@redhat.com>
9
-msg timestamp=on
11
Message-id: 20170825155732.15665-2-stefanha@redhat.com
10
'json:{"driver":"vxhs","vdisk-id":"c3e9095a-a5ee-4dce-afeb-2a59fb387410",
12
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
11
"server":{"host":"172.172.17.4","port":"9999"}}'
13
---
14
COPYING.PYTHON | 270 ++++++
15
scripts/argparse.py | 2406 +++++++++++++++++++++++++++++++++++++++++++++++++++
16
2 files changed, 2676 insertions(+)
17
create mode 100644 COPYING.PYTHON
18
create mode 100644 scripts/argparse.py
12
19
13
Sample command line using URI syntax:
20
diff --git a/COPYING.PYTHON b/COPYING.PYTHON
14
qemu-img convert -f raw -O raw -n
15
/var/lib/nova/instances/_base/0c5eacd5ebea5ed914b6a3e7b18f1ce734c386ad
16
vxhs://192.168.0.1:9999/c6718f6b-0401-441d-a8c3-1f0064d75ee0
17
18
Sample command line using TLS credentials (run in secure mode):
19
./qemu-io --object
20
tls-creds-x509,id=tls0,dir=/etc/pki/qemu/vxhs,endpoint=client -c 'read
21
-v 66000 2.5k' 'json:{"server.host": "127.0.0.1", "server.port": "9999",
22
"vdisk-id": "/test.raw", "driver": "vxhs", "tls-creds":"tls0"}'
23
24
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
25
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
26
Reviewed-by: Jeff Cody <jcody@redhat.com>
27
Signed-off-by: Jeff Cody <jcody@redhat.com>
28
Message-id: 1491277689-24949-2-git-send-email-Ashish.Mittal@veritas.com
29
---
30
block/Makefile.objs | 2 +
31
block/trace-events | 17 ++
32
block/vxhs.c | 575 +++++++++++++++++++++++++++++++++++++++++++++++++++
33
configure | 39 ++++
34
qapi/block-core.json | 23 ++-
35
5 files changed, 654 insertions(+), 2 deletions(-)
36
create mode 100644 block/vxhs.c
37
38
diff --git a/block/Makefile.objs b/block/Makefile.objs
39
index XXXXXXX..XXXXXXX 100644
40
--- a/block/Makefile.objs
41
+++ b/block/Makefile.objs
42
@@ -XXX,XX +XXX,XX @@ block-obj-$(CONFIG_LIBNFS) += nfs.o
43
block-obj-$(CONFIG_CURL) += curl.o
44
block-obj-$(CONFIG_RBD) += rbd.o
45
block-obj-$(CONFIG_GLUSTERFS) += gluster.o
46
+block-obj-$(CONFIG_VXHS) += vxhs.o
47
block-obj-$(CONFIG_LIBSSH2) += ssh.o
48
block-obj-y += accounting.o dirty-bitmap.o
49
block-obj-y += write-threshold.o
50
@@ -XXX,XX +XXX,XX @@ rbd.o-cflags := $(RBD_CFLAGS)
51
rbd.o-libs := $(RBD_LIBS)
52
gluster.o-cflags := $(GLUSTERFS_CFLAGS)
53
gluster.o-libs := $(GLUSTERFS_LIBS)
54
+vxhs.o-libs := $(VXHS_LIBS)
55
ssh.o-cflags := $(LIBSSH2_CFLAGS)
56
ssh.o-libs := $(LIBSSH2_LIBS)
57
block-obj-$(if $(CONFIG_BZIP2),m,n) += dmg-bz2.o
58
diff --git a/block/trace-events b/block/trace-events
59
index XXXXXXX..XXXXXXX 100644
60
--- a/block/trace-events
61
+++ b/block/trace-events
62
@@ -XXX,XX +XXX,XX @@ qed_aio_write_data(void *s, void *acb, int ret, uint64_t offset, size_t len) "s
63
qed_aio_write_prefill(void *s, void *acb, uint64_t start, size_t len, uint64_t offset) "s %p acb %p start %"PRIu64" len %zu offset %"PRIu64
64
qed_aio_write_postfill(void *s, void *acb, uint64_t start, size_t len, uint64_t offset) "s %p acb %p start %"PRIu64" len %zu offset %"PRIu64
65
qed_aio_write_main(void *s, void *acb, int ret, uint64_t offset, size_t len) "s %p acb %p ret %d offset %"PRIu64" len %zu"
66
+
67
+# block/vxhs.c
68
+vxhs_iio_callback(int error) "ctx is NULL: error %d"
69
+vxhs_iio_callback_chnfail(int err, int error) "QNIO channel failed, no i/o %d, %d"
70
+vxhs_iio_callback_unknwn(int opcode, int err) "unexpected opcode %d, errno %d"
71
+vxhs_aio_rw_invalid(int req) "Invalid I/O request iodir %d"
72
+vxhs_aio_rw_ioerr(char *guid, int iodir, uint64_t size, uint64_t off, void *acb, int ret, int err) "IO ERROR (vDisk %s) FOR : Read/Write = %d size = %lu offset = %lu ACB = %p. Error = %d, errno = %d"
73
+vxhs_get_vdisk_stat_err(char *guid, int ret, int err) "vDisk (%s) stat ioctl failed, ret = %d, errno = %d"
74
+vxhs_get_vdisk_stat(char *vdisk_guid, uint64_t vdisk_size) "vDisk %s stat ioctl returned size %lu"
75
+vxhs_complete_aio(void *acb, uint64_t ret) "aio failed acb %p ret %ld"
76
+vxhs_parse_uri_filename(const char *filename) "URI passed via bdrv_parse_filename %s"
77
+vxhs_open_vdiskid(const char *vdisk_id) "Opening vdisk-id %s"
78
+vxhs_open_hostinfo(char *of_vsa_addr, int port) "Adding host %s:%d to BDRVVXHSState"
79
+vxhs_open_iio_open(const char *host) "Failed to connect to storage agent on host %s"
80
+vxhs_parse_uri_hostinfo(char *host, int port) "Host: IP %s, Port %d"
81
+vxhs_close(char *vdisk_guid) "Closing vdisk %s"
82
+vxhs_get_creds(const char *cacert, const char *client_key, const char *client_cert) "cacert %s, client_key %s, client_cert %s"
83
diff --git a/block/vxhs.c b/block/vxhs.c
84
new file mode 100644
21
new file mode 100644
85
index XXXXXXX..XXXXXXX
22
index XXXXXXX..XXXXXXX
86
--- /dev/null
23
--- /dev/null
87
+++ b/block/vxhs.c
24
+++ b/COPYING.PYTHON
88
@@ -XXX,XX +XXX,XX @@
25
@@ -XXX,XX +XXX,XX @@
89
+/*
26
+A. HISTORY OF THE SOFTWARE
90
+ * QEMU Block driver for Veritas HyperScale (VxHS)
27
+==========================
91
+ *
28
+
92
+ * Copyright (c) 2017 Veritas Technologies LLC.
29
+Python was created in the early 1990s by Guido van Rossum at Stichting
93
+ *
30
+Mathematisch Centrum (CWI, see http://www.cwi.nl) in the Netherlands
94
+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
31
+as a successor of a language called ABC. Guido remains Python's
95
+ * See the COPYING file in the top-level directory.
32
+principal author, although it includes many contributions from others.
96
+ *
33
+
97
+ */
34
+In 1995, Guido continued his work on Python at the Corporation for
98
+
35
+National Research Initiatives (CNRI, see http://www.cnri.reston.va.us)
99
+#include "qemu/osdep.h"
36
+in Reston, Virginia where he released several versions of the
100
+#include <qnio/qnio_api.h>
37
+software.
101
+#include <sys/param.h>
38
+
102
+#include "block/block_int.h"
39
+In May 2000, Guido and the Python core development team moved to
103
+#include "qapi/qmp/qerror.h"
40
+BeOpen.com to form the BeOpen PythonLabs team. In October of the same
104
+#include "qapi/qmp/qdict.h"
41
+year, the PythonLabs team moved to Digital Creations (now Zope
105
+#include "qapi/qmp/qstring.h"
42
+Corporation, see http://www.zope.com). In 2001, the Python Software
106
+#include "trace.h"
43
+Foundation (PSF, see http://www.python.org/psf/) was formed, a
107
+#include "qemu/uri.h"
44
+non-profit organization created specifically to own Python-related
108
+#include "qapi/error.h"
45
+Intellectual Property. Zope Corporation is a sponsoring member of
109
+#include "qemu/uuid.h"
46
+the PSF.
110
+#include "crypto/tlscredsx509.h"
47
+
111
+
48
+All Python releases are Open Source (see http://www.opensource.org for
112
+#define VXHS_OPT_FILENAME "filename"
49
+the Open Source Definition). Historically, most, but not all, Python
113
+#define VXHS_OPT_VDISK_ID "vdisk-id"
50
+releases have also been GPL-compatible; the table below summarizes
114
+#define VXHS_OPT_SERVER "server"
51
+the various releases.
115
+#define VXHS_OPT_HOST "host"
52
+
116
+#define VXHS_OPT_PORT "port"
53
+ Release Derived Year Owner GPL-
117
+
54
+ from compatible? (1)
118
+/* Only accessed under QEMU global mutex */
55
+
119
+static uint32_t vxhs_ref;
56
+ 0.9.0 thru 1.2 1991-1995 CWI yes
120
+
57
+ 1.3 thru 1.5.2 1.2 1995-1999 CNRI yes
121
+typedef enum {
58
+ 1.6 1.5.2 2000 CNRI no
122
+ VDISK_AIO_READ,
59
+ 2.0 1.6 2000 BeOpen.com no
123
+ VDISK_AIO_WRITE,
60
+ 1.6.1 1.6 2001 CNRI yes (2)
124
+} VDISKAIOCmd;
61
+ 2.1 2.0+1.6.1 2001 PSF no
125
+
62
+ 2.0.1 2.0+1.6.1 2001 PSF yes
126
+/*
63
+ 2.1.1 2.1+2.0.1 2001 PSF yes
127
+ * HyperScale AIO callbacks structure
64
+ 2.2 2.1.1 2001 PSF yes
128
+ */
65
+ 2.1.2 2.1.1 2002 PSF yes
129
+typedef struct VXHSAIOCB {
66
+ 2.1.3 2.1.2 2002 PSF yes
130
+ BlockAIOCB common;
67
+ 2.2.1 2.2 2002 PSF yes
131
+ int err;
68
+ 2.2.2 2.2.1 2002 PSF yes
132
+} VXHSAIOCB;
69
+ 2.2.3 2.2.2 2003 PSF yes
133
+
70
+ 2.3 2.2.2 2002-2003 PSF yes
134
+typedef struct VXHSvDiskHostsInfo {
71
+ 2.3.1 2.3 2002-2003 PSF yes
135
+ void *dev_handle; /* Device handle */
72
+ 2.3.2 2.3.1 2002-2003 PSF yes
136
+ char *host; /* Host name or IP */
73
+ 2.3.3 2.3.2 2002-2003 PSF yes
137
+ int port; /* Host's port number */
74
+ 2.3.4 2.3.3 2004 PSF yes
138
+} VXHSvDiskHostsInfo;
75
+ 2.3.5 2.3.4 2005 PSF yes
139
+
76
+ 2.4 2.3 2004 PSF yes
140
+/*
77
+ 2.4.1 2.4 2005 PSF yes
141
+ * Structure per vDisk maintained for state
78
+ 2.4.2 2.4.1 2005 PSF yes
142
+ */
79
+ 2.4.3 2.4.2 2006 PSF yes
143
+typedef struct BDRVVXHSState {
80
+ 2.5 2.4 2006 PSF yes
144
+ VXHSvDiskHostsInfo vdisk_hostinfo; /* Per host info */
81
+ 2.7 2.6 2010 PSF yes
145
+ char *vdisk_guid;
82
+
146
+ char *tlscredsid; /* tlscredsid */
83
+Footnotes:
147
+} BDRVVXHSState;
84
+
148
+
85
+(1) GPL-compatible doesn't mean that we're distributing Python under
149
+static void vxhs_complete_aio_bh(void *opaque)
86
+ the GPL. All Python licenses, unlike the GPL, let you distribute
150
+{
87
+ a modified version without making your changes open source. The
151
+ VXHSAIOCB *acb = opaque;
88
+ GPL-compatible licenses make it possible to combine Python with
152
+ BlockCompletionFunc *cb = acb->common.cb;
89
+ other software that is released under the GPL; the others don't.
153
+ void *cb_opaque = acb->common.opaque;
90
+
154
+ int ret = 0;
91
+(2) According to Richard Stallman, 1.6.1 is not GPL-compatible,
155
+
92
+ because its license has a choice of law clause. According to
156
+ if (acb->err != 0) {
93
+ CNRI, however, Stallman's lawyer has told CNRI's lawyer that 1.6.1
157
+ trace_vxhs_complete_aio(acb, acb->err);
94
+ is "not incompatible" with the GPL.
158
+ ret = (-EIO);
95
+
159
+ }
96
+Thanks to the many outside volunteers who have worked under Guido's
160
+
97
+direction to make these releases possible.
161
+ qemu_aio_unref(acb);
98
+
162
+ cb(cb_opaque, ret);
99
+
163
+}
100
+B. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING PYTHON
164
+
101
+===============================================================
165
+/*
102
+
166
+ * Called from a libqnio thread
103
+PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
167
+ */
104
+--------------------------------------------
168
+static void vxhs_iio_callback(void *ctx, uint32_t opcode, uint32_t error)
105
+
169
+{
106
+1. This LICENSE AGREEMENT is between the Python Software Foundation
170
+ VXHSAIOCB *acb = NULL;
107
+("PSF"), and the Individual or Organization ("Licensee") accessing and
171
+
108
+otherwise using this software ("Python") in source or binary form and
172
+ switch (opcode) {
109
+its associated documentation.
173
+ case IRP_READ_REQUEST:
110
+
174
+ case IRP_WRITE_REQUEST:
111
+2. Subject to the terms and conditions of this License Agreement, PSF
175
+
112
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
176
+ /*
113
+license to reproduce, analyze, test, perform and/or display publicly,
177
+ * ctx is VXHSAIOCB*
114
+prepare derivative works, distribute, and otherwise use Python
178
+ * ctx is NULL if error is QNIOERROR_CHANNEL_HUP
115
+alone or in any derivative version, provided, however, that PSF's
179
+ */
116
+License Agreement and PSF's notice of copyright, i.e., "Copyright (c)
180
+ if (ctx) {
117
+2001, 2002, 2003, 2004, 2005, 2006 Python Software Foundation; All Rights
181
+ acb = ctx;
118
+Reserved" are retained in Python alone or in any derivative version
182
+ } else {
119
+prepared by Licensee.
183
+ trace_vxhs_iio_callback(error);
120
+
184
+ goto out;
121
+3. In the event Licensee prepares a derivative work that is based on
185
+ }
122
+or incorporates Python or any part thereof, and wants to make
186
+
123
+the derivative work available to others as provided herein, then
187
+ if (error) {
124
+Licensee hereby agrees to include in any such work a brief summary of
188
+ if (!acb->err) {
125
+the changes made to Python.
189
+ acb->err = error;
126
+
127
+4. PSF is making Python available to Licensee on an "AS IS"
128
+basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
129
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
130
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
131
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
132
+INFRINGE ANY THIRD PARTY RIGHTS.
133
+
134
+5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
135
+FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
136
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
137
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
138
+
139
+6. This License Agreement will automatically terminate upon a material
140
+breach of its terms and conditions.
141
+
142
+7. Nothing in this License Agreement shall be deemed to create any
143
+relationship of agency, partnership, or joint venture between PSF and
144
+Licensee. This License Agreement does not grant permission to use PSF
145
+trademarks or trade name in a trademark sense to endorse or promote
146
+products or services of Licensee, or any third party.
147
+
148
+8. By copying, installing or otherwise using Python, Licensee
149
+agrees to be bound by the terms and conditions of this License
150
+Agreement.
151
+
152
+
153
+BEOPEN.COM LICENSE AGREEMENT FOR PYTHON 2.0
154
+-------------------------------------------
155
+
156
+BEOPEN PYTHON OPEN SOURCE LICENSE AGREEMENT VERSION 1
157
+
158
+1. This LICENSE AGREEMENT is between BeOpen.com ("BeOpen"), having an
159
+office at 160 Saratoga Avenue, Santa Clara, CA 95051, and the
160
+Individual or Organization ("Licensee") accessing and otherwise using
161
+this software in source or binary form and its associated
162
+documentation ("the Software").
163
+
164
+2. Subject to the terms and conditions of this BeOpen Python License
165
+Agreement, BeOpen hereby grants Licensee a non-exclusive,
166
+royalty-free, world-wide license to reproduce, analyze, test, perform
167
+and/or display publicly, prepare derivative works, distribute, and
168
+otherwise use the Software alone or in any derivative version,
169
+provided, however, that the BeOpen Python License is retained in the
170
+Software, alone or in any derivative version prepared by Licensee.
171
+
172
+3. BeOpen is making the Software available to Licensee on an "AS IS"
173
+basis. BEOPEN MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
174
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, BEOPEN MAKES NO AND
175
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
176
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE WILL NOT
177
+INFRINGE ANY THIRD PARTY RIGHTS.
178
+
179
+4. BEOPEN SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF THE
180
+SOFTWARE FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS
181
+AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THE SOFTWARE, OR ANY
182
+DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
183
+
184
+5. This License Agreement will automatically terminate upon a material
185
+breach of its terms and conditions.
186
+
187
+6. This License Agreement shall be governed by and interpreted in all
188
+respects by the law of the State of California, excluding conflict of
189
+law provisions. Nothing in this License Agreement shall be deemed to
190
+create any relationship of agency, partnership, or joint venture
191
+between BeOpen and Licensee. This License Agreement does not grant
192
+permission to use BeOpen trademarks or trade names in a trademark
193
+sense to endorse or promote products or services of Licensee, or any
194
+third party. As an exception, the "BeOpen Python" logos available at
195
+http://www.pythonlabs.com/logos.html may be used according to the
196
+permissions granted on that web page.
197
+
198
+7. By copying, installing or otherwise using the software, Licensee
199
+agrees to be bound by the terms and conditions of this License
200
+Agreement.
201
+
202
+
203
+CNRI LICENSE AGREEMENT FOR PYTHON 1.6.1
204
+---------------------------------------
205
+
206
+1. This LICENSE AGREEMENT is between the Corporation for National
207
+Research Initiatives, having an office at 1895 Preston White Drive,
208
+Reston, VA 20191 ("CNRI"), and the Individual or Organization
209
+("Licensee") accessing and otherwise using Python 1.6.1 software in
210
+source or binary form and its associated documentation.
211
+
212
+2. Subject to the terms and conditions of this License Agreement, CNRI
213
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
214
+license to reproduce, analyze, test, perform and/or display publicly,
215
+prepare derivative works, distribute, and otherwise use Python 1.6.1
216
+alone or in any derivative version, provided, however, that CNRI's
217
+License Agreement and CNRI's notice of copyright, i.e., "Copyright (c)
218
+1995-2001 Corporation for National Research Initiatives; All Rights
219
+Reserved" are retained in Python 1.6.1 alone or in any derivative
220
+version prepared by Licensee. Alternately, in lieu of CNRI's License
221
+Agreement, Licensee may substitute the following text (omitting the
222
+quotes): "Python 1.6.1 is made available subject to the terms and
223
+conditions in CNRI's License Agreement. This Agreement together with
224
+Python 1.6.1 may be located on the Internet using the following
225
+unique, persistent identifier (known as a handle): 1895.22/1013. This
226
+Agreement may also be obtained from a proxy server on the Internet
227
+using the following URL: http://hdl.handle.net/1895.22/1013".
228
+
229
+3. In the event Licensee prepares a derivative work that is based on
230
+or incorporates Python 1.6.1 or any part thereof, and wants to make
231
+the derivative work available to others as provided herein, then
232
+Licensee hereby agrees to include in any such work a brief summary of
233
+the changes made to Python 1.6.1.
234
+
235
+4. CNRI is making Python 1.6.1 available to Licensee on an "AS IS"
236
+basis. CNRI MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
237
+IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, CNRI MAKES NO AND
238
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
239
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON 1.6.1 WILL NOT
240
+INFRINGE ANY THIRD PARTY RIGHTS.
241
+
242
+5. CNRI SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
243
+1.6.1 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
244
+A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON 1.6.1,
245
+OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
246
+
247
+6. This License Agreement will automatically terminate upon a material
248
+breach of its terms and conditions.
249
+
250
+7. This License Agreement shall be governed by the federal
251
+intellectual property law of the United States, including without
252
+limitation the federal copyright law, and, to the extent such
253
+U.S. federal law does not apply, by the law of the Commonwealth of
254
+Virginia, excluding Virginia's conflict of law provisions.
255
+Notwithstanding the foregoing, with regard to derivative works based
256
+on Python 1.6.1 that incorporate non-separable material that was
257
+previously distributed under the GNU General Public License (GPL), the
258
+law of the Commonwealth of Virginia shall govern this License
259
+Agreement only as to issues arising under or with respect to
260
+Paragraphs 4, 5, and 7 of this License Agreement. Nothing in this
261
+License Agreement shall be deemed to create any relationship of
262
+agency, partnership, or joint venture between CNRI and Licensee. This
263
+License Agreement does not grant permission to use CNRI trademarks or
264
+trade name in a trademark sense to endorse or promote products or
265
+services of Licensee, or any third party.
266
+
267
+8. By clicking on the "ACCEPT" button where indicated, or by copying,
268
+installing or otherwise using Python 1.6.1, Licensee agrees to be
269
+bound by the terms and conditions of this License Agreement.
270
+
271
+ ACCEPT
272
+
273
+
274
+CWI LICENSE AGREEMENT FOR PYTHON 0.9.0 THROUGH 1.2
275
+--------------------------------------------------
276
+
277
+Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,
278
+The Netherlands. All rights reserved.
279
+
280
+Permission to use, copy, modify, and distribute this software and its
281
+documentation for any purpose and without fee is hereby granted,
282
+provided that the above copyright notice appear in all copies and that
283
+both that copyright notice and this permission notice appear in
284
+supporting documentation, and that the name of Stichting Mathematisch
285
+Centrum or CWI not be used in advertising or publicity pertaining to
286
+distribution of the software without specific, written prior
287
+permission.
288
+
289
+STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
290
+THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
291
+FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
292
+FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
293
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
294
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
295
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
296
diff --git a/scripts/argparse.py b/scripts/argparse.py
297
new file mode 100644
298
index XXXXXXX..XXXXXXX
299
--- /dev/null
300
+++ b/scripts/argparse.py
301
@@ -XXX,XX +XXX,XX @@
302
+# This is a local copy of the standard library argparse module taken from PyPI.
303
+# It is licensed under the Python Software Foundation License. This is a
304
+# fallback for Python 2.6 which does not include this module. Python 2.7+ and
305
+# 3+ will never load this module because built-in modules are loaded before
306
+# anything in sys.path.
307
+#
308
+# If your script is not located in the same directory as this file, import it
309
+# like this:
310
+#
311
+# import os
312
+# import sys
313
+# sys.path.append(os.path.join(os.path.dirname(__file__), ..., 'scripts'))
314
+# import argparse
315
+
316
+# Author: Steven J. Bethard <steven.bethard@gmail.com>.
317
+# Maintainer: Thomas Waldmann <tw@waldmann-edv.de>
318
+
319
+"""Command-line parsing library
320
+
321
+This module is an optparse-inspired command-line parsing library that:
322
+
323
+ - handles both optional and positional arguments
324
+ - produces highly informative usage messages
325
+ - supports parsers that dispatch to sub-parsers
326
+
327
+The following is a simple usage example that sums integers from the
328
+command-line and writes the result to a file::
329
+
330
+ parser = argparse.ArgumentParser(
331
+ description='sum the integers at the command line')
332
+ parser.add_argument(
333
+ 'integers', metavar='int', nargs='+', type=int,
334
+ help='an integer to be summed')
335
+ parser.add_argument(
336
+ '--log', default=sys.stdout, type=argparse.FileType('w'),
337
+ help='the file where the sum should be written')
338
+ args = parser.parse_args()
339
+ args.log.write('%s' % sum(args.integers))
340
+ args.log.close()
341
+
342
+The module contains the following public classes:
343
+
344
+ - ArgumentParser -- The main entry point for command-line parsing. As the
345
+ example above shows, the add_argument() method is used to populate
346
+ the parser with actions for optional and positional arguments. Then
347
+ the parse_args() method is invoked to convert the args at the
348
+ command-line into an object with attributes.
349
+
350
+ - ArgumentError -- The exception raised by ArgumentParser objects when
351
+ there are errors with the parser's actions. Errors raised while
352
+ parsing the command-line are caught by ArgumentParser and emitted
353
+ as command-line messages.
354
+
355
+ - FileType -- A factory for defining types of files to be created. As the
356
+ example above shows, instances of FileType are typically passed as
357
+ the type= argument of add_argument() calls.
358
+
359
+ - Action -- The base class for parser actions. Typically actions are
360
+ selected by passing strings like 'store_true' or 'append_const' to
361
+ the action= argument of add_argument(). However, for greater
362
+ customization of ArgumentParser actions, subclasses of Action may
363
+ be defined and passed as the action= argument.
364
+
365
+ - HelpFormatter, RawDescriptionHelpFormatter, RawTextHelpFormatter,
366
+ ArgumentDefaultsHelpFormatter -- Formatter classes which
367
+ may be passed as the formatter_class= argument to the
368
+ ArgumentParser constructor. HelpFormatter is the default,
369
+ RawDescriptionHelpFormatter and RawTextHelpFormatter tell the parser
370
+ not to change the formatting for help text, and
371
+ ArgumentDefaultsHelpFormatter adds information about argument defaults
372
+ to the help.
373
+
374
+All other classes in this module are considered implementation details.
375
+(Also note that HelpFormatter and RawDescriptionHelpFormatter are only
376
+considered public as object names -- the API of the formatter objects is
377
+still considered an implementation detail.)
378
+"""
379
+
380
+__version__ = '1.4.0' # we use our own version number independant of the
381
+ # one in stdlib and we release this on pypi.
382
+
383
+__external_lib__ = True # to make sure the tests really test THIS lib,
384
+ # not the builtin one in Python stdlib
385
+
386
+__all__ = [
387
+ 'ArgumentParser',
388
+ 'ArgumentError',
389
+ 'ArgumentTypeError',
390
+ 'FileType',
391
+ 'HelpFormatter',
392
+ 'ArgumentDefaultsHelpFormatter',
393
+ 'RawDescriptionHelpFormatter',
394
+ 'RawTextHelpFormatter',
395
+ 'Namespace',
396
+ 'Action',
397
+ 'ONE_OR_MORE',
398
+ 'OPTIONAL',
399
+ 'PARSER',
400
+ 'REMAINDER',
401
+ 'SUPPRESS',
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'),
190
+ }
2367
+ }
191
+ trace_vxhs_iio_callback(error);
2368
+ default = _('expected %s argument(s)') % action.nargs
192
+ }
2369
+ msg = nargs_errors.get(action.nargs, default)
193
+
2370
+ raise ArgumentError(action, msg)
194
+ aio_bh_schedule_oneshot(bdrv_get_aio_context(acb->common.bs),
2371
+
195
+ vxhs_complete_aio_bh, acb);
2372
+ # return the number of arguments matched
196
+ break;
2373
+ return len(match.group(1))
197
+
2374
+
198
+ default:
2375
+ def _match_arguments_partial(self, actions, arg_strings_pattern):
199
+ if (error == QNIOERROR_HUP) {
2376
+ # progressively shorten the actions list by slicing off the
200
+ /*
2377
+ # final actions until we find a match
201
+ * Channel failed, spontaneous notification,
2378
+ result = []
202
+ * not in response to I/O
2379
+ for i in range(len(actions), 0, -1):
203
+ */
2380
+ actions_slice = actions[:i]
204
+ trace_vxhs_iio_callback_chnfail(error, errno);
2381
+ pattern = ''.join([self._get_nargs_pattern(action)
205
+ } else {
2382
+ for action in actions_slice])
206
+ trace_vxhs_iio_callback_unknwn(opcode, error);
2383
+ match = _re.match(pattern, arg_strings_pattern)
207
+ }
2384
+ if match is not None:
208
+ break;
2385
+ result.extend([len(string) for string in match.groups()])
209
+ }
2386
+ break
210
+out:
2387
+
211
+ return;
2388
+ # return the list of arg string counts
212
+}
2389
+ return result
213
+
2390
+
214
+static QemuOptsList runtime_opts = {
2391
+ def _parse_optional(self, arg_string):
215
+ .name = "vxhs",
2392
+ # if it's an empty string, it was meant to be a positional
216
+ .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
2393
+ if not arg_string:
217
+ .desc = {
2394
+ return None
218
+ {
2395
+
219
+ .name = VXHS_OPT_FILENAME,
2396
+ # if it doesn't start with a prefix, it was meant to be positional
220
+ .type = QEMU_OPT_STRING,
2397
+ if not arg_string[0] in self.prefix_chars:
221
+ .help = "URI to the Veritas HyperScale image",
2398
+ return None
222
+ },
2399
+
223
+ {
2400
+ # if the option string is present in the parser, return the action
224
+ .name = VXHS_OPT_VDISK_ID,
2401
+ if arg_string in self._option_string_actions:
225
+ .type = QEMU_OPT_STRING,
2402
+ action = self._option_string_actions[arg_string]
226
+ .help = "UUID of the VxHS vdisk",
2403
+ return action, arg_string, None
227
+ },
2404
+
228
+ {
2405
+ # if it's just a single character, it was meant to be positional
229
+ .name = "tls-creds",
2406
+ if len(arg_string) == 1:
230
+ .type = QEMU_OPT_STRING,
2407
+ return None
231
+ .help = "ID of the TLS/SSL credentials to use",
2408
+
232
+ },
2409
+ # if the option string before the "=" is present, return the action
233
+ { /* end of list */ }
2410
+ if '=' in arg_string:
234
+ },
2411
+ option_string, explicit_arg = arg_string.split('=', 1)
235
+};
2412
+ if option_string in self._option_string_actions:
236
+
2413
+ action = self._option_string_actions[option_string]
237
+static QemuOptsList runtime_tcp_opts = {
2414
+ return action, option_string, explicit_arg
238
+ .name = "vxhs_tcp",
2415
+
239
+ .head = QTAILQ_HEAD_INITIALIZER(runtime_tcp_opts.head),
2416
+ # search through all possible prefixes of the option string
240
+ .desc = {
2417
+ # and all actions in the parser for possible interpretations
241
+ {
2418
+ option_tuples = self._get_option_tuples(arg_string)
242
+ .name = VXHS_OPT_HOST,
2419
+
243
+ .type = QEMU_OPT_STRING,
2420
+ # if multiple actions match, the option string was ambiguous
244
+ .help = "host address (ipv4 addresses)",
2421
+ if len(option_tuples) > 1:
245
+ },
2422
+ options = ', '.join([option_string
246
+ {
2423
+ for action, option_string, explicit_arg in option_tuples])
247
+ .name = VXHS_OPT_PORT,
2424
+ tup = arg_string, options
248
+ .type = QEMU_OPT_NUMBER,
2425
+ self.error(_('ambiguous option: %s could match %s') % tup)
249
+ .help = "port number on which VxHSD is listening (default 9999)",
2426
+
250
+ .def_value_str = "9999"
2427
+ # if exactly one action matched, this segmentation is good,
251
+ },
2428
+ # so return the parsed action
252
+ { /* end of list */ }
2429
+ elif len(option_tuples) == 1:
253
+ },
2430
+ option_tuple, = option_tuples
254
+};
2431
+ return option_tuple
255
+
2432
+
256
+/*
2433
+ # if it was not found as an option, but it looks like a negative
257
+ * Parse incoming URI and populate *options with the host
2434
+ # number, it was meant to be positional
258
+ * and device information
2435
+ # unless there are negative-number-like options
259
+ */
2436
+ if self._negative_number_matcher.match(arg_string):
260
+static int vxhs_parse_uri(const char *filename, QDict *options)
2437
+ if not self._has_negative_number_optionals:
261
+{
2438
+ return None
262
+ URI *uri = NULL;
2439
+
263
+ char *port;
2440
+ # if it contains a space, it was meant to be a positional
264
+ int ret = 0;
2441
+ if ' ' in arg_string:
265
+
2442
+ return None
266
+ trace_vxhs_parse_uri_filename(filename);
2443
+
267
+ uri = uri_parse(filename);
2444
+ # it was meant to be an optional but there is no such option
268
+ if (!uri || !uri->server || !uri->path) {
2445
+ # in this parser (though it might be a valid option in a subparser)
269
+ uri_free(uri);
2446
+ return None, arg_string, None
270
+ return -EINVAL;
2447
+
271
+ }
2448
+ def _get_option_tuples(self, option_string):
272
+
2449
+ result = []
273
+ qdict_put(options, VXHS_OPT_SERVER".host", qstring_from_str(uri->server));
2450
+
274
+
2451
+ # option strings starting with two prefix characters are only
275
+ if (uri->port) {
2452
+ # split at the '='
276
+ port = g_strdup_printf("%d", uri->port);
2453
+ chars = self.prefix_chars
277
+ qdict_put(options, VXHS_OPT_SERVER".port", qstring_from_str(port));
2454
+ if option_string[0] in chars and option_string[1] in chars:
278
+ g_free(port);
2455
+ if '=' in option_string:
279
+ }
2456
+ option_prefix, explicit_arg = option_string.split('=', 1)
280
+
2457
+ else:
281
+ qdict_put(options, "vdisk-id", qstring_from_str(uri->path));
2458
+ option_prefix = option_string
282
+
2459
+ explicit_arg = None
283
+ trace_vxhs_parse_uri_hostinfo(uri->server, uri->port);
2460
+ for option_string in self._option_string_actions:
284
+ uri_free(uri);
2461
+ if option_string.startswith(option_prefix):
285
+
2462
+ action = self._option_string_actions[option_string]
286
+ return ret;
2463
+ tup = action, option_string, explicit_arg
287
+}
2464
+ result.append(tup)
288
+
2465
+
289
+static void vxhs_parse_filename(const char *filename, QDict *options,
2466
+ # single character options can be concatenated with their arguments
290
+ Error **errp)
2467
+ # but multiple character options always have to have their argument
291
+{
2468
+ # separate
292
+ if (qdict_haskey(options, "vdisk-id") || qdict_haskey(options, "server")) {
2469
+ elif option_string[0] in chars and option_string[1] not in chars:
293
+ error_setg(errp, "vdisk-id/server and a file name may not be specified "
2470
+ option_prefix = option_string
294
+ "at the same time");
2471
+ explicit_arg = None
295
+ return;
2472
+ short_option_prefix = option_string[:2]
296
+ }
2473
+ short_explicit_arg = option_string[2:]
297
+
2474
+
298
+ if (strstr(filename, "://")) {
2475
+ for option_string in self._option_string_actions:
299
+ int ret = vxhs_parse_uri(filename, options);
2476
+ if option_string == short_option_prefix:
300
+ if (ret < 0) {
2477
+ action = self._option_string_actions[option_string]
301
+ error_setg(errp, "Invalid URI. URI should be of the form "
2478
+ tup = action, option_string, short_explicit_arg
302
+ " vxhs://<host_ip>:<port>/<vdisk-id>");
2479
+ result.append(tup)
303
+ }
2480
+ elif option_string.startswith(option_prefix):
304
+ }
2481
+ action = self._option_string_actions[option_string]
305
+}
2482
+ tup = action, option_string, explicit_arg
306
+
2483
+ result.append(tup)
307
+static int vxhs_init_and_ref(void)
2484
+
308
+{
2485
+ # shouldn't ever get here
309
+ if (vxhs_ref++ == 0) {
2486
+ else:
310
+ if (iio_init(QNIO_VERSION, vxhs_iio_callback)) {
2487
+ self.error(_('unexpected option string: %s') % option_string)
311
+ return -ENODEV;
2488
+
312
+ }
2489
+ # return the collected option tuples
313
+ }
2490
+ return result
314
+ return 0;
2491
+
315
+}
2492
+ def _get_nargs_pattern(self, action):
316
+
2493
+ # in all examples below, we have to allow for '--' args
317
+static void vxhs_unref(void)
2494
+ # which are represented as '-' in the pattern
318
+{
2495
+ nargs = action.nargs
319
+ if (--vxhs_ref == 0) {
2496
+
320
+ iio_fini();
2497
+ # the default (None) is assumed to be a single argument
321
+ }
2498
+ if nargs is None:
322
+}
2499
+ nargs_pattern = '(-*A-*)'
323
+
2500
+
324
+static void vxhs_get_tls_creds(const char *id, char **cacert,
2501
+ # allow zero or one arguments
325
+ char **key, char **cert, Error **errp)
2502
+ elif nargs == OPTIONAL:
326
+{
2503
+ nargs_pattern = '(-*A?-*)'
327
+ Object *obj;
2504
+
328
+ QCryptoTLSCreds *creds;
2505
+ # allow zero or more arguments
329
+ QCryptoTLSCredsX509 *creds_x509;
2506
+ elif nargs == ZERO_OR_MORE:
330
+
2507
+ nargs_pattern = '(-*[A-]*)'
331
+ obj = object_resolve_path_component(
2508
+
332
+ object_get_objects_root(), id);
2509
+ # allow one or more arguments
333
+
2510
+ elif nargs == ONE_OR_MORE:
334
+ if (!obj) {
2511
+ nargs_pattern = '(-*A[A-]*)'
335
+ error_setg(errp, "No TLS credentials with id '%s'",
2512
+
336
+ id);
2513
+ # allow any number of options or arguments
337
+ return;
2514
+ elif nargs == REMAINDER:
338
+ }
2515
+ nargs_pattern = '([-AO]*)'
339
+
2516
+
340
+ creds_x509 = (QCryptoTLSCredsX509 *)
2517
+ # allow one argument followed by any number of options or arguments
341
+ object_dynamic_cast(obj, TYPE_QCRYPTO_TLS_CREDS_X509);
2518
+ elif nargs == PARSER:
342
+
2519
+ nargs_pattern = '(-*A[-AO]*)'
343
+ if (!creds_x509) {
2520
+
344
+ error_setg(errp, "Object with id '%s' is not TLS credentials",
2521
+ # all others should be integers
345
+ id);
2522
+ else:
346
+ return;
2523
+ nargs_pattern = '(-*%s-*)' % '-*'.join('A' * nargs)
347
+ }
2524
+
348
+
2525
+ # if this is an optional action, -- is not allowed
349
+ creds = &creds_x509->parent_obj;
2526
+ if action.option_strings:
350
+
2527
+ nargs_pattern = nargs_pattern.replace('-*', '')
351
+ if (creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
2528
+ nargs_pattern = nargs_pattern.replace('-', '')
352
+ error_setg(errp,
2529
+
353
+ "Expecting TLS credentials with a client endpoint");
2530
+ # return the pattern
354
+ return;
2531
+ return nargs_pattern
355
+ }
2532
+
356
+
2533
+ # ========================
357
+ /*
2534
+ # Value conversion methods
358
+ * Get the cacert, client_cert and client_key file names.
2535
+ # ========================
359
+ */
2536
+ def _get_values(self, action, arg_strings):
360
+ if (!creds->dir) {
2537
+ # for everything but PARSER args, strip out '--'
361
+ error_setg(errp, "TLS object missing 'dir' property value");
2538
+ if action.nargs not in [PARSER, REMAINDER]:
362
+ return;
2539
+ arg_strings = [s for s in arg_strings if s != '--']
363
+ }
2540
+
364
+
2541
+ # optional argument produces a default when not present
365
+ *cacert = g_strdup_printf("%s/%s", creds->dir,
2542
+ if not arg_strings and action.nargs == OPTIONAL:
366
+ QCRYPTO_TLS_CREDS_X509_CA_CERT);
2543
+ if action.option_strings:
367
+ *cert = g_strdup_printf("%s/%s", creds->dir,
2544
+ value = action.const
368
+ QCRYPTO_TLS_CREDS_X509_CLIENT_CERT);
2545
+ else:
369
+ *key = g_strdup_printf("%s/%s", creds->dir,
2546
+ value = action.default
370
+ QCRYPTO_TLS_CREDS_X509_CLIENT_KEY);
2547
+ if isinstance(value, basestring):
371
+}
2548
+ value = self._get_value(action, value)
372
+
2549
+ self._check_value(action, value)
373
+static int vxhs_open(BlockDriverState *bs, QDict *options,
2550
+
374
+ int bdrv_flags, Error **errp)
2551
+ # when nargs='*' on a positional, if there were no command-line
375
+{
2552
+ # args, use the default if it is anything other than None
376
+ BDRVVXHSState *s = bs->opaque;
2553
+ elif (not arg_strings and action.nargs == ZERO_OR_MORE and
377
+ void *dev_handlep;
2554
+ not action.option_strings):
378
+ QDict *backing_options = NULL;
2555
+ if action.default is not None:
379
+ QemuOpts *opts = NULL;
2556
+ value = action.default
380
+ QemuOpts *tcp_opts = NULL;
2557
+ else:
381
+ char *of_vsa_addr = NULL;
2558
+ value = arg_strings
382
+ Error *local_err = NULL;
2559
+ self._check_value(action, value)
383
+ const char *vdisk_id_opt;
2560
+
384
+ const char *server_host_opt;
2561
+ # single argument or optional argument produces a single value
385
+ int ret = 0;
2562
+ elif len(arg_strings) == 1 and action.nargs in [None, OPTIONAL]:
386
+ char *cacert = NULL;
2563
+ arg_string, = arg_strings
387
+ char *client_key = NULL;
2564
+ value = self._get_value(action, arg_string)
388
+ char *client_cert = NULL;
2565
+ self._check_value(action, value)
389
+
2566
+
390
+ ret = vxhs_init_and_ref();
2567
+ # REMAINDER arguments convert all values, checking none
391
+ if (ret < 0) {
2568
+ elif action.nargs == REMAINDER:
392
+ ret = -EINVAL;
2569
+ value = [self._get_value(action, v) for v in arg_strings]
393
+ goto out;
2570
+
394
+ }
2571
+ # PARSER arguments convert all values, but check only the first
395
+
2572
+ elif action.nargs == PARSER:
396
+ /* Create opts info from runtime_opts and runtime_tcp_opts list */
2573
+ value = [self._get_value(action, v) for v in arg_strings]
397
+ opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
2574
+ self._check_value(action, value[0])
398
+ tcp_opts = qemu_opts_create(&runtime_tcp_opts, NULL, 0, &error_abort);
2575
+
399
+
2576
+ # all other types of nargs produce a list
400
+ qemu_opts_absorb_qdict(opts, options, &local_err);
2577
+ else:
401
+ if (local_err) {
2578
+ value = [self._get_value(action, v) for v in arg_strings]
402
+ ret = -EINVAL;
2579
+ for v in value:
403
+ goto out;
2580
+ self._check_value(action, v)
404
+ }
2581
+
405
+
2582
+ # return the converted value
406
+ /* vdisk-id is the disk UUID */
2583
+ return value
407
+ vdisk_id_opt = qemu_opt_get(opts, VXHS_OPT_VDISK_ID);
2584
+
408
+ if (!vdisk_id_opt) {
2585
+ def _get_value(self, action, arg_string):
409
+ error_setg(&local_err, QERR_MISSING_PARAMETER, VXHS_OPT_VDISK_ID);
2586
+ type_func = self._registry_get('type', action.type, action.type)
410
+ ret = -EINVAL;
2587
+ if not _callable(type_func):
411
+ goto out;
2588
+ msg = _('%r is not callable')
412
+ }
2589
+ raise ArgumentError(action, msg % type_func)
413
+
2590
+
414
+ /* vdisk-id may contain a leading '/' */
2591
+ # convert the value to the appropriate type
415
+ if (strlen(vdisk_id_opt) > UUID_FMT_LEN + 1) {
2592
+ try:
416
+ error_setg(&local_err, "vdisk-id cannot be more than %d characters",
2593
+ result = type_func(arg_string)
417
+ UUID_FMT_LEN);
2594
+
418
+ ret = -EINVAL;
2595
+ # ArgumentTypeErrors indicate errors
419
+ goto out;
2596
+ except ArgumentTypeError:
420
+ }
2597
+ name = getattr(action.type, '__name__', repr(action.type))
421
+
2598
+ msg = str(_sys.exc_info()[1])
422
+ s->vdisk_guid = g_strdup(vdisk_id_opt);
2599
+ raise ArgumentError(action, msg)
423
+ trace_vxhs_open_vdiskid(vdisk_id_opt);
2600
+
424
+
2601
+ # TypeErrors or ValueErrors also indicate errors
425
+ /* get the 'server.' arguments */
2602
+ except (TypeError, ValueError):
426
+ qdict_extract_subqdict(options, &backing_options, VXHS_OPT_SERVER".");
2603
+ name = getattr(action.type, '__name__', repr(action.type))
427
+
2604
+ msg = _('invalid %s value: %r')
428
+ qemu_opts_absorb_qdict(tcp_opts, backing_options, &local_err);
2605
+ raise ArgumentError(action, msg % (name, arg_string))
429
+ if (local_err != NULL) {
2606
+
430
+ ret = -EINVAL;
2607
+ # return the converted value
431
+ goto out;
2608
+ return result
432
+ }
2609
+
433
+
2610
+ def _check_value(self, action, value):
434
+ server_host_opt = qemu_opt_get(tcp_opts, VXHS_OPT_HOST);
2611
+ # converted value must be one of the choices (if specified)
435
+ if (!server_host_opt) {
2612
+ if action.choices is not None and value not in action.choices:
436
+ error_setg(&local_err, QERR_MISSING_PARAMETER,
2613
+ tup = value, ', '.join(map(repr, action.choices))
437
+ VXHS_OPT_SERVER"."VXHS_OPT_HOST);
2614
+ msg = _('invalid choice: %r (choose from %s)') % tup
438
+ ret = -EINVAL;
2615
+ raise ArgumentError(action, msg)
439
+ goto out;
2616
+
440
+ }
2617
+ # =======================
441
+
2618
+ # Help-formatting methods
442
+ if (strlen(server_host_opt) > MAXHOSTNAMELEN) {
2619
+ # =======================
443
+ error_setg(&local_err, "server.host cannot be more than %d characters",
2620
+ def format_usage(self):
444
+ MAXHOSTNAMELEN);
2621
+ formatter = self._get_formatter()
445
+ ret = -EINVAL;
2622
+ formatter.add_usage(self.usage, self._actions,
446
+ goto out;
2623
+ self._mutually_exclusive_groups)
447
+ }
2624
+ return formatter.format_help()
448
+
2625
+
449
+ /* check if we got tls-creds via the --object argument */
2626
+ def format_help(self):
450
+ s->tlscredsid = g_strdup(qemu_opt_get(opts, "tls-creds"));
2627
+ formatter = self._get_formatter()
451
+ if (s->tlscredsid) {
2628
+
452
+ vxhs_get_tls_creds(s->tlscredsid, &cacert, &client_key,
2629
+ # usage
453
+ &client_cert, &local_err);
2630
+ formatter.add_usage(self.usage, self._actions,
454
+ if (local_err != NULL) {
2631
+ self._mutually_exclusive_groups)
455
+ ret = -EINVAL;
2632
+
456
+ goto out;
2633
+ # description
457
+ }
2634
+ formatter.add_text(self.description)
458
+ trace_vxhs_get_creds(cacert, client_key, client_cert);
2635
+
459
+ }
2636
+ # positionals, optionals and user-defined groups
460
+
2637
+ for action_group in self._action_groups:
461
+ s->vdisk_hostinfo.host = g_strdup(server_host_opt);
2638
+ formatter.start_section(action_group.title)
462
+ s->vdisk_hostinfo.port = g_ascii_strtoll(qemu_opt_get(tcp_opts,
2639
+ formatter.add_text(action_group.description)
463
+ VXHS_OPT_PORT),
2640
+ formatter.add_arguments(action_group._group_actions)
464
+ NULL, 0);
2641
+ formatter.end_section()
465
+
2642
+
466
+ trace_vxhs_open_hostinfo(s->vdisk_hostinfo.host,
2643
+ # epilog
467
+ s->vdisk_hostinfo.port);
2644
+ formatter.add_text(self.epilog)
468
+
2645
+
469
+ of_vsa_addr = g_strdup_printf("of://%s:%d",
2646
+ # determine help from format above
470
+ s->vdisk_hostinfo.host,
2647
+ return formatter.format_help()
471
+ s->vdisk_hostinfo.port);
2648
+
472
+
2649
+ def format_version(self):
473
+ /*
2650
+ import warnings
474
+ * Open qnio channel to storage agent if not opened before
2651
+ warnings.warn(
475
+ */
2652
+ 'The format_version method is deprecated -- the "version" '
476
+ dev_handlep = iio_open(of_vsa_addr, s->vdisk_guid, 0,
2653
+ 'argument to ArgumentParser is no longer supported.',
477
+ cacert, client_key, client_cert);
2654
+ DeprecationWarning)
478
+ if (dev_handlep == NULL) {
2655
+ formatter = self._get_formatter()
479
+ trace_vxhs_open_iio_open(of_vsa_addr);
2656
+ formatter.add_text(self.version)
480
+ ret = -ENODEV;
2657
+ return formatter.format_help()
481
+ goto out;
2658
+
482
+ }
2659
+ def _get_formatter(self):
483
+ s->vdisk_hostinfo.dev_handle = dev_handlep;
2660
+ return self.formatter_class(prog=self.prog)
484
+
2661
+
485
+out:
2662
+ # =====================
486
+ g_free(of_vsa_addr);
2663
+ # Help-printing methods
487
+ QDECREF(backing_options);
2664
+ # =====================
488
+ qemu_opts_del(tcp_opts);
2665
+ def print_usage(self, file=None):
489
+ qemu_opts_del(opts);
2666
+ if file is None:
490
+ g_free(cacert);
2667
+ file = _sys.stdout
491
+ g_free(client_key);
2668
+ self._print_message(self.format_usage(), file)
492
+ g_free(client_cert);
2669
+
493
+
2670
+ def print_help(self, file=None):
494
+ if (ret < 0) {
2671
+ if file is None:
495
+ vxhs_unref();
2672
+ file = _sys.stdout
496
+ error_propagate(errp, local_err);
2673
+ self._print_message(self.format_help(), file)
497
+ g_free(s->vdisk_hostinfo.host);
2674
+
498
+ g_free(s->vdisk_guid);
2675
+ def print_version(self, file=None):
499
+ g_free(s->tlscredsid);
2676
+ import warnings
500
+ s->vdisk_guid = NULL;
2677
+ warnings.warn(
501
+ }
2678
+ 'The print_version method is deprecated -- the "version" '
502
+
2679
+ 'argument to ArgumentParser is no longer supported.',
503
+ return ret;
2680
+ DeprecationWarning)
504
+}
2681
+ self._print_message(self.format_version(), file)
505
+
2682
+
506
+static const AIOCBInfo vxhs_aiocb_info = {
2683
+ def _print_message(self, message, file=None):
507
+ .aiocb_size = sizeof(VXHSAIOCB)
2684
+ if message:
508
+};
2685
+ if file is None:
509
+
2686
+ file = _sys.stderr
510
+/*
2687
+ file.write(message)
511
+ * This allocates QEMU-VXHS callback for each IO
2688
+
512
+ * and is passed to QNIO. When QNIO completes the work,
2689
+ # ===============
513
+ * it will be passed back through the callback.
2690
+ # Exiting methods
514
+ */
2691
+ # ===============
515
+static BlockAIOCB *vxhs_aio_rw(BlockDriverState *bs, int64_t sector_num,
2692
+ def exit(self, status=0, message=None):
516
+ QEMUIOVector *qiov, int nb_sectors,
2693
+ if message:
517
+ BlockCompletionFunc *cb, void *opaque,
2694
+ self._print_message(message, _sys.stderr)
518
+ VDISKAIOCmd iodir)
2695
+ _sys.exit(status)
519
+{
2696
+
520
+ VXHSAIOCB *acb = NULL;
2697
+ def error(self, message):
521
+ BDRVVXHSState *s = bs->opaque;
2698
+ """error(message: string)
522
+ size_t size;
2699
+
523
+ uint64_t offset;
2700
+ Prints a usage message incorporating the message to stderr and
524
+ int iio_flags = 0;
2701
+ exits.
525
+ int ret = 0;
2702
+
526
+ void *dev_handle = s->vdisk_hostinfo.dev_handle;
2703
+ If you override this in a subclass, it should not return -- it
527
+
2704
+ should either exit or raise an exception.
528
+ offset = sector_num * BDRV_SECTOR_SIZE;
2705
+ """
529
+ size = nb_sectors * BDRV_SECTOR_SIZE;
2706
+ self.print_usage(_sys.stderr)
530
+ acb = qemu_aio_get(&vxhs_aiocb_info, bs, cb, opaque);
2707
+ self.exit(2, _('%s: error: %s\n') % (self.prog, message))
531
+
532
+ /*
533
+ * Initialize VXHSAIOCB.
534
+ */
535
+ acb->err = 0;
536
+
537
+ iio_flags = IIO_FLAG_ASYNC;
538
+
539
+ switch (iodir) {
540
+ case VDISK_AIO_WRITE:
541
+ ret = iio_writev(dev_handle, acb, qiov->iov, qiov->niov,
542
+ offset, (uint64_t)size, iio_flags);
543
+ break;
544
+ case VDISK_AIO_READ:
545
+ ret = iio_readv(dev_handle, acb, qiov->iov, qiov->niov,
546
+ offset, (uint64_t)size, iio_flags);
547
+ break;
548
+ default:
549
+ trace_vxhs_aio_rw_invalid(iodir);
550
+ goto errout;
551
+ }
552
+
553
+ if (ret != 0) {
554
+ trace_vxhs_aio_rw_ioerr(s->vdisk_guid, iodir, size, offset,
555
+ acb, ret, errno);
556
+ goto errout;
557
+ }
558
+ return &acb->common;
559
+
560
+errout:
561
+ qemu_aio_unref(acb);
562
+ return NULL;
563
+}
564
+
565
+static BlockAIOCB *vxhs_aio_readv(BlockDriverState *bs,
566
+ int64_t sector_num, QEMUIOVector *qiov,
567
+ int nb_sectors,
568
+ BlockCompletionFunc *cb, void *opaque)
569
+{
570
+ return vxhs_aio_rw(bs, sector_num, qiov, nb_sectors, cb,
571
+ opaque, VDISK_AIO_READ);
572
+}
573
+
574
+static BlockAIOCB *vxhs_aio_writev(BlockDriverState *bs,
575
+ int64_t sector_num, QEMUIOVector *qiov,
576
+ int nb_sectors,
577
+ BlockCompletionFunc *cb, void *opaque)
578
+{
579
+ return vxhs_aio_rw(bs, sector_num, qiov, nb_sectors,
580
+ cb, opaque, VDISK_AIO_WRITE);
581
+}
582
+
583
+static void vxhs_close(BlockDriverState *bs)
584
+{
585
+ BDRVVXHSState *s = bs->opaque;
586
+
587
+ trace_vxhs_close(s->vdisk_guid);
588
+
589
+ g_free(s->vdisk_guid);
590
+ s->vdisk_guid = NULL;
591
+
592
+ /*
593
+ * Close vDisk device
594
+ */
595
+ if (s->vdisk_hostinfo.dev_handle) {
596
+ iio_close(s->vdisk_hostinfo.dev_handle);
597
+ s->vdisk_hostinfo.dev_handle = NULL;
598
+ }
599
+
600
+ vxhs_unref();
601
+
602
+ /*
603
+ * Free the dynamically allocated host string etc
604
+ */
605
+ g_free(s->vdisk_hostinfo.host);
606
+ g_free(s->tlscredsid);
607
+ s->tlscredsid = NULL;
608
+ s->vdisk_hostinfo.host = NULL;
609
+ s->vdisk_hostinfo.port = 0;
610
+}
611
+
612
+static int64_t vxhs_get_vdisk_stat(BDRVVXHSState *s)
613
+{
614
+ int64_t vdisk_size = -1;
615
+ int ret = 0;
616
+ void *dev_handle = s->vdisk_hostinfo.dev_handle;
617
+
618
+ ret = iio_ioctl(dev_handle, IOR_VDISK_STAT, &vdisk_size, 0);
619
+ if (ret < 0) {
620
+ trace_vxhs_get_vdisk_stat_err(s->vdisk_guid, ret, errno);
621
+ return -EIO;
622
+ }
623
+
624
+ trace_vxhs_get_vdisk_stat(s->vdisk_guid, vdisk_size);
625
+ return vdisk_size;
626
+}
627
+
628
+/*
629
+ * Returns the size of vDisk in bytes. This is required
630
+ * by QEMU block upper block layer so that it is visible
631
+ * to guest.
632
+ */
633
+static int64_t vxhs_getlength(BlockDriverState *bs)
634
+{
635
+ BDRVVXHSState *s = bs->opaque;
636
+ int64_t vdisk_size;
637
+
638
+ vdisk_size = vxhs_get_vdisk_stat(s);
639
+ if (vdisk_size < 0) {
640
+ return -EIO;
641
+ }
642
+
643
+ return vdisk_size;
644
+}
645
+
646
+static BlockDriver bdrv_vxhs = {
647
+ .format_name = "vxhs",
648
+ .protocol_name = "vxhs",
649
+ .instance_size = sizeof(BDRVVXHSState),
650
+ .bdrv_file_open = vxhs_open,
651
+ .bdrv_parse_filename = vxhs_parse_filename,
652
+ .bdrv_close = vxhs_close,
653
+ .bdrv_getlength = vxhs_getlength,
654
+ .bdrv_aio_readv = vxhs_aio_readv,
655
+ .bdrv_aio_writev = vxhs_aio_writev,
656
+};
657
+
658
+static void bdrv_vxhs_init(void)
659
+{
660
+ bdrv_register(&bdrv_vxhs);
661
+}
662
+
663
+block_init(bdrv_vxhs_init);
664
diff --git a/configure b/configure
665
index XXXXXXX..XXXXXXX 100755
666
--- a/configure
667
+++ b/configure
668
@@ -XXX,XX +XXX,XX @@ numa=""
669
tcmalloc="no"
670
jemalloc="no"
671
replication="yes"
672
+vxhs=""
673
674
supported_cpu="no"
675
supported_os="no"
676
@@ -XXX,XX +XXX,XX @@ for opt do
677
;;
678
--enable-replication) replication="yes"
679
;;
680
+ --disable-vxhs) vxhs="no"
681
+ ;;
682
+ --enable-vxhs) vxhs="yes"
683
+ ;;
684
*)
685
echo "ERROR: unknown option $opt"
686
echo "Try '$0 --help' for more information"
687
@@ -XXX,XX +XXX,XX @@ disabled with --disable-FEATURE, default is enabled if available:
688
xfsctl xfsctl support
689
qom-cast-debug cast debugging support
690
tools build qemu-io, qemu-nbd and qemu-image tools
691
+ vxhs Veritas HyperScale vDisk backend support
692
693
NOTE: The object files are built at the place where configure is launched
694
EOF
695
@@ -XXX,XX +XXX,XX @@ if compile_prog "" "" ; then
696
fi
697
698
##########################################
699
+# Veritas HyperScale block driver VxHS
700
+# Check if libvxhs is installed
701
+
702
+if test "$vxhs" != "no" ; then
703
+ cat > $TMPC <<EOF
704
+#include <stdint.h>
705
+#include <qnio/qnio_api.h>
706
+
707
+void *vxhs_callback;
708
+
709
+int main(void) {
710
+ iio_init(QNIO_VERSION, vxhs_callback);
711
+ return 0;
712
+}
713
+EOF
714
+ vxhs_libs="-lvxhs -lssl"
715
+ if compile_prog "" "$vxhs_libs" ; then
716
+ vxhs=yes
717
+ else
718
+ if test "$vxhs" = "yes" ; then
719
+ feature_not_found "vxhs block device" "Install libvxhs See github"
720
+ fi
721
+ vxhs=no
722
+ fi
723
+fi
724
+
725
+##########################################
726
# End of CC checks
727
# After here, no more $cc or $ld runs
728
729
@@ -XXX,XX +XXX,XX @@ echo "tcmalloc support $tcmalloc"
730
echo "jemalloc support $jemalloc"
731
echo "avx2 optimization $avx2_opt"
732
echo "replication support $replication"
733
+echo "VxHS block device $vxhs"
734
735
if test "$sdl_too_old" = "yes"; then
736
echo "-> Your SDL version is too old - please upgrade to have SDL support"
737
@@ -XXX,XX +XXX,XX @@ if test "$pthread_setname_np" = "yes" ; then
738
echo "CONFIG_PTHREAD_SETNAME_NP=y" >> $config_host_mak
739
fi
740
741
+if test "$vxhs" = "yes" ; then
742
+ echo "CONFIG_VXHS=y" >> $config_host_mak
743
+ echo "VXHS_LIBS=$vxhs_libs" >> $config_host_mak
744
+fi
745
+
746
if test "$tcg_interpreter" = "yes"; then
747
QEMU_INCLUDES="-I\$(SRC_PATH)/tcg/tci $QEMU_INCLUDES"
748
elif test "$ARCH" = "sparc64" ; then
749
diff --git a/qapi/block-core.json b/qapi/block-core.json
750
index XXXXXXX..XXXXXXX 100644
751
--- a/qapi/block-core.json
752
+++ b/qapi/block-core.json
753
@@ -XXX,XX +XXX,XX @@
754
#
755
# Drivers that are supported in block device operations.
756
#
757
+# @vxhs: Since 2.10
758
+#
759
# Since: 2.9
760
##
761
{ 'enum': 'BlockdevDriver',
762
@@ -XXX,XX +XXX,XX @@
763
'host_device', 'http', 'https', 'iscsi', 'luks', 'nbd', 'nfs',
764
'null-aio', 'null-co', 'parallels', 'qcow', 'qcow2', 'qed',
765
'quorum', 'raw', 'rbd', 'replication', 'sheepdog', 'ssh',
766
- 'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat' ] }
767
+ 'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat', 'vxhs' ] }
768
769
##
770
# @BlockdevOptionsFile:
771
@@ -XXX,XX +XXX,XX @@
772
'data': { '*offset': 'int', '*size': 'int' } }
773
774
##
775
+# @BlockdevOptionsVxHS:
776
+#
777
+# Driver specific block device options for VxHS
778
+#
779
+# @vdisk-id: UUID of VxHS volume
780
+# @server: vxhs server IP, port
781
+# @tls-creds: TLS credentials ID
782
+#
783
+# Since: 2.10
784
+##
785
+{ 'struct': 'BlockdevOptionsVxHS',
786
+ 'data': { 'vdisk-id': 'str',
787
+ 'server': 'InetSocketAddressBase',
788
+ '*tls-creds': 'str' } }
789
+
790
+##
791
# @BlockdevOptions:
792
#
793
# Options for creating a block device. Many options are available for all
794
@@ -XXX,XX +XXX,XX @@
795
'vhdx': 'BlockdevOptionsGenericFormat',
796
'vmdk': 'BlockdevOptionsGenericCOWFormat',
797
'vpc': 'BlockdevOptionsGenericFormat',
798
- 'vvfat': 'BlockdevOptionsVVFAT'
799
+ 'vvfat': 'BlockdevOptionsVVFAT',
800
+ 'vxhs': 'BlockdevOptionsVxHS'
801
} }
802
803
##
804
--
2708
--
805
2.9.3
2709
2.13.5
806
2710
807
2711
diff view generated by jsdifflib
1
Move bdrv_is_read_only() up with its friends.
1
Add the scripts/ directory to sys.path so Python 2.6 will be able to
2
import argparse.
2
3
3
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
4
Cc: Fam Zheng <famz@redhat.com>
4
Reviewed-by: John Snow <jsnow@redhat.com>
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
5
Signed-off-by: Jeff Cody <jcody@redhat.com>
6
Acked-by: John Snow <jsnow@redhat.com>
6
Message-id: 73b2399459760c32506f9407efb9dddb3a2789de.1491597120.git.jcody@redhat.com
7
Acked-by: Fam Zheng <famz@redhat.com>
8
Message-id: 20170825155732.15665-3-stefanha@redhat.com
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
7
---
10
---
8
block.c | 10 +++++-----
11
tests/docker/docker.py | 4 +++-
9
1 file changed, 5 insertions(+), 5 deletions(-)
12
1 file changed, 3 insertions(+), 1 deletion(-)
10
13
11
diff --git a/block.c b/block.c
14
diff --git a/tests/docker/docker.py b/tests/docker/docker.py
12
index XXXXXXX..XXXXXXX 100644
15
index XXXXXXX..XXXXXXX 100755
13
--- a/block.c
16
--- a/tests/docker/docker.py
14
+++ b/block.c
17
+++ b/tests/docker/docker.py
15
@@ -XXX,XX +XXX,XX @@ void path_combine(char *dest, int dest_size,
18
@@ -XXX,XX +XXX,XX @@
16
}
19
17
}
20
import os
18
21
import sys
19
+bool bdrv_is_read_only(BlockDriverState *bs)
22
+sys.path.append(os.path.join(os.path.dirname(__file__),
20
+{
23
+ '..', '..', 'scripts'))
21
+ return bs->read_only;
24
+import argparse
22
+}
25
import subprocess
23
+
26
import json
24
int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
27
import hashlib
25
{
28
import atexit
26
/* Do not set read_only if copy_on_read is enabled */
29
import uuid
27
@@ -XXX,XX +XXX,XX @@ void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
30
-import argparse
28
*nb_sectors_ptr = nb_sectors < 0 ? 0 : nb_sectors;
31
import tempfile
29
}
32
import re
30
33
import signal
31
-bool bdrv_is_read_only(BlockDriverState *bs)
32
-{
33
- return bs->read_only;
34
-}
35
-
36
bool bdrv_is_sg(BlockDriverState *bs)
37
{
38
return bs->sg;
39
--
34
--
40
2.9.3
35
2.13.5
41
36
42
37
diff view generated by jsdifflib
1
The protocol VXHS does not support image creation. Some tests expect
1
Add the scripts/ directory to sys.path so Python 2.6 will be able to
2
to be able to create images through the protocol. Exclude VXHS from
2
import argparse.
3
these tests.
4
3
5
Signed-off-by: Jeff Cody <jcody@redhat.com>
4
Cc: Daniel P. Berrange <berrange@redhat.com>
5
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
6
Acked-by: John Snow <jsnow@redhat.com>
7
Acked-by: Fam Zheng <famz@redhat.com>
8
Message-id: 20170825155732.15665-4-stefanha@redhat.com
9
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
6
---
10
---
7
tests/qemu-iotests/017 | 1 +
11
tests/migration/guestperf/shell.py | 8 +++++---
8
tests/qemu-iotests/020 | 1 +
12
1 file changed, 5 insertions(+), 3 deletions(-)
9
tests/qemu-iotests/029 | 1 +
10
tests/qemu-iotests/073 | 1 +
11
tests/qemu-iotests/114 | 1 +
12
tests/qemu-iotests/130 | 1 +
13
tests/qemu-iotests/134 | 1 +
14
tests/qemu-iotests/156 | 1 +
15
tests/qemu-iotests/158 | 1 +
16
9 files changed, 9 insertions(+)
17
13
18
diff --git a/tests/qemu-iotests/017 b/tests/qemu-iotests/017
14
diff --git a/tests/migration/guestperf/shell.py b/tests/migration/guestperf/shell.py
19
index XXXXXXX..XXXXXXX 100755
15
index XXXXXXX..XXXXXXX 100644
20
--- a/tests/qemu-iotests/017
16
--- a/tests/migration/guestperf/shell.py
21
+++ b/tests/qemu-iotests/017
17
+++ b/tests/migration/guestperf/shell.py
22
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
18
@@ -XXX,XX +XXX,XX @@
23
# Any format supporting backing files
19
#
24
_supported_fmt qcow qcow2 vmdk qed
20
25
_supported_proto generic
21
26
+_unsupported_proto vxhs
22
-import argparse
27
_supported_os Linux
23
-import fnmatch
28
_unsupported_imgopts "subformat=monolithicFlat" "subformat=twoGbMaxExtentFlat"
24
import os
29
25
import os.path
30
diff --git a/tests/qemu-iotests/020 b/tests/qemu-iotests/020
26
-import platform
31
index XXXXXXX..XXXXXXX 100755
27
import sys
32
--- a/tests/qemu-iotests/020
28
+sys.path.append(os.path.join(os.path.dirname(__file__),
33
+++ b/tests/qemu-iotests/020
29
+ '..', '..', '..', 'scripts'))
34
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
30
+import argparse
35
# Any format supporting backing files
31
+import fnmatch
36
_supported_fmt qcow qcow2 vmdk qed
32
+import platform
37
_supported_proto generic
33
38
+_unsupported_proto vxhs
34
from guestperf.hardware import Hardware
39
_supported_os Linux
35
from guestperf.engine import Engine
40
_unsupported_imgopts "subformat=monolithicFlat" \
41
"subformat=twoGbMaxExtentFlat" \
42
diff --git a/tests/qemu-iotests/029 b/tests/qemu-iotests/029
43
index XXXXXXX..XXXXXXX 100755
44
--- a/tests/qemu-iotests/029
45
+++ b/tests/qemu-iotests/029
46
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
47
# Any format supporting intenal snapshots
48
_supported_fmt qcow2
49
_supported_proto generic
50
+_unsupported_proto vxhs
51
_supported_os Linux
52
# Internal snapshots are (currently) impossible with refcount_bits=1
53
_unsupported_imgopts 'refcount_bits=1[^0-9]'
54
diff --git a/tests/qemu-iotests/073 b/tests/qemu-iotests/073
55
index XXXXXXX..XXXXXXX 100755
56
--- a/tests/qemu-iotests/073
57
+++ b/tests/qemu-iotests/073
58
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
59
60
_supported_fmt qcow2
61
_supported_proto generic
62
+_unsupported_proto vxhs
63
_supported_os Linux
64
65
CLUSTER_SIZE=64k
66
diff --git a/tests/qemu-iotests/114 b/tests/qemu-iotests/114
67
index XXXXXXX..XXXXXXX 100755
68
--- a/tests/qemu-iotests/114
69
+++ b/tests/qemu-iotests/114
70
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
71
72
_supported_fmt qcow2
73
_supported_proto generic
74
+_unsupported_proto vxhs
75
_supported_os Linux
76
77
78
diff --git a/tests/qemu-iotests/130 b/tests/qemu-iotests/130
79
index XXXXXXX..XXXXXXX 100755
80
--- a/tests/qemu-iotests/130
81
+++ b/tests/qemu-iotests/130
82
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
83
84
_supported_fmt qcow2
85
_supported_proto generic
86
+_unsupported_proto vxhs
87
_supported_os Linux
88
89
qemu_comm_method="monitor"
90
diff --git a/tests/qemu-iotests/134 b/tests/qemu-iotests/134
91
index XXXXXXX..XXXXXXX 100755
92
--- a/tests/qemu-iotests/134
93
+++ b/tests/qemu-iotests/134
94
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
95
96
_supported_fmt qcow2
97
_supported_proto generic
98
+_unsupported_proto vxhs
99
_supported_os Linux
100
101
102
diff --git a/tests/qemu-iotests/156 b/tests/qemu-iotests/156
103
index XXXXXXX..XXXXXXX 100755
104
--- a/tests/qemu-iotests/156
105
+++ b/tests/qemu-iotests/156
106
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
107
108
_supported_fmt qcow2 qed
109
_supported_proto generic
110
+_unsupported_proto vxhs
111
_supported_os Linux
112
113
# Create source disk
114
diff --git a/tests/qemu-iotests/158 b/tests/qemu-iotests/158
115
index XXXXXXX..XXXXXXX 100755
116
--- a/tests/qemu-iotests/158
117
+++ b/tests/qemu-iotests/158
118
@@ -XXX,XX +XXX,XX @@ trap "_cleanup; exit \$status" 0 1 2 3 15
119
120
_supported_fmt qcow2
121
_supported_proto generic
122
+_unsupported_proto vxhs
123
_supported_os Linux
124
125
126
--
36
--
127
2.9.3
37
2.13.5
128
38
129
39
diff view generated by jsdifflib
1
From: Ashish Mittal <ashmit602@gmail.com>
1
From: Fred Rolland <rollandf@gmail.com>
2
2
3
These changes use a vxhs test server that is a part of the following
3
Update doc with the usage of UUID for initiator name.
4
repository:
5
https://github.com/VeritasHyperScale/libqnio.git
6
4
7
Signed-off-by: Ashish Mittal <Ashish.Mittal@veritas.com>
5
Related-To: https://bugzilla.redhat.com/1006468
8
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
6
Signed-off-by: Fred Rolland <frolland@redhat.com>
9
Reviewed-by: Jeff Cody <jcody@redhat.com>
7
Message-id: 20170823084830.30500-1-frolland@redhat.com
10
Signed-off-by: Jeff Cody <jcody@redhat.com>
8
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
11
Message-id: 1491277689-24949-3-git-send-email-Ashish.Mittal@veritas.com
12
---
9
---
13
tests/qemu-iotests/common | 6 ++++++
10
qemu-doc.texi | 5 +++--
14
tests/qemu-iotests/common.config | 13 +++++++++++++
11
1 file changed, 3 insertions(+), 2 deletions(-)
15
tests/qemu-iotests/common.filter | 1 +
16
tests/qemu-iotests/common.rc | 19 +++++++++++++++++++
17
4 files changed, 39 insertions(+)
18
12
19
diff --git a/tests/qemu-iotests/common b/tests/qemu-iotests/common
13
diff --git a/qemu-doc.texi b/qemu-doc.texi
20
index XXXXXXX..XXXXXXX 100644
14
index XXXXXXX..XXXXXXX 100644
21
--- a/tests/qemu-iotests/common
15
--- a/qemu-doc.texi
22
+++ b/tests/qemu-iotests/common
16
+++ b/qemu-doc.texi
23
@@ -XXX,XX +XXX,XX @@ check options
17
@@ -XXX,XX +XXX,XX @@ in a configuration file provided via '-readconfig' or directly on the
24
-ssh test ssh
18
command line.
25
-nfs test nfs
19
26
-luks test luks
20
If the initiator-name is not specified qemu will use a default name
27
+ -vxhs test vxhs
21
-of 'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
28
-xdiff graphical mode diff
22
+of 'iqn.2008-11.org.linux-kvm[:<uuid>'] where <uuid> is the UUID of the
29
-nocache use O_DIRECT on backing file
23
+virtual machine. If the UUID is not specified qemu will use
30
-misalign misalign memory allocations
24
+'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
31
@@ -XXX,XX +XXX,XX @@ testlist options
25
virtual machine.
32
xpand=false
26
33
;;
27
-
34
28
@example
35
+ -vxhs)
29
Setting a specific initiator name to use when logging in to the target
36
+ IMGPROTO=vxhs
30
-iscsi initiator-name=iqn.qemu.test:my-initiator
37
+ xpand=false
38
+ ;;
39
+
40
-ssh)
41
IMGPROTO=ssh
42
xpand=false
43
diff --git a/tests/qemu-iotests/common.config b/tests/qemu-iotests/common.config
44
index XXXXXXX..XXXXXXX 100644
45
--- a/tests/qemu-iotests/common.config
46
+++ b/tests/qemu-iotests/common.config
47
@@ -XXX,XX +XXX,XX @@ if [ -z "$QEMU_NBD_PROG" ]; then
48
export QEMU_NBD_PROG="`set_prog_path qemu-nbd`"
49
fi
50
51
+if [ -z "$QEMU_VXHS_PROG" ]; then
52
+ export QEMU_VXHS_PROG="`set_prog_path qnio_server`"
53
+fi
54
+
55
_qemu_wrapper()
56
{
57
(
58
@@ -XXX,XX +XXX,XX @@ _qemu_nbd_wrapper()
59
)
60
}
61
62
+_qemu_vxhs_wrapper()
63
+{
64
+ (
65
+ echo $BASHPID > "${TEST_DIR}/qemu-vxhs.pid"
66
+ exec "$QEMU_VXHS_PROG" $QEMU_VXHS_OPTIONS "$@"
67
+ )
68
+}
69
+
70
export QEMU=_qemu_wrapper
71
export QEMU_IMG=_qemu_img_wrapper
72
export QEMU_IO=_qemu_io_wrapper
73
export QEMU_NBD=_qemu_nbd_wrapper
74
+export QEMU_VXHS=_qemu_vxhs_wrapper
75
76
QEMU_IMG_EXTRA_ARGS=
77
if [ "$IMGOPTSSYNTAX" = "true" ]; then
78
diff --git a/tests/qemu-iotests/common.filter b/tests/qemu-iotests/common.filter
79
index XXXXXXX..XXXXXXX 100644
80
--- a/tests/qemu-iotests/common.filter
81
+++ b/tests/qemu-iotests/common.filter
82
@@ -XXX,XX +XXX,XX @@ _filter_img_info()
83
-e "s#$TEST_DIR#TEST_DIR#g" \
84
-e "s#$IMGFMT#IMGFMT#g" \
85
-e 's#nbd://127.0.0.1:10810$#TEST_DIR/t.IMGFMT#g' \
86
+ -e 's#json.*vdisk-id.*vxhs"}}#TEST_DIR/t.IMGFMT#' \
87
-e "/encrypted: yes/d" \
88
-e "/cluster_size: [0-9]\\+/d" \
89
-e "/table_size: [0-9]\\+/d" \
90
diff --git a/tests/qemu-iotests/common.rc b/tests/qemu-iotests/common.rc
91
index XXXXXXX..XXXXXXX 100644
92
--- a/tests/qemu-iotests/common.rc
93
+++ b/tests/qemu-iotests/common.rc
94
@@ -XXX,XX +XXX,XX @@ else
95
elif [ "$IMGPROTO" = "nfs" ]; then
96
TEST_DIR="nfs://127.0.0.1/$TEST_DIR"
97
TEST_IMG=$TEST_DIR/t.$IMGFMT
98
+ elif [ "$IMGPROTO" = "vxhs" ]; then
99
+ TEST_IMG_FILE=$TEST_DIR/t.$IMGFMT
100
+ TEST_IMG="vxhs://127.0.0.1:9999/t.$IMGFMT"
101
else
102
TEST_IMG=$IMGPROTO:$TEST_DIR/t.$IMGFMT
103
fi
104
@@ -XXX,XX +XXX,XX @@ _make_test_img()
105
eval "$QEMU_NBD -v -t -b 127.0.0.1 -p 10810 -f $IMGFMT $TEST_IMG_FILE >/dev/null &"
106
sleep 1 # FIXME: qemu-nbd needs to be listening before we continue
107
fi
108
+
109
+ # Start QNIO server on image directory for vxhs protocol
110
+ if [ $IMGPROTO = "vxhs" ]; then
111
+ eval "$QEMU_VXHS -d $TEST_DIR > /dev/null &"
112
+ sleep 1 # Wait for server to come up.
113
+ fi
114
}
115
116
_rm_test_img()
117
@@ -XXX,XX +XXX,XX @@ _cleanup_test_img()
118
fi
119
rm -f "$TEST_IMG_FILE"
120
;;
121
+ vxhs)
122
+ if [ -f "${TEST_DIR}/qemu-vxhs.pid" ]; then
123
+ local QEMU_VXHS_PID
124
+ read QEMU_VXHS_PID < "${TEST_DIR}/qemu-vxhs.pid"
125
+ kill ${QEMU_VXHS_PID} >/dev/null 2>&1
126
+ rm -f "${TEST_DIR}/qemu-vxhs.pid"
127
+ fi
128
+ rm -f "$TEST_IMG_FILE"
129
+ ;;
130
+
131
file)
132
_rm_test_img "$TEST_DIR/t.$IMGFMT"
133
_rm_test_img "$TEST_DIR/t.$IMGFMT.orig"
134
--
31
--
135
2.9.3
32
2.13.5
136
33
137
34
diff view generated by jsdifflib
1
The BDRV_O_ALLOW_RDWR flag allows / prohibits the changing of
1
Most qcow2 files are uncompressed so it is wasteful to allocate (32 + 1)
2
the BDS 'read_only' state, but there are a few places where it
2
* cluster_size + 512 bytes upfront. Allocate s->cluster_cache and
3
is ignored. In the bdrv_set_read_only() helper, make sure to
3
s->cluster_data when the first read operation is performance on a
4
honor the flag.
4
compressed cluster.
5
5
6
Signed-off-by: Jeff Cody <jcody@redhat.com>
6
The buffers are freed in .bdrv_close(). .bdrv_open() no longer has any
7
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
7
code paths that can allocate these buffers, so remove the free functions
8
Reviewed-by: John Snow <jsnow@redhat.com>
8
in the error code path.
9
Message-id: be2e5fb2d285cbece2b6d06bed54a6f56520d251.1491597120.git.jcody@redhat.com
9
10
This patch can result in significant memory savings when many qcow2
11
disks are attached or backing file chains are long:
12
13
Before 12.81% (1,023,193,088B)
14
After 5.36% (393,893,888B)
15
16
Reported-by: Alexey Kardashevskiy <aik@ozlabs.ru>
17
Tested-by: Alexey Kardashevskiy <aik@ozlabs.ru>
18
Reviewed-by: Eric Blake <eblake@redhat.com>
19
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
20
Message-id: 20170821135530.32344-1-stefanha@redhat.com
21
Cc: Kevin Wolf <kwolf@redhat.com>
22
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
10
---
23
---
11
block.c | 7 +++++++
24
block/qcow2-cluster.c | 17 +++++++++++++++++
12
1 file changed, 7 insertions(+)
25
block/qcow2.c | 12 ------------
26
2 files changed, 17 insertions(+), 12 deletions(-)
13
27
14
diff --git a/block.c b/block.c
28
diff --git a/block/qcow2-cluster.c b/block/qcow2-cluster.c
15
index XXXXXXX..XXXXXXX 100644
29
index XXXXXXX..XXXXXXX 100644
16
--- a/block.c
30
--- a/block/qcow2-cluster.c
17
+++ b/block.c
31
+++ b/block/qcow2-cluster.c
18
@@ -XXX,XX +XXX,XX @@ int bdrv_set_read_only(BlockDriverState *bs, bool read_only, Error **errp)
32
@@ -XXX,XX +XXX,XX @@ int qcow2_decompress_cluster(BlockDriverState *bs, uint64_t cluster_offset)
19
return -EINVAL;
33
nb_csectors = ((cluster_offset >> s->csize_shift) & s->csize_mask) + 1;
34
sector_offset = coffset & 511;
35
csize = nb_csectors * 512 - sector_offset;
36
+
37
+ /* Allocate buffers on first decompress operation, most images are
38
+ * uncompressed and the memory overhead can be avoided. The buffers
39
+ * are freed in .bdrv_close().
40
+ */
41
+ if (!s->cluster_data) {
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
+
53
BLKDBG_EVENT(bs->file, BLKDBG_READ_COMPRESSED);
54
ret = bdrv_read(bs->file, coffset >> 9, s->cluster_data,
55
nb_csectors);
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;
20
}
62
}
21
63
22
+ /* Do not clear read_only if it is prohibited */
64
- s->cluster_cache = g_malloc(s->cluster_size);
23
+ if (!read_only && !(bs->open_flags & BDRV_O_ALLOW_RDWR)) {
65
- /* one more sector for decompressed data alignment */
24
+ error_setg(errp, "Node '%s' is read only",
66
- s->cluster_data = qemu_try_blockalign(bs->file->bs, QCOW_MAX_CRYPT_CLUSTERS
25
+ bdrv_get_device_or_node_name(bs));
67
- * s->cluster_size + 512);
26
+ return -EPERM;
68
- if (s->cluster_data == NULL) {
27
+ }
69
- error_setg(errp, "Could not allocate temporary cluster buffer");
28
+
70
- ret = -ENOMEM;
29
bs->read_only = read_only;
71
- goto fail;
30
return 0;
72
- }
31
}
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;
32
--
86
--
33
2.9.3
87
2.13.5
34
88
35
89
diff view generated by jsdifflib