* [Qemu-devel] [PULL 1/3] tests: refactor file monitor test to make it more understandable
2019-04-02 12:54 [Qemu-devel] [PULL 0/3] Filemon next patches Daniel P. Berrangé
@ 2019-04-02 12:54 ` Daniel P. Berrangé
2019-04-02 12:54 ` [Qemu-devel] [PULL 2/3] filemon: ensure watch IDs are unique to QFileMonitor scope Daniel P. Berrangé
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Daniel P. Berrangé @ 2019-04-02 12:54 UTC (permalink / raw)
To: qemu-devel
Cc: Gerd Hoffmann, Daniel P. Berrangé, Bandan Das,
Marc-André Lureau
The current file monitor unit tests are too clever for their own good
making it hard to understand the desired output.
Instead of trying to infer the expected events, explicitly list the
events we expect in the operation sequence.
Instead of dynamically building a matrix of tests, just have one giant
operation sequence that validates all scenarios in a single test.
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
tests/test-util-filemonitor.c | 534 +++++++++++++---------------------
1 file changed, 208 insertions(+), 326 deletions(-)
diff --git a/tests/test-util-filemonitor.c b/tests/test-util-filemonitor.c
index 5d95cea5ee..ea3715a8f4 100644
--- a/tests/test-util-filemonitor.c
+++ b/tests/test-util-filemonitor.c
@@ -26,6 +26,9 @@
#include <utime.h>
enum {
+ QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ QFILE_MONITOR_TEST_OP_EVENT,
QFILE_MONITOR_TEST_OP_CREATE,
QFILE_MONITOR_TEST_OP_APPEND,
QFILE_MONITOR_TEST_OP_TRUNC,
@@ -38,20 +41,10 @@ typedef struct {
int type;
const char *filesrc;
const char *filedst;
+ int watchid;
+ int eventid;
} QFileMonitorTestOp;
-typedef struct {
- const char *file;
-} QFileMonitorTestWatch;
-
-typedef struct {
- gsize nwatches;
- const QFileMonitorTestWatch *watches;
-
- gsize nops;
- const QFileMonitorTestOp *ops;
-} QFileMonitorTestPlan;
-
typedef struct {
int id;
QFileMonitorEvent event;
@@ -67,6 +60,7 @@ typedef struct {
static QemuMutex evlock;
static bool evstopping;
static bool evrunning;
+static bool debug;
/*
* Main function for a background thread that is
@@ -200,9 +194,125 @@ qemu_file_monitor_test_expect(QFileMonitorTestData *data,
static void
-test_file_monitor_events(const void *opaque)
+test_file_monitor_events(void)
{
- const QFileMonitorTestPlan *plan = opaque;
+ QFileMonitorTestOp ops[] = {
+ { .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ .filesrc = NULL, .watchid = 0 },
+ { .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ .filesrc = "one.txt", .watchid = 1 },
+ { .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ .filesrc = "two.txt", .watchid = 2 },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_CREATE,
+ .filesrc = "one.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 1,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_CREATE,
+ .filesrc = "two.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 2,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_CREATE,
+ .filesrc = "three.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "three.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_UNLINK,
+ .filesrc = "three.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "three.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_RENAME,
+ .filesrc = "one.txt", .filedst = "two.txt" },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 1,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 2,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_APPEND,
+ .filesrc = "two.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_MODIFIED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 2,
+ .eventid = QFILE_MONITOR_EVENT_MODIFIED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_TOUCH,
+ .filesrc = "two.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_ATTRIBUTES },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 2,
+ .eventid = QFILE_MONITOR_EVENT_ATTRIBUTES },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ .filesrc = "one.txt", .watchid = 1 },
+ { .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ .filesrc = "one.txt", .watchid = 3 },
+ { .type = QFILE_MONITOR_TEST_OP_CREATE,
+ .filesrc = "one.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 3,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ .filesrc = "one.txt", .watchid = 3 },
+ { .type = QFILE_MONITOR_TEST_OP_UNLINK,
+ .filesrc = "one.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_UNLINK,
+ .filesrc = "two.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 2,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ .filesrc = "two.txt", .watchid = 2 },
+ { .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ .filesrc = NULL, .watchid = 0 },
+ };
Error *local_err = NULL;
GError *gerr = NULL;
QFileMonitor *mon = qemu_file_monitor_new(&local_err);
@@ -210,7 +320,7 @@ test_file_monitor_events(const void *opaque)
GTimer *timer;
gchar *dir = NULL;
int err = -1;
- gsize i, j;
+ gsize i;
char *pathsrc = NULL;
char *pathdst = NULL;
QFileMonitorTestData data;
@@ -248,33 +358,13 @@ test_file_monitor_events(const void *opaque)
}
/*
- * First register all the directory / file watches
- * we're interested in seeing events against
+ * Run through the operation sequence validating events
+ * as we go
*/
- for (i = 0; i < plan->nwatches; i++) {
- int watchid;
- watchid = qemu_file_monitor_add_watch(mon,
- dir,
- plan->watches[i].file,
- qemu_file_monitor_test_handler,
- &data,
- &local_err);
- if (watchid < 0) {
- g_printerr("Unable to add watch %s",
- error_get_pretty(local_err));
- goto cleanup;
- }
- }
-
-
- /*
- * Now invoke all the file operations (create,
- * delete, rename, chmod, etc). These operations
- * will trigger the various file monitor events
- */
- for (i = 0; i < plan->nops; i++) {
- const QFileMonitorTestOp *op = &(plan->ops[i]);
+ for (i = 0; i < G_N_ELEMENTS(ops); i++) {
+ const QFileMonitorTestOp *op = &(ops[i]);
int fd;
+ int watchid;
struct utimbuf ubuf;
pathsrc = g_strdup_printf("%s/%s", dir, op->filesrc);
@@ -283,7 +373,50 @@ test_file_monitor_events(const void *opaque)
}
switch (op->type) {
+ case QFILE_MONITOR_TEST_OP_ADD_WATCH:
+ if (debug) {
+ g_printerr("Add watch %s %s %d\n",
+ dir, op->filesrc, op->watchid);
+ }
+ watchid =
+ qemu_file_monitor_add_watch(mon,
+ dir,
+ op->filesrc,
+ qemu_file_monitor_test_handler,
+ &data,
+ &local_err);
+ if (watchid < 0) {
+ g_printerr("Unable to add watch %s",
+ error_get_pretty(local_err));
+ goto cleanup;
+ }
+ if (watchid != op->watchid) {
+ g_printerr("Unexpected watch ID %d, wanted %d\n",
+ watchid, op->watchid);
+ goto cleanup;
+ }
+ break;
+ case QFILE_MONITOR_TEST_OP_DEL_WATCH:
+ if (debug) {
+ g_printerr("Del watch %s %d\n", dir, op->watchid);
+ }
+ qemu_file_monitor_remove_watch(mon,
+ dir,
+ op->watchid);
+ break;
+ case QFILE_MONITOR_TEST_OP_EVENT:
+ if (debug) {
+ g_printerr("Event id=%d event=%d file=%s\n",
+ op->watchid, op->eventid, op->filesrc);
+ }
+ if (!qemu_file_monitor_test_expect(
+ &data, op->watchid, op->eventid, op->filesrc))
+ goto cleanup;
+ break;
case QFILE_MONITOR_TEST_OP_CREATE:
+ if (debug) {
+ g_printerr("Create %s\n", pathsrc);
+ }
fd = open(pathsrc, O_WRONLY | O_CREAT, 0700);
if (fd < 0) {
g_printerr("Unable to create %s: %s",
@@ -294,6 +427,9 @@ test_file_monitor_events(const void *opaque)
break;
case QFILE_MONITOR_TEST_OP_APPEND:
+ if (debug) {
+ g_printerr("Append %s\n", pathsrc);
+ }
fd = open(pathsrc, O_WRONLY | O_APPEND, 0700);
if (fd < 0) {
g_printerr("Unable to open %s: %s",
@@ -311,6 +447,9 @@ test_file_monitor_events(const void *opaque)
break;
case QFILE_MONITOR_TEST_OP_TRUNC:
+ if (debug) {
+ g_printerr("Truncate %s\n", pathsrc);
+ }
if (truncate(pathsrc, 4) < 0) {
g_printerr("Unable to truncate %s: %s",
pathsrc, strerror(errno));
@@ -319,6 +458,9 @@ test_file_monitor_events(const void *opaque)
break;
case QFILE_MONITOR_TEST_OP_RENAME:
+ if (debug) {
+ g_printerr("Rename %s -> %s\n", pathsrc, pathdst);
+ }
if (rename(pathsrc, pathdst) < 0) {
g_printerr("Unable to rename %s to %s: %s",
pathsrc, pathdst, strerror(errno));
@@ -327,6 +469,9 @@ test_file_monitor_events(const void *opaque)
break;
case QFILE_MONITOR_TEST_OP_UNLINK:
+ if (debug) {
+ g_printerr("Unlink %s\n", pathsrc);
+ }
if (unlink(pathsrc) < 0) {
g_printerr("Unable to unlink %s: %s",
pathsrc, strerror(errno));
@@ -335,6 +480,9 @@ test_file_monitor_events(const void *opaque)
break;
case QFILE_MONITOR_TEST_OP_TOUCH:
+ if (debug) {
+ g_printerr("Touch %s\n", pathsrc);
+ }
ubuf.actime = 1024;
ubuf.modtime = 1025;
if (utime(pathsrc, &ubuf) < 0) {
@@ -353,92 +501,6 @@ test_file_monitor_events(const void *opaque)
pathsrc = pathdst = NULL;
}
-
- /*
- * Finally validate that we have received all the events
- * we expect to see for the combination of watches and
- * file operations
- */
- for (i = 0; i < plan->nops; i++) {
- const QFileMonitorTestOp *op = &(plan->ops[i]);
-
- switch (op->type) {
- case QFILE_MONITOR_TEST_OP_CREATE:
- for (j = 0; j < plan->nwatches; j++) {
- if (plan->watches[j].file &&
- !g_str_equal(plan->watches[j].file, op->filesrc))
- continue;
-
- if (!qemu_file_monitor_test_expect(
- &data, j, QFILE_MONITOR_EVENT_CREATED, op->filesrc))
- goto cleanup;
- }
- break;
-
- case QFILE_MONITOR_TEST_OP_APPEND:
- case QFILE_MONITOR_TEST_OP_TRUNC:
- for (j = 0; j < plan->nwatches; j++) {
- if (plan->watches[j].file &&
- !g_str_equal(plan->watches[j].file, op->filesrc))
- continue;
-
- if (!qemu_file_monitor_test_expect(
- &data, j, QFILE_MONITOR_EVENT_MODIFIED, op->filesrc))
- goto cleanup;
- }
- break;
-
- case QFILE_MONITOR_TEST_OP_RENAME:
- for (j = 0; j < plan->nwatches; j++) {
- if (plan->watches[j].file &&
- !g_str_equal(plan->watches[j].file, op->filesrc))
- continue;
-
- if (!qemu_file_monitor_test_expect(
- &data, j, QFILE_MONITOR_EVENT_DELETED, op->filesrc))
- goto cleanup;
- }
-
- for (j = 0; j < plan->nwatches; j++) {
- if (plan->watches[j].file &&
- !g_str_equal(plan->watches[j].file, op->filedst))
- continue;
-
- if (!qemu_file_monitor_test_expect(
- &data, j, QFILE_MONITOR_EVENT_CREATED, op->filedst))
- goto cleanup;
- }
- break;
-
- case QFILE_MONITOR_TEST_OP_TOUCH:
- for (j = 0; j < plan->nwatches; j++) {
- if (plan->watches[j].file &&
- !g_str_equal(plan->watches[j].file, op->filesrc))
- continue;
-
- if (!qemu_file_monitor_test_expect(
- &data, j, QFILE_MONITOR_EVENT_ATTRIBUTES, op->filesrc))
- goto cleanup;
- }
- break;
-
- case QFILE_MONITOR_TEST_OP_UNLINK:
- for (j = 0; j < plan->nwatches; j++) {
- if (plan->watches[j].file &&
- !g_str_equal(plan->watches[j].file, op->filesrc))
- continue;
-
- if (!qemu_file_monitor_test_expect(
- &data, j, QFILE_MONITOR_EVENT_DELETED, op->filesrc))
- goto cleanup;
- }
- break;
-
- default:
- g_assert_not_reached();
- }
- }
-
err = 0;
cleanup:
@@ -460,171 +522,36 @@ test_file_monitor_events(const void *opaque)
}
g_timer_destroy(timer);
- for (i = 0; i < plan->nops; i++) {
- const QFileMonitorTestOp *op = &(plan->ops[i]);
- pathsrc = g_strdup_printf("%s/%s", dir, op->filesrc);
- unlink(pathsrc);
- g_free(pathsrc);
- if (op->filedst) {
- pathdst = g_strdup_printf("%s/%s", dir, op->filedst);
- unlink(pathdst);
- g_free(pathdst);
- }
- }
-
qemu_file_monitor_free(mon);
g_list_foreach(data.records,
(GFunc)qemu_file_monitor_test_record_free, NULL);
g_list_free(data.records);
qemu_mutex_destroy(&data.lock);
if (dir) {
- rmdir(dir);
+ for (i = 0; i < G_N_ELEMENTS(ops); i++) {
+ const QFileMonitorTestOp *op = &(ops[i]);
+ char *path = g_strdup_printf("%s/%s",
+ dir, op->filesrc);
+ unlink(path);
+ g_free(path);
+ if (op->filedst) {
+ path = g_strdup_printf("%s/%s",
+ dir, op->filedst);
+ unlink(path);
+ g_free(path);
+ }
+ }
+ if (rmdir(dir) < 0) {
+ g_printerr("Failed to remove %s: %s\n",
+ dir, strerror(errno));
+ abort();
+ }
}
g_free(dir);
g_assert(err == 0);
}
-/*
- * Set of structs which define which file name patterns
- * we're trying to watch against. NULL, means all files
- * in the directory
- */
-static const QFileMonitorTestWatch watches_any[] = {
- { NULL },
-};
-
-static const QFileMonitorTestWatch watches_one[] = {
- { "one.txt" },
-};
-
-static const QFileMonitorTestWatch watches_two[] = {
- { "two.txt" },
-};
-
-static const QFileMonitorTestWatch watches_many[] = {
- { NULL },
- { "one.txt" },
- { "two.txt" },
-};
-
-
-/*
- * Various sets of file operations we're going to
- * trigger and validate events for
- */
-static const QFileMonitorTestOp ops_create_one[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", }
-};
-
-static const QFileMonitorTestOp ops_delete_one[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_UNLINK,
- .filesrc = "one.txt", }
-};
-
-static const QFileMonitorTestOp ops_create_many[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "two.txt", },
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "three.txt", }
-};
-
-static const QFileMonitorTestOp ops_rename_one[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_RENAME,
- .filesrc = "one.txt", .filedst = "two.txt" }
-};
-
-static const QFileMonitorTestOp ops_rename_many[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "two.txt", },
- { .type = QFILE_MONITOR_TEST_OP_RENAME,
- .filesrc = "one.txt", .filedst = "two.txt" }
-};
-
-static const QFileMonitorTestOp ops_append_one[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_APPEND,
- .filesrc = "one.txt", },
-};
-
-static const QFileMonitorTestOp ops_trunc_one[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_TRUNC,
- .filesrc = "one.txt", },
-};
-
-static const QFileMonitorTestOp ops_touch_one[] = {
- { .type = QFILE_MONITOR_TEST_OP_CREATE,
- .filesrc = "one.txt", },
- { .type = QFILE_MONITOR_TEST_OP_TOUCH,
- .filesrc = "one.txt", },
-};
-
-
-/*
- * No we define data sets for the combinatorial
- * expansion of file watches and operation sets
- */
-#define PLAN_DATA(o, w) \
- static const QFileMonitorTestPlan plan_ ## o ## _ ## w = { \
- .nops = G_N_ELEMENTS(ops_ ##o), \
- .ops = ops_ ##o, \
- .nwatches = G_N_ELEMENTS(watches_ ##w), \
- .watches = watches_ ## w, \
- }
-
-PLAN_DATA(create_one, any);
-PLAN_DATA(create_one, one);
-PLAN_DATA(create_one, two);
-PLAN_DATA(create_one, many);
-
-PLAN_DATA(delete_one, any);
-PLAN_DATA(delete_one, one);
-PLAN_DATA(delete_one, two);
-PLAN_DATA(delete_one, many);
-
-PLAN_DATA(create_many, any);
-PLAN_DATA(create_many, one);
-PLAN_DATA(create_many, two);
-PLAN_DATA(create_many, many);
-
-PLAN_DATA(rename_one, any);
-PLAN_DATA(rename_one, one);
-PLAN_DATA(rename_one, two);
-PLAN_DATA(rename_one, many);
-
-PLAN_DATA(rename_many, any);
-PLAN_DATA(rename_many, one);
-PLAN_DATA(rename_many, two);
-PLAN_DATA(rename_many, many);
-
-PLAN_DATA(append_one, any);
-PLAN_DATA(append_one, one);
-PLAN_DATA(append_one, two);
-PLAN_DATA(append_one, many);
-
-PLAN_DATA(trunc_one, any);
-PLAN_DATA(trunc_one, one);
-PLAN_DATA(trunc_one, two);
-PLAN_DATA(trunc_one, many);
-
-PLAN_DATA(touch_one, any);
-PLAN_DATA(touch_one, one);
-PLAN_DATA(touch_one, two);
-PLAN_DATA(touch_one, many);
-
-
int main(int argc, char **argv)
{
g_test_init(&argc, &argv, NULL);
@@ -633,53 +560,8 @@ int main(int argc, char **argv)
qemu_mutex_init(&evlock);
- /*
- * Register test cases for the combinatorial
- * expansion of file watches and operation sets
- */
- #define PLAN_REGISTER(o, w) \
- g_test_add_data_func("/util/filemonitor/" # o "/" # w, \
- &plan_ ## o ## _ ## w, test_file_monitor_events)
-
- PLAN_REGISTER(create_one, any);
- PLAN_REGISTER(create_one, one);
- PLAN_REGISTER(create_one, two);
- PLAN_REGISTER(create_one, many);
-
- PLAN_REGISTER(delete_one, any);
- PLAN_REGISTER(delete_one, one);
- PLAN_REGISTER(delete_one, two);
- PLAN_REGISTER(delete_one, many);
-
- PLAN_REGISTER(create_many, any);
- PLAN_REGISTER(create_many, one);
- PLAN_REGISTER(create_many, two);
- PLAN_REGISTER(create_many, many);
-
- PLAN_REGISTER(rename_one, any);
- PLAN_REGISTER(rename_one, one);
- PLAN_REGISTER(rename_one, two);
- PLAN_REGISTER(rename_one, many);
-
- PLAN_REGISTER(rename_many, any);
- PLAN_REGISTER(rename_many, one);
- PLAN_REGISTER(rename_many, two);
- PLAN_REGISTER(rename_many, many);
-
- PLAN_REGISTER(append_one, any);
- PLAN_REGISTER(append_one, one);
- PLAN_REGISTER(append_one, two);
- PLAN_REGISTER(append_one, many);
-
- PLAN_REGISTER(trunc_one, any);
- PLAN_REGISTER(trunc_one, one);
- PLAN_REGISTER(trunc_one, two);
- PLAN_REGISTER(trunc_one, many);
-
- PLAN_REGISTER(touch_one, any);
- PLAN_REGISTER(touch_one, one);
- PLAN_REGISTER(touch_one, two);
- PLAN_REGISTER(touch_one, many);
+ debug = getenv("FILEMONITOR_DEBUG") != NULL;
+ g_test_add_func("/util/filemonitor", test_file_monitor_events);
return g_test_run();
}
--
2.20.1
^ permalink raw reply related [flat|nested] 5+ messages in thread* [Qemu-devel] [PULL 2/3] filemon: ensure watch IDs are unique to QFileMonitor scope
2019-04-02 12:54 [Qemu-devel] [PULL 0/3] Filemon next patches Daniel P. Berrangé
2019-04-02 12:54 ` [Qemu-devel] [PULL 1/3] tests: refactor file monitor test to make it more understandable Daniel P. Berrangé
@ 2019-04-02 12:54 ` Daniel P. Berrangé
2019-04-02 12:54 ` [Qemu-devel] [PULL 3/3] filemon: fix watch IDs to avoid potential wraparound issues Daniel P. Berrangé
2019-04-02 14:31 ` [Qemu-devel] [PULL 0/3] Filemon next patches Peter Maydell
3 siblings, 0 replies; 5+ messages in thread
From: Daniel P. Berrangé @ 2019-04-02 12:54 UTC (permalink / raw)
To: qemu-devel
Cc: Gerd Hoffmann, Daniel P. Berrangé, Bandan Das,
Marc-André Lureau
The watch IDs are mistakenly only unique within the scope of the
directory being monitored. This is not useful for clients which are
monitoring multiple directories. They require watch IDs to be unique
globally within the QFileMonitor scope.
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Tested-by: Bandan Das <bsd@redhat.com>
Reviewed-by: Bandan Das <bsd@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
tests/test-util-filemonitor.c | 116 +++++++++++++++++++++++++++++++---
util/filemonitor-inotify.c | 5 +-
2 files changed, 110 insertions(+), 11 deletions(-)
diff --git a/tests/test-util-filemonitor.c b/tests/test-util-filemonitor.c
index ea3715a8f4..71a7cf5de0 100644
--- a/tests/test-util-filemonitor.c
+++ b/tests/test-util-filemonitor.c
@@ -35,6 +35,8 @@ enum {
QFILE_MONITOR_TEST_OP_RENAME,
QFILE_MONITOR_TEST_OP_TOUCH,
QFILE_MONITOR_TEST_OP_UNLINK,
+ QFILE_MONITOR_TEST_OP_MKDIR,
+ QFILE_MONITOR_TEST_OP_RMDIR,
};
typedef struct {
@@ -298,6 +300,54 @@ test_file_monitor_events(void)
.eventid = QFILE_MONITOR_EVENT_DELETED },
+ { .type = QFILE_MONITOR_TEST_OP_MKDIR,
+ .filesrc = "fish", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "fish", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ .filesrc = "fish/", .watchid = 4 },
+ { .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
+ .filesrc = "fish/one.txt", .watchid = 5 },
+ { .type = QFILE_MONITOR_TEST_OP_CREATE,
+ .filesrc = "fish/one.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 4,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 5,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ .filesrc = "fish/one.txt", .watchid = 5 },
+ { .type = QFILE_MONITOR_TEST_OP_RENAME,
+ .filesrc = "fish/one.txt", .filedst = "two.txt", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "one.txt", .watchid = 4,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "two.txt", .watchid = 2,
+ .eventid = QFILE_MONITOR_EVENT_CREATED },
+
+
+ { .type = QFILE_MONITOR_TEST_OP_RMDIR,
+ .filesrc = "fish", },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "", .watchid = 4,
+ .eventid = QFILE_MONITOR_EVENT_IGNORED },
+ { .type = QFILE_MONITOR_TEST_OP_EVENT,
+ .filesrc = "fish", .watchid = 0,
+ .eventid = QFILE_MONITOR_EVENT_DELETED },
+ { .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
+ .filesrc = "fish", .watchid = 4 },
+
+
{ .type = QFILE_MONITOR_TEST_OP_UNLINK,
.filesrc = "two.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
@@ -366,6 +416,8 @@ test_file_monitor_events(void)
int fd;
int watchid;
struct utimbuf ubuf;
+ char *watchdir;
+ const char *watchfile;
pathsrc = g_strdup_printf("%s/%s", dir, op->filesrc);
if (op->filedst) {
@@ -378,13 +430,26 @@ test_file_monitor_events(void)
g_printerr("Add watch %s %s %d\n",
dir, op->filesrc, op->watchid);
}
+ if (op->filesrc && strchr(op->filesrc, '/')) {
+ watchdir = g_strdup_printf("%s/%s", dir, op->filesrc);
+ watchfile = strrchr(watchdir, '/');
+ *(char *)watchfile = '\0';
+ watchfile++;
+ if (*watchfile == '\0') {
+ watchfile = NULL;
+ }
+ } else {
+ watchdir = g_strdup(dir);
+ watchfile = op->filesrc;
+ }
watchid =
qemu_file_monitor_add_watch(mon,
- dir,
- op->filesrc,
+ watchdir,
+ watchfile,
qemu_file_monitor_test_handler,
&data,
&local_err);
+ g_free(watchdir);
if (watchid < 0) {
g_printerr("Unable to add watch %s",
error_get_pretty(local_err));
@@ -400,9 +465,17 @@ test_file_monitor_events(void)
if (debug) {
g_printerr("Del watch %s %d\n", dir, op->watchid);
}
+ if (op->filesrc && strchr(op->filesrc, '/')) {
+ watchdir = g_strdup_printf("%s/%s", dir, op->filesrc);
+ watchfile = strrchr(watchdir, '/');
+ *(char *)watchfile = '\0';
+ } else {
+ watchdir = g_strdup(dir);
+ }
qemu_file_monitor_remove_watch(mon,
- dir,
+ watchdir,
op->watchid);
+ g_free(watchdir);
break;
case QFILE_MONITOR_TEST_OP_EVENT:
if (debug) {
@@ -492,6 +565,28 @@ test_file_monitor_events(void)
}
break;
+ case QFILE_MONITOR_TEST_OP_MKDIR:
+ if (debug) {
+ g_printerr("Mkdir %s\n", pathsrc);
+ }
+ if (mkdir(pathsrc, 0700) < 0) {
+ g_printerr("Unable to mkdir %s: %s",
+ pathsrc, strerror(errno));
+ goto cleanup;
+ }
+ break;
+
+ case QFILE_MONITOR_TEST_OP_RMDIR:
+ if (debug) {
+ g_printerr("Rmdir %s\n", pathsrc);
+ }
+ if (rmdir(pathsrc) < 0) {
+ g_printerr("Unable to rmdir %s: %s",
+ pathsrc, strerror(errno));
+ goto cleanup;
+ }
+ break;
+
default:
g_assert_not_reached();
}
@@ -532,13 +627,18 @@ test_file_monitor_events(void)
const QFileMonitorTestOp *op = &(ops[i]);
char *path = g_strdup_printf("%s/%s",
dir, op->filesrc);
- unlink(path);
- g_free(path);
- if (op->filedst) {
- path = g_strdup_printf("%s/%s",
- dir, op->filedst);
+ if (op->type == QFILE_MONITOR_TEST_OP_MKDIR) {
+ rmdir(path);
+ g_free(path);
+ } else {
unlink(path);
g_free(path);
+ if (op->filedst) {
+ path = g_strdup_printf("%s/%s",
+ dir, op->filedst);
+ unlink(path);
+ g_free(path);
+ }
}
}
if (rmdir(dir) < 0) {
diff --git a/util/filemonitor-inotify.c b/util/filemonitor-inotify.c
index 3a72be037f..3eb29f860b 100644
--- a/util/filemonitor-inotify.c
+++ b/util/filemonitor-inotify.c
@@ -29,7 +29,7 @@
struct QFileMonitor {
int fd;
-
+ int nextid; /* watch ID counter */
QemuMutex lock; /* protects dirs & idmap */
GHashTable *dirs; /* dirname => QFileMonitorDir */
GHashTable *idmap; /* inotify ID => dirname */
@@ -47,7 +47,6 @@ typedef struct {
typedef struct {
char *path;
int id; /* inotify ID */
- int nextid; /* watch ID counter */
GArray *watches; /* QFileMonitorWatch elements */
} QFileMonitorDir;
@@ -277,7 +276,7 @@ qemu_file_monitor_add_watch(QFileMonitor *mon,
}
}
- watch.id = dir->nextid++;
+ watch.id = mon->nextid++;
watch.filename = g_strdup(filename);
watch.cb = cb;
watch.opaque = opaque;
--
2.20.1
^ permalink raw reply related [flat|nested] 5+ messages in thread* [Qemu-devel] [PULL 3/3] filemon: fix watch IDs to avoid potential wraparound issues
2019-04-02 12:54 [Qemu-devel] [PULL 0/3] Filemon next patches Daniel P. Berrangé
2019-04-02 12:54 ` [Qemu-devel] [PULL 1/3] tests: refactor file monitor test to make it more understandable Daniel P. Berrangé
2019-04-02 12:54 ` [Qemu-devel] [PULL 2/3] filemon: ensure watch IDs are unique to QFileMonitor scope Daniel P. Berrangé
@ 2019-04-02 12:54 ` Daniel P. Berrangé
2019-04-02 14:31 ` [Qemu-devel] [PULL 0/3] Filemon next patches Peter Maydell
3 siblings, 0 replies; 5+ messages in thread
From: Daniel P. Berrangé @ 2019-04-02 12:54 UTC (permalink / raw)
To: qemu-devel
Cc: Gerd Hoffmann, Daniel P. Berrangé, Bandan Das,
Marc-André Lureau
Watch IDs are allocated from incrementing a int counter against
the QFileMonitor object. In very long life QEMU processes with
a huge amount of USB MTP activity creating & deleting directories
it is just about conceivable that the int counter can wrap
around. This would result in incorrect behaviour of the file
monitor watch APIs due to clashing watch IDs.
Instead of trying to detect this situation, this patch changes
the way watch IDs are allocated. It is turned into an int64_t
variable where the high 32 bits are set from the underlying
inotify "int" ID. This gives an ID that is guaranteed unique
for the directory as a whole, and we can rely on the kernel
to enforce this. QFileMonitor then sets the low 32 bits from
a per-directory counter.
The USB MTP device only sets watches on the directory as a
whole, not files within, so there is no risk of guest
triggered wrap around on the low 32 bits.
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
authz/listfile.c | 2 +-
hw/usb/dev-mtp.c | 10 +--
include/authz/listfile.h | 2 +-
include/qemu/filemonitor.h | 16 ++---
tests/test-util-filemonitor.c | 130 +++++++++++++++++++---------------
util/filemonitor-inotify.c | 25 +++----
util/filemonitor-stub.c | 4 +-
util/trace-events | 6 +-
8 files changed, 105 insertions(+), 90 deletions(-)
diff --git a/authz/listfile.c b/authz/listfile.c
index d4579767e7..bc2b58ef6d 100644
--- a/authz/listfile.c
+++ b/authz/listfile.c
@@ -93,7 +93,7 @@ qauthz_list_file_load(QAuthZListFile *fauthz, Error **errp)
static void
-qauthz_list_file_event(int wd G_GNUC_UNUSED,
+qauthz_list_file_event(int64_t wd G_GNUC_UNUSED,
QFileMonitorEvent ev G_GNUC_UNUSED,
const char *name G_GNUC_UNUSED,
void *opaque)
diff --git a/hw/usb/dev-mtp.c b/hw/usb/dev-mtp.c
index 4dc1317e2e..ebf210fbf8 100644
--- a/hw/usb/dev-mtp.c
+++ b/hw/usb/dev-mtp.c
@@ -170,7 +170,7 @@ struct MTPObject {
char *path;
struct stat stat;
/* file monitor watch id */
- int watchid;
+ int64_t watchid;
MTPObject *parent;
uint32_t nchildren;
QLIST_HEAD(, MTPObject) children;
@@ -498,7 +498,7 @@ static MTPObject *usb_mtp_object_lookup_name(MTPObject *parent,
return NULL;
}
-static MTPObject *usb_mtp_object_lookup_id(MTPState *s, int id)
+static MTPObject *usb_mtp_object_lookup_id(MTPState *s, int64_t id)
{
MTPObject *iter;
@@ -511,7 +511,7 @@ static MTPObject *usb_mtp_object_lookup_id(MTPState *s, int id)
return NULL;
}
-static void file_monitor_event(int id,
+static void file_monitor_event(int64_t id,
QFileMonitorEvent ev,
const char *name,
void *opaque)
@@ -625,8 +625,8 @@ static void usb_mtp_object_readdir(MTPState *s, MTPObject *o)
}
if (s->file_monitor) {
- int id = qemu_file_monitor_add_watch(s->file_monitor, o->path, NULL,
- file_monitor_event, s, &err);
+ int64_t id = qemu_file_monitor_add_watch(s->file_monitor, o->path, NULL,
+ file_monitor_event, s, &err);
if (id == -1) {
error_report("usb-mtp: failed to add watch for %s: %s", o->path,
error_get_pretty(err));
diff --git a/include/authz/listfile.h b/include/authz/listfile.h
index ebbd5a4288..0d618c903c 100644
--- a/include/authz/listfile.h
+++ b/include/authz/listfile.h
@@ -92,7 +92,7 @@ struct QAuthZListFile {
char *filename;
bool refresh;
QFileMonitor *file_monitor;
- int file_watch;
+ int64_t file_watch;
};
diff --git a/include/qemu/filemonitor.h b/include/qemu/filemonitor.h
index cd031832ed..64267d09b2 100644
--- a/include/qemu/filemonitor.h
+++ b/include/qemu/filemonitor.h
@@ -52,7 +52,7 @@ typedef enum {
* empty.
*
*/
-typedef void (*QFileMonitorHandler)(int id,
+typedef void (*QFileMonitorHandler)(int64_t id,
QFileMonitorEvent event,
const char *filename,
void *opaque);
@@ -103,12 +103,12 @@ void qemu_file_monitor_free(QFileMonitor *mon);
*
* Returns: a positive integer watch ID, or -1 on error
*/
-int qemu_file_monitor_add_watch(QFileMonitor *mon,
- const char *dirpath,
- const char *filename,
- QFileMonitorHandler cb,
- void *opaque,
- Error **errp);
+int64_t qemu_file_monitor_add_watch(QFileMonitor *mon,
+ const char *dirpath,
+ const char *filename,
+ QFileMonitorHandler cb,
+ void *opaque,
+ Error **errp);
/**
* qemu_file_monitor_remove_watch:
@@ -123,6 +123,6 @@ int qemu_file_monitor_add_watch(QFileMonitor *mon,
*/
void qemu_file_monitor_remove_watch(QFileMonitor *mon,
const char *dirpath,
- int id);
+ int64_t id);
#endif /* QEMU_FILE_MONITOR_H */
diff --git a/tests/test-util-filemonitor.c b/tests/test-util-filemonitor.c
index 71a7cf5de0..46e781c022 100644
--- a/tests/test-util-filemonitor.c
+++ b/tests/test-util-filemonitor.c
@@ -43,12 +43,12 @@ typedef struct {
int type;
const char *filesrc;
const char *filedst;
- int watchid;
+ int64_t *watchid;
int eventid;
} QFileMonitorTestOp;
typedef struct {
- int id;
+ int64_t id;
QFileMonitorEvent event;
char *filename;
} QFileMonitorTestRecord;
@@ -90,7 +90,7 @@ qemu_file_monitor_test_event_loop(void *opaque G_GNUC_UNUSED)
* an ordered list of all events that it receives
*/
static void
-qemu_file_monitor_test_handler(int id,
+qemu_file_monitor_test_handler(int64_t id,
QFileMonitorEvent event,
const char *filename,
void *opaque)
@@ -156,7 +156,7 @@ qemu_file_monitor_test_next_record(QFileMonitorTestData *data)
*/
static bool
qemu_file_monitor_test_expect(QFileMonitorTestData *data,
- int id,
+ int64_t id,
QFileMonitorEvent event,
const char *filename)
{
@@ -166,13 +166,14 @@ qemu_file_monitor_test_expect(QFileMonitorTestData *data,
rec = qemu_file_monitor_test_next_record(data);
if (!rec) {
- g_printerr("Missing event watch id %d event %d file %s\n",
+ g_printerr("Missing event watch id %" PRIx64 " event %d file %s\n",
id, event, filename);
return false;
}
if (id != rec->id) {
- g_printerr("Expected watch id %d but got %d\n", id, rec->id);
+ g_printerr("Expected watch id %" PRIx64 " but got %" PRIx64 "\n",
+ id, rec->id);
goto cleanup;
}
@@ -198,170 +199,176 @@ qemu_file_monitor_test_expect(QFileMonitorTestData *data,
static void
test_file_monitor_events(void)
{
+ int64_t watch0 = 0;
+ int64_t watch1 = 0;
+ int64_t watch2 = 0;
+ int64_t watch3 = 0;
+ int64_t watch4 = 0;
+ int64_t watch5 = 0;
QFileMonitorTestOp ops[] = {
{ .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
- .filesrc = NULL, .watchid = 0 },
+ .filesrc = NULL, .watchid = &watch0 },
{ .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
- .filesrc = "one.txt", .watchid = 1 },
+ .filesrc = "one.txt", .watchid = &watch1 },
{ .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
- .filesrc = "two.txt", .watchid = 2 },
+ .filesrc = "two.txt", .watchid = &watch2 },
{ .type = QFILE_MONITOR_TEST_OP_CREATE,
.filesrc = "one.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 0,
+ .filesrc = "one.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 1,
+ .filesrc = "one.txt", .watchid = &watch1,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_CREATE,
.filesrc = "two.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 0,
+ .filesrc = "two.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 2,
+ .filesrc = "two.txt", .watchid = &watch2,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_CREATE,
.filesrc = "three.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "three.txt", .watchid = 0,
+ .filesrc = "three.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_UNLINK,
.filesrc = "three.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "three.txt", .watchid = 0,
+ .filesrc = "three.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_RENAME,
.filesrc = "one.txt", .filedst = "two.txt" },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 0,
+ .filesrc = "one.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 1,
+ .filesrc = "one.txt", .watchid = &watch1,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 0,
+ .filesrc = "two.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 2,
+ .filesrc = "two.txt", .watchid = &watch2,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_APPEND,
.filesrc = "two.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 0,
+ .filesrc = "two.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_MODIFIED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 2,
+ .filesrc = "two.txt", .watchid = &watch2,
.eventid = QFILE_MONITOR_EVENT_MODIFIED },
{ .type = QFILE_MONITOR_TEST_OP_TOUCH,
.filesrc = "two.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 0,
+ .filesrc = "two.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_ATTRIBUTES },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 2,
+ .filesrc = "two.txt", .watchid = &watch2,
.eventid = QFILE_MONITOR_EVENT_ATTRIBUTES },
{ .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
- .filesrc = "one.txt", .watchid = 1 },
+ .filesrc = "one.txt", .watchid = &watch1 },
{ .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
- .filesrc = "one.txt", .watchid = 3 },
+ .filesrc = "one.txt", .watchid = &watch3 },
{ .type = QFILE_MONITOR_TEST_OP_CREATE,
.filesrc = "one.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 0,
+ .filesrc = "one.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 3,
+ .filesrc = "one.txt", .watchid = &watch3,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
- .filesrc = "one.txt", .watchid = 3 },
+ .filesrc = "one.txt", .watchid = &watch3 },
{ .type = QFILE_MONITOR_TEST_OP_UNLINK,
.filesrc = "one.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 0,
+ .filesrc = "one.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_MKDIR,
.filesrc = "fish", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "fish", .watchid = 0,
+ .filesrc = "fish", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
- .filesrc = "fish/", .watchid = 4 },
+ .filesrc = "fish/", .watchid = &watch4 },
{ .type = QFILE_MONITOR_TEST_OP_ADD_WATCH,
- .filesrc = "fish/one.txt", .watchid = 5 },
+ .filesrc = "fish/one.txt", .watchid = &watch5 },
{ .type = QFILE_MONITOR_TEST_OP_CREATE,
.filesrc = "fish/one.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 4,
+ .filesrc = "one.txt", .watchid = &watch4,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 5,
+ .filesrc = "one.txt", .watchid = &watch5,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
- .filesrc = "fish/one.txt", .watchid = 5 },
+ .filesrc = "fish/one.txt", .watchid = &watch5 },
{ .type = QFILE_MONITOR_TEST_OP_RENAME,
.filesrc = "fish/one.txt", .filedst = "two.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "one.txt", .watchid = 4,
+ .filesrc = "one.txt", .watchid = &watch4,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 0,
+ .filesrc = "two.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 2,
+ .filesrc = "two.txt", .watchid = &watch2,
.eventid = QFILE_MONITOR_EVENT_CREATED },
{ .type = QFILE_MONITOR_TEST_OP_RMDIR,
.filesrc = "fish", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "", .watchid = 4,
+ .filesrc = "", .watchid = &watch4,
.eventid = QFILE_MONITOR_EVENT_IGNORED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "fish", .watchid = 0,
+ .filesrc = "fish", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
- .filesrc = "fish", .watchid = 4 },
+ .filesrc = "fish", .watchid = &watch4 },
{ .type = QFILE_MONITOR_TEST_OP_UNLINK,
.filesrc = "two.txt", },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 0,
+ .filesrc = "two.txt", .watchid = &watch0,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_EVENT,
- .filesrc = "two.txt", .watchid = 2,
+ .filesrc = "two.txt", .watchid = &watch2,
.eventid = QFILE_MONITOR_EVENT_DELETED },
{ .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
- .filesrc = "two.txt", .watchid = 2 },
+ .filesrc = "two.txt", .watchid = &watch2 },
{ .type = QFILE_MONITOR_TEST_OP_DEL_WATCH,
- .filesrc = NULL, .watchid = 0 },
+ .filesrc = NULL, .watchid = &watch0 },
};
Error *local_err = NULL;
GError *gerr = NULL;
@@ -374,6 +381,7 @@ test_file_monitor_events(void)
char *pathsrc = NULL;
char *pathdst = NULL;
QFileMonitorTestData data;
+ GHashTable *ids = g_hash_table_new(g_int64_hash, g_int64_equal);
qemu_mutex_init(&data.lock);
data.records = NULL;
@@ -414,7 +422,6 @@ test_file_monitor_events(void)
for (i = 0; i < G_N_ELEMENTS(ops); i++) {
const QFileMonitorTestOp *op = &(ops[i]);
int fd;
- int watchid;
struct utimbuf ubuf;
char *watchdir;
const char *watchfile;
@@ -427,8 +434,8 @@ test_file_monitor_events(void)
switch (op->type) {
case QFILE_MONITOR_TEST_OP_ADD_WATCH:
if (debug) {
- g_printerr("Add watch %s %s %d\n",
- dir, op->filesrc, op->watchid);
+ g_printerr("Add watch %s %s\n",
+ dir, op->filesrc);
}
if (op->filesrc && strchr(op->filesrc, '/')) {
watchdir = g_strdup_printf("%s/%s", dir, op->filesrc);
@@ -442,7 +449,7 @@ test_file_monitor_events(void)
watchdir = g_strdup(dir);
watchfile = op->filesrc;
}
- watchid =
+ *op->watchid =
qemu_file_monitor_add_watch(mon,
watchdir,
watchfile,
@@ -450,20 +457,23 @@ test_file_monitor_events(void)
&data,
&local_err);
g_free(watchdir);
- if (watchid < 0) {
+ if (*op->watchid < 0) {
g_printerr("Unable to add watch %s",
error_get_pretty(local_err));
goto cleanup;
}
- if (watchid != op->watchid) {
- g_printerr("Unexpected watch ID %d, wanted %d\n",
- watchid, op->watchid);
+ if (debug) {
+ g_printerr("Watch ID %" PRIx64 "\n", *op->watchid);
+ }
+ if (g_hash_table_contains(ids, op->watchid)) {
+ g_printerr("Watch ID %" PRIx64 "already exists", *op->watchid);
goto cleanup;
}
+ g_hash_table_add(ids, op->watchid);
break;
case QFILE_MONITOR_TEST_OP_DEL_WATCH:
if (debug) {
- g_printerr("Del watch %s %d\n", dir, op->watchid);
+ g_printerr("Del watch %s %" PRIx64 "\n", dir, *op->watchid);
}
if (op->filesrc && strchr(op->filesrc, '/')) {
watchdir = g_strdup_printf("%s/%s", dir, op->filesrc);
@@ -472,18 +482,19 @@ test_file_monitor_events(void)
} else {
watchdir = g_strdup(dir);
}
+ g_hash_table_remove(ids, op->watchid);
qemu_file_monitor_remove_watch(mon,
watchdir,
- op->watchid);
+ *op->watchid);
g_free(watchdir);
break;
case QFILE_MONITOR_TEST_OP_EVENT:
if (debug) {
- g_printerr("Event id=%d event=%d file=%s\n",
- op->watchid, op->eventid, op->filesrc);
+ g_printerr("Event id=%" PRIx64 " event=%d file=%s\n",
+ *op->watchid, op->eventid, op->filesrc);
}
if (!qemu_file_monitor_test_expect(
- &data, op->watchid, op->eventid, op->filesrc))
+ &data, *op->watchid, op->eventid, op->filesrc))
goto cleanup;
break;
case QFILE_MONITOR_TEST_OP_CREATE:
@@ -596,6 +607,8 @@ test_file_monitor_events(void)
pathsrc = pathdst = NULL;
}
+ g_assert_cmpint(g_hash_table_size(ids), ==, 0);
+
err = 0;
cleanup:
@@ -647,6 +660,7 @@ test_file_monitor_events(void)
abort();
}
}
+ g_hash_table_unref(ids);
g_free(dir);
g_assert(err == 0);
}
diff --git a/util/filemonitor-inotify.c b/util/filemonitor-inotify.c
index 3eb29f860b..b5f4b93f3f 100644
--- a/util/filemonitor-inotify.c
+++ b/util/filemonitor-inotify.c
@@ -29,7 +29,6 @@
struct QFileMonitor {
int fd;
- int nextid; /* watch ID counter */
QemuMutex lock; /* protects dirs & idmap */
GHashTable *dirs; /* dirname => QFileMonitorDir */
GHashTable *idmap; /* inotify ID => dirname */
@@ -37,7 +36,7 @@ struct QFileMonitor {
typedef struct {
- int id; /* watch ID */
+ int64_t id; /* watch ID */
char *filename; /* optional filter */
QFileMonitorHandler cb;
void *opaque;
@@ -46,7 +45,8 @@ typedef struct {
typedef struct {
char *path;
- int id; /* inotify ID */
+ int inotify_id; /* inotify ID */
+ int next_file_id; /* file ID counter */
GArray *watches; /* QFileMonitorWatch elements */
} QFileMonitorDir;
@@ -126,7 +126,8 @@ static void qemu_file_monitor_watch(void *arg)
g_assert_not_reached();
}
- trace_qemu_file_monitor_event(mon, dir->path, name, ev->mask, dir->id);
+ trace_qemu_file_monitor_event(mon, dir->path, name, ev->mask,
+ dir->inotify_id);
for (i = 0; i < dir->watches->len; i++) {
QFileMonitorWatch *watch = &g_array_index(dir->watches,
QFileMonitorWatch,
@@ -237,7 +238,7 @@ qemu_file_monitor_free(QFileMonitor *mon)
g_idle_add((GSourceFunc)qemu_file_monitor_free_idle, mon);
}
-int
+int64_t
qemu_file_monitor_add_watch(QFileMonitor *mon,
const char *dirpath,
const char *filename,
@@ -247,7 +248,7 @@ qemu_file_monitor_add_watch(QFileMonitor *mon,
{
QFileMonitorDir *dir;
QFileMonitorWatch watch;
- int ret = -1;
+ int64_t ret = -1;
qemu_mutex_lock(&mon->lock);
dir = g_hash_table_lookup(mon->dirs, dirpath);
@@ -265,7 +266,7 @@ qemu_file_monitor_add_watch(QFileMonitor *mon,
dir = g_new0(QFileMonitorDir, 1);
dir->path = g_strdup(dirpath);
- dir->id = rv;
+ dir->inotify_id = rv;
dir->watches = g_array_new(FALSE, TRUE, sizeof(QFileMonitorWatch));
g_hash_table_insert(mon->dirs, dir->path, dir);
@@ -276,7 +277,7 @@ qemu_file_monitor_add_watch(QFileMonitor *mon,
}
}
- watch.id = mon->nextid++;
+ watch.id = (((int64_t)dir->inotify_id) << 32) | dir->next_file_id++;
watch.filename = g_strdup(filename);
watch.cb = cb;
watch.opaque = opaque;
@@ -297,7 +298,7 @@ qemu_file_monitor_add_watch(QFileMonitor *mon,
void qemu_file_monitor_remove_watch(QFileMonitor *mon,
const char *dirpath,
- int id)
+ int64_t id)
{
QFileMonitorDir *dir;
gsize i;
@@ -322,10 +323,10 @@ void qemu_file_monitor_remove_watch(QFileMonitor *mon,
}
if (dir->watches->len == 0) {
- inotify_rm_watch(mon->fd, dir->id);
- trace_qemu_file_monitor_disable_watch(mon, dir->path, dir->id);
+ inotify_rm_watch(mon->fd, dir->inotify_id);
+ trace_qemu_file_monitor_disable_watch(mon, dir->path, dir->inotify_id);
- g_hash_table_remove(mon->idmap, GINT_TO_POINTER(dir->id));
+ g_hash_table_remove(mon->idmap, GINT_TO_POINTER(dir->inotify_id));
g_hash_table_remove(mon->dirs, dir->path);
if (g_hash_table_size(mon->dirs) == 0) {
diff --git a/util/filemonitor-stub.c b/util/filemonitor-stub.c
index 48268b2bb6..2c0e97edd8 100644
--- a/util/filemonitor-stub.c
+++ b/util/filemonitor-stub.c
@@ -38,7 +38,7 @@ qemu_file_monitor_free(QFileMonitor *mon G_GNUC_UNUSED)
}
-int
+int64_t
qemu_file_monitor_add_watch(QFileMonitor *mon G_GNUC_UNUSED,
const char *dirpath G_GNUC_UNUSED,
const char *filename G_GNUC_UNUSED,
@@ -54,6 +54,6 @@ qemu_file_monitor_add_watch(QFileMonitor *mon G_GNUC_UNUSED,
void
qemu_file_monitor_remove_watch(QFileMonitor *mon G_GNUC_UNUSED,
const char *dirpath G_GNUC_UNUSED,
- int id G_GNUC_UNUSED)
+ int64_t id G_GNUC_UNUSED)
{
}
diff --git a/util/trace-events b/util/trace-events
index 56c27287be..9dbd237dad 100644
--- a/util/trace-events
+++ b/util/trace-events
@@ -22,13 +22,13 @@ buffer_move(const char *buf, size_t len, const char *from) "%s: %zd bytes from %
buffer_free(const char *buf, size_t len) "%s: capacity %zd"
# filemonitor-inotify.c
-qemu_file_monitor_add_watch(void *mon, const char *dirpath, const char *filename, void *cb, void *opaque, int id) "File monitor %p add watch dir='%s' file='%s' cb=%p opaque=%p id=%u"
-qemu_file_monitor_remove_watch(void *mon, const char *dirpath, int id) "File monitor %p remove watch dir='%s' id=%u"
+qemu_file_monitor_add_watch(void *mon, const char *dirpath, const char *filename, void *cb, void *opaque, int64_t id) "File monitor %p add watch dir='%s' file='%s' cb=%p opaque=%p id=%" PRId64
+qemu_file_monitor_remove_watch(void *mon, const char *dirpath, int64_t id) "File monitor %p remove watch dir='%s' id=%" PRId64
qemu_file_monitor_new(void *mon, int fd) "File monitor %p created fd=%d"
qemu_file_monitor_enable_watch(void *mon, const char *dirpath, int id) "File monitor %p enable watch dir='%s' id=%u"
qemu_file_monitor_disable_watch(void *mon, const char *dirpath, int id) "Fle monitor %p disable watch dir='%s' id=%u"
qemu_file_monitor_event(void *mon, const char *dirpath, const char *filename, int mask, unsigned int id) "File monitor %p event dir='%s' file='%s' mask=0x%x id=%u"
-qemu_file_monitor_dispatch(void *mon, const char *dirpath, const char *filename, int ev, void *cb, void *opaque, unsigned int id) "File monitor %p dispatch dir='%s' file='%s' ev=%d cb=%p opaque=%p id=%u"
+qemu_file_monitor_dispatch(void *mon, const char *dirpath, const char *filename, int ev, void *cb, void *opaque, int64_t id) "File monitor %p dispatch dir='%s' file='%s' ev=%d cb=%p opaque=%p id=%" PRId64
# qemu-coroutine.c
qemu_aio_coroutine_enter(void *ctx, void *from, void *to, void *opaque) "ctx %p from %p to %p opaque %p"
--
2.20.1
^ permalink raw reply related [flat|nested] 5+ messages in thread* Re: [Qemu-devel] [PULL 0/3] Filemon next patches
2019-04-02 12:54 [Qemu-devel] [PULL 0/3] Filemon next patches Daniel P. Berrangé
` (2 preceding siblings ...)
2019-04-02 12:54 ` [Qemu-devel] [PULL 3/3] filemon: fix watch IDs to avoid potential wraparound issues Daniel P. Berrangé
@ 2019-04-02 14:31 ` Peter Maydell
3 siblings, 0 replies; 5+ messages in thread
From: Peter Maydell @ 2019-04-02 14:31 UTC (permalink / raw)
To: Daniel P. Berrangé; +Cc: QEMU Developers, Bandan Das, Gerd Hoffmann
On Tue, 2 Apr 2019 at 20:10, Daniel P. Berrangé <berrange@redhat.com> wrote:
>
> The following changes since commit d61d1a1fb2f1db6c54651844a28389c523f3f8c7:
>
> Merge remote-tracking branch 'remotes/kraxel/tags/fixes-20190402-pull-request' into staging (2019-04-02 08:18:24 +0100)
>
> are available in the Git repository at:
>
> https://github.com/berrange/qemu tags/filemon-next-pull-request
>
> for you to fetch changes up to b4682a63f86ed81abcaa543ea6135e17f9e99d01:
>
> filemon: fix watch IDs to avoid potential wraparound issues (2019-04-02 13:52:02 +0100)
>
> ----------------------------------------------------------------
> filemon: various fixes / improvements to file monitor for USB MTP
>
> Ensure watch IDs unique within a monitor and avoid integer wraparound
> issues when many watches are set & unset over time.
>
> ----------------------------------------------------------------
>
> Daniel P. Berrangé (3):
> tests: refactor file monitor test to make it more understandable
> filemon: ensure watch IDs are unique to QFileMonitor scope
> filemon: fix watch IDs to avoid potential wraparound issues
Applied, thanks.
Please update the changelog at https://wiki.qemu.org/ChangeLog/4.0
for any user-visible changes.
-- PMM
^ permalink raw reply [flat|nested] 5+ messages in thread