* [PATCH v4 01/19] tools/xenstore: make hashtable key parameter const
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 17:51 ` Julien Grall
2023-08-14 7:46 ` [PATCH v4 02/19] tools/xenstore: let hashtable_add() fail in case of existing entry Juergen Gross
` (18 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
The key is never modified by hashtable code, so it should be marked as
const.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- make value const, too.
V4:
- undo V3 change again (Julien Grall)
---
tools/xenstore/hashtable.c | 5 +++--
tools/xenstore/hashtable.h | 4 ++--
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/tools/xenstore/hashtable.c b/tools/xenstore/hashtable.c
index 11f6bf8f15..9daddd9782 100644
--- a/tools/xenstore/hashtable.c
+++ b/tools/xenstore/hashtable.c
@@ -11,7 +11,8 @@
struct entry
{
- void *k, *v;
+ const void *k;
+ void *v;
unsigned int h;
struct entry *next;
};
@@ -140,7 +141,7 @@ static int hashtable_expand(struct hashtable *h)
return 0;
}
-int hashtable_add(struct hashtable *h, void *k, void *v)
+int hashtable_add(struct hashtable *h, const void *k, void *v)
{
/* This method allows duplicate keys - but they shouldn't be used */
unsigned int index;
diff --git a/tools/xenstore/hashtable.h b/tools/xenstore/hashtable.h
index 5a2cc4a4be..792f6cda7b 100644
--- a/tools/xenstore/hashtable.h
+++ b/tools/xenstore/hashtable.h
@@ -48,8 +48,8 @@ create_hashtable(const void *ctx, const char *name,
* If in doubt, remove before insert.
*/
-int
-hashtable_add(struct hashtable *h, void *k, void *v);
+int
+hashtable_add(struct hashtable *h, const void *k, void *v);
/*****************************************************************************
* hashtable_search
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 02/19] tools/xenstore: let hashtable_add() fail in case of existing entry
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
2023-08-14 7:46 ` [PATCH v4 01/19] tools/xenstore: make hashtable key parameter const Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 7:46 ` [PATCH v4 03/19] tools/xenstore: add hashtable_replace() function Juergen Gross
` (17 subsequent siblings)
19 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD, Julien Grall
Silently adding another entry with the same key to a hashtable is a
perfect receipt for later failure with hard to diagnose symptoms.
Let hashtable_add() fail in case another entry with the same key is
already existing.
Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
---
V2:
- split off from next patch (Julien Grall)
- fix coding style (Julien Grall)
- use for () loop (Julien Grall)
---
tools/xenstore/hashtable.c | 40 ++++++++++++++++++++++++++------------
tools/xenstore/hashtable.h | 6 ------
2 files changed, 28 insertions(+), 18 deletions(-)
diff --git a/tools/xenstore/hashtable.c b/tools/xenstore/hashtable.c
index 9daddd9782..88e14c4c57 100644
--- a/tools/xenstore/hashtable.c
+++ b/tools/xenstore/hashtable.c
@@ -141,11 +141,34 @@ static int hashtable_expand(struct hashtable *h)
return 0;
}
+static struct entry *hashtable_search_entry(const struct hashtable *h,
+ const void *k)
+{
+ struct entry *e;
+ unsigned int hashvalue, index;
+
+ hashvalue = hash(h, k);
+ index = indexFor(h->tablelength, hashvalue);
+ e = h->table[index];
+
+ for (e = h->table[index]; e; e = e->next)
+ {
+ /* Check hash value to short circuit heavier comparison */
+ if ((hashvalue == e->h) && (h->eqfn(k, e->k)))
+ return e;
+ }
+
+ return NULL;
+}
+
int hashtable_add(struct hashtable *h, const void *k, void *v)
{
- /* This method allows duplicate keys - but they shouldn't be used */
unsigned int index;
struct entry *e;
+
+ if (hashtable_search_entry(h, k))
+ return EEXIST;
+
if (++(h->entrycount) > h->loadlimit)
{
/* Ignore the return value. If expand fails, we should
@@ -176,17 +199,10 @@ int hashtable_add(struct hashtable *h, const void *k, void *v)
void *hashtable_search(const struct hashtable *h, const void *k)
{
struct entry *e;
- unsigned int hashvalue, index;
- hashvalue = hash(h,k);
- index = indexFor(h->tablelength,hashvalue);
- e = h->table[index];
- while (NULL != e)
- {
- /* Check hash value to short circuit heavier comparison */
- if ((hashvalue == e->h) && (h->eqfn(k, e->k))) return e->v;
- e = e->next;
- }
- return NULL;
+
+ e = hashtable_search_entry(h, k);
+
+ return e ? e->v : NULL;
}
void
diff --git a/tools/xenstore/hashtable.h b/tools/xenstore/hashtable.h
index 792f6cda7b..e208d439a2 100644
--- a/tools/xenstore/hashtable.h
+++ b/tools/xenstore/hashtable.h
@@ -40,12 +40,6 @@ create_hashtable(const void *ctx, const char *name,
*
* This function will cause the table to expand if the insertion would take
* the ratio of entries to table size over the maximum load factor.
- *
- * This function does not check for repeated insertions with a duplicate key.
- * The value returned when using a duplicate key is undefined -- when
- * the hashtable changes size, the order of retrieval of duplicate key
- * entries is reversed.
- * If in doubt, remove before insert.
*/
int
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 03/19] tools/xenstore: add hashtable_replace() function
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
2023-08-14 7:46 ` [PATCH v4 01/19] tools/xenstore: make hashtable key parameter const Juergen Gross
2023-08-14 7:46 ` [PATCH v4 02/19] tools/xenstore: let hashtable_add() fail in case of existing entry Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 7:46 ` [PATCH v4 04/19] tools/xenstore: drop use of tdb Juergen Gross
` (16 subsequent siblings)
19 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD, Julien Grall
For an effective way to replace a hashtable entry add a new function
hashtable_replace().
This is in preparation to replace TDB with a more simple data storage.
Signed-off-by: Juergen Gross <jgross@suse.com>
Acked-by: Julien Grall <jgrall@amazon.com>
---
V3:
- fix commit message (Julien Grall)
- move unrelated change to previous patch (Julien Grall)
- make value parameter const
V4:
- remove "const" from value parameter again (Julien Grall)
---
tools/xenstore/hashtable.c | 19 +++++++++++++++++++
tools/xenstore/hashtable.h | 16 ++++++++++++++++
2 files changed, 35 insertions(+)
diff --git a/tools/xenstore/hashtable.c b/tools/xenstore/hashtable.c
index 88e14c4c57..0c26a09567 100644
--- a/tools/xenstore/hashtable.c
+++ b/tools/xenstore/hashtable.c
@@ -205,6 +205,25 @@ void *hashtable_search(const struct hashtable *h, const void *k)
return e ? e->v : NULL;
}
+int hashtable_replace(struct hashtable *h, const void *k, void *v)
+{
+ struct entry *e;
+
+ e = hashtable_search_entry(h, k);
+ if (!e)
+ return ENOENT;
+
+ if (h->flags & HASHTABLE_FREE_VALUE)
+ {
+ talloc_free(e->v);
+ talloc_steal(e, v);
+ }
+
+ e->v = v;
+
+ return 0;
+}
+
void
hashtable_remove(struct hashtable *h, const void *k)
{
diff --git a/tools/xenstore/hashtable.h b/tools/xenstore/hashtable.h
index e208d439a2..336540413b 100644
--- a/tools/xenstore/hashtable.h
+++ b/tools/xenstore/hashtable.h
@@ -45,6 +45,22 @@ create_hashtable(const void *ctx, const char *name,
int
hashtable_add(struct hashtable *h, const void *k, void *v);
+/*****************************************************************************
+ * hashtable_replace
+
+ * @name hashtable_nsert
+ * @param h the hashtable to insert into
+ * @param k the key - hashtable claims ownership and will free on removal
+ * @param v the value - does not claim ownership
+ * @return zero for successful insertion
+ *
+ * This function does check for an entry being present before replacing it
+ * with a new value.
+ */
+
+int
+hashtable_replace(struct hashtable *h, const void *k, void *v);
+
/*****************************************************************************
* hashtable_search
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 04/19] tools/xenstore: drop use of tdb
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (2 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 03/19] tools/xenstore: add hashtable_replace() function Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 7:46 ` [PATCH v4 05/19] tools/xenstore: remove tdb code Juergen Gross
` (15 subsequent siblings)
19 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD, Julien Grall
Today all Xenstore nodes are stored in a TDB data base. This data base
has several disadvantages:
- It is using a fixed sized hash table, resulting in high memory
overhead for small installations with only very few VMs, and a rather
large performance hit for systems with lots of VMs due to many
collisions.
The hash table size today is 7919 entries. This means that e.g. in
case of a simple desktop use case with 2 or 3 VMs probably far less
than 10% of the entries will be used (assuming roughly 100 nodes per
VM). OTOH a setup on a large server with 500 VMs would result in
heavy conflicts in the hash list with 5-10 nodes per hash table entry.
- TDB is using a single large memory area for storing the nodes. It
only ever increases this area and will never shrink it afterwards.
This will result in more memory usage than necessary after a peak of
Xenstore usage.
- Xenstore is only single-threaded, while TDB is designed to be fit
for multi-threaded use cases, resulting in much higher code
complexity than needed.
- Special use cases of Xenstore are not possible to implement with TDB
in an effective way, while an implementation of a data base tailored
for Xenstore could simplify some handling (e.g. transactions) a lot.
So drop using TDB and store the nodes directly in memory making them
easily accessible. Use a hash-based lookup mechanism for fast lookup
of nodes by their full path.
For now only replace TDB keeping the current access functions.
Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
---
V2:
- add const (Julien Grall)
- use specific pointer type instead of void * (Julien Grall)
- add comment to db_fetch() (Julien Grall)
V3:
- use talloc_memdup() (Julien Grall)
---
tools/xenstore/xenstored_core.c | 156 ++++++++++---------------
tools/xenstore/xenstored_core.h | 5 +-
tools/xenstore/xenstored_transaction.c | 1 -
3 files changed, 62 insertions(+), 100 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index a12ede147c..2b94392fd4 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -53,7 +53,6 @@
#include "xenstored_domain.h"
#include "xenstored_control.h"
#include "xenstored_lu.h"
-#include "tdb.h"
#ifndef NO_SOCKETS
#if defined(HAVE_SYSTEMD)
@@ -85,7 +84,7 @@ bool keep_orphans = false;
static int reopen_log_pipe[2];
static int reopen_log_pipe0_pollfd_idx = -1;
char *tracefile = NULL;
-static TDB_CONTEXT *tdb_ctx = NULL;
+static struct hashtable *nodes;
unsigned int trace_flags = TRACE_OBJ | TRACE_IO;
static const char *sockmsg_string(enum xsd_sockmsg_type type);
@@ -556,32 +555,30 @@ static void initialize_fds(int *p_sock_pollfd_idx, int *ptimeout)
}
}
-static void set_tdb_key(const char *name, TDB_DATA *key)
-{
- /*
- * Dropping const is fine here, as the key will never be modified
- * by TDB.
- */
- key->dptr = (char *)name;
- key->dsize = strlen(name);
-}
-
struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
{
- TDB_DATA key, data;
+ const struct xs_tdb_record_hdr *hdr;
+ struct xs_tdb_record_hdr *p;
- set_tdb_key(db_name, &key);
- data = tdb_fetch(tdb_ctx, key);
- if (!data.dptr) {
- errno = (tdb_error(tdb_ctx) == TDB_ERR_NOEXIST) ? ENOENT : EIO;
- *size = 0;
- } else {
- *size = data.dsize;
- trace_tdb("read %s size %zu\n", db_name,
- *size + strlen(db_name));
+ hdr = hashtable_search(nodes, db_name);
+ if (!hdr) {
+ errno = ENOENT;
+ return NULL;
}
- return (struct xs_tdb_record_hdr *)data.dptr;
+ *size = sizeof(*hdr) + hdr->num_perms * sizeof(hdr->perms[0]) +
+ hdr->datalen + hdr->childlen;
+
+ /* Return a copy, avoiding a potential modification in the DB. */
+ p = talloc_memdup(NULL, hdr, *size);
+ if (!p) {
+ errno = ENOMEM;
+ return NULL;
+ }
+
+ trace_tdb("read %s size %zu\n", db_name, *size + strlen(db_name));
+
+ return p;
}
static void get_acc_data(const char *name, struct node_account_data *acc)
@@ -621,12 +618,10 @@ int db_write(struct connection *conn, const char *db_name, void *data,
struct xs_tdb_record_hdr *hdr = data;
struct node_account_data old_acc = {};
unsigned int old_domid, new_domid;
+ size_t name_len = strlen(db_name);
+ const char *name;
int ret;
- TDB_DATA key, dat;
- set_tdb_key(db_name, &key);
- dat.dptr = data;
- dat.dsize = size;
if (!acc)
old_acc.memory = -1;
else
@@ -642,29 +637,36 @@ int db_write(struct connection *conn, const char *db_name, void *data,
*/
if (old_acc.memory)
domain_memory_add_nochk(conn, old_domid,
- -old_acc.memory - key.dsize);
- ret = domain_memory_add(conn, new_domid, size + key.dsize,
+ -old_acc.memory - name_len);
+ ret = domain_memory_add(conn, new_domid, size + name_len,
no_quota_check);
if (ret) {
/* Error path, so no quota check. */
if (old_acc.memory)
domain_memory_add_nochk(conn, old_domid,
- old_acc.memory + key.dsize);
+ old_acc.memory + name_len);
return ret;
}
- /* TDB should set errno, but doesn't even set ecode AFAICT. */
- if (tdb_store(tdb_ctx, key, dat,
- (mode == NODE_CREATE) ? TDB_INSERT : TDB_MODIFY) != 0) {
- domain_memory_add_nochk(conn, new_domid, -size - key.dsize);
+ if (mode == NODE_CREATE) {
+ /* db_name could be modified later, so allocate a copy. */
+ name = talloc_strdup(data, db_name);
+ ret = name ? hashtable_add(nodes, name, data) : ENOMEM;
+ } else
+ ret = hashtable_replace(nodes, db_name, data);
+
+ if (ret) {
+ /* Free data, as it isn't owned by hashtable now. */
+ talloc_free(data);
+ domain_memory_add_nochk(conn, new_domid, -size - name_len);
/* Error path, so no quota check. */
if (old_acc.memory)
domain_memory_add_nochk(conn, old_domid,
- old_acc.memory + key.dsize);
- errno = EIO;
+ old_acc.memory + name_len);
+ errno = ret;
return errno;
}
- trace_tdb("store %s size %zu\n", db_name, size + key.dsize);
+ trace_tdb("store %s size %zu\n", db_name, size + name_len);
if (acc) {
/* Don't use new_domid, as it might be a transaction node. */
@@ -680,9 +682,6 @@ int db_delete(struct connection *conn, const char *name,
{
struct node_account_data tmp_acc;
unsigned int domid;
- TDB_DATA key;
-
- set_tdb_key(name, &key);
if (!acc) {
acc = &tmp_acc;
@@ -691,15 +690,13 @@ int db_delete(struct connection *conn, const char *name,
get_acc_data(name, acc);
- if (tdb_delete(tdb_ctx, key)) {
- errno = EIO;
- return errno;
- }
+ hashtable_remove(nodes, name);
trace_tdb("delete %s\n", name);
if (acc->memory) {
domid = get_acc_domid(conn, name, acc->domid);
- domain_memory_add_nochk(conn, domid, -acc->memory - key.dsize);
+ domain_memory_add_nochk(conn, domid,
+ -acc->memory - strlen(name));
}
return 0;
@@ -2354,43 +2351,29 @@ static void manual_node(const char *name, const char *child)
talloc_free(node);
}
-static void tdb_logger(TDB_CONTEXT *tdb, int level, const char * fmt, ...)
+static unsigned int hash_from_key_fn(const void *k)
{
- va_list ap;
- char *s;
- int saved_errno = errno;
+ const char *str = k;
+ unsigned int hash = 5381;
+ char c;
- va_start(ap, fmt);
- s = talloc_vasprintf(NULL, fmt, ap);
- va_end(ap);
+ while ((c = *str++))
+ hash = ((hash << 5) + hash) + (unsigned int)c;
- if (s) {
- trace("TDB: %s\n", s);
- syslog(LOG_ERR, "TDB: %s", s);
- if (verbose)
- xprintf("TDB: %s", s);
- talloc_free(s);
- } else {
- trace("talloc failure during logging\n");
- syslog(LOG_ERR, "talloc failure during logging\n");
- }
+ return hash;
+}
- errno = saved_errno;
+static int keys_equal_fn(const void *key1, const void *key2)
+{
+ return 0 == strcmp(key1, key2);
}
void setup_structure(bool live_update)
{
- char *tdbname;
-
- tdbname = talloc_strdup(talloc_autofree_context(), "/dev/mem");
- if (!tdbname)
- barf_perror("Could not create tdbname");
-
- tdb_ctx = tdb_open_ex(tdbname, 7919, TDB_INTERNAL | TDB_NOLOCK,
- O_RDWR | O_CREAT | O_EXCL | O_CLOEXEC,
- 0640, &tdb_logger, NULL);
- if (!tdb_ctx)
- barf_perror("Could not create tdb file %s", tdbname);
+ nodes = create_hashtable(NULL, "nodes", hash_from_key_fn, keys_equal_fn,
+ HASHTABLE_FREE_KEY | HASHTABLE_FREE_VALUE);
+ if (!nodes)
+ barf_perror("Could not create nodes hashtable");
if (live_update)
manual_node("/", NULL);
@@ -2404,24 +2387,6 @@ void setup_structure(bool live_update)
}
}
-static unsigned int hash_from_key_fn(const void *k)
-{
- const char *str = k;
- unsigned int hash = 5381;
- char c;
-
- while ((c = *str++))
- hash = ((hash << 5) + hash) + (unsigned int)c;
-
- return hash;
-}
-
-
-static int keys_equal_fn(const void *key1, const void *key2)
-{
- return 0 == strcmp(key1, key2);
-}
-
int remember_string(struct hashtable *hash, const char *str)
{
char *k = talloc_strdup(NULL, str);
@@ -2481,12 +2446,11 @@ static int check_store_enoent(const void *ctx, struct connection *conn,
/**
* Helper to clean_store below.
*/
-static int clean_store_(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA val,
- void *private)
+static int clean_store_(const void *key, void *val, void *private)
{
struct hashtable *reachable = private;
char *slash;
- char * name = talloc_strndup(NULL, key.dptr, key.dsize);
+ char *name = talloc_strdup(NULL, key);
if (!name) {
log("clean_store: ENOMEM");
@@ -2516,7 +2480,7 @@ static int clean_store_(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA val,
*/
static void clean_store(struct check_store_data *data)
{
- tdb_traverse(tdb_ctx, &clean_store_, data->reachable);
+ hashtable_iterate(nodes, clean_store_, data->reachable);
domain_check_acc(data->domains);
}
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index f5aa8d51a0..ce40c61f44 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -33,7 +33,6 @@
#include "xenstore_lib.h"
#include "xenstore_state.h"
#include "list.h"
-#include "tdb.h"
#include "hashtable.h"
#ifndef O_CLOEXEC
@@ -237,7 +236,7 @@ static inline unsigned int get_node_owner(const struct node *node)
return node->perms.p[0].id;
}
-/* Write a node to the tdb data base. */
+/* Write a node to the data base. */
enum write_node_mode {
NODE_CREATE,
NODE_MODIFY
@@ -247,7 +246,7 @@ int write_node_raw(struct connection *conn, const char *db_name,
struct node *node, enum write_node_mode mode,
bool no_quota_check);
-/* Get a node from the tdb data base. */
+/* Get a node from the data base. */
struct node *read_node(struct connection *conn, const void *ctx,
const char *name);
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstore/xenstored_transaction.c
index 1981d1d55d..378fe79763 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstore/xenstored_transaction.c
@@ -397,7 +397,6 @@ static int finalize_transaction(struct connection *conn,
? NODE_CREATE : NODE_MODIFY;
*is_corrupt |= db_write(conn, i->node, hdr,
size, NULL, mode, true);
- talloc_free(hdr);
if (db_delete(conn, i->trans_name, NULL))
*is_corrupt = true;
} else {
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 05/19] tools/xenstore: remove tdb code
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (3 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 04/19] tools/xenstore: drop use of tdb Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 7:46 ` [PATCH v4 06/19] tools/xenstore: let db_delete() return void Juergen Gross
` (14 subsequent siblings)
19 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD, Julien Grall
Now that TDB isn't used anymore, remove it.
Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
---
tools/xenstore/Makefile.common | 2 +-
tools/xenstore/tdb.c | 1748 --------------------------------
tools/xenstore/tdb.h | 132 ---
3 files changed, 1 insertion(+), 1881 deletions(-)
delete mode 100644 tools/xenstore/tdb.c
delete mode 100644 tools/xenstore/tdb.h
diff --git a/tools/xenstore/Makefile.common b/tools/xenstore/Makefile.common
index 657a16849e..3259ab51e6 100644
--- a/tools/xenstore/Makefile.common
+++ b/tools/xenstore/Makefile.common
@@ -2,7 +2,7 @@
XENSTORED_OBJS-y := xenstored_core.o xenstored_watch.o xenstored_domain.o
XENSTORED_OBJS-y += xenstored_transaction.o xenstored_control.o xenstored_lu.o
-XENSTORED_OBJS-y += talloc.o utils.o tdb.o hashtable.o
+XENSTORED_OBJS-y += talloc.o utils.o hashtable.o
XENSTORED_OBJS-$(CONFIG_Linux) += xenstored_posix.o xenstored_lu_daemon.o
XENSTORED_OBJS-$(CONFIG_NetBSD) += xenstored_posix.o xenstored_lu_daemon.o
diff --git a/tools/xenstore/tdb.c b/tools/xenstore/tdb.c
deleted file mode 100644
index 29593b76c3..0000000000
--- a/tools/xenstore/tdb.c
+++ /dev/null
@@ -1,1748 +0,0 @@
- /*
- Unix SMB/CIFS implementation.
-
- trivial database library
-
- Copyright (C) Andrew Tridgell 1999-2004
- Copyright (C) Paul `Rusty' Russell 2000
- Copyright (C) Jeremy Allison 2000-2003
-
- ** NOTE! The following LGPL license applies to the tdb
- ** library. This does NOT imply that all of Samba is released
- ** under the LGPL
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; If not, see <http://www.gnu.org/licenses/>.
-*/
-
-
-#ifndef _SAMBA_BUILD_
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
-
-#include <stdlib.h>
-#include <stdio.h>
-#include <stdint.h>
-#include <fcntl.h>
-#include <unistd.h>
-#include <string.h>
-#include <fcntl.h>
-#include <errno.h>
-#include <sys/mman.h>
-#include <sys/stat.h>
-#include "tdb.h"
-#include <stdarg.h>
-#include "talloc.h"
-#undef HAVE_MMAP
-#else
-#include "includes.h"
-#include "lib/tdb/include/tdb.h"
-#include "system/time.h"
-#include "system/shmem.h"
-#include "system/filesys.h"
-#endif
-
-#define TDB_MAGIC_FOOD "TDB file\n"
-#define TDB_VERSION (0x26011967 + 7)
-#define TDB_MAGIC (0x26011999U)
-#define TDB_FREE_MAGIC (~TDB_MAGIC)
-#define TDB_DEAD_MAGIC (0xFEE1DEAD)
-#define TDB_ALIGNMENT 4
-#define MIN_REC_SIZE (2*sizeof(struct list_struct) + TDB_ALIGNMENT)
-#define DEFAULT_HASH_SIZE 131
-#define TDB_PAGE_SIZE 0x2000
-#define FREELIST_TOP (sizeof(struct tdb_header))
-#define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
-#define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
-#define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
-#define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
-#define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off))
-#define TDB_DATA_START(hash_size) (TDB_HASH_TOP(hash_size-1))
-
-
-/* NB assumes there is a local variable called "tdb" that is the
- * current context, also takes doubly-parenthesized print-style
- * argument. */
-#define TDB_LOG(x) tdb->log_fn x
-
-/* lock offsets */
-#define GLOBAL_LOCK 0
-#define ACTIVE_LOCK 4
-
-#ifndef MAP_FILE
-#define MAP_FILE 0
-#endif
-
-#ifndef MAP_FAILED
-#define MAP_FAILED ((void *)-1)
-#endif
-
-#ifndef discard_const_p
-# if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
-# define discard_const(ptr) ((void *)((intptr_t)(ptr)))
-# else
-# define discard_const(ptr) ((void *)(ptr))
-# endif
-# define discard_const_p(type, ptr) ((type *)discard_const(ptr))
-#endif
-
-/* free memory if the pointer is valid and zero the pointer */
-#ifndef SAFE_FREE
-#define SAFE_FREE(x) do { if ((x) != NULL) {talloc_free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
-#endif
-
-#define BUCKET(hash) ((hash) % tdb->header.hash_size)
-static TDB_DATA tdb_null;
-
-/* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
-static TDB_CONTEXT *tdbs = NULL;
-
-static int tdb_munmap(TDB_CONTEXT *tdb)
-{
- if (tdb->flags & TDB_INTERNAL)
- return 0;
-
-#ifdef HAVE_MMAP
- if (tdb->map_ptr) {
- int ret = munmap(tdb->map_ptr, tdb->map_size);
- if (ret != 0)
- return ret;
- }
-#endif
- tdb->map_ptr = NULL;
- return 0;
-}
-
-static void tdb_mmap(TDB_CONTEXT *tdb)
-{
- if (tdb->flags & TDB_INTERNAL)
- return;
-
-#ifdef HAVE_MMAP
- if (!(tdb->flags & TDB_NOMMAP)) {
- tdb->map_ptr = mmap(NULL, tdb->map_size,
- PROT_READ|(tdb->read_only? 0:PROT_WRITE),
- MAP_SHARED|MAP_FILE, tdb->fd, 0);
-
- /*
- * NB. When mmap fails it returns MAP_FAILED *NOT* NULL !!!!
- */
-
- if (tdb->map_ptr == MAP_FAILED) {
- tdb->map_ptr = NULL;
- TDB_LOG((tdb, 2, "tdb_mmap failed for size %d (%s)\n",
- tdb->map_size, strerror(errno)));
- }
- } else {
- tdb->map_ptr = NULL;
- }
-#else
- tdb->map_ptr = NULL;
-#endif
-}
-
-/* Endian conversion: we only ever deal with 4 byte quantities */
-static void *convert(void *buf, uint32_t size)
-{
- uint32_t i, *p = buf;
- for (i = 0; i < size / 4; i++)
- p[i] = TDB_BYTEREV(p[i]);
- return buf;
-}
-#define DOCONV() (tdb->flags & TDB_CONVERT)
-#define CONVERT(x) (DOCONV() ? convert(&x, sizeof(x)) : &x)
-
-/* the body of the database is made of one list_struct for the free space
- plus a separate data list for each hash value */
-struct list_struct {
- tdb_off next; /* offset of the next record in the list */
- tdb_len rec_len; /* total byte length of record */
- tdb_len key_len; /* byte length of key */
- tdb_len data_len; /* byte length of data */
- uint32_t full_hash; /* the full 32 bit hash of the key */
- uint32_t magic; /* try to catch errors */
- /* the following union is implied:
- union {
- char record[rec_len];
- struct {
- char key[key_len];
- char data[data_len];
- }
- uint32_t totalsize; (tailer)
- }
- */
-};
-
-/* a byte range locking function - return 0 on success
- this functions locks/unlocks 1 byte at the specified offset.
-
- On error, errno is also set so that errors are passed back properly
- through tdb_open(). */
-static int tdb_brlock(TDB_CONTEXT *tdb, tdb_off offset,
- int rw_type, int lck_type, int probe)
-{
- struct flock fl;
- int ret;
-
- if (tdb->flags & TDB_NOLOCK)
- return 0;
- if ((rw_type == F_WRLCK) && (tdb->read_only)) {
- errno = EACCES;
- return -1;
- }
-
- fl.l_type = rw_type;
- fl.l_whence = SEEK_SET;
- fl.l_start = offset;
- fl.l_len = 1;
- fl.l_pid = 0;
-
- do {
- ret = fcntl(tdb->fd,lck_type,&fl);
- } while (ret == -1 && errno == EINTR);
-
- if (ret == -1) {
- if (!probe && lck_type != F_SETLK) {
- /* Ensure error code is set for log fun to examine. */
- tdb->ecode = TDB_ERR_LOCK;
- TDB_LOG((tdb, 5,"tdb_brlock failed (fd=%d) at offset %d rw_type=%d lck_type=%d\n",
- tdb->fd, offset, rw_type, lck_type));
- }
- /* Generic lock error. errno set by fcntl.
- * EAGAIN is an expected return from non-blocking
- * locks. */
- if (errno != EAGAIN) {
- TDB_LOG((tdb, 5, "tdb_brlock failed (fd=%d) at offset %d rw_type=%d lck_type=%d: %s\n",
- tdb->fd, offset, rw_type, lck_type,
- strerror(errno)));
- }
- return TDB_ERRCODE(TDB_ERR_LOCK, -1);
- }
- return 0;
-}
-
-/* lock a list in the database. list -1 is the alloc list */
-static int tdb_lock(TDB_CONTEXT *tdb, int list, int ltype)
-{
- if (list < -1 || list >= (int)tdb->header.hash_size) {
- TDB_LOG((tdb, 0,"tdb_lock: invalid list %d for ltype=%d\n",
- list, ltype));
- return -1;
- }
- if (tdb->flags & TDB_NOLOCK)
- return 0;
-
- /* Since fcntl locks don't nest, we do a lock for the first one,
- and simply bump the count for future ones */
- if (tdb->locked[list+1].count == 0) {
- if (tdb_brlock(tdb,FREELIST_TOP+4*list,ltype,F_SETLKW, 0)) {
- TDB_LOG((tdb, 0,"tdb_lock failed on list %d ltype=%d (%s)\n",
- list, ltype, strerror(errno)));
- return -1;
- }
- tdb->locked[list+1].ltype = ltype;
- }
- tdb->locked[list+1].count++;
- return 0;
-}
-
-/* unlock the database: returns void because it's too late for errors. */
- /* changed to return int it may be interesting to know there
- has been an error --simo */
-static int tdb_unlock(TDB_CONTEXT *tdb, int list,
- int ltype __attribute__((unused)))
-{
- int ret = -1;
-
- if (tdb->flags & TDB_NOLOCK)
- return 0;
-
- /* Sanity checks */
- if (list < -1 || list >= (int)tdb->header.hash_size) {
- TDB_LOG((tdb, 0, "tdb_unlock: list %d invalid (%d)\n", list, tdb->header.hash_size));
- return ret;
- }
-
- if (tdb->locked[list+1].count==0) {
- TDB_LOG((tdb, 0, "tdb_unlock: count is 0\n"));
- return ret;
- }
-
- if (tdb->locked[list+1].count == 1) {
- /* Down to last nested lock: unlock underneath */
- ret = tdb_brlock(tdb, FREELIST_TOP+4*list, F_UNLCK, F_SETLKW, 0);
- } else {
- ret = 0;
- }
- tdb->locked[list+1].count--;
-
- if (ret)
- TDB_LOG((tdb, 0,"tdb_unlock: An error occurred unlocking!\n"));
- return ret;
-}
-
-/* This is based on the hash algorithm from gdbm */
-static uint32_t default_tdb_hash(TDB_DATA *key)
-{
- uint32_t value; /* Used to compute the hash value. */
- uint32_t i; /* Used to cycle through random values. */
-
- /* Set the initial value from the key size. */
- for (value = 0x238F13AF * key->dsize, i=0; i < key->dsize; i++)
- value = (value + (key->dptr[i] << (i*5 % 24)));
-
- return (1103515243 * value + 12345);
-}
-
-/* check for an out of bounds access - if it is out of bounds then
- see if the database has been expanded by someone else and expand
- if necessary
- note that "len" is the minimum length needed for the db
-*/
-static int tdb_oob(TDB_CONTEXT *tdb, tdb_off len, int probe)
-{
- struct stat st;
- if (len <= tdb->map_size)
- return 0;
- if (tdb->flags & TDB_INTERNAL) {
- if (!probe) {
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_IO;
- TDB_LOG((tdb, 0,"tdb_oob len %d beyond internal malloc size %d\n",
- (int)len, (int)tdb->map_size));
- }
- return TDB_ERRCODE(TDB_ERR_IO, -1);
- }
-
- if (fstat(tdb->fd, &st) == -1)
- return TDB_ERRCODE(TDB_ERR_IO, -1);
-
- if (st.st_size < (off_t)len) {
- if (!probe) {
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_IO;
- TDB_LOG((tdb, 0,"tdb_oob len %d beyond eof at %d\n",
- (int)len, (int)st.st_size));
- }
- return TDB_ERRCODE(TDB_ERR_IO, -1);
- }
-
- /* Unmap, update size, remap */
- if (tdb_munmap(tdb) == -1)
- return TDB_ERRCODE(TDB_ERR_IO, -1);
- tdb->map_size = st.st_size;
- tdb_mmap(tdb);
- return 0;
-}
-
-/* write a lump of data at a specified offset */
-static int tdb_write(TDB_CONTEXT *tdb, tdb_off off, void *buf, tdb_len len)
-{
- if (tdb_oob(tdb, off + len, 0) != 0)
- return -1;
-
- if (tdb->map_ptr)
- memcpy(off + (char *)tdb->map_ptr, buf, len);
-#ifdef HAVE_PWRITE
- else if (pwrite(tdb->fd, buf, len, off) != (ssize_t)len) {
-#else
- else if (lseek(tdb->fd, off, SEEK_SET) != (off_t)off
- || write(tdb->fd, buf, len) != (off_t)len) {
-#endif
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_IO;
- TDB_LOG((tdb, 0,"tdb_write failed at %d len=%d (%s)\n",
- off, len, strerror(errno)));
- return TDB_ERRCODE(TDB_ERR_IO, -1);
- }
- return 0;
-}
-
-/* read a lump of data at a specified offset, maybe convert */
-static int tdb_read(TDB_CONTEXT *tdb,tdb_off off,void *buf,tdb_len len,int cv)
-{
- if (tdb_oob(tdb, off + len, 0) != 0)
- return -1;
-
- if (tdb->map_ptr)
- memcpy(buf, off + (char *)tdb->map_ptr, len);
-#ifdef HAVE_PREAD
- else if (pread(tdb->fd, buf, len, off) != (off_t)len) {
-#else
- else if (lseek(tdb->fd, off, SEEK_SET) != (off_t)off
- || read(tdb->fd, buf, len) != (off_t)len) {
-#endif
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_IO;
- TDB_LOG((tdb, 0,"tdb_read failed at %d len=%d (%s)\n",
- off, len, strerror(errno)));
- return TDB_ERRCODE(TDB_ERR_IO, -1);
- }
- if (cv)
- convert(buf, len);
- return 0;
-}
-
-/* don't allocate memory: used in tdb_delete path. */
-static int tdb_key_eq(TDB_CONTEXT *tdb, tdb_off off, TDB_DATA key)
-{
- char buf[64];
- uint32_t len;
-
- if (tdb_oob(tdb, off + key.dsize, 0) != 0)
- return -1;
-
- if (tdb->map_ptr)
- return !memcmp(off + (char*)tdb->map_ptr, key.dptr, key.dsize);
-
- while (key.dsize) {
- len = key.dsize;
- if (len > sizeof(buf))
- len = sizeof(buf);
- if (tdb_read(tdb, off, buf, len, 0) != 0)
- return -1;
- if (memcmp(buf, key.dptr, len) != 0)
- return 0;
- key.dptr += len;
- key.dsize -= len;
- off += len;
- }
- return 1;
-}
-
-/* read a lump of data, allocating the space for it */
-static char *tdb_alloc_read(TDB_CONTEXT *tdb, tdb_off offset, tdb_len len)
-{
- char *buf;
-
- if (!(buf = talloc_size(tdb, len))) {
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_OOM;
- TDB_LOG((tdb, 0,"tdb_alloc_read malloc failed len=%d (%s)\n",
- len, strerror(errno)));
- return TDB_ERRCODE(TDB_ERR_OOM, buf);
- }
- if (tdb_read(tdb, offset, buf, len, 0) == -1) {
- SAFE_FREE(buf);
- return NULL;
- }
- return buf;
-}
-
-/* read/write a tdb_off */
-static int ofs_read(TDB_CONTEXT *tdb, tdb_off offset, tdb_off *d)
-{
- return tdb_read(tdb, offset, (char*)d, sizeof(*d), DOCONV());
-}
-static int ofs_write(TDB_CONTEXT *tdb, tdb_off offset, tdb_off *d)
-{
- tdb_off off = *d;
- return tdb_write(tdb, offset, CONVERT(off), sizeof(*d));
-}
-
-/* read/write a record */
-static int rec_read(TDB_CONTEXT *tdb, tdb_off offset, struct list_struct *rec)
-{
- if (tdb_read(tdb, offset, rec, sizeof(*rec),DOCONV()) == -1)
- return -1;
- if (TDB_BAD_MAGIC(rec)) {
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_CORRUPT;
- TDB_LOG((tdb, 0,"rec_read bad magic 0x%x at offset=%d\n", rec->magic, offset));
- return TDB_ERRCODE(TDB_ERR_CORRUPT, -1);
- }
- return tdb_oob(tdb, rec->next+sizeof(*rec), 0);
-}
-static int rec_write(TDB_CONTEXT *tdb, tdb_off offset, struct list_struct *rec)
-{
- struct list_struct r = *rec;
- return tdb_write(tdb, offset, CONVERT(r), sizeof(r));
-}
-
-/* read a freelist record and check for simple errors */
-static int rec_free_read(TDB_CONTEXT *tdb, tdb_off off, struct list_struct *rec)
-{
- if (tdb_read(tdb, off, rec, sizeof(*rec),DOCONV()) == -1)
- return -1;
-
- if (rec->magic == TDB_MAGIC) {
- /* this happens when a app is showdown while deleting a record - we should
- not completely fail when this happens */
- TDB_LOG((tdb, 0,"rec_free_read non-free magic 0x%x at offset=%d - fixing\n",
- rec->magic, off));
- rec->magic = TDB_FREE_MAGIC;
- if (tdb_write(tdb, off, rec, sizeof(*rec)) == -1)
- return -1;
- }
-
- if (rec->magic != TDB_FREE_MAGIC) {
- /* Ensure ecode is set for log fn. */
- tdb->ecode = TDB_ERR_CORRUPT;
- TDB_LOG((tdb, 0,"rec_free_read bad magic 0x%x at offset=%d\n",
- rec->magic, off));
- return TDB_ERRCODE(TDB_ERR_CORRUPT, -1);
- }
- if (tdb_oob(tdb, rec->next+sizeof(*rec), 0) != 0)
- return -1;
- return 0;
-}
-
-/* update a record tailer (must hold allocation lock) */
-static int update_tailer(TDB_CONTEXT *tdb, tdb_off offset,
- const struct list_struct *rec)
-{
- tdb_off totalsize;
-
- /* Offset of tailer from record header */
- totalsize = sizeof(*rec) + rec->rec_len;
- return ofs_write(tdb, offset + totalsize - sizeof(tdb_off),
- &totalsize);
-}
-
-/* Remove an element from the freelist. Must have alloc lock. */
-static int remove_from_freelist(TDB_CONTEXT *tdb, tdb_off off, tdb_off next)
-{
- tdb_off last_ptr, i;
-
- /* read in the freelist top */
- last_ptr = FREELIST_TOP;
- while (ofs_read(tdb, last_ptr, &i) != -1 && i != 0) {
- if (i == off) {
- /* We've found it! */
- return ofs_write(tdb, last_ptr, &next);
- }
- /* Follow chain (next offset is at start of record) */
- last_ptr = i;
- }
- TDB_LOG((tdb, 0,"remove_from_freelist: not on list at off=%d\n", off));
- return TDB_ERRCODE(TDB_ERR_CORRUPT, -1);
-}
-
-/* Add an element into the freelist. Merge adjacent records if
- neccessary. */
-static int tdb_free(TDB_CONTEXT *tdb, tdb_off offset, struct list_struct *rec)
-{
- tdb_off right, left;
-
- /* Allocation and tailer lock */
- if (tdb_lock(tdb, -1, F_WRLCK) != 0)
- return -1;
-
- /* set an initial tailer, so if we fail we don't leave a bogus record */
- if (update_tailer(tdb, offset, rec) != 0) {
- TDB_LOG((tdb, 0, "tdb_free: upfate_tailer failed!\n"));
- goto fail;
- }
-
- /* Look right first (I'm an Australian, dammit) */
- right = offset + sizeof(*rec) + rec->rec_len;
- if (right + sizeof(*rec) <= tdb->map_size) {
- struct list_struct r;
-
- if (tdb_read(tdb, right, &r, sizeof(r), DOCONV()) == -1) {
- TDB_LOG((tdb, 0, "tdb_free: right read failed at %u\n", right));
- goto left;
- }
-
- /* If it's free, expand to include it. */
- if (r.magic == TDB_FREE_MAGIC) {
- if (remove_from_freelist(tdb, right, r.next) == -1) {
- TDB_LOG((tdb, 0, "tdb_free: right free failed at %u\n", right));
- goto left;
- }
- rec->rec_len += sizeof(r) + r.rec_len;
- }
- }
-
-left:
- /* Look left */
- left = offset - sizeof(tdb_off);
- if (left > TDB_DATA_START(tdb->header.hash_size)) {
- struct list_struct l;
- tdb_off leftsize;
-
- /* Read in tailer and jump back to header */
- if (ofs_read(tdb, left, &leftsize) == -1) {
- TDB_LOG((tdb, 0, "tdb_free: left offset read failed at %u\n", left));
- goto update;
- }
- left = offset - leftsize;
-
- /* Now read in record */
- if (tdb_read(tdb, left, &l, sizeof(l), DOCONV()) == -1) {
- TDB_LOG((tdb, 0, "tdb_free: left read failed at %u (%u)\n", left, leftsize));
- goto update;
- }
-
- /* If it's free, expand to include it. */
- if (l.magic == TDB_FREE_MAGIC) {
- if (remove_from_freelist(tdb, left, l.next) == -1) {
- TDB_LOG((tdb, 0, "tdb_free: left free failed at %u\n", left));
- goto update;
- } else {
- offset = left;
- rec->rec_len += leftsize;
- }
- }
- }
-
-update:
- if (update_tailer(tdb, offset, rec) == -1) {
- TDB_LOG((tdb, 0, "tdb_free: update_tailer failed at %u\n", offset));
- goto fail;
- }
-
- /* Now, prepend to free list */
- rec->magic = TDB_FREE_MAGIC;
-
- if (ofs_read(tdb, FREELIST_TOP, &rec->next) == -1 ||
- rec_write(tdb, offset, rec) == -1 ||
- ofs_write(tdb, FREELIST_TOP, &offset) == -1) {
- TDB_LOG((tdb, 0, "tdb_free record write failed at offset=%d\n", offset));
- goto fail;
- }
-
- /* And we're done. */
- tdb_unlock(tdb, -1, F_WRLCK);
- return 0;
-
- fail:
- tdb_unlock(tdb, -1, F_WRLCK);
- return -1;
-}
-
-
-/* expand a file. we prefer to use ftruncate, as that is what posix
- says to use for mmap expansion */
-static int expand_file(TDB_CONTEXT *tdb, tdb_off size, tdb_off addition)
-{
- char buf[1024];
-#ifdef HAVE_FTRUNCATE_EXTEND
- if (ftruncate(tdb->fd, size+addition) != 0) {
- TDB_LOG((tdb, 0, "expand_file ftruncate to %d failed (%s)\n",
- size+addition, strerror(errno)));
- return -1;
- }
-#else
- char b = 0;
-
-#ifdef HAVE_PWRITE
- if (pwrite(tdb->fd, &b, 1, (size+addition) - 1) != 1) {
-#else
- if (lseek(tdb->fd, (size+addition) - 1, SEEK_SET) != (off_t)(size+addition) - 1 ||
- write(tdb->fd, &b, 1) != 1) {
-#endif
- TDB_LOG((tdb, 0, "expand_file to %d failed (%s)\n",
- size+addition, strerror(errno)));
- return -1;
- }
-#endif
-
- /* now fill the file with something. This ensures that the file isn't sparse, which would be
- very bad if we ran out of disk. This must be done with write, not via mmap */
- memset(buf, 0x42, sizeof(buf));
- while (addition) {
- int n = addition>sizeof(buf)?sizeof(buf):addition;
-#ifdef HAVE_PWRITE
- int ret = pwrite(tdb->fd, buf, n, size);
-#else
- int ret;
- if (lseek(tdb->fd, size, SEEK_SET) != (off_t)size)
- return -1;
- ret = write(tdb->fd, buf, n);
-#endif
- if (ret != n) {
- TDB_LOG((tdb, 0, "expand_file write of %d failed (%s)\n",
- n, strerror(errno)));
- return -1;
- }
- addition -= n;
- size += n;
- }
- return 0;
-}
-
-
-/* expand the database at least size bytes by expanding the underlying
- file and doing the mmap again if necessary */
-static int tdb_expand(TDB_CONTEXT *tdb, tdb_off size)
-{
- struct list_struct rec;
- tdb_off offset;
-
- if (tdb_lock(tdb, -1, F_WRLCK) == -1) {
- TDB_LOG((tdb, 0, "lock failed in tdb_expand\n"));
- return -1;
- }
-
- /* must know about any previous expansions by another process */
- tdb_oob(tdb, tdb->map_size + 1, 1);
-
- /* always make room for at least 10 more records, and round
- the database up to a multiple of TDB_PAGE_SIZE */
- size = TDB_ALIGN(tdb->map_size + size*10, TDB_PAGE_SIZE) - tdb->map_size;
-
- if (!(tdb->flags & TDB_INTERNAL))
- tdb_munmap(tdb);
-
- /*
- * We must ensure the file is unmapped before doing this
- * to ensure consistency with systems like OpenBSD where
- * writes and mmaps are not consistent.
- */
-
- /* expand the file itself */
- if (!(tdb->flags & TDB_INTERNAL)) {
- if (expand_file(tdb, tdb->map_size, size) != 0)
- goto fail;
- }
-
- tdb->map_size += size;
-
- if (tdb->flags & TDB_INTERNAL) {
- char *new_map_ptr = talloc_realloc_size(tdb, tdb->map_ptr,
- tdb->map_size);
- if (!new_map_ptr) {
- tdb->map_size -= size;
- goto fail;
- }
- tdb->map_ptr = new_map_ptr;
- } else {
- /*
- * We must ensure the file is remapped before adding the space
- * to ensure consistency with systems like OpenBSD where
- * writes and mmaps are not consistent.
- */
-
- /* We're ok if the mmap fails as we'll fallback to read/write */
- tdb_mmap(tdb);
- }
-
- /* form a new freelist record */
- memset(&rec,'\0',sizeof(rec));
- rec.rec_len = size - sizeof(rec);
-
- /* link it into the free list */
- offset = tdb->map_size - size;
- if (tdb_free(tdb, offset, &rec) == -1)
- goto fail;
-
- tdb_unlock(tdb, -1, F_WRLCK);
- return 0;
- fail:
- tdb_unlock(tdb, -1, F_WRLCK);
- return -1;
-}
-
-
-/*
- the core of tdb_allocate - called when we have decided which
- free list entry to use
- */
-static tdb_off tdb_allocate_ofs(TDB_CONTEXT *tdb, tdb_len length, tdb_off rec_ptr,
- struct list_struct *rec, tdb_off last_ptr)
-{
- struct list_struct newrec;
- tdb_off newrec_ptr;
-
- memset(&newrec, '\0', sizeof(newrec));
-
- /* found it - now possibly split it up */
- if (rec->rec_len > length + MIN_REC_SIZE) {
- /* Length of left piece */
- length = TDB_ALIGN(length, TDB_ALIGNMENT);
-
- /* Right piece to go on free list */
- newrec.rec_len = rec->rec_len - (sizeof(*rec) + length);
- newrec_ptr = rec_ptr + sizeof(*rec) + length;
-
- /* And left record is shortened */
- rec->rec_len = length;
- } else {
- newrec_ptr = 0;
- }
-
- /* Remove allocated record from the free list */
- if (ofs_write(tdb, last_ptr, &rec->next) == -1) {
- return 0;
- }
-
- /* Update header: do this before we drop alloc
- lock, otherwise tdb_free() might try to
- merge with us, thinking we're free.
- (Thanks Jeremy Allison). */
- rec->magic = TDB_MAGIC;
- if (rec_write(tdb, rec_ptr, rec) == -1) {
- return 0;
- }
-
- /* Did we create new block? */
- if (newrec_ptr) {
- /* Update allocated record tailer (we
- shortened it). */
- if (update_tailer(tdb, rec_ptr, rec) == -1) {
- return 0;
- }
-
- /* Free new record */
- if (tdb_free(tdb, newrec_ptr, &newrec) == -1) {
- return 0;
- }
- }
-
- /* all done - return the new record offset */
- return rec_ptr;
-}
-
-/* allocate some space from the free list. The offset returned points
- to a unconnected list_struct within the database with room for at
- least length bytes of total data
-
- 0 is returned if the space could not be allocated
- */
-static tdb_off tdb_allocate(TDB_CONTEXT *tdb, tdb_len length,
- struct list_struct *rec)
-{
- tdb_off rec_ptr, last_ptr, newrec_ptr;
- struct {
- tdb_off rec_ptr, last_ptr;
- tdb_len rec_len;
- } bestfit = { 0, 0, 0 };
-
- if (tdb_lock(tdb, -1, F_WRLCK) == -1)
- return 0;
-
- /* Extra bytes required for tailer */
- length += sizeof(tdb_off);
-
- again:
- last_ptr = FREELIST_TOP;
-
- /* read in the freelist top */
- if (ofs_read(tdb, FREELIST_TOP, &rec_ptr) == -1)
- goto fail;
-
- bestfit.rec_ptr = 0;
-
- /*
- this is a best fit allocation strategy. Originally we used
- a first fit strategy, but it suffered from massive fragmentation
- issues when faced with a slowly increasing record size.
- */
- while (rec_ptr) {
- if (rec_free_read(tdb, rec_ptr, rec) == -1) {
- goto fail;
- }
-
- if (rec->rec_len >= length) {
- if (bestfit.rec_ptr == 0 ||
- rec->rec_len < bestfit.rec_len) {
- bestfit.rec_len = rec->rec_len;
- bestfit.rec_ptr = rec_ptr;
- bestfit.last_ptr = last_ptr;
- /* consider a fit to be good enough if we aren't wasting more than half the space */
- if (bestfit.rec_len < 2*length) {
- break;
- }
- }
- }
-
- /* move to the next record */
- last_ptr = rec_ptr;
- rec_ptr = rec->next;
- }
-
- if (bestfit.rec_ptr != 0) {
- if (rec_free_read(tdb, bestfit.rec_ptr, rec) == -1) {
- goto fail;
- }
-
- newrec_ptr = tdb_allocate_ofs(tdb, length, bestfit.rec_ptr, rec, bestfit.last_ptr);
- tdb_unlock(tdb, -1, F_WRLCK);
- return newrec_ptr;
- }
-
- /* we didn't find enough space. See if we can expand the
- database and if we can then try again */
- if (tdb_expand(tdb, length + sizeof(*rec)) == 0)
- goto again;
- fail:
- tdb_unlock(tdb, -1, F_WRLCK);
- return 0;
-}
-
-/* initialise a new database with a specified hash size */
-static int tdb_new_database(TDB_CONTEXT *tdb, int hash_size)
-{
- struct tdb_header *newdb;
- int size, ret = -1;
-
- /* We make it up in memory, then write it out if not internal */
- size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off);
- if (!(newdb = talloc_zero_size(tdb, size)))
- return TDB_ERRCODE(TDB_ERR_OOM, -1);
-
- /* Fill in the header */
- newdb->version = TDB_VERSION;
- newdb->hash_size = hash_size;
- if (tdb->flags & TDB_INTERNAL) {
- tdb->map_size = size;
- tdb->map_ptr = (char *)newdb;
- memcpy(&tdb->header, newdb, sizeof(tdb->header));
- /* Convert the `ondisk' version if asked. */
- CONVERT(*newdb);
- return 0;
- }
- if (lseek(tdb->fd, 0, SEEK_SET) == -1)
- goto fail;
-
- if (ftruncate(tdb->fd, 0) == -1)
- goto fail;
-
- /* This creates an endian-converted header, as if read from disk */
- CONVERT(*newdb);
- memcpy(&tdb->header, newdb, sizeof(tdb->header));
- /* Don't endian-convert the magic food! */
- memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
- if (write(tdb->fd, newdb, size) != size)
- ret = -1;
- else
- ret = 0;
-
- fail:
- SAFE_FREE(newdb);
- return ret;
-}
-
-/* Returns 0 on fail. On success, return offset of record, and fills
- in rec */
-static tdb_off tdb_find(TDB_CONTEXT *tdb, TDB_DATA key, uint32_t hash,
- struct list_struct *r)
-{
- tdb_off rec_ptr;
-
- /* read in the hash top */
- if (ofs_read(tdb, TDB_HASH_TOP(hash), &rec_ptr) == -1)
- return 0;
-
- /* keep looking until we find the right record */
- while (rec_ptr) {
- if (rec_read(tdb, rec_ptr, r) == -1)
- return 0;
-
- if (!TDB_DEAD(r) && hash==r->full_hash && key.dsize==r->key_len) {
- /* a very likely hit - read the key */
- int cmp = tdb_key_eq(tdb, rec_ptr + sizeof(*r), key);
- if (cmp < 0)
- return 0;
- else if (cmp > 0)
- return rec_ptr;
- }
- rec_ptr = r->next;
- }
- return TDB_ERRCODE(TDB_ERR_NOEXIST, 0);
-}
-
-/* As tdb_find, but if you succeed, keep the lock */
-static tdb_off tdb_find_lock_hash(TDB_CONTEXT *tdb, TDB_DATA key, uint32_t hash, int locktype,
- struct list_struct *rec)
-{
- uint32_t rec_ptr;
-
- if (tdb_lock(tdb, BUCKET(hash), locktype) == -1)
- return 0;
- if (!(rec_ptr = tdb_find(tdb, key, hash, rec)))
- tdb_unlock(tdb, BUCKET(hash), locktype);
- return rec_ptr;
-}
-
-enum TDB_ERROR tdb_error(TDB_CONTEXT *tdb)
-{
- return tdb->ecode;
-}
-
-static struct tdb_errname {
- enum TDB_ERROR ecode; const char *estring;
-} emap[] = { {TDB_SUCCESS, "Success"},
- {TDB_ERR_CORRUPT, "Corrupt database"},
- {TDB_ERR_IO, "IO Error"},
- {TDB_ERR_LOCK, "Locking error"},
- {TDB_ERR_OOM, "Out of memory"},
- {TDB_ERR_EXISTS, "Record exists"},
- {TDB_ERR_NOLOCK, "Lock exists on other keys"},
- {TDB_ERR_NOEXIST, "Record does not exist"} };
-
-/* Error string for the last tdb error */
-const char *tdb_errorstr(TDB_CONTEXT *tdb)
-{
- uint32_t i;
- for (i = 0; i < sizeof(emap) / sizeof(struct tdb_errname); i++)
- if (tdb->ecode == emap[i].ecode)
- return emap[i].estring;
- return "Invalid error code";
-}
-
-/* update an entry in place - this only works if the new data size
- is <= the old data size and the key exists.
- on failure return -1.
-*/
-
-static int tdb_update_hash(TDB_CONTEXT *tdb, TDB_DATA key, uint32_t hash, TDB_DATA dbuf)
-{
- struct list_struct rec;
- tdb_off rec_ptr;
-
- /* find entry */
- if (!(rec_ptr = tdb_find(tdb, key, hash, &rec)))
- return -1;
-
- /* must be long enough key, data and tailer */
- if (rec.rec_len < key.dsize + dbuf.dsize + sizeof(tdb_off)) {
- tdb->ecode = TDB_SUCCESS; /* Not really an error */
- return -1;
- }
-
- if (tdb_write(tdb, rec_ptr + sizeof(rec) + rec.key_len,
- dbuf.dptr, dbuf.dsize) == -1)
- return -1;
-
- if (dbuf.dsize != rec.data_len) {
- /* update size */
- rec.data_len = dbuf.dsize;
- return rec_write(tdb, rec_ptr, &rec);
- }
-
- return 0;
-}
-
-/* find an entry in the database given a key */
-/* If an entry doesn't exist tdb_err will be set to
- * TDB_ERR_NOEXIST. If a key has no data attached
- * then the TDB_DATA will have zero length but
- * a non-zero pointer
- */
-
-TDB_DATA tdb_fetch(TDB_CONTEXT *tdb, TDB_DATA key)
-{
- tdb_off rec_ptr;
- struct list_struct rec;
- TDB_DATA ret;
- uint32_t hash;
-
- /* find which hash bucket it is in */
- hash = tdb->hash_fn(&key);
- if (!(rec_ptr = tdb_find_lock_hash(tdb,key,hash,F_RDLCK,&rec)))
- return tdb_null;
-
- ret.dptr = tdb_alloc_read(tdb, rec_ptr + sizeof(rec) + rec.key_len,
- rec.data_len);
- ret.dsize = rec.data_len;
- tdb_unlock(tdb, BUCKET(rec.full_hash), F_RDLCK);
- return ret;
-}
-
-/* check if an entry in the database exists
-
- note that 1 is returned if the key is found and 0 is returned if not found
- this doesn't match the conventions in the rest of this module, but is
- compatible with gdbm
-*/
-static int tdb_exists_hash(TDB_CONTEXT *tdb, TDB_DATA key, uint32_t hash)
-{
- struct list_struct rec;
-
- if (tdb_find_lock_hash(tdb, key, hash, F_RDLCK, &rec) == 0)
- return 0;
- tdb_unlock(tdb, BUCKET(rec.full_hash), F_RDLCK);
- return 1;
-}
-
-/* record lock stops delete underneath */
-static int lock_record(TDB_CONTEXT *tdb, tdb_off off)
-{
- return off ? tdb_brlock(tdb, off, F_RDLCK, F_SETLKW, 0) : 0;
-}
-/*
- Write locks override our own fcntl readlocks, so check it here.
- Note this is meant to be F_SETLK, *not* F_SETLKW, as it's not
- an error to fail to get the lock here.
-*/
-
-static int write_lock_record(TDB_CONTEXT *tdb, tdb_off off)
-{
- struct tdb_traverse_lock *i;
- for (i = &tdb->travlocks; i; i = i->next)
- if (i->off == off)
- return -1;
- return tdb_brlock(tdb, off, F_WRLCK, F_SETLK, 1);
-}
-
-/*
- Note this is meant to be F_SETLK, *not* F_SETLKW, as it's not
- an error to fail to get the lock here.
-*/
-
-static int write_unlock_record(TDB_CONTEXT *tdb, tdb_off off)
-{
- return tdb_brlock(tdb, off, F_UNLCK, F_SETLK, 0);
-}
-/* fcntl locks don't stack: avoid unlocking someone else's */
-static int unlock_record(TDB_CONTEXT *tdb, tdb_off off)
-{
- struct tdb_traverse_lock *i;
- uint32_t count = 0;
-
- if (off == 0)
- return 0;
- for (i = &tdb->travlocks; i; i = i->next)
- if (i->off == off)
- count++;
- return (count == 1 ? tdb_brlock(tdb, off, F_UNLCK, F_SETLKW, 0) : 0);
-}
-
-/* actually delete an entry in the database given the offset */
-static int do_delete(TDB_CONTEXT *tdb, tdb_off rec_ptr, struct list_struct*rec)
-{
- tdb_off last_ptr, i;
- struct list_struct lastrec;
-
- if (tdb->read_only) return -1;
-
- if (write_lock_record(tdb, rec_ptr) == -1) {
- /* Someone traversing here: mark it as dead */
- rec->magic = TDB_DEAD_MAGIC;
- return rec_write(tdb, rec_ptr, rec);
- }
- if (write_unlock_record(tdb, rec_ptr) != 0)
- return -1;
-
- /* find previous record in hash chain */
- if (ofs_read(tdb, TDB_HASH_TOP(rec->full_hash), &i) == -1)
- return -1;
- for (last_ptr = 0; i != rec_ptr; last_ptr = i, i = lastrec.next)
- if (rec_read(tdb, i, &lastrec) == -1)
- return -1;
-
- /* unlink it: next ptr is at start of record. */
- if (last_ptr == 0)
- last_ptr = TDB_HASH_TOP(rec->full_hash);
- if (ofs_write(tdb, last_ptr, &rec->next) == -1)
- return -1;
-
- /* recover the space */
- if (tdb_free(tdb, rec_ptr, rec) == -1)
- return -1;
- return 0;
-}
-
-/* Uses traverse lock: 0 = finish, -1 = error, other = record offset */
-static int tdb_next_lock(TDB_CONTEXT *tdb, struct tdb_traverse_lock *tlock,
- struct list_struct *rec)
-{
- int want_next = (tlock->off != 0);
-
- /* Lock each chain from the start one. */
- for (; tlock->hash < tdb->header.hash_size; tlock->hash++) {
-
- /* this is an optimisation for the common case where
- the hash chain is empty, which is particularly
- common for the use of tdb with ldb, where large
- hashes are used. In that case we spend most of our
- time in tdb_brlock(), locking empty hash chains.
-
- To avoid this, we do an unlocked pre-check to see
- if the hash chain is empty before starting to look
- inside it. If it is empty then we can avoid that
- hash chain. If it isn't empty then we can't believe
- the value we get back, as we read it without a
- lock, so instead we get the lock and re-fetch the
- value below.
-
- Notice that not doing this optimisation on the
- first hash chain is critical. We must guarantee
- that we have done at least one fcntl lock at the
- start of a search to guarantee that memory is
- coherent on SMP systems. If records are added by
- others during the search then thats OK, and we
- could possibly miss those with this trick, but we
- could miss them anyway without this trick, so the
- semantics don't change.
-
- With a non-indexed ldb search this trick gains us a
- factor of around 80 in speed on a linux 2.6.x
- system (testing using ldbtest).
- */
- if (!tlock->off && tlock->hash != 0) {
- uint32_t off;
- if (tdb->map_ptr) {
- for (;tlock->hash < tdb->header.hash_size;tlock->hash++) {
- if (0 != *(uint32_t *)(TDB_HASH_TOP(tlock->hash) + (unsigned char *)tdb->map_ptr)) {
- break;
- }
- }
- if (tlock->hash == tdb->header.hash_size) {
- continue;
- }
- } else {
- if (ofs_read(tdb, TDB_HASH_TOP(tlock->hash), &off) == 0 &&
- off == 0) {
- continue;
- }
- }
- }
-
- if (tdb_lock(tdb, tlock->hash, F_WRLCK) == -1)
- return -1;
-
- /* No previous record? Start at top of chain. */
- if (!tlock->off) {
- if (ofs_read(tdb, TDB_HASH_TOP(tlock->hash),
- &tlock->off) == -1)
- goto fail;
- } else {
- /* Otherwise unlock the previous record. */
- if (unlock_record(tdb, tlock->off) != 0)
- goto fail;
- }
-
- if (want_next) {
- /* We have offset of old record: grab next */
- if (rec_read(tdb, tlock->off, rec) == -1)
- goto fail;
- tlock->off = rec->next;
- }
-
- /* Iterate through chain */
- while( tlock->off) {
- tdb_off current;
- if (rec_read(tdb, tlock->off, rec) == -1)
- goto fail;
-
- /* Detect infinite loops. From "Shlomi Yaakobovich" <Shlomi@exanet.com>. */
- if (tlock->off == rec->next) {
- TDB_LOG((tdb, 0, "tdb_next_lock: loop detected.\n"));
- goto fail;
- }
-
- if (!TDB_DEAD(rec)) {
- /* Woohoo: we found one! */
- if (lock_record(tdb, tlock->off) != 0)
- goto fail;
- return tlock->off;
- }
-
- /* Try to clean dead ones from old traverses */
- current = tlock->off;
- tlock->off = rec->next;
- if (!tdb->read_only &&
- do_delete(tdb, current, rec) != 0)
- goto fail;
- }
- tdb_unlock(tdb, tlock->hash, F_WRLCK);
- want_next = 0;
- }
- /* We finished iteration without finding anything */
- return TDB_ERRCODE(TDB_SUCCESS, 0);
-
- fail:
- tlock->off = 0;
- if (tdb_unlock(tdb, tlock->hash, F_WRLCK) != 0)
- TDB_LOG((tdb, 0, "tdb_next_lock: On error unlock failed!\n"));
- return -1;
-}
-
-/* traverse the entire database - calling fn(tdb, key, data) on each element.
- return -1 on error or the record count traversed
- if fn is NULL then it is not called
- a non-zero return value from fn() indicates that the traversal should stop
- */
-int tdb_traverse(TDB_CONTEXT *tdb, tdb_traverse_func fn, void *private)
-{
- TDB_DATA key, dbuf;
- struct list_struct rec;
- struct tdb_traverse_lock tl = { NULL, 0, 0 };
- int ret, count = 0;
-
- /* This was in the initializaton, above, but the IRIX compiler
- * did not like it. crh
- */
- tl.next = tdb->travlocks.next;
-
- /* fcntl locks don't stack: beware traverse inside traverse */
- tdb->travlocks.next = &tl;
-
- /* tdb_next_lock places locks on the record returned, and its chain */
- while ((ret = tdb_next_lock(tdb, &tl, &rec)) > 0) {
- count++;
- /* now read the full record */
- key.dptr = tdb_alloc_read(tdb, tl.off + sizeof(rec),
- rec.key_len + rec.data_len);
- if (!key.dptr) {
- ret = -1;
- if (tdb_unlock(tdb, tl.hash, F_WRLCK) != 0)
- goto out;
- if (unlock_record(tdb, tl.off) != 0)
- TDB_LOG((tdb, 0, "tdb_traverse: key.dptr == NULL and unlock_record failed!\n"));
- goto out;
- }
- key.dsize = rec.key_len;
- dbuf.dptr = key.dptr + rec.key_len;
- dbuf.dsize = rec.data_len;
-
- /* Drop chain lock, call out */
- if (tdb_unlock(tdb, tl.hash, F_WRLCK) != 0) {
- ret = -1;
- goto out;
- }
- if (fn && fn(tdb, key, dbuf, private)) {
- /* They want us to terminate traversal */
- ret = count;
- if (unlock_record(tdb, tl.off) != 0) {
- TDB_LOG((tdb, 0, "tdb_traverse: unlock_record failed!\n"));
- ret = -1;
- }
- tdb->travlocks.next = tl.next;
- SAFE_FREE(key.dptr);
- return count;
- }
- SAFE_FREE(key.dptr);
- }
-out:
- tdb->travlocks.next = tl.next;
- if (ret < 0)
- return -1;
- else
- return count;
-}
-
-/* find the first entry in the database and return its key */
-TDB_DATA tdb_firstkey(TDB_CONTEXT *tdb)
-{
- TDB_DATA key;
- struct list_struct rec;
-
- /* release any old lock */
- if (unlock_record(tdb, tdb->travlocks.off) != 0)
- return tdb_null;
- tdb->travlocks.off = tdb->travlocks.hash = 0;
-
- if (tdb_next_lock(tdb, &tdb->travlocks, &rec) <= 0)
- return tdb_null;
- /* now read the key */
- key.dsize = rec.key_len;
- key.dptr =tdb_alloc_read(tdb,tdb->travlocks.off+sizeof(rec),key.dsize);
- if (tdb_unlock(tdb, BUCKET(tdb->travlocks.hash), F_WRLCK) != 0)
- TDB_LOG((tdb, 0, "tdb_firstkey: error occurred while tdb_unlocking!\n"));
- return key;
-}
-
-/* find the next entry in the database, returning its key */
-TDB_DATA tdb_nextkey(TDB_CONTEXT *tdb, TDB_DATA oldkey)
-{
- uint32_t oldhash;
- TDB_DATA key = tdb_null;
- struct list_struct rec;
- char *k = NULL;
-
- /* Is locked key the old key? If so, traverse will be reliable. */
- if (tdb->travlocks.off) {
- if (tdb_lock(tdb,tdb->travlocks.hash,F_WRLCK))
- return tdb_null;
- if (rec_read(tdb, tdb->travlocks.off, &rec) == -1
- || !(k = tdb_alloc_read(tdb,tdb->travlocks.off+sizeof(rec),
- rec.key_len))
- || memcmp(k, oldkey.dptr, oldkey.dsize) != 0) {
- /* No, it wasn't: unlock it and start from scratch */
- if (unlock_record(tdb, tdb->travlocks.off) != 0)
- return tdb_null;
- if (tdb_unlock(tdb, tdb->travlocks.hash, F_WRLCK) != 0)
- return tdb_null;
- tdb->travlocks.off = 0;
- }
-
- SAFE_FREE(k);
- }
-
- if (!tdb->travlocks.off) {
- /* No previous element: do normal find, and lock record */
- tdb->travlocks.off = tdb_find_lock_hash(tdb, oldkey, tdb->hash_fn(&oldkey), F_WRLCK, &rec);
- if (!tdb->travlocks.off)
- return tdb_null;
- tdb->travlocks.hash = BUCKET(rec.full_hash);
- if (lock_record(tdb, tdb->travlocks.off) != 0) {
- TDB_LOG((tdb, 0, "tdb_nextkey: lock_record failed (%s)!\n", strerror(errno)));
- return tdb_null;
- }
- }
- oldhash = tdb->travlocks.hash;
-
- /* Grab next record: locks chain and returned record,
- unlocks old record */
- if (tdb_next_lock(tdb, &tdb->travlocks, &rec) > 0) {
- key.dsize = rec.key_len;
- key.dptr = tdb_alloc_read(tdb, tdb->travlocks.off+sizeof(rec),
- key.dsize);
- /* Unlock the chain of this new record */
- if (tdb_unlock(tdb, tdb->travlocks.hash, F_WRLCK) != 0)
- TDB_LOG((tdb, 0, "tdb_nextkey: WARNING tdb_unlock failed!\n"));
- }
- /* Unlock the chain of old record */
- if (tdb_unlock(tdb, BUCKET(oldhash), F_WRLCK) != 0)
- TDB_LOG((tdb, 0, "tdb_nextkey: WARNING tdb_unlock failed!\n"));
- return key;
-}
-
-/* delete an entry in the database given a key */
-static int tdb_delete_hash(TDB_CONTEXT *tdb, TDB_DATA key, uint32_t hash)
-{
- tdb_off rec_ptr;
- struct list_struct rec;
- int ret;
-
- if (!(rec_ptr = tdb_find_lock_hash(tdb, key, hash, F_WRLCK, &rec)))
- return -1;
- ret = do_delete(tdb, rec_ptr, &rec);
- if (tdb_unlock(tdb, BUCKET(rec.full_hash), F_WRLCK) != 0)
- TDB_LOG((tdb, 0, "tdb_delete: WARNING tdb_unlock failed!\n"));
- return ret;
-}
-
-int tdb_delete(TDB_CONTEXT *tdb, TDB_DATA key)
-{
- uint32_t hash = tdb->hash_fn(&key);
- return tdb_delete_hash(tdb, key, hash);
-}
-
-/* store an element in the database, replacing any existing element
- with the same key
-
- return 0 on success, -1 on failure
-*/
-int tdb_store(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag)
-{
- struct list_struct rec;
- uint32_t hash;
- tdb_off rec_ptr;
- char *p = NULL;
- int ret = 0;
-
- /* find which hash bucket it is in */
- hash = tdb->hash_fn(&key);
- if (tdb_lock(tdb, BUCKET(hash), F_WRLCK) == -1)
- return -1;
-
- /* check for it existing, on insert. */
- if (flag == TDB_INSERT) {
- if (tdb_exists_hash(tdb, key, hash)) {
- tdb->ecode = TDB_ERR_EXISTS;
- goto fail;
- }
- } else {
- /* first try in-place update, on modify or replace. */
- if (tdb_update_hash(tdb, key, hash, dbuf) == 0)
- goto out;
- if (tdb->ecode == TDB_ERR_NOEXIST &&
- flag == TDB_MODIFY) {
- /* if the record doesn't exist and we are in TDB_MODIFY mode then
- we should fail the store */
- goto fail;
- }
- }
- /* reset the error code potentially set by the tdb_update() */
- tdb->ecode = TDB_SUCCESS;
-
- /* delete any existing record - if it doesn't exist we don't
- care. Doing this first reduces fragmentation, and avoids
- coalescing with `allocated' block before it's updated. */
- if (flag != TDB_INSERT)
- tdb_delete_hash(tdb, key, hash);
-
- /* Copy key+value *before* allocating free space in case malloc
- fails and we are left with a dead spot in the tdb. */
-
- if (!(p = (char *)talloc_size(tdb, key.dsize + dbuf.dsize))) {
- tdb->ecode = TDB_ERR_OOM;
- goto fail;
- }
-
- memcpy(p, key.dptr, key.dsize);
- if (dbuf.dsize)
- memcpy(p+key.dsize, dbuf.dptr, dbuf.dsize);
-
- /* we have to allocate some space */
- if (!(rec_ptr = tdb_allocate(tdb, key.dsize + dbuf.dsize, &rec)))
- goto fail;
-
- /* Read hash top into next ptr */
- if (ofs_read(tdb, TDB_HASH_TOP(hash), &rec.next) == -1)
- goto fail;
-
- rec.key_len = key.dsize;
- rec.data_len = dbuf.dsize;
- rec.full_hash = hash;
- rec.magic = TDB_MAGIC;
-
- /* write out and point the top of the hash chain at it */
- if (rec_write(tdb, rec_ptr, &rec) == -1
- || tdb_write(tdb, rec_ptr+sizeof(rec), p, key.dsize+dbuf.dsize)==-1
- || ofs_write(tdb, TDB_HASH_TOP(hash), &rec_ptr) == -1) {
- /* Need to tdb_unallocate() here */
- goto fail;
- }
- out:
- SAFE_FREE(p);
- tdb_unlock(tdb, BUCKET(hash), F_WRLCK);
- return ret;
-fail:
- ret = -1;
- goto out;
-}
-
-static int tdb_already_open(dev_t device,
- ino_t ino)
-{
- TDB_CONTEXT *i;
-
- for (i = tdbs; i; i = i->next) {
- if (i->device == device && i->inode == ino) {
- return 1;
- }
- }
-
- return 0;
-}
-
-/* a default logging function */
-static void null_log_fn(TDB_CONTEXT *tdb __attribute__((unused)),
- int level __attribute__((unused)),
- const char *fmt __attribute__((unused)), ...)
-{
-}
-
-
-TDB_CONTEXT *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
- int open_flags, mode_t mode,
- tdb_log_func log_fn,
- tdb_hash_func hash_fn)
-{
- TDB_CONTEXT *tdb;
- struct stat st;
- int rev = 0, locked = 0;
- uint8_t *vp;
- uint32_t vertest;
-
- if (!(tdb = talloc_zero(name, TDB_CONTEXT))) {
- /* Can't log this */
- errno = ENOMEM;
- goto fail;
- }
- tdb->fd = -1;
- tdb->name = NULL;
- tdb->map_ptr = NULL;
- tdb->flags = tdb_flags;
- tdb->open_flags = open_flags;
- tdb->log_fn = log_fn?log_fn:null_log_fn;
- tdb->hash_fn = hash_fn ? hash_fn : default_tdb_hash;
-
- if ((open_flags & O_ACCMODE) == O_WRONLY) {
- TDB_LOG((tdb, 0, "tdb_open_ex: can't open tdb %s write-only\n",
- name));
- errno = EINVAL;
- goto fail;
- }
-
- if (hash_size == 0)
- hash_size = DEFAULT_HASH_SIZE;
- if ((open_flags & O_ACCMODE) == O_RDONLY) {
- tdb->read_only = 1;
- /* read only databases don't do locking or clear if first */
- tdb->flags |= TDB_NOLOCK;
- tdb->flags &= ~TDB_CLEAR_IF_FIRST;
- }
-
- /* internal databases don't mmap or lock, and start off cleared */
- if (tdb->flags & TDB_INTERNAL) {
- tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
- tdb->flags &= ~TDB_CLEAR_IF_FIRST;
- if (tdb_new_database(tdb, hash_size) != 0) {
- TDB_LOG((tdb, 0, "tdb_open_ex: tdb_new_database failed!"));
- goto fail;
- }
- goto internal;
- }
-
- if ((tdb->fd = open(name, open_flags, mode)) == -1) {
- TDB_LOG((tdb, 5, "tdb_open_ex: could not open file %s: %s\n",
- name, strerror(errno)));
- goto fail; /* errno set by open(2) */
- }
-
- /* ensure there is only one process initialising at once */
- if (tdb_brlock(tdb, GLOBAL_LOCK, F_WRLCK, F_SETLKW, 0) == -1) {
- TDB_LOG((tdb, 0, "tdb_open_ex: failed to get global lock on %s: %s\n",
- name, strerror(errno)));
- goto fail; /* errno set by tdb_brlock */
- }
-
- /* we need to zero database if we are the only one with it open */
- if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
- (locked = (tdb_brlock(tdb, ACTIVE_LOCK, F_WRLCK, F_SETLK, 0) == 0))) {
- open_flags |= O_CREAT;
- if (ftruncate(tdb->fd, 0) == -1) {
- TDB_LOG((tdb, 0, "tdb_open_ex: "
- "failed to truncate %s: %s\n",
- name, strerror(errno)));
- goto fail; /* errno set by ftruncate */
- }
- }
-
- if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
- || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0
- || (tdb->header.version != TDB_VERSION
- && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION))))) {
- /* its not a valid database - possibly initialise it */
- if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
- errno = EIO; /* ie bad format or something */
- goto fail;
- }
- rev = (tdb->flags & TDB_CONVERT);
- }
- vp = (uint8_t *)&tdb->header.version;
- vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
- (((uint32_t)vp[2]) << 8) | (uint32_t)vp[3];
- tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
- if (!rev)
- tdb->flags &= ~TDB_CONVERT;
- else {
- tdb->flags |= TDB_CONVERT;
- convert(&tdb->header, sizeof(tdb->header));
- }
- if (fstat(tdb->fd, &st) == -1)
- goto fail;
-
- /* Is it already in the open list? If so, fail. */
- if (tdb_already_open(st.st_dev, st.st_ino)) {
- TDB_LOG((tdb, 2, "tdb_open_ex: "
- "%s (%d,%d) is already open in this process\n",
- name, (int)st.st_dev, (int)st.st_ino));
- errno = EBUSY;
- goto fail;
- }
-
- if (!(tdb->name = (char *)talloc_strdup(tdb, name))) {
- errno = ENOMEM;
- goto fail;
- }
-
- tdb->map_size = st.st_size;
- tdb->device = st.st_dev;
- tdb->inode = st.st_ino;
- tdb->locked = talloc_zero_array(tdb, struct tdb_lock_type,
- tdb->header.hash_size+1);
- if (!tdb->locked) {
- TDB_LOG((tdb, 2, "tdb_open_ex: "
- "failed to allocate lock structure for %s\n",
- name));
- errno = ENOMEM;
- goto fail;
- }
- tdb_mmap(tdb);
- if (locked) {
- if (tdb_brlock(tdb, ACTIVE_LOCK, F_UNLCK, F_SETLK, 0) == -1) {
- TDB_LOG((tdb, 0, "tdb_open_ex: "
- "failed to take ACTIVE_LOCK on %s: %s\n",
- name, strerror(errno)));
- goto fail;
- }
-
- }
-
- /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
- we didn't get the initial exclusive lock as we need to let all other
- users know we're using it. */
-
- if (tdb_flags & TDB_CLEAR_IF_FIRST) {
- /* leave this lock in place to indicate it's in use */
- if (tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0) == -1)
- goto fail;
- }
-
-
- internal:
- /* Internal (memory-only) databases skip all the code above to
- * do with disk files, and resume here by releasing their
- * global lock and hooking into the active list. */
- if (tdb_brlock(tdb, GLOBAL_LOCK, F_UNLCK, F_SETLKW, 0) == -1)
- goto fail;
- tdb->next = tdbs;
- tdbs = tdb;
- return tdb;
-
- fail:
- { int save_errno = errno;
-
- if (!tdb)
- return NULL;
-
- if (tdb->map_ptr) {
- if (tdb->flags & TDB_INTERNAL)
- SAFE_FREE(tdb->map_ptr);
- else
- tdb_munmap(tdb);
- }
- SAFE_FREE(tdb->name);
- if (tdb->fd != -1)
- if (close(tdb->fd) != 0)
- TDB_LOG((tdb, 5, "tdb_open_ex: failed to close tdb->fd on error!\n"));
- SAFE_FREE(tdb->locked);
- SAFE_FREE(tdb);
- errno = save_errno;
- return NULL;
- }
-}
-
-/**
- * Close a database.
- *
- * @returns -1 for error; 0 for success.
- **/
-int tdb_close(TDB_CONTEXT *tdb)
-{
- TDB_CONTEXT **i;
- int ret = 0;
-
- if (tdb->map_ptr) {
- if (tdb->flags & TDB_INTERNAL)
- SAFE_FREE(tdb->map_ptr);
- else
- tdb_munmap(tdb);
- }
- SAFE_FREE(tdb->name);
- if (tdb->fd != -1)
- ret = close(tdb->fd);
- SAFE_FREE(tdb->locked);
-
- /* Remove from contexts list */
- for (i = &tdbs; *i; i = &(*i)->next) {
- if (*i == tdb) {
- *i = tdb->next;
- break;
- }
- }
-
- memset(tdb, 0, sizeof(*tdb));
- SAFE_FREE(tdb);
-
- return ret;
-}
diff --git a/tools/xenstore/tdb.h b/tools/xenstore/tdb.h
deleted file mode 100644
index ce3c7339f8..0000000000
--- a/tools/xenstore/tdb.h
+++ /dev/null
@@ -1,132 +0,0 @@
-#ifndef __TDB_H__
-#define __TDB_H__
-
-#include "utils.h"
-
-/*
- Unix SMB/CIFS implementation.
-
- trivial database library
-
- Copyright (C) Andrew Tridgell 1999-2004
-
- ** NOTE! The following LGPL license applies to the tdb
- ** library. This does NOT imply that all of Samba is released
- ** under the LGPL
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; If not, see <http://www.gnu.org/licenses/>.
-*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-
-/* flags to tdb_store() */
-#define TDB_REPLACE 1
-#define TDB_INSERT 2
-#define TDB_MODIFY 3
-
-/* flags for tdb_open() */
-#define TDB_DEFAULT 0 /* just a readability place holder */
-#define TDB_CLEAR_IF_FIRST 1
-#define TDB_INTERNAL 2 /* don't store on disk */
-#define TDB_NOLOCK 4 /* don't do any locking */
-#define TDB_NOMMAP 8 /* don't use mmap */
-#define TDB_CONVERT 16 /* convert endian (internal use) */
-#define TDB_BIGENDIAN 32 /* header is big-endian (internal use) */
-
-#define TDB_ERRCODE(code, ret) ((tdb->ecode = (code)), ret)
-
-/* error codes */
-enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK,
- TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOLOCK, TDB_ERR_LOCK_TIMEOUT,
- TDB_ERR_NOEXIST};
-
-#ifndef uint32_t
-#define uint32_t unsigned
-#endif
-
-typedef struct TDB_DATA {
- char *dptr;
- size_t dsize;
-} TDB_DATA;
-
-typedef uint32_t tdb_len;
-typedef uint32_t tdb_off;
-
-/* this is stored at the front of every database */
-struct tdb_header {
- char magic_food[32]; /* for /etc/magic */
- uint32_t version; /* version of the code */
- uint32_t hash_size; /* number of hash entries */
- tdb_off rwlocks;
- tdb_off reserved[31];
-};
-
-struct tdb_lock_type {
- uint32_t count;
- uint32_t ltype;
-};
-
-struct tdb_traverse_lock {
- struct tdb_traverse_lock *next;
- uint32_t off;
- uint32_t hash;
-};
-
-/* this is the context structure that is returned from a db open */
-typedef struct tdb_context {
- char *name; /* the name of the database */
- void *map_ptr; /* where it is currently mapped */
- int fd; /* open file descriptor for the database */
- tdb_len map_size; /* how much space has been mapped */
- int read_only; /* opened read-only */
- struct tdb_lock_type *locked; /* array of chain locks */
- enum TDB_ERROR ecode; /* error code for last tdb error */
- struct tdb_header header; /* a cached copy of the header */
- uint32_t flags; /* the flags passed to tdb_open */
- struct tdb_traverse_lock travlocks; /* current traversal locks */
- struct tdb_context *next; /* all tdbs to avoid multiple opens */
- dev_t device; /* uniquely identifies this tdb */
- ino_t inode; /* uniquely identifies this tdb */
- void (*log_fn)(struct tdb_context *tdb, int level, const char *, ...) PRINTF_ATTRIBUTE(3,4); /* logging function */
- uint32_t (*hash_fn)(TDB_DATA *key);
- int open_flags; /* flags used in the open - needed by reopen */
-} TDB_CONTEXT;
-
-typedef int (*tdb_traverse_func)(TDB_CONTEXT *, TDB_DATA, TDB_DATA, void *);
-typedef void (*tdb_log_func)(TDB_CONTEXT *, int , const char *, ...);
-typedef uint32_t (*tdb_hash_func)(TDB_DATA *key);
-
-TDB_CONTEXT *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
- int open_flags, mode_t mode,
- tdb_log_func log_fn,
- tdb_hash_func hash_fn);
-
-enum TDB_ERROR tdb_error(TDB_CONTEXT *tdb);
-const char *tdb_errorstr(TDB_CONTEXT *tdb);
-TDB_DATA tdb_fetch(TDB_CONTEXT *tdb, TDB_DATA key);
-int tdb_delete(TDB_CONTEXT *tdb, TDB_DATA key);
-int tdb_store(TDB_CONTEXT *tdb, TDB_DATA key, TDB_DATA dbuf, int flag);
-int tdb_close(TDB_CONTEXT *tdb);
-TDB_DATA tdb_firstkey(TDB_CONTEXT *tdb);
-TDB_DATA tdb_nextkey(TDB_CONTEXT *tdb, TDB_DATA key);
-int tdb_traverse(TDB_CONTEXT *tdb, tdb_traverse_func fn, void *);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* tdb.h */
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 06/19] tools/xenstore: let db_delete() return void
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (4 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 05/19] tools/xenstore: remove tdb code Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 7:46 ` [PATCH v4 07/19] tools/xenstore: change talloc_free() to take a const pointer Juergen Gross
` (13 subsequent siblings)
19 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD, Julien Grall
db_delete() only ever is returning 0. Switch it to return void and
remove all the error handling dealing wit a non-zero return value.
Suggested-by: Julien Grall <julien@xen.org>
Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
---
V2:
- new patch
---
tools/xenstore/xenstored_core.c | 11 ++++-------
tools/xenstore/xenstored_core.h | 4 ++--
tools/xenstore/xenstored_transaction.c | 14 +++++---------
3 files changed, 11 insertions(+), 18 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index 2b94392fd4..a08962c3ea 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -677,8 +677,8 @@ int db_write(struct connection *conn, const char *db_name, void *data,
return 0;
}
-int db_delete(struct connection *conn, const char *name,
- struct node_account_data *acc)
+void db_delete(struct connection *conn, const char *name,
+ struct node_account_data *acc)
{
struct node_account_data tmp_acc;
unsigned int domid;
@@ -698,8 +698,6 @@ int db_delete(struct connection *conn, const char *name,
domain_memory_add_nochk(conn, domid,
-acc->memory - strlen(name));
}
-
- return 0;
}
/*
@@ -1670,9 +1668,8 @@ static int delnode_sub(const void *ctx, struct connection *conn,
if (domain_nbentry_dec(conn, get_node_owner(node)))
return WALK_TREE_ERROR_STOP;
- /* In case of error stop the walk. */
- if (!ret && db_delete(conn, db_name, &node->acc))
- return WALK_TREE_ERROR_STOP;
+ if (!ret)
+ db_delete(conn, db_name, &node->acc);
/*
* Fire the watches now, when we can still see the node permissions.
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index ce40c61f44..e1aeb4aecd 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -366,8 +366,8 @@ struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size);
int db_write(struct connection *conn, const char *db_name, void *data,
size_t size, struct node_account_data *acc,
enum write_node_mode mode, bool no_quota_check);
-int db_delete(struct connection *conn, const char *name,
- struct node_account_data *acc);
+void db_delete(struct connection *conn, const char *name,
+ struct node_account_data *acc);
void conn_free_buffered_data(struct connection *conn);
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstore/xenstored_transaction.c
index 378fe79763..fbcea3663e 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstore/xenstored_transaction.c
@@ -377,10 +377,8 @@ static int finalize_transaction(struct connection *conn,
/* Entries for unmodified nodes can be removed early. */
if (!i->modified) {
- if (i->ta_node) {
- if (db_delete(conn, i->trans_name, NULL))
- return EIO;
- }
+ if (i->ta_node)
+ db_delete(conn, i->trans_name, NULL);
list_del(&i->list);
talloc_free(i);
}
@@ -397,8 +395,7 @@ static int finalize_transaction(struct connection *conn,
? NODE_CREATE : NODE_MODIFY;
*is_corrupt |= db_write(conn, i->node, hdr,
size, NULL, mode, true);
- if (db_delete(conn, i->trans_name, NULL))
- *is_corrupt = true;
+ db_delete(conn, i->trans_name, NULL);
} else {
*is_corrupt = true;
}
@@ -408,9 +405,8 @@ static int finalize_transaction(struct connection *conn,
* in this transaction will have no generation
* information stored.
*/
- *is_corrupt |= (i->generation == NO_GENERATION)
- ? false
- : db_delete(conn, i->node, NULL);
+ if (i->generation != NO_GENERATION)
+ db_delete(conn, i->node, NULL);
}
if (i->fire_watch)
fire_watches(conn, trans, i->node, NULL, i->watch_exact,
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 07/19] tools/xenstore: change talloc_free() to take a const pointer
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (5 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 06/19] tools/xenstore: let db_delete() return void Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 17:53 ` Julien Grall
2023-08-14 7:46 ` [PATCH v4 08/19] tools/xenstore: move copying of node data out of db_fetch() Juergen Gross
` (12 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
With talloc_free() and related functions not taking a pointer to const
it is tedious to use the const attribute for talloc()-ed memory in
many cases.
Change the related prototypes to use "const void *" instead of
"void *".
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new patch
V4:
- add comment (Julien Grall)
---
tools/xenstore/talloc.c | 10 ++++++----
tools/xenstore/talloc.h | 4 ++--
2 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/tools/xenstore/talloc.c b/tools/xenstore/talloc.c
index 23c3a23b19..e42c7d4471 100644
--- a/tools/xenstore/talloc.c
+++ b/tools/xenstore/talloc.c
@@ -319,7 +319,7 @@ static int talloc_unreference(const void *context, const void *ptr)
remove a specific parent context from a pointer. This is a more
controlled varient of talloc_free()
*/
-int talloc_unlink(const void *context, void *ptr)
+int talloc_unlink(const void *context, const void *ptr)
{
struct talloc_chunk *tc_p, *new_p;
void *new_parent;
@@ -499,7 +499,7 @@ void *talloc_init(const char *fmt, ...)
should probably not be used in new code. It's in here to keep the talloc
code consistent across Samba 3 and 4.
*/
-static void talloc_free_children(void *ptr)
+static void talloc_free_children(const void *ptr)
{
struct talloc_chunk *tc;
@@ -539,7 +539,7 @@ static void talloc_free_children(void *ptr)
will not be freed if the ref_count is > 1 or the destructor (if
any) returns non-zero
*/
-int talloc_free(void *ptr)
+int talloc_free(const void *ptr)
{
int saved_errno = errno;
struct talloc_chunk *tc;
@@ -571,7 +571,9 @@ int talloc_free(void *ptr)
goto err;
}
tc->destructor = (talloc_destructor_t)-1;
- if (d(ptr) == -1) {
+
+ /* The destructor needs to be able to change the object! */
+ if (d((void *)ptr) == -1) {
tc->destructor = d;
goto err;
}
diff --git a/tools/xenstore/talloc.h b/tools/xenstore/talloc.h
index 518fcac151..32cee63d4d 100644
--- a/tools/xenstore/talloc.h
+++ b/tools/xenstore/talloc.h
@@ -92,7 +92,7 @@ void *_talloc(const void *context, size_t size);
void talloc_set_destructor(const void *ptr, int (*destructor)(void *));
void talloc_increase_ref_count(const void *ptr);
void *talloc_reference(const void *context, const void *ptr);
-int talloc_unlink(const void *context, void *ptr);
+int talloc_unlink(const void *context, const void *ptr);
void talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
void talloc_set_name_const(const void *ptr, const char *name);
void *talloc_named(const void *context, size_t size,
@@ -103,7 +103,7 @@ void *talloc_check_name(const void *ptr, const char *name);
void talloc_report_depth(const void *ptr, FILE *f, int depth);
void *talloc_parent(const void *ptr);
void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
-int talloc_free(void *ptr);
+int talloc_free(const void *ptr);
void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
void *talloc_steal(const void *new_ctx, const void *ptr);
off_t talloc_total_size(const void *ptr);
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 08/19] tools/xenstore: move copying of node data out of db_fetch()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (6 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 07/19] tools/xenstore: change talloc_free() to take a const pointer Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 17:55 ` Julien Grall
2023-08-14 7:46 ` [PATCH v4 09/19] tools/xenstore: rework struct xs_tdb_record_hdr Juergen Gross
` (11 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Today the node data is copied in db_fetch() on each data base read in
order to avoid accidental data base modifications when working on a
node.
read_node() is the only caller of db_fetch() which isn't freeing the
returned data area immediately after using it. The other callers don't
modify the returned data, so they don't need the data to be copied.
Move copying of the data into read_node(), resulting in a speedup of
the other callers due to no memory allocation and no copying being
needed anymore.
This allows to let db_fetch() return a pointer to const data.
As db_fetch() can't return any error other than ENOENT now, error
handling for the callers can be simplified.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V2:
- new patch
V3:
- modify return type of db_fetch() to return a pointer to const
(Julien Grall)
- drop stale comment (Julien Grall)
- fix transaction handling
V4:
- don't drop const attribute for hdr (Julien Grall)
---
tools/xenstore/xenstored_core.c | 43 ++++++++++----------------
tools/xenstore/xenstored_core.h | 2 +-
tools/xenstore/xenstored_transaction.c | 23 +++++++++-----
3 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index a08962c3ea..53e29aeb9a 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -555,10 +555,9 @@ static void initialize_fds(int *p_sock_pollfd_idx, int *ptimeout)
}
}
-struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
+const struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
{
const struct xs_tdb_record_hdr *hdr;
- struct xs_tdb_record_hdr *p;
hdr = hashtable_search(nodes, db_name);
if (!hdr) {
@@ -569,22 +568,15 @@ struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
*size = sizeof(*hdr) + hdr->num_perms * sizeof(hdr->perms[0]) +
hdr->datalen + hdr->childlen;
- /* Return a copy, avoiding a potential modification in the DB. */
- p = talloc_memdup(NULL, hdr, *size);
- if (!p) {
- errno = ENOMEM;
- return NULL;
- }
-
trace_tdb("read %s size %zu\n", db_name, *size + strlen(db_name));
- return p;
+ return hdr;
}
static void get_acc_data(const char *name, struct node_account_data *acc)
{
size_t size;
- struct xs_tdb_record_hdr *hdr;
+ const struct xs_tdb_record_hdr *hdr;
if (acc->memory < 0) {
hdr = db_fetch(name, &size);
@@ -595,7 +587,6 @@ static void get_acc_data(const char *name, struct node_account_data *acc)
acc->memory = size;
acc->domid = hdr->perms[0].id;
}
- talloc_free(hdr);
}
}
@@ -708,7 +699,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
const char *name)
{
size_t size;
- struct xs_tdb_record_hdr *hdr;
+ const struct xs_tdb_record_hdr *hdr;
struct node *node;
const char *db_name;
int err;
@@ -729,30 +720,30 @@ struct node *read_node(struct connection *conn, const void *ctx,
hdr = db_fetch(db_name, &size);
if (hdr == NULL) {
- if (errno == ENOENT) {
- node->generation = NO_GENERATION;
- err = access_node(conn, node, NODE_ACCESS_READ, NULL);
- errno = err ? : ENOENT;
- } else {
- log("DB error on read: %s", strerror(errno));
- errno = EIO;
- }
+ node->generation = NO_GENERATION;
+ err = access_node(conn, node, NODE_ACCESS_READ, NULL);
+ errno = err ? : ENOENT;
goto error;
}
node->parent = NULL;
- talloc_steal(node, hdr);
/* Datalen, childlen, number of permissions */
node->generation = hdr->generation;
node->perms.num = hdr->num_perms;
node->datalen = hdr->datalen;
node->childlen = hdr->childlen;
-
- /* Permissions are struct xs_permissions. */
- node->perms.p = hdr->perms;
- node->acc.domid = get_node_owner(node);
+ node->acc.domid = hdr->perms[0].id;
node->acc.memory = size;
+
+ /* Copy node data to new memory area, starting with permissions. */
+ size -= sizeof(*hdr);
+ node->perms.p = talloc_memdup(node, hdr->perms, size);
+ if (node->perms.p == NULL) {
+ errno = ENOMEM;
+ goto error;
+ }
+
if (domain_adjust_node_perms(node))
goto error;
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index e1aeb4aecd..4a370f766f 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -362,7 +362,7 @@ extern xengnttab_handle **xgt_handle;
int remember_string(struct hashtable *hash, const char *str);
/* Data base access functions. */
-struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size);
+const struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size);
int db_write(struct connection *conn, const char *db_name, void *data,
size_t size, struct node_account_data *acc,
enum write_node_mode mode, bool no_quota_check);
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstore/xenstored_transaction.c
index fbcea3663e..a90283dcc5 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstore/xenstored_transaction.c
@@ -357,20 +357,17 @@ static int finalize_transaction(struct connection *conn,
{
struct accessed_node *i, *n;
size_t size;
- struct xs_tdb_record_hdr *hdr;
+ const struct xs_tdb_record_hdr *hdr;
uint64_t gen;
list_for_each_entry_safe(i, n, &trans->accessed, list) {
if (i->check_gen) {
hdr = db_fetch(i->node, &size);
if (!hdr) {
- if (errno != ENOENT)
- return errno;
gen = NO_GENERATION;
} else {
gen = hdr->generation;
}
- talloc_free(hdr);
if (i->generation != gen)
return EAGAIN;
}
@@ -388,14 +385,26 @@ static int finalize_transaction(struct connection *conn,
if (i->ta_node) {
hdr = db_fetch(i->trans_name, &size);
if (hdr) {
+ /*
+ * Delete transaction entry and write it as
+ * no-TA entry. As we only hold a reference
+ * to the data, increment its ref count, then
+ * delete it from the DB. Now we own it and can
+ * drop the const attribute for changing the
+ * generation count.
+ */
enum write_node_mode mode;
+ struct xs_tdb_record_hdr *own;
- hdr->generation = ++generation;
+ talloc_increase_ref_count(hdr);
+ db_delete(conn, i->trans_name, NULL);
+
+ own = (struct xs_tdb_record_hdr *)hdr;
+ own->generation = ++generation;
mode = (i->generation == NO_GENERATION)
? NODE_CREATE : NODE_MODIFY;
- *is_corrupt |= db_write(conn, i->node, hdr,
+ *is_corrupt |= db_write(conn, i->node, own,
size, NULL, mode, true);
- db_delete(conn, i->trans_name, NULL);
} else {
*is_corrupt = true;
}
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 08/19] tools/xenstore: move copying of node data out of db_fetch()
2023-08-14 7:46 ` [PATCH v4 08/19] tools/xenstore: move copying of node data out of db_fetch() Juergen Gross
@ 2023-08-14 17:55 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-14 17:55 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:46, Juergen Gross wrote:
> Today the node data is copied in db_fetch() on each data base read in
> order to avoid accidental data base modifications when working on a
> node.
>
> read_node() is the only caller of db_fetch() which isn't freeing the
> returned data area immediately after using it. The other callers don't
> modify the returned data, so they don't need the data to be copied.
>
> Move copying of the data into read_node(), resulting in a speedup of
> the other callers due to no memory allocation and no copying being
> needed anymore.
>
> This allows to let db_fetch() return a pointer to const data.
>
> As db_fetch() can't return any error other than ENOENT now, error
> handling for the callers can be simplified.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 09/19] tools/xenstore: rework struct xs_tdb_record_hdr
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (7 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 08/19] tools/xenstore: move copying of node data out of db_fetch() Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 18:04 ` Julien Grall
2023-08-14 7:46 ` [PATCH v4 10/19] tools/xenstore: don't use struct node_perms in struct node Juergen Gross
` (10 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Struct xs_tdb_record_hdr is used for nodes stored in the data base.
When working on a node, struct node is being used, which is including
the same information as struct xs_tdb_record_hdr, but in a different
format. Rework struct xs_tdb_record_hdr in order to prepare including
it in struct node.
Do the following modifications:
- move its definition to xenstored_core.h, as the reason to put it into
utils.h are no longer existing
- rename it to struct node_hdr, as the "tdb" in its name has only
historical reasons
- replace the empty permission array at the end with a comment about
the layout of data in the data base (concatenation of header,
permissions, node contents, and children list)
- use narrower types for num_perms and datalen, as those are naturally
limited to XENSTORE_PAYLOAD_MAX (childlen is different here, as it is
in theory basically unlimited)
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V2:
- new patch
V4:
- add BUILD_BUG_ON() for verifying datalen can hold large enough value
for XENSTORE_PAYLOAD_MAX (Julien Grall)
- let perms_from_node_hdr() return const (Julien Grall)
- open code perms_from_node_hdr() for the non-const case (Julien Grall)
---
tools/xenstore/utils.h | 9 -----
tools/xenstore/xenstored_core.c | 46 +++++++++++++++++---------
tools/xenstore/xenstored_core.h | 20 ++++++++++-
tools/xenstore/xenstored_transaction.c | 6 ++--
4 files changed, 53 insertions(+), 28 deletions(-)
diff --git a/tools/xenstore/utils.h b/tools/xenstore/utils.h
index 028ecb9d7a..405d662ea2 100644
--- a/tools/xenstore/utils.h
+++ b/tools/xenstore/utils.h
@@ -9,15 +9,6 @@
#include "xenstore_lib.h"
-/* Header of the node record in tdb. */
-struct xs_tdb_record_hdr {
- uint64_t generation;
- uint32_t num_perms;
- uint32_t datalen;
- uint32_t childlen;
- struct xs_permissions perms[0];
-};
-
/* Is A == B ? */
#define streq(a,b) (strcmp((a),(b)) == 0)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index 53e29aeb9a..9fc17a9efc 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -555,9 +555,9 @@ static void initialize_fds(int *p_sock_pollfd_idx, int *ptimeout)
}
}
-const struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
+const struct node_hdr *db_fetch(const char *db_name, size_t *size)
{
- const struct xs_tdb_record_hdr *hdr;
+ const struct node_hdr *hdr;
hdr = hashtable_search(nodes, db_name);
if (!hdr) {
@@ -565,7 +565,7 @@ const struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
return NULL;
}
- *size = sizeof(*hdr) + hdr->num_perms * sizeof(hdr->perms[0]) +
+ *size = sizeof(*hdr) + hdr->num_perms * sizeof(struct xs_permissions) +
hdr->datalen + hdr->childlen;
trace_tdb("read %s size %zu\n", db_name, *size + strlen(db_name));
@@ -573,10 +573,16 @@ const struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size)
return hdr;
}
+static const struct xs_permissions *perms_from_node_hdr(
+ const struct node_hdr *hdr)
+{
+ return (const struct xs_permissions *)(hdr + 1);
+}
+
static void get_acc_data(const char *name, struct node_account_data *acc)
{
size_t size;
- const struct xs_tdb_record_hdr *hdr;
+ const struct node_hdr *hdr;
if (acc->memory < 0) {
hdr = db_fetch(name, &size);
@@ -585,7 +591,7 @@ static void get_acc_data(const char *name, struct node_account_data *acc)
acc->memory = 0;
} else {
acc->memory = size;
- acc->domid = hdr->perms[0].id;
+ acc->domid = perms_from_node_hdr(hdr)->id;
}
}
}
@@ -606,7 +612,7 @@ int db_write(struct connection *conn, const char *db_name, void *data,
size_t size, struct node_account_data *acc,
enum write_node_mode mode, bool no_quota_check)
{
- struct xs_tdb_record_hdr *hdr = data;
+ const struct node_hdr *hdr = data;
struct node_account_data old_acc = {};
unsigned int old_domid, new_domid;
size_t name_len = strlen(db_name);
@@ -620,7 +626,7 @@ int db_write(struct connection *conn, const char *db_name, void *data,
get_acc_data(db_name, &old_acc);
old_domid = get_acc_domid(conn, db_name, old_acc.domid);
- new_domid = get_acc_domid(conn, db_name, hdr->perms[0].id);
+ new_domid = get_acc_domid(conn, db_name, perms_from_node_hdr(hdr)->id);
/*
* Don't check for ENOENT, as we want to be able to switch orphaned
@@ -661,7 +667,7 @@ int db_write(struct connection *conn, const char *db_name, void *data,
if (acc) {
/* Don't use new_domid, as it might be a transaction node. */
- acc->domid = hdr->perms[0].id;
+ acc->domid = perms_from_node_hdr(hdr)->id;
acc->memory = size;
}
@@ -699,7 +705,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
const char *name)
{
size_t size;
- const struct xs_tdb_record_hdr *hdr;
+ const struct node_hdr *hdr;
struct node *node;
const char *db_name;
int err;
@@ -733,12 +739,12 @@ struct node *read_node(struct connection *conn, const void *ctx,
node->perms.num = hdr->num_perms;
node->datalen = hdr->datalen;
node->childlen = hdr->childlen;
- node->acc.domid = hdr->perms[0].id;
+ node->acc.domid = perms_from_node_hdr(hdr)->id;
node->acc.memory = size;
/* Copy node data to new memory area, starting with permissions. */
size -= sizeof(*hdr);
- node->perms.p = talloc_memdup(node, hdr->perms, size);
+ node->perms.p = talloc_memdup(node, perms_from_node_hdr(hdr), size);
if (node->perms.p == NULL) {
errno = ENOMEM;
goto error;
@@ -785,7 +791,7 @@ int write_node_raw(struct connection *conn, const char *db_name,
void *data;
size_t size;
void *p;
- struct xs_tdb_record_hdr *hdr;
+ struct node_hdr *hdr;
if (domain_adjust_node_perms(node))
return errno;
@@ -806,15 +812,18 @@ int write_node_raw(struct connection *conn, const char *db_name,
return errno;
}
+ BUILD_BUG_ON(XENSTORE_PAYLOAD_MAX >= (typeof(hdr->datalen))(-1));
+
hdr = data;
hdr->generation = node->generation;
hdr->num_perms = node->perms.num;
hdr->datalen = node->datalen;
hdr->childlen = node->childlen;
- memcpy(hdr->perms, node->perms.p,
- node->perms.num * sizeof(*node->perms.p));
- p = hdr->perms + node->perms.num;
+ /* Open code perms_from_node_hdr() for the non-const case. */
+ p = hdr + 1;
+ memcpy(p, node->perms.p, node->perms.num * sizeof(*node->perms.p));
+ p += node->perms.num * sizeof(*node->perms.p);
memcpy(p, node->data, node->datalen);
p += node->datalen;
memcpy(p, node->children, node->childlen);
@@ -2144,6 +2153,13 @@ static void handle_input(struct connection *conn)
if (in->used != sizeof(in->hdr))
return;
+ /*
+ * The payload size is not only currently restricted by
+ * the protocol but also the internal implementation
+ * (see various BUILD_BUG_ON()).
+ * Any potential change of the maximum payload size
+ * needs to be negotiated between the involved parties.
+ */
if (in->hdr.msg.len > XENSTORE_PAYLOAD_MAX) {
syslog(LOG_ERR, "Client tried to feed us %i",
in->hdr.msg.len);
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index 4a370f766f..1a933892e3 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -168,6 +168,24 @@ struct connection
};
extern struct list_head connections;
+/*
+ * Header of the node record in the data base.
+ * In the data base the memory of the node is a single memory chunk with the
+ * following format:
+ * struct {
+ * node_hdr hdr;
+ * struct xs_permissions perms[hdr.num_perms];
+ * char data[hdr.datalen];
+ * char children[hdr.childlen];
+ * };
+ */
+struct node_hdr {
+ uint64_t generation;
+ uint16_t num_perms;
+ uint16_t datalen;
+ uint32_t childlen;
+};
+
struct node_perms {
unsigned int num;
struct xs_permissions *p;
@@ -362,7 +380,7 @@ extern xengnttab_handle **xgt_handle;
int remember_string(struct hashtable *hash, const char *str);
/* Data base access functions. */
-const struct xs_tdb_record_hdr *db_fetch(const char *db_name, size_t *size);
+const struct node_hdr *db_fetch(const char *db_name, size_t *size);
int db_write(struct connection *conn, const char *db_name, void *data,
size_t size, struct node_account_data *acc,
enum write_node_mode mode, bool no_quota_check);
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstore/xenstored_transaction.c
index a90283dcc5..9ca73b9874 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstore/xenstored_transaction.c
@@ -357,7 +357,7 @@ static int finalize_transaction(struct connection *conn,
{
struct accessed_node *i, *n;
size_t size;
- const struct xs_tdb_record_hdr *hdr;
+ const struct node_hdr *hdr;
uint64_t gen;
list_for_each_entry_safe(i, n, &trans->accessed, list) {
@@ -394,12 +394,12 @@ static int finalize_transaction(struct connection *conn,
* generation count.
*/
enum write_node_mode mode;
- struct xs_tdb_record_hdr *own;
+ struct node_hdr *own;
talloc_increase_ref_count(hdr);
db_delete(conn, i->trans_name, NULL);
- own = (struct xs_tdb_record_hdr *)hdr;
+ own = (struct node_hdr *)hdr;
own->generation = ++generation;
mode = (i->generation == NO_GENERATION)
? NODE_CREATE : NODE_MODIFY;
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 09/19] tools/xenstore: rework struct xs_tdb_record_hdr
2023-08-14 7:46 ` [PATCH v4 09/19] tools/xenstore: rework struct xs_tdb_record_hdr Juergen Gross
@ 2023-08-14 18:04 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-14 18:04 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:46, Juergen Gross wrote:
> Struct xs_tdb_record_hdr is used for nodes stored in the data base.
> When working on a node, struct node is being used, which is including
> the same information as struct xs_tdb_record_hdr, but in a different
> format. Rework struct xs_tdb_record_hdr in order to prepare including
> it in struct node.
>
> Do the following modifications:
>
> - move its definition to xenstored_core.h, as the reason to put it into
> utils.h are no longer existing
>
> - rename it to struct node_hdr, as the "tdb" in its name has only
> historical reasons
>
> - replace the empty permission array at the end with a comment about
> the layout of data in the data base (concatenation of header,
> permissions, node contents, and children list)
>
> - use narrower types for num_perms and datalen, as those are naturally
> limited to XENSTORE_PAYLOAD_MAX (childlen is different here, as it is
> in theory basically unlimited)
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 10/19] tools/xenstore: don't use struct node_perms in struct node
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (8 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 09/19] tools/xenstore: rework struct xs_tdb_record_hdr Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-14 18:09 ` Julien Grall
2023-08-14 7:46 ` [PATCH v4 11/19] tools/xenstore: use struct node_hdr " Juergen Gross
` (9 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Open code struct node_perms in struct node in order to prepare using
struct node_hdr in struct node.
Add two helpers to transfer permissions between struct node and struct
node_perms and a helper to directly get connection base permissions
from a node.
Let perms_to_strings() take a struct node as parameter and rename it
to node_perms_to_strings().
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V2:
- new patch
V4:
- add perm_for_conn_from_node() helper (Julien Grall)
- let perms_to_strings() take the node as parameter (Julien Grall)
- rename perms_to_strings()
---
tools/xenstore/xenstored_core.c | 86 +++++++++++++-------------
tools/xenstore/xenstored_core.h | 31 +++++++++-
tools/xenstore/xenstored_domain.c | 13 ++--
tools/xenstore/xenstored_transaction.c | 8 +--
tools/xenstore/xenstored_watch.c | 4 +-
5 files changed, 83 insertions(+), 59 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index 9fc17a9efc..d7a4f0f1cb 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -736,7 +736,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
/* Datalen, childlen, number of permissions */
node->generation = hdr->generation;
- node->perms.num = hdr->num_perms;
+ node->num_perms = hdr->num_perms;
node->datalen = hdr->datalen;
node->childlen = hdr->childlen;
node->acc.domid = perms_from_node_hdr(hdr)->id;
@@ -744,8 +744,8 @@ struct node *read_node(struct connection *conn, const void *ctx,
/* Copy node data to new memory area, starting with permissions. */
size -= sizeof(*hdr);
- node->perms.p = talloc_memdup(node, perms_from_node_hdr(hdr), size);
- if (node->perms.p == NULL) {
+ node->perms = talloc_memdup(node, perms_from_node_hdr(hdr), size);
+ if (node->perms == NULL) {
errno = ENOMEM;
goto error;
}
@@ -758,7 +758,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
node->acc.memory = 0;
/* Data is binary blob (usually ascii, no nul). */
- node->data = node->perms.p + hdr->num_perms;
+ node->data = node->perms + hdr->num_perms;
/* Children is strings, nul separated. */
node->children = node->data + node->datalen;
@@ -797,7 +797,7 @@ int write_node_raw(struct connection *conn, const char *db_name,
return errno;
size = sizeof(*hdr)
- + node->perms.num * sizeof(node->perms.p[0])
+ + node->num_perms * sizeof(node->perms[0])
+ node->datalen + node->childlen;
/* Call domain_max_chk() in any case in order to record max values. */
@@ -816,14 +816,14 @@ int write_node_raw(struct connection *conn, const char *db_name,
hdr = data;
hdr->generation = node->generation;
- hdr->num_perms = node->perms.num;
+ hdr->num_perms = node->num_perms;
hdr->datalen = node->datalen;
hdr->childlen = node->childlen;
/* Open code perms_from_node_hdr() for the non-const case. */
p = hdr + 1;
- memcpy(p, node->perms.p, node->perms.num * sizeof(*node->perms.p));
- p += node->perms.num * sizeof(*node->perms.p);
+ memcpy(p, node->perms, node->num_perms * sizeof(*node->perms));
+ p += node->num_perms * sizeof(*node->perms);
memcpy(p, node->data, node->datalen);
p += node->datalen;
memcpy(p, node->children, node->childlen);
@@ -923,7 +923,8 @@ static int ask_parents(struct connection *conn, const void *ctx,
return 0;
}
- *perm = perm_for_conn(conn, &node->perms);
+ *perm = perm_for_conn_from_node(conn, node);
+
return 0;
}
@@ -963,11 +964,9 @@ static struct node *get_node(struct connection *conn,
node = read_node(conn, ctx, name);
/* If we don't have permission, we don't have node. */
- if (node) {
- if ((perm_for_conn(conn, &node->perms) & perm) != perm) {
- errno = EACCES;
- node = NULL;
- }
+ if (node && (perm_for_conn_from_node(conn, node) & perm) != perm) {
+ errno = EACCES;
+ node = NULL;
}
/* Clean up errno if they weren't supposed to know. */
if (!node && !read_node_can_propagate_errno())
@@ -1211,19 +1210,18 @@ const char *onearg(struct buffered_data *in)
return in->buffer;
}
-static char *perms_to_strings(const void *ctx, const struct node_perms *perms,
- unsigned int *len)
+static char *node_perms_to_strings(const struct node *node, unsigned int *len)
{
unsigned int i;
char *strings = NULL;
char buffer[MAX_STRLEN(unsigned int) + 1];
- for (*len = 0, i = 0; i < perms->num; i++) {
- if (!xenstore_perm_to_string(&perms->p[i], buffer,
+ for (*len = 0, i = 0; i < node->num_perms; i++) {
+ if (!xenstore_perm_to_string(&node->perms[i], buffer,
sizeof(buffer)))
return NULL;
- strings = talloc_realloc(ctx, strings, char,
+ strings = talloc_realloc(node, strings, char,
*len + strlen(buffer) + 1);
if (!strings)
return NULL;
@@ -1438,14 +1436,14 @@ static struct node *construct_node(struct connection *conn, const void *ctx,
node->name = talloc_steal(node, names[levels - 1]);
/* Inherit permissions, unpriv domains own what they create. */
- node->perms.num = parent->perms.num;
- node->perms.p = talloc_memdup(node, parent->perms.p,
- node->perms.num *
- sizeof(*node->perms.p));
- if (!node->perms.p)
+ node->num_perms = parent->num_perms;
+ node->perms = talloc_memdup(node, parent->perms,
+ node->num_perms *
+ sizeof(*node->perms));
+ if (!node->perms)
goto nomem;
if (domain_is_unprivileged(conn))
- node->perms.p[0].id = conn->id;
+ node->perms[0].id = conn->id;
/* No children, no data */
node->children = node->data = NULL;
@@ -1773,7 +1771,7 @@ static int do_get_perms(const void *ctx, struct connection *conn,
if (!node)
return errno;
- strings = perms_to_strings(node, &node->perms, &len);
+ strings = node_perms_to_strings(node, &len);
if (!strings)
return errno;
@@ -1822,10 +1820,10 @@ static int do_set_perms(const void *ctx, struct connection *conn,
perms.p[0].id != get_node_owner(node))
return EPERM;
- old_perms = node->perms;
+ node_to_node_perms(node, &old_perms);
if (domain_nbentry_dec(conn, get_node_owner(node)))
return ENOMEM;
- node->perms = perms;
+ node_perms_to_node(&perms, node);
if (domain_nbentry_inc(conn, get_node_owner(node)))
return ENOMEM;
@@ -2344,8 +2342,8 @@ static void manual_node(const char *name, const char *child)
barf_perror("Could not allocate initial node %s", name);
node->name = name;
- node->perms.p = &perms;
- node->perms.num = 1;
+ node->perms = &perms;
+ node->num_perms = 1;
node->children = (char *)child;
if (child)
node->childlen = strlen(child) + 1;
@@ -3216,10 +3214,10 @@ static int dump_state_node(const void *ctx, struct connection *conn,
sn.conn_id = 0;
sn.ta_id = 0;
sn.ta_access = 0;
- sn.perm_n = node->perms.num;
+ sn.perm_n = node->num_perms;
sn.path_len = pathlen;
sn.data_len = node->datalen;
- head.length += node->perms.num * sizeof(*sn.perms);
+ head.length += node->num_perms * sizeof(*sn.perms);
head.length += pathlen;
head.length += node->datalen;
head.length = ROUNDUP(head.length, 3);
@@ -3229,7 +3227,7 @@ static int dump_state_node(const void *ctx, struct connection *conn,
if (fwrite(&sn, sizeof(sn), 1, fp) != 1)
return dump_state_node_err(data, "Dump node state error");
- ret = dump_state_node_perms(fp, node->perms.p, node->perms.num);
+ ret = dump_state_node_perms(fp, node->perms, node->num_perms);
if (ret)
return dump_state_node_err(data, ret);
@@ -3426,29 +3424,29 @@ void read_state_node(const void *ctx, const void *state)
node->data = name + sn->path_len;
node->childlen = 0;
node->children = NULL;
- node->perms.num = sn->perm_n;
- node->perms.p = talloc_array(node, struct xs_permissions,
- node->perms.num);
- if (!node->perms.p)
+ node->num_perms = sn->perm_n;
+ node->perms = talloc_array(node, struct xs_permissions,
+ node->num_perms);
+ if (!node->perms)
barf("allocation error restoring node");
- for (i = 0; i < node->perms.num; i++) {
+ for (i = 0; i < node->num_perms; i++) {
switch (sn->perms[i].access) {
case 'r':
- node->perms.p[i].perms = XS_PERM_READ;
+ node->perms[i].perms = XS_PERM_READ;
break;
case 'w':
- node->perms.p[i].perms = XS_PERM_WRITE;
+ node->perms[i].perms = XS_PERM_WRITE;
break;
case 'b':
- node->perms.p[i].perms = XS_PERM_READ | XS_PERM_WRITE;
+ node->perms[i].perms = XS_PERM_READ | XS_PERM_WRITE;
break;
default:
- node->perms.p[i].perms = XS_PERM_NONE;
+ node->perms[i].perms = XS_PERM_NONE;
break;
}
if (sn->perms[i].flags & XS_STATE_NODE_PERM_IGNORE)
- node->perms.p[i].perms |= XS_PERM_IGNORE;
- node->perms.p[i].id = sn->perms[i].domid;
+ node->perms[i].perms |= XS_PERM_IGNORE;
+ node->perms[i].id = sn->perms[i].domid;
}
if (!strstarts(name, "@")) {
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index 1a933892e3..4bed462dda 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -209,7 +209,8 @@ struct node {
#define NO_GENERATION ~((uint64_t)0)
/* Permissions. */
- struct node_perms perms;
+ unsigned int num_perms;
+ struct xs_permissions *perms;
/* Contents. */
unsigned int datalen;
@@ -251,7 +252,33 @@ unsigned int perm_for_conn(struct connection *conn,
/* Get owner of a node. */
static inline unsigned int get_node_owner(const struct node *node)
{
- return node->perms.p[0].id;
+ return node->perms[0].id;
+}
+
+/* Transfer permissions from node to struct node_perms. */
+static inline void node_to_node_perms(const struct node *node,
+ struct node_perms *perms)
+{
+ perms->num = node->num_perms;
+ perms->p = node->perms;
+}
+
+static inline unsigned int perm_for_conn_from_node(struct connection *conn,
+ const struct node *node)
+{
+ struct node_perms perms;
+
+ node_to_node_perms(node, &perms);
+
+ return perm_for_conn(conn, &perms);
+}
+
+/* Transfer permissions from struct node_perms to node. */
+static inline void node_perms_to_node(const struct node_perms *perms,
+ struct node *node)
+{
+ node->num_perms = perms->num;
+ node->perms = perms->p;
}
/* Write a node to the data base. */
diff --git a/tools/xenstore/xenstored_domain.c b/tools/xenstore/xenstored_domain.c
index 10d2280f84..1ba73d9db2 100644
--- a/tools/xenstore/xenstored_domain.c
+++ b/tools/xenstore/xenstored_domain.c
@@ -513,12 +513,12 @@ static int domain_tree_remove_sub(const void *ctx, struct connection *conn,
struct domain *domain = arg;
int ret = WALK_TREE_OK;
- if (node->perms.p[0].id != domain->domid)
+ if (node->perms[0].id != domain->domid)
return WALK_TREE_OK;
if (keep_orphans) {
domain_nbentry_dec(NULL, domain->domid);
- node->perms.p[0].id = priv_domid;
+ node->perms[0].id = priv_domid;
node->acc.memory = 0;
domain_nbentry_inc(NULL, priv_domid);
if (write_node_raw(NULL, node->name, node, NODE_MODIFY, true)) {
@@ -1335,12 +1335,11 @@ int domain_adjust_node_perms(struct node *node)
{
unsigned int i;
- for (i = 1; i < node->perms.num; i++) {
- if (node->perms.p[i].perms & XS_PERM_IGNORE)
+ for (i = 1; i < node->num_perms; i++) {
+ if (node->perms[i].perms & XS_PERM_IGNORE)
continue;
- if (!chk_domain_generation(node->perms.p[i].id,
- node->generation))
- node->perms.p[i].perms |= XS_PERM_IGNORE;
+ if (!chk_domain_generation(node->perms[i].id, node->generation))
+ node->perms[i].perms |= XS_PERM_IGNORE;
}
return 0;
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstore/xenstored_transaction.c
index 9ca73b9874..213a2c436c 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstore/xenstored_transaction.c
@@ -259,13 +259,13 @@ int access_node(struct connection *conn, struct node *node,
if (!i->trans_name)
goto nomem;
i->node = strchr(i->trans_name, '/') + 1;
- if (node->generation != NO_GENERATION && node->perms.num) {
+ if (node->generation != NO_GENERATION && node->num_perms) {
i->perms.p = talloc_array(i, struct xs_permissions,
- node->perms.num);
+ node->num_perms);
if (!i->perms.p)
goto nomem;
- i->perms.num = node->perms.num;
- memcpy(i->perms.p, node->perms.p,
+ i->perms.num = node->num_perms;
+ memcpy(i->perms.p, node->perms,
i->perms.num * sizeof(*i->perms.p));
}
diff --git a/tools/xenstore/xenstored_watch.c b/tools/xenstore/xenstored_watch.c
index fefbf56ab2..5767675e04 100644
--- a/tools/xenstore/xenstored_watch.c
+++ b/tools/xenstore/xenstored_watch.c
@@ -92,7 +92,7 @@ static bool watch_permitted(struct connection *conn, const void *ctx,
return false;
}
- perm = perm_for_conn(conn, &node->perms);
+ perm = perm_for_conn_from_node(conn, node);
if (perm & XS_PERM_READ)
return true;
@@ -106,7 +106,7 @@ static bool watch_permitted(struct connection *conn, const void *ctx,
return false;
}
- perm = perm_for_conn(conn, &parent->perms);
+ perm = perm_for_conn_from_node(conn, parent);
return perm & XS_PERM_READ;
}
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 10/19] tools/xenstore: don't use struct node_perms in struct node
2023-08-14 7:46 ` [PATCH v4 10/19] tools/xenstore: don't use struct node_perms in struct node Juergen Gross
@ 2023-08-14 18:09 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-14 18:09 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:46, Juergen Gross wrote:
> Open code struct node_perms in struct node in order to prepare using
> struct node_hdr in struct node.
>
> Add two helpers to transfer permissions between struct node and struct
> node_perms and a helper to directly get connection base permissions
> from a node.
>
> Let perms_to_strings() take a struct node as parameter and rename it
> to node_perms_to_strings().
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 11/19] tools/xenstore: use struct node_hdr in struct node
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (9 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 10/19] tools/xenstore: don't use struct node_perms in struct node Juergen Gross
@ 2023-08-14 7:46 ` Juergen Gross
2023-08-18 10:57 ` Julien Grall
2023-08-14 7:47 ` [PATCH v4 12/19] tools/xenstore: alloc new memory in domain_adjust_node_perms() Juergen Gross
` (8 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:46 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Replace some individual fields in struct node with struct node_hdr.
This allows to add a helper for calculating the accounted memory size
of a node.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V2:
- new patch
V4:
- add const to parameter of calc_node_acc_size()
- modify comment (Julien Grall)
---
tools/xenstore/xenstored_core.c | 110 ++++++++++++-------------
tools/xenstore/xenstored_core.h | 16 ++--
tools/xenstore/xenstored_domain.c | 5 +-
tools/xenstore/xenstored_transaction.c | 13 +--
4 files changed, 72 insertions(+), 72 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index d7a4f0f1cb..ab4714263d 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -555,6 +555,12 @@ static void initialize_fds(int *p_sock_pollfd_idx, int *ptimeout)
}
}
+static size_t calc_node_acc_size(const struct node_hdr *hdr)
+{
+ return sizeof(*hdr) + hdr->num_perms * sizeof(struct xs_permissions) +
+ hdr->datalen + hdr->childlen;
+}
+
const struct node_hdr *db_fetch(const char *db_name, size_t *size)
{
const struct node_hdr *hdr;
@@ -565,8 +571,7 @@ const struct node_hdr *db_fetch(const char *db_name, size_t *size)
return NULL;
}
- *size = sizeof(*hdr) + hdr->num_perms * sizeof(struct xs_permissions) +
- hdr->datalen + hdr->childlen;
+ *size = calc_node_acc_size(hdr);
trace_tdb("read %s size %zu\n", db_name, *size + strlen(db_name));
@@ -726,7 +731,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
hdr = db_fetch(db_name, &size);
if (hdr == NULL) {
- node->generation = NO_GENERATION;
+ node->hdr.generation = NO_GENERATION;
err = access_node(conn, node, NODE_ACCESS_READ, NULL);
errno = err ? : ENOENT;
goto error;
@@ -735,10 +740,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
node->parent = NULL;
/* Datalen, childlen, number of permissions */
- node->generation = hdr->generation;
- node->num_perms = hdr->num_perms;
- node->datalen = hdr->datalen;
- node->childlen = hdr->childlen;
+ node->hdr = *hdr;
node->acc.domid = perms_from_node_hdr(hdr)->id;
node->acc.memory = size;
@@ -760,7 +762,7 @@ struct node *read_node(struct connection *conn, const void *ctx,
/* Data is binary blob (usually ascii, no nul). */
node->data = node->perms + hdr->num_perms;
/* Children is strings, nul separated. */
- node->children = node->data + node->datalen;
+ node->children = node->data + node->hdr.datalen;
if (access_node(conn, node, NODE_ACCESS_READ, NULL))
goto error;
@@ -796,9 +798,7 @@ int write_node_raw(struct connection *conn, const char *db_name,
if (domain_adjust_node_perms(node))
return errno;
- size = sizeof(*hdr)
- + node->num_perms * sizeof(node->perms[0])
- + node->datalen + node->childlen;
+ size = calc_node_acc_size(&node->hdr);
/* Call domain_max_chk() in any case in order to record max values. */
if (domain_max_chk(conn, ACC_NODESZ, size) && !no_quota_check) {
@@ -815,18 +815,15 @@ int write_node_raw(struct connection *conn, const char *db_name,
BUILD_BUG_ON(XENSTORE_PAYLOAD_MAX >= (typeof(hdr->datalen))(-1));
hdr = data;
- hdr->generation = node->generation;
- hdr->num_perms = node->num_perms;
- hdr->datalen = node->datalen;
- hdr->childlen = node->childlen;
+ *hdr = node->hdr;
/* Open code perms_from_node_hdr() for the non-const case. */
p = hdr + 1;
- memcpy(p, node->perms, node->num_perms * sizeof(*node->perms));
- p += node->num_perms * sizeof(*node->perms);
- memcpy(p, node->data, node->datalen);
- p += node->datalen;
- memcpy(p, node->children, node->childlen);
+ memcpy(p, node->perms, node->hdr.num_perms * sizeof(*node->perms));
+ p += node->hdr.num_perms * sizeof(*node->perms);
+ memcpy(p, node->data, node->hdr.datalen);
+ p += node->hdr.datalen;
+ memcpy(p, node->children, node->hdr.childlen);
if (db_write(conn, db_name, data, size, &node->acc, mode,
no_quota_check))
@@ -1216,7 +1213,7 @@ static char *node_perms_to_strings(const struct node *node, unsigned int *len)
char *strings = NULL;
char buffer[MAX_STRLEN(unsigned int) + 1];
- for (*len = 0, i = 0; i < node->num_perms; i++) {
+ for (*len = 0, i = 0; i < node->hdr.num_perms; i++) {
if (!xenstore_perm_to_string(&node->perms[i], buffer,
sizeof(buffer)))
return NULL;
@@ -1287,7 +1284,7 @@ static int send_directory(const void *ctx, struct connection *conn,
if (!node)
return errno;
- send_reply(conn, XS_DIRECTORY, node->children, node->childlen);
+ send_reply(conn, XS_DIRECTORY, node->children, node->hdr.childlen);
return 0;
}
@@ -1312,10 +1309,11 @@ static int send_directory_part(const void *ctx, struct connection *conn,
/* Second arg is childlist offset. */
off = atoi(in->buffer + strlen(in->buffer) + 1);
- genlen = snprintf(gen, sizeof(gen), "%"PRIu64, node->generation) + 1;
+ genlen = snprintf(gen, sizeof(gen), "%"PRIu64, node->hdr.generation) +
+ 1;
/* Offset behind list: just return a list with an empty string. */
- if (off >= node->childlen) {
+ if (off >= node->hdr.childlen) {
gen[genlen] = 0;
send_reply(conn, XS_DIRECTORY_PART, gen, genlen + 1);
return 0;
@@ -1328,7 +1326,7 @@ static int send_directory_part(const void *ctx, struct connection *conn,
while (len + strlen(child) < maxlen) {
len += strlen(child) + 1;
child += strlen(child) + 1;
- if (off + len == node->childlen)
+ if (off + len == node->hdr.childlen)
break;
}
@@ -1338,7 +1336,7 @@ static int send_directory_part(const void *ctx, struct connection *conn,
memcpy(data, gen, genlen);
memcpy(data + genlen, node->children + off, len);
- if (off + len == node->childlen) {
+ if (off + len == node->hdr.childlen) {
data[genlen + len] = 0;
len++;
}
@@ -1358,7 +1356,7 @@ static int do_read(const void *ctx, struct connection *conn,
if (!node)
return errno;
- send_reply(conn, XS_READ, node->data, node->datalen);
+ send_reply(conn, XS_READ, node->data, node->hdr.datalen);
return 0;
}
@@ -1377,13 +1375,13 @@ static int add_child(const void *ctx, struct node *parent, const char *name)
base = basename(name);
baselen = strlen(base) + 1;
- children = talloc_array(ctx, char, parent->childlen + baselen);
+ children = talloc_array(ctx, char, parent->hdr.childlen + baselen);
if (!children)
return ENOMEM;
- memcpy(children, parent->children, parent->childlen);
- memcpy(children + parent->childlen, base, baselen);
+ memcpy(children, parent->children, parent->hdr.childlen);
+ memcpy(children + parent->hdr.childlen, base, baselen);
parent->children = children;
- parent->childlen += baselen;
+ parent->hdr.childlen += baselen;
return 0;
}
@@ -1436,9 +1434,9 @@ static struct node *construct_node(struct connection *conn, const void *ctx,
node->name = talloc_steal(node, names[levels - 1]);
/* Inherit permissions, unpriv domains own what they create. */
- node->num_perms = parent->num_perms;
+ node->hdr.num_perms = parent->hdr.num_perms;
node->perms = talloc_memdup(node, parent->perms,
- node->num_perms *
+ node->hdr.num_perms *
sizeof(*node->perms));
if (!node->perms)
goto nomem;
@@ -1447,7 +1445,7 @@ static struct node *construct_node(struct connection *conn, const void *ctx,
/* No children, no data */
node->children = node->data = NULL;
- node->childlen = node->datalen = 0;
+ node->hdr.childlen = node->hdr.datalen = 0;
node->acc.memory = 0;
node->parent = parent;
@@ -1499,7 +1497,7 @@ static struct node *create_node(struct connection *conn, const void *ctx,
ta_node_created(conn->transaction);
node->data = data;
- node->datalen = datalen;
+ node->hdr.datalen = datalen;
/*
* We write out the nodes bottom up.
@@ -1579,7 +1577,7 @@ static int do_write(const void *ctx, struct connection *conn,
return errno;
} else {
node->data = in->buffer + offset;
- node->datalen = datalen;
+ node->hdr.datalen = datalen;
if (write_node(conn, node, NODE_MODIFY, false))
return errno;
}
@@ -1627,8 +1625,8 @@ static int remove_child_entry(struct connection *conn, struct node *node,
{
size_t childlen = strlen(node->children + offset);
- memdel(node->children, offset, childlen + 1, node->childlen);
- node->childlen -= childlen + 1;
+ memdel(node->children, offset, childlen + 1, node->hdr.childlen);
+ node->hdr.childlen -= childlen + 1;
return write_node(conn, node, NODE_MODIFY, true);
}
@@ -1638,8 +1636,9 @@ static int delete_child(struct connection *conn,
{
unsigned int i;
- for (i = 0; i < node->childlen; i += strlen(node->children+i) + 1) {
- if (streq(node->children+i, childname)) {
+ for (i = 0; i < node->hdr.childlen;
+ i += strlen(node->children + i) + 1) {
+ if (streq(node->children + i, childname)) {
errno = remove_child_entry(conn, node, i) ? EIO : 0;
return errno;
}
@@ -1906,7 +1905,7 @@ int walk_node_tree(const void *ctx, struct connection *conn, const char *root,
/* node == NULL possible only for the initial loop iteration. */
if (node) {
/* Go one step up if ret or if last child finished. */
- if (ret || node->childoff >= node->childlen) {
+ if (ret || node->childoff >= node->hdr.childlen) {
parent = node->parent;
/* Call function AFTER processing a node. */
ret = walk_call_func(ctx, conn, node, parent,
@@ -2343,10 +2342,10 @@ static void manual_node(const char *name, const char *child)
node->name = name;
node->perms = &perms;
- node->num_perms = 1;
+ node->hdr.num_perms = 1;
node->children = (char *)child;
if (child)
- node->childlen = strlen(child) + 1;
+ node->hdr.childlen = strlen(child) + 1;
if (write_node(NULL, node, NODE_CREATE, false))
barf_perror("Could not create initial node %s", name);
@@ -3214,12 +3213,12 @@ static int dump_state_node(const void *ctx, struct connection *conn,
sn.conn_id = 0;
sn.ta_id = 0;
sn.ta_access = 0;
- sn.perm_n = node->num_perms;
+ sn.perm_n = node->hdr.num_perms;
sn.path_len = pathlen;
- sn.data_len = node->datalen;
- head.length += node->num_perms * sizeof(*sn.perms);
+ sn.data_len = node->hdr.datalen;
+ head.length += node->hdr.num_perms * sizeof(*sn.perms);
head.length += pathlen;
- head.length += node->datalen;
+ head.length += node->hdr.datalen;
head.length = ROUNDUP(head.length, 3);
if (fwrite(&head, sizeof(head), 1, fp) != 1)
@@ -3227,14 +3226,15 @@ static int dump_state_node(const void *ctx, struct connection *conn,
if (fwrite(&sn, sizeof(sn), 1, fp) != 1)
return dump_state_node_err(data, "Dump node state error");
- ret = dump_state_node_perms(fp, node->perms, node->num_perms);
+ ret = dump_state_node_perms(fp, node->perms, node->hdr.num_perms);
if (ret)
return dump_state_node_err(data, ret);
if (fwrite(node->name, pathlen, 1, fp) != 1)
return dump_state_node_err(data, "Dump node path error");
- if (node->datalen && fwrite(node->data, node->datalen, 1, fp) != 1)
+ if (node->hdr.datalen &&
+ fwrite(node->data, node->hdr.datalen, 1, fp) != 1)
return dump_state_node_err(data, "Dump node data error");
ret = dump_state_align(fp);
@@ -3419,17 +3419,17 @@ void read_state_node(const void *ctx, const void *state)
node->acc.memory = 0;
node->name = name;
- node->generation = ++generation;
- node->datalen = sn->data_len;
+ node->hdr.generation = ++generation;
+ node->hdr.datalen = sn->data_len;
node->data = name + sn->path_len;
- node->childlen = 0;
+ node->hdr.childlen = 0;
node->children = NULL;
- node->num_perms = sn->perm_n;
+ node->hdr.num_perms = sn->perm_n;
node->perms = talloc_array(node, struct xs_permissions,
- node->num_perms);
+ node->hdr.num_perms);
if (!node->perms)
barf("allocation error restoring node");
- for (i = 0; i < node->num_perms; i++) {
+ for (i = 0; i < node->hdr.num_perms; i++) {
switch (sn->perms[i].access) {
case 'r':
node->perms[i].perms = XS_PERM_READ;
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index 4bed462dda..cbed412a86 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -181,6 +181,7 @@ extern struct list_head connections;
*/
struct node_hdr {
uint64_t generation;
+#define NO_GENERATION ~((uint64_t)0)
uint16_t num_perms;
uint16_t datalen;
uint32_t childlen;
@@ -197,6 +198,10 @@ struct node_account_data {
};
struct node {
+ /* Copied to/from data base. */
+ struct node_hdr hdr;
+
+ /* Xenstore path. */
const char *name;
/* Name used to access data base. */
const char *db_name;
@@ -204,20 +209,13 @@ struct node {
/* Parent (optional) */
struct node *parent;
- /* Generation count. */
- uint64_t generation;
-#define NO_GENERATION ~((uint64_t)0)
-
/* Permissions. */
- unsigned int num_perms;
struct xs_permissions *perms;
/* Contents. */
- unsigned int datalen;
void *data;
/* Children, each nul-terminated. */
- unsigned int childlen;
unsigned int childoff; /* Used by walk_node_tree() internally. */
char *children;
@@ -259,7 +257,7 @@ static inline unsigned int get_node_owner(const struct node *node)
static inline void node_to_node_perms(const struct node *node,
struct node_perms *perms)
{
- perms->num = node->num_perms;
+ perms->num = node->hdr.num_perms;
perms->p = node->perms;
}
@@ -277,7 +275,7 @@ static inline unsigned int perm_for_conn_from_node(struct connection *conn,
static inline void node_perms_to_node(const struct node_perms *perms,
struct node *node)
{
- node->num_perms = perms->num;
+ node->hdr.num_perms = perms->num;
node->perms = perms->p;
}
diff --git a/tools/xenstore/xenstored_domain.c b/tools/xenstore/xenstored_domain.c
index 1ba73d9db2..fdf1095acb 100644
--- a/tools/xenstore/xenstored_domain.c
+++ b/tools/xenstore/xenstored_domain.c
@@ -1335,10 +1335,11 @@ int domain_adjust_node_perms(struct node *node)
{
unsigned int i;
- for (i = 1; i < node->num_perms; i++) {
+ for (i = 1; i < node->hdr.num_perms; i++) {
if (node->perms[i].perms & XS_PERM_IGNORE)
continue;
- if (!chk_domain_generation(node->perms[i].id, node->generation))
+ if (!chk_domain_generation(node->perms[i].id,
+ node->hdr.generation))
node->perms[i].perms |= XS_PERM_IGNORE;
}
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstore/xenstored_transaction.c
index 213a2c436c..1f892b002d 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstore/xenstored_transaction.c
@@ -232,7 +232,7 @@ int access_node(struct connection *conn, struct node *node,
bool introduce = false;
if (type != NODE_ACCESS_READ) {
- node->generation = ++generation;
+ node->hdr.generation = ++generation;
if (conn && !conn->transaction)
wrl_apply_debit_direct(conn);
}
@@ -259,12 +259,13 @@ int access_node(struct connection *conn, struct node *node,
if (!i->trans_name)
goto nomem;
i->node = strchr(i->trans_name, '/') + 1;
- if (node->generation != NO_GENERATION && node->num_perms) {
+ if (node->hdr.generation != NO_GENERATION &&
+ node->hdr.num_perms) {
i->perms.p = talloc_array(i, struct xs_permissions,
- node->num_perms);
+ node->hdr.num_perms);
if (!i->perms.p)
goto nomem;
- i->perms.num = node->num_perms;
+ i->perms.num = node->hdr.num_perms;
memcpy(i->perms.p, node->perms,
i->perms.num * sizeof(*i->perms.p));
}
@@ -282,9 +283,9 @@ int access_node(struct connection *conn, struct node *node,
* from the write types.
*/
if (type == NODE_ACCESS_READ) {
- i->generation = node->generation;
+ i->generation = node->hdr.generation;
i->check_gen = true;
- if (node->generation != NO_GENERATION) {
+ if (node->hdr.generation != NO_GENERATION) {
ret = write_node_raw(conn, i->trans_name, node,
NODE_CREATE, true);
if (ret)
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 12/19] tools/xenstore: alloc new memory in domain_adjust_node_perms()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (10 preceding siblings ...)
2023-08-14 7:46 ` [PATCH v4 11/19] tools/xenstore: use struct node_hdr " Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 10:59 ` [PATCH v4 12/19]tools/xenstore: " Julien Grall
2023-08-14 7:47 ` [PATCH v4 13/19] tools/xenstore: introduce read_node_const() Juergen Gross
` (7 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
In order to avoid modifying the node data in the data base in case a
domain is gone, let domain_adjust_node_perms() allocate new memory for
the permissions in case they need to be modified. As this should
happen only in very rare cases, it is fine to do this even when having
copied the node data already.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new patch
V4:
- add comments (Julien Grall)
---
tools/xenstore/xenstored_core.c | 10 +++++-----
tools/xenstore/xenstored_domain.c | 24 ++++++++++++++++++++----
tools/xenstore/xenstored_domain.h | 8 +++++++-
3 files changed, 32 insertions(+), 10 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index ab4714263d..c8c8c4b8f4 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -752,6 +752,11 @@ struct node *read_node(struct connection *conn, const void *ctx,
goto error;
}
+ /* Data is binary blob (usually ascii, no nul). */
+ node->data = node->perms + hdr->num_perms;
+ /* Children is strings, nul separated. */
+ node->children = node->data + node->hdr.datalen;
+
if (domain_adjust_node_perms(node))
goto error;
@@ -759,11 +764,6 @@ struct node *read_node(struct connection *conn, const void *ctx,
if (node->acc.domid != get_node_owner(node))
node->acc.memory = 0;
- /* Data is binary blob (usually ascii, no nul). */
- node->data = node->perms + hdr->num_perms;
- /* Children is strings, nul separated. */
- node->children = node->data + node->hdr.datalen;
-
if (access_node(conn, node, NODE_ACCESS_READ, NULL))
goto error;
diff --git a/tools/xenstore/xenstored_domain.c b/tools/xenstore/xenstored_domain.c
index fdf1095acb..c00ea397cf 100644
--- a/tools/xenstore/xenstored_domain.c
+++ b/tools/xenstore/xenstored_domain.c
@@ -1334,13 +1334,29 @@ int domain_alloc_permrefs(struct node_perms *perms)
int domain_adjust_node_perms(struct node *node)
{
unsigned int i;
+ struct xs_permissions *perms = node->perms;
+ bool copied = false;
for (i = 1; i < node->hdr.num_perms; i++) {
- if (node->perms[i].perms & XS_PERM_IGNORE)
+ if ((perms[i].perms & XS_PERM_IGNORE) ||
+ chk_domain_generation(perms[i].id, node->hdr.generation))
continue;
- if (!chk_domain_generation(node->perms[i].id,
- node->hdr.generation))
- node->perms[i].perms |= XS_PERM_IGNORE;
+
+ /*
+ * Don't do a in-place modification, as the node might
+ * reference data directly in the data base, which we don't
+ * want to modify.
+ */
+ if (!copied) {
+ perms = talloc_memdup(node, node->perms,
+ node->hdr.num_perms * sizeof(*perms));
+ if (!perms)
+ return ENOMEM;
+ node->perms = perms;
+ copied = true;
+ }
+
+ perms[i].perms |= XS_PERM_IGNORE;
}
return 0;
diff --git a/tools/xenstore/xenstored_domain.h b/tools/xenstore/xenstored_domain.h
index 4950b00aee..7625dca8cd 100644
--- a/tools/xenstore/xenstored_domain.h
+++ b/tools/xenstore/xenstored_domain.h
@@ -90,8 +90,14 @@ void ignore_connection(struct connection *conn, unsigned int err);
/* Returns the implicit path of a connection (only domains have this) */
const char *get_implicit_path(const struct connection *conn);
-/* Remove node permissions for no longer existing domains. */
+/*
+ * Remove node permissions for no longer existing domains.
+ * In case of a change of permissions the related array is reallocated in
+ * order to avoid a data base change when operating on a node directly
+ * referencing the data base contents.
+ */
int domain_adjust_node_perms(struct node *node);
+
int domain_alloc_permrefs(struct node_perms *perms);
/* Quota manipulation */
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 12/19]tools/xenstore: alloc new memory in domain_adjust_node_perms()
2023-08-14 7:47 ` [PATCH v4 12/19] tools/xenstore: alloc new memory in domain_adjust_node_perms() Juergen Gross
@ 2023-08-18 10:59 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-18 10:59 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:47, Juergen Gross wrote:
> In order to avoid modifying the node data in the data base in case a
> domain is gone, let domain_adjust_node_perms() allocate new memory for
> the permissions in case they need to be modified. As this should
> happen only in very rare cases, it is fine to do this even when having
> copied the node data already.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 13/19] tools/xenstore: introduce read_node_const()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (11 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 12/19] tools/xenstore: alloc new memory in domain_adjust_node_perms() Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 11:06 ` Julien Grall
2023-08-14 7:47 ` [PATCH v4 14/19] tools/xenstore: merge get_spec_node() into get_node_canonicalized() Juergen Gross
` (6 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Introduce a read_node() variant returning a pointer to const struct
node, which doesn't do a copy of the node data after retrieval from
the data base.
Call this variant where appropriate.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new approach (Julien Grall)
V4:
- fix patch subject (Julien Grall)
- let read_node_helper() return a bool (Julien Grall)
---
tools/xenstore/xenstored_core.c | 105 ++++++++++++++++++++++--------
tools/xenstore/xenstored_core.h | 2 +
tools/xenstore/xenstored_domain.c | 4 +-
tools/xenstore/xenstored_watch.c | 10 +--
tools/xenstore/xenstored_watch.h | 3 +-
5 files changed, 90 insertions(+), 34 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index c8c8c4b8f4..f8e5e7b697 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -706,11 +706,11 @@ void db_delete(struct connection *conn, const char *name,
* If it fails, returns NULL and sets errno.
* Temporary memory allocations will be done with ctx.
*/
-struct node *read_node(struct connection *conn, const void *ctx,
- const char *name)
+static struct node *read_node_alloc(struct connection *conn, const void *ctx,
+ const char *name,
+ const struct node_hdr **hdr)
{
size_t size;
- const struct node_hdr *hdr;
struct node *node;
const char *db_name;
int err;
@@ -720,17 +720,16 @@ struct node *read_node(struct connection *conn, const void *ctx,
errno = ENOMEM;
return NULL;
}
+
node->name = talloc_strdup(node, name);
if (!node->name) {
- talloc_free(node);
errno = ENOMEM;
- return NULL;
+ goto error;
}
db_name = transaction_prepend(conn, name);
- hdr = db_fetch(db_name, &size);
-
- if (hdr == NULL) {
+ *hdr = db_fetch(db_name, &size);
+ if (*hdr == NULL) {
node->hdr.generation = NO_GENERATION;
err = access_node(conn, node, NODE_ACCESS_READ, NULL);
errno = err ? : ENOENT;
@@ -740,31 +739,80 @@ struct node *read_node(struct connection *conn, const void *ctx,
node->parent = NULL;
/* Datalen, childlen, number of permissions */
- node->hdr = *hdr;
- node->acc.domid = perms_from_node_hdr(hdr)->id;
+ node->hdr = **hdr;
+ node->acc.domid = perms_from_node_hdr(*hdr)->id;
node->acc.memory = size;
- /* Copy node data to new memory area, starting with permissions. */
- size -= sizeof(*hdr);
- node->perms = talloc_memdup(node, perms_from_node_hdr(hdr), size);
- if (node->perms == NULL) {
- errno = ENOMEM;
- goto error;
- }
+ return node;
+
+ error:
+ talloc_free(node);
+ return NULL;
+}
+static bool read_node_helper(struct connection *conn, struct node *node)
+{
/* Data is binary blob (usually ascii, no nul). */
- node->data = node->perms + hdr->num_perms;
+ node->data = node->perms + node->hdr.num_perms;
/* Children is strings, nul separated. */
node->children = node->data + node->hdr.datalen;
if (domain_adjust_node_perms(node))
- goto error;
+ return false;
/* If owner is gone reset currently accounted memory size. */
if (node->acc.domid != get_node_owner(node))
node->acc.memory = 0;
if (access_node(conn, node, NODE_ACCESS_READ, NULL))
+ return false;
+
+ return true;
+}
+
+struct node *read_node(struct connection *conn, const void *ctx,
+ const char *name)
+{
+ size_t size;
+ const struct node_hdr *hdr;
+ struct node *node;
+
+ node = read_node_alloc(conn, ctx, name, &hdr);
+ if (!node)
+ return NULL;
+
+ /* Copy node data to new memory area, starting with permissions. */
+ size = node->acc.memory - sizeof(*hdr);
+ node->perms = talloc_memdup(node, perms_from_node_hdr(hdr), size);
+ if (node->perms == NULL) {
+ errno = ENOMEM;
+ goto error;
+ }
+
+ if (!read_node_helper(conn, node))
+ goto error;
+
+ return node;
+
+ error:
+ talloc_free(node);
+ return NULL;
+}
+
+const struct node *read_node_const(struct connection *conn, const void *ctx,
+ const char *name)
+{
+ const struct node_hdr *hdr;
+ struct node *node;
+
+ node = read_node_alloc(conn, ctx, name, &hdr);
+ if (!node)
+ return NULL;
+
+ /* Unfortunately node->perms isn't const. */
+ node->perms = (void *)perms_from_node_hdr(hdr);
+
+ if (!read_node_helper(conn, node))
goto error;
return node;
@@ -900,13 +948,13 @@ char *get_parent(const void *ctx, const char *node)
static int ask_parents(struct connection *conn, const void *ctx,
const char *name, unsigned int *perm)
{
- struct node *node;
+ const struct node *node;
do {
name = get_parent(ctx, name);
if (!name)
return errno;
- node = read_node(conn, ctx, name);
+ node = read_node_const(conn, ctx, name);
if (node)
break;
if (read_node_can_propagate_errno())
@@ -3197,9 +3245,8 @@ static int dump_state_node_err(struct dump_node_data *data, const char *err)
}
static int dump_state_node(const void *ctx, struct connection *conn,
- struct node *node, void *arg)
+ const struct node *node, struct dump_node_data *data)
{
- struct dump_node_data *data = arg;
FILE *fp = data->fp;
unsigned int pathlen;
struct xs_state_record_header head;
@@ -3244,14 +3291,20 @@ static int dump_state_node(const void *ctx, struct connection *conn,
return WALK_TREE_OK;
}
+static int dump_state_node_enter(const void *ctx, struct connection *conn,
+ struct node *node, void *arg)
+{
+ return dump_state_node(ctx, conn, node, arg);
+}
+
static int dump_state_special_node(FILE *fp, const void *ctx,
struct dump_node_data *data,
const char *name)
{
- struct node *node;
+ const struct node *node;
int ret;
- node = read_node(NULL, ctx, name);
+ node = read_node_const(NULL, ctx, name);
if (!node)
return dump_state_node_err(data, "Dump node read node error");
@@ -3267,7 +3320,7 @@ const char *dump_state_nodes(FILE *fp, const void *ctx)
.fp = fp,
.err = "Dump node walk error"
};
- struct walk_funcs walkfuncs = { .enter = dump_state_node };
+ struct walk_funcs walkfuncs = { .enter = dump_state_node_enter };
if (walk_node_tree(ctx, NULL, "/", &walkfuncs, &data))
return data.err;
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index cbed412a86..07c59c07b7 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -292,6 +292,8 @@ int write_node_raw(struct connection *conn, const char *db_name,
/* Get a node from the data base. */
struct node *read_node(struct connection *conn, const void *ctx,
const char *name);
+const struct node *read_node_const(struct connection *conn, const void *ctx,
+ const char *name);
/* Remove a node and its children. */
int rm_node(struct connection *conn, const void *ctx, const char *name);
diff --git a/tools/xenstore/xenstored_domain.c b/tools/xenstore/xenstored_domain.c
index c00ea397cf..1bf138c8b1 100644
--- a/tools/xenstore/xenstored_domain.c
+++ b/tools/xenstore/xenstored_domain.c
@@ -563,12 +563,12 @@ static void domain_tree_remove(struct domain *domain)
static void fire_special_watches(const char *name)
{
void *ctx = talloc_new(NULL);
- struct node *node;
+ const struct node *node;
if (!ctx)
return;
- node = read_node(NULL, ctx, name);
+ node = read_node_const(NULL, ctx, name);
if (node)
fire_watches(NULL, ctx, name, node, true, NULL);
diff --git a/tools/xenstore/xenstored_watch.c b/tools/xenstore/xenstored_watch.c
index 5767675e04..d6e5a4be1e 100644
--- a/tools/xenstore/xenstored_watch.c
+++ b/tools/xenstore/xenstored_watch.c
@@ -73,11 +73,11 @@ static const char *get_watch_path(const struct watch *watch, const char *name)
* changed permissions we need to take the old permissions into account, too.
*/
static bool watch_permitted(struct connection *conn, const void *ctx,
- const char *name, struct node *node,
+ const char *name, const struct node *node,
struct node_perms *perms)
{
unsigned int perm;
- struct node *parent;
+ const struct node *parent;
char *parent_name;
if (perms) {
@@ -87,7 +87,7 @@ static bool watch_permitted(struct connection *conn, const void *ctx,
}
if (!node) {
- node = read_node(conn, ctx, name);
+ node = read_node_const(conn, ctx, name);
if (!node)
return false;
}
@@ -101,7 +101,7 @@ static bool watch_permitted(struct connection *conn, const void *ctx,
parent_name = get_parent(ctx, node->name);
if (!parent_name)
return false;
- parent = read_node(conn, ctx, parent_name);
+ parent = read_node_const(conn, ctx, parent_name);
if (!parent)
return false;
}
@@ -119,7 +119,7 @@ static bool watch_permitted(struct connection *conn, const void *ctx,
* watch event, too.
*/
void fire_watches(struct connection *conn, const void *ctx, const char *name,
- struct node *node, bool exact, struct node_perms *perms)
+ const struct node *node, bool exact, struct node_perms *perms)
{
struct connection *i;
struct buffered_data *req;
diff --git a/tools/xenstore/xenstored_watch.h b/tools/xenstore/xenstored_watch.h
index 091890edca..ea247997ad 100644
--- a/tools/xenstore/xenstored_watch.h
+++ b/tools/xenstore/xenstored_watch.h
@@ -28,7 +28,8 @@ int do_unwatch(const void *ctx, struct connection *conn,
/* Fire all watches: !exact means all the children are affected (ie. rm). */
void fire_watches(struct connection *conn, const void *tmp, const char *name,
- struct node *node, bool exact, struct node_perms *perms);
+ const struct node *node, bool exact,
+ struct node_perms *perms);
void conn_delete_all_watches(struct connection *conn);
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* [PATCH v4 14/19] tools/xenstore: merge get_spec_node() into get_node_canonicalized()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (12 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 13/19] tools/xenstore: introduce read_node_const() Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 11:07 ` Julien Grall
2023-08-14 7:47 ` [PATCH v4 15/19] tools/xenstore: merge is_valid_nodename() into canonicalize() Juergen Gross
` (5 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Add a "allow_special" parameter to get_node_canonicalized() allowing
to merge get_spec_node() into get_node_canonicalized().
Add the same parameter to is_valid_nodename(), as this will simplify
check_watch_path().
This is done in preparation to introducing a get_node() variant
returning a pointer to const struct node.
Note that this will change how special node names are going to be
validated, as now the normal restrictions for node names will be
applied:
- they can't end with "/"
- they can't contain "//"
- they can't contain characters other than the ones allowed for normal
nodes
- the length of the node name is restricted by the max path length
quota
For defined special node names this isn't any real restriction, though.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new patch
V4:
- expand commit message (Julien Grall)
---
tools/xenstore/xenstored_core.c | 45 +++++++++++++-------------------
tools/xenstore/xenstored_core.h | 3 ++-
tools/xenstore/xenstored_watch.c | 19 +++++---------
3 files changed, 26 insertions(+), 41 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index f8e5e7b697..0ebe4bb7d2 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -1219,13 +1219,14 @@ static bool valid_chars(const char *node)
"0123456789-/_@") == strlen(node));
}
-bool is_valid_nodename(const struct connection *conn, const char *node)
+bool is_valid_nodename(const struct connection *conn, const char *node,
+ bool allow_special)
{
int local_off = 0;
unsigned int domid;
- /* Must start in /. */
- if (!strstarts(node, "/"))
+ /* Must start in / or - if special nodes are allowed - in @. */
+ if (!strstarts(node, "/") && (!allow_special || !strstarts(node, "@")))
return false;
/* Cannot end in / (unless it's just "/"). */
@@ -1293,7 +1294,8 @@ static struct node *get_node_canonicalized(struct connection *conn,
const void *ctx,
const char *name,
const char **canonical_name,
- unsigned int perm)
+ unsigned int perm,
+ bool allow_special)
{
const char *tmp_name;
@@ -1302,33 +1304,20 @@ static struct node *get_node_canonicalized(struct connection *conn,
*canonical_name = canonicalize(conn, ctx, name);
if (!*canonical_name)
return NULL;
- if (!is_valid_nodename(conn, *canonical_name)) {
+ if (!is_valid_nodename(conn, *canonical_name, allow_special)) {
errno = EINVAL;
return NULL;
}
return get_node(conn, ctx, *canonical_name, perm);
}
-static struct node *get_spec_node(struct connection *conn, const void *ctx,
- const char *name, const char **canonical_name,
- unsigned int perm)
-{
- if (name[0] == '@') {
- if (canonical_name)
- *canonical_name = name;
- return get_node(conn, ctx, name, perm);
- }
-
- return get_node_canonicalized(conn, ctx, name, canonical_name, perm);
-}
-
static int send_directory(const void *ctx, struct connection *conn,
struct buffered_data *in)
{
struct node *node;
node = get_node_canonicalized(conn, ctx, onearg(in), NULL,
- XS_PERM_READ);
+ XS_PERM_READ, false);
if (!node)
return errno;
@@ -1350,7 +1339,7 @@ static int send_directory_part(const void *ctx, struct connection *conn,
/* First arg is node name. */
node = get_node_canonicalized(conn, ctx, in->buffer, NULL,
- XS_PERM_READ);
+ XS_PERM_READ, false);
if (!node)
return errno;
@@ -1400,7 +1389,7 @@ static int do_read(const void *ctx, struct connection *conn,
struct node *node;
node = get_node_canonicalized(conn, ctx, onearg(in), NULL,
- XS_PERM_READ);
+ XS_PERM_READ, false);
if (!node)
return errno;
@@ -1614,7 +1603,8 @@ static int do_write(const void *ctx, struct connection *conn,
offset = strlen(vec[0]) + 1;
datalen = in->used - offset;
- node = get_node_canonicalized(conn, ctx, vec[0], &name, XS_PERM_WRITE);
+ node = get_node_canonicalized(conn, ctx, vec[0], &name, XS_PERM_WRITE,
+ false);
if (!node) {
/* No permissions, invalid input? */
if (errno != ENOENT)
@@ -1643,7 +1633,7 @@ static int do_mkdir(const void *ctx, struct connection *conn,
const char *name;
node = get_node_canonicalized(conn, ctx, onearg(in), &name,
- XS_PERM_WRITE);
+ XS_PERM_WRITE, false);
/* If it already exists, fine. */
if (!node) {
@@ -1773,7 +1763,7 @@ static int do_rm(const void *ctx, struct connection *conn,
char *parentname;
node = get_node_canonicalized(conn, ctx, onearg(in), &name,
- XS_PERM_WRITE);
+ XS_PERM_WRITE, false);
if (!node) {
/* Didn't exist already? Fine, if parent exists. */
if (errno == ENOENT) {
@@ -1814,7 +1804,8 @@ static int do_get_perms(const void *ctx, struct connection *conn,
char *strings;
unsigned int len;
- node = get_spec_node(conn, ctx, onearg(in), NULL, XS_PERM_READ);
+ node = get_node_canonicalized(conn, ctx, onearg(in), NULL, XS_PERM_READ,
+ true);
if (!node)
return errno;
@@ -1857,8 +1848,8 @@ static int do_set_perms(const void *ctx, struct connection *conn,
return ENOENT;
/* We must own node to do this (tools can do this too). */
- node = get_spec_node(conn, ctx, in->buffer, &name,
- XS_PERM_WRITE | XS_PERM_OWNER);
+ node = get_node_canonicalized(conn, ctx, in->buffer, &name,
+ XS_PERM_WRITE | XS_PERM_OWNER, true);
if (!node)
return errno;
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index 07c59c07b7..5575cc0689 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -305,7 +305,8 @@ void check_store(void);
void corrupt(struct connection *conn, const char *fmt, ...);
/* Is this a valid node name? */
-bool is_valid_nodename(const struct connection *conn, const char *node);
+bool is_valid_nodename(const struct connection *conn, const char *node,
+ bool allow_special);
/* Get name of parent node. */
char *get_parent(const void *ctx, const char *node);
diff --git a/tools/xenstore/xenstored_watch.c b/tools/xenstore/xenstored_watch.c
index d6e5a4be1e..e695762c64 100644
--- a/tools/xenstore/xenstored_watch.c
+++ b/tools/xenstore/xenstored_watch.c
@@ -163,19 +163,12 @@ static int destroy_watch(void *_watch)
static int check_watch_path(struct connection *conn, const void *ctx,
const char **path, bool *relative)
{
- /* Check if valid event. */
- if (strstarts(*path, "@")) {
- *relative = false;
- if (strlen(*path) > XENSTORE_REL_PATH_MAX)
- goto inval;
- } else {
- *relative = !strstarts(*path, "/");
- *path = canonicalize(conn, ctx, *path);
- if (!*path)
- return errno;
- if (!is_valid_nodename(conn, *path))
- goto inval;
- }
+ *relative = !strstarts(*path, "/") && !strstarts(*path, "@");
+ *path = canonicalize(conn, ctx, *path);
+ if (!*path)
+ return errno;
+ if (!is_valid_nodename(conn, *path, true))
+ goto inval;
return 0;
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 14/19] tools/xenstore: merge get_spec_node() into get_node_canonicalized()
2023-08-14 7:47 ` [PATCH v4 14/19] tools/xenstore: merge get_spec_node() into get_node_canonicalized() Juergen Gross
@ 2023-08-18 11:07 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-18 11:07 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:47, Juergen Gross wrote:
> Add a "allow_special" parameter to get_node_canonicalized() allowing
> to merge get_spec_node() into get_node_canonicalized().
>
> Add the same parameter to is_valid_nodename(), as this will simplify
> check_watch_path().
>
> This is done in preparation to introducing a get_node() variant
> returning a pointer to const struct node.
>
> Note that this will change how special node names are going to be
> validated, as now the normal restrictions for node names will be
> applied:
>
> - they can't end with "/"
> - they can't contain "//"
> - they can't contain characters other than the ones allowed for normal
> nodes
> - the length of the node name is restricted by the max path length
> quota
>
> For defined special node names this isn't any real restriction, though.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 15/19] tools/xenstore: merge is_valid_nodename() into canonicalize()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (13 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 14/19] tools/xenstore: merge get_spec_node() into get_node_canonicalized() Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 11:12 ` Julien Grall
2023-08-14 7:47 ` [PATCH v4 16/19] tools/xenstore: rework get_node() Juergen Gross
` (4 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Today is_valid_nodename() is always called directly after calling
canonicalize(), with the exception of do_unwatch(), where the call
is missing (which is not correct, but results just in a wrong error
reason being returned).
Merge is_valid_nodename() into canonicalize(). While at it merge
valid_chars() into it, too.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new patch
V4:
- make name const in canonicalize()
- don't merge valid_chars() (Julien Grall)
- free full path string in case of error (Julien Grall)
---
tools/xenstore/xenstored_core.c | 85 +++++++++++++++++---------------
tools/xenstore/xenstored_core.h | 6 +--
tools/xenstore/xenstored_watch.c | 16 ++----
3 files changed, 50 insertions(+), 57 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index 0ebe4bb7d2..69e147df2c 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -1219,33 +1219,6 @@ static bool valid_chars(const char *node)
"0123456789-/_@") == strlen(node));
}
-bool is_valid_nodename(const struct connection *conn, const char *node,
- bool allow_special)
-{
- int local_off = 0;
- unsigned int domid;
-
- /* Must start in / or - if special nodes are allowed - in @. */
- if (!strstarts(node, "/") && (!allow_special || !strstarts(node, "@")))
- return false;
-
- /* Cannot end in / (unless it's just "/"). */
- if (strends(node, "/") && !streq(node, "/"))
- return false;
-
- /* No double //. */
- if (strstr(node, "//"))
- return false;
-
- if (sscanf(node, "/local/domain/%5u/%n", &domid, &local_off) != 1)
- local_off = 0;
-
- if (domain_max_chk(conn, ACC_PATHLEN, strlen(node) - local_off))
- return false;
-
- return valid_chars(node);
-}
-
/* We expect one arg in the input: return NULL otherwise.
* The payload must contain exactly one nul, at the end.
*/
@@ -1278,16 +1251,51 @@ static char *node_perms_to_strings(const struct node *node, unsigned int *len)
}
const char *canonicalize(struct connection *conn, const void *ctx,
- const char *node)
+ const char *node, bool allow_special)
{
- const char *prefix;
+ const char *name;
+ int local_off = 0;
+ unsigned int domid;
- if (!node || (node[0] == '/') || (node[0] == '@'))
- return node;
- prefix = get_implicit_path(conn);
- if (prefix)
- return talloc_asprintf(ctx, "%s/%s", prefix, node);
- return node;
+ /*
+ * Invalid if any of:
+ * - no node at all
+ * - illegal character in node
+ * - starts with '@' but no special node allowed
+ */
+ errno = EINVAL;
+ if (!node ||
+ !valid_chars(node) ||
+ (node[0] == '@' && !allow_special))
+ return NULL;
+
+ if (node[0] != '/' && node[0] != '@') {
+ name = talloc_asprintf(ctx, "%s/%s", get_implicit_path(conn),
+ node);
+ if (!name)
+ return NULL;
+ } else
+ name = node;
+
+ if (sscanf(name, "/local/domain/%5u/%n", &domid, &local_off) != 1)
+ local_off = 0;
+
+ /*
+ * Only valid if:
+ * - doesn't end in / (unless it's just "/")
+ * - no double //
+ * - not violating max allowed path length
+ */
+ if (!(strends(name, "/") && !streq(name, "/")) &&
+ !strstr(name, "//") &&
+ !domain_max_chk(conn, ACC_PATHLEN, strlen(name) - local_off))
+ return name;
+
+ /* Release the memory if 'name' was allocated by us. */
+ if (name != node)
+ talloc_free(name);
+
+ return NULL;
}
static struct node *get_node_canonicalized(struct connection *conn,
@@ -1301,13 +1309,10 @@ static struct node *get_node_canonicalized(struct connection *conn,
if (!canonical_name)
canonical_name = &tmp_name;
- *canonical_name = canonicalize(conn, ctx, name);
+ *canonical_name = canonicalize(conn, ctx, name, allow_special);
if (!*canonical_name)
return NULL;
- if (!is_valid_nodename(conn, *canonical_name, allow_special)) {
- errno = EINVAL;
- return NULL;
- }
+
return get_node(conn, ctx, *canonical_name, perm);
}
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstore/xenstored_core.h
index 5575cc0689..ad87199042 100644
--- a/tools/xenstore/xenstored_core.h
+++ b/tools/xenstore/xenstored_core.h
@@ -241,7 +241,7 @@ void send_ack(struct connection *conn, enum xsd_sockmsg_type type);
/* Canonicalize this path if possible. */
const char *canonicalize(struct connection *conn, const void *ctx,
- const char *node);
+ const char *node, bool allow_special);
/* Get access permissions. */
unsigned int perm_for_conn(struct connection *conn,
@@ -304,10 +304,6 @@ struct connection *get_connection_by_id(unsigned int conn_id);
void check_store(void);
void corrupt(struct connection *conn, const char *fmt, ...);
-/* Is this a valid node name? */
-bool is_valid_nodename(const struct connection *conn, const char *node,
- bool allow_special);
-
/* Get name of parent node. */
char *get_parent(const void *ctx, const char *node);
diff --git a/tools/xenstore/xenstored_watch.c b/tools/xenstore/xenstored_watch.c
index e695762c64..7d4d097cf9 100644
--- a/tools/xenstore/xenstored_watch.c
+++ b/tools/xenstore/xenstored_watch.c
@@ -164,17 +164,9 @@ static int check_watch_path(struct connection *conn, const void *ctx,
const char **path, bool *relative)
{
*relative = !strstarts(*path, "/") && !strstarts(*path, "@");
- *path = canonicalize(conn, ctx, *path);
- if (!*path)
- return errno;
- if (!is_valid_nodename(conn, *path, true))
- goto inval;
-
- return 0;
+ *path = canonicalize(conn, ctx, *path, true);
- inval:
- errno = EINVAL;
- return errno;
+ return *path ? 0 : errno;
}
static struct watch *add_watch(struct connection *conn, const char *path,
@@ -258,9 +250,9 @@ int do_unwatch(const void *ctx, struct connection *conn,
if (get_strings(in, vec, ARRAY_SIZE(vec)) != ARRAY_SIZE(vec))
return EINVAL;
- node = canonicalize(conn, ctx, vec[0]);
+ node = canonicalize(conn, ctx, vec[0], true);
if (!node)
- return ENOMEM;
+ return errno;
list_for_each_entry(watch, &conn->watches, list) {
if (streq(watch->node, node) && streq(watch->token, vec[1])) {
list_del(&watch->list);
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 15/19] tools/xenstore: merge is_valid_nodename() into canonicalize()
2023-08-14 7:47 ` [PATCH v4 15/19] tools/xenstore: merge is_valid_nodename() into canonicalize() Juergen Gross
@ 2023-08-18 11:12 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-18 11:12 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:47, Juergen Gross wrote:
> Today is_valid_nodename() is always called directly after calling
> canonicalize(), with the exception of do_unwatch(), where the call
> is missing (which is not correct, but results just in a wrong error
> reason being returned).
>
> Merge is_valid_nodename() into canonicalize(). While at it merge
> valid_chars() into it, too.
You don't valid_chars() anymore. So the second sentence can be removed.
I can do the change while committing.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 16/19] tools/xenstore: rework get_node()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (14 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 15/19] tools/xenstore: merge is_valid_nodename() into canonicalize() Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 11:14 ` Julien Grall
2023-08-14 7:47 ` [PATCH v4 17/19] tools/xenstore: introduce get_node_const() Juergen Gross
` (3 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Today get_node_canonicalized() is the only caller of get_node().
In order to prepare introducing a get_node() variant returning a
pointer to const struct node, do the following restructuring:
- move the call of read_node() from get_node() into
get_node_canonicalized()
- rename get_node() to get_node_chk_perm()
- rename get_node_canonicalized() to get_node()
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new patch
V4:
- change initial value of err in get_node_chk_perm() (Julien Grall)
- rename err to success in get_node_chk_perm() (Julien Grall)
---
tools/xenstore/xenstored_core.c | 57 +++++++++++++++------------------
1 file changed, 25 insertions(+), 32 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index 69e147df2c..9098b7eee2 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -1000,23 +1000,22 @@ static int errno_from_parents(struct connection *conn, const void *ctx,
* If it fails, returns NULL and sets errno.
* Temporary memory allocations are done with ctx.
*/
-static struct node *get_node(struct connection *conn,
- const void *ctx,
- const char *name,
- unsigned int perm)
+static bool get_node_chk_perm(struct connection *conn, const void *ctx,
+ const struct node *node, const char *name,
+ unsigned int perm)
{
- struct node *node;
+ bool success = node;
- node = read_node(conn, ctx, name);
/* If we don't have permission, we don't have node. */
if (node && (perm_for_conn_from_node(conn, node) & perm) != perm) {
errno = EACCES;
- node = NULL;
+ success = false;
}
/* Clean up errno if they weren't supposed to know. */
- if (!node && !read_node_can_propagate_errno())
+ if (!success && !read_node_can_propagate_errno())
errno = errno_from_parents(conn, ctx, name, errno, perm);
- return node;
+
+ return success;
}
static struct buffered_data *new_buffer(void *ctx)
@@ -1298,14 +1297,12 @@ const char *canonicalize(struct connection *conn, const void *ctx,
return NULL;
}
-static struct node *get_node_canonicalized(struct connection *conn,
- const void *ctx,
- const char *name,
- const char **canonical_name,
- unsigned int perm,
- bool allow_special)
+static struct node *get_node(struct connection *conn, const void *ctx,
+ const char *name, const char **canonical_name,
+ unsigned int perm, bool allow_special)
{
const char *tmp_name;
+ struct node *node;
if (!canonical_name)
canonical_name = &tmp_name;
@@ -1313,7 +1310,10 @@ static struct node *get_node_canonicalized(struct connection *conn,
if (!*canonical_name)
return NULL;
- return get_node(conn, ctx, *canonical_name, perm);
+ node = read_node(conn, ctx, *canonical_name);
+
+ return get_node_chk_perm(conn, ctx, node, *canonical_name, perm)
+ ? node : NULL;
}
static int send_directory(const void *ctx, struct connection *conn,
@@ -1321,8 +1321,7 @@ static int send_directory(const void *ctx, struct connection *conn,
{
struct node *node;
- node = get_node_canonicalized(conn, ctx, onearg(in), NULL,
- XS_PERM_READ, false);
+ node = get_node(conn, ctx, onearg(in), NULL, XS_PERM_READ, false);
if (!node)
return errno;
@@ -1343,8 +1342,7 @@ static int send_directory_part(const void *ctx, struct connection *conn,
return EINVAL;
/* First arg is node name. */
- node = get_node_canonicalized(conn, ctx, in->buffer, NULL,
- XS_PERM_READ, false);
+ node = get_node(conn, ctx, in->buffer, NULL, XS_PERM_READ, false);
if (!node)
return errno;
@@ -1393,8 +1391,7 @@ static int do_read(const void *ctx, struct connection *conn,
{
struct node *node;
- node = get_node_canonicalized(conn, ctx, onearg(in), NULL,
- XS_PERM_READ, false);
+ node = get_node(conn, ctx, onearg(in), NULL, XS_PERM_READ, false);
if (!node)
return errno;
@@ -1608,8 +1605,7 @@ static int do_write(const void *ctx, struct connection *conn,
offset = strlen(vec[0]) + 1;
datalen = in->used - offset;
- node = get_node_canonicalized(conn, ctx, vec[0], &name, XS_PERM_WRITE,
- false);
+ node = get_node(conn, ctx, vec[0], &name, XS_PERM_WRITE, false);
if (!node) {
/* No permissions, invalid input? */
if (errno != ENOENT)
@@ -1637,8 +1633,7 @@ static int do_mkdir(const void *ctx, struct connection *conn,
struct node *node;
const char *name;
- node = get_node_canonicalized(conn, ctx, onearg(in), &name,
- XS_PERM_WRITE, false);
+ node = get_node(conn, ctx, onearg(in), &name, XS_PERM_WRITE, false);
/* If it already exists, fine. */
if (!node) {
@@ -1767,8 +1762,7 @@ static int do_rm(const void *ctx, struct connection *conn,
const char *name;
char *parentname;
- node = get_node_canonicalized(conn, ctx, onearg(in), &name,
- XS_PERM_WRITE, false);
+ node = get_node(conn, ctx, onearg(in), &name, XS_PERM_WRITE, false);
if (!node) {
/* Didn't exist already? Fine, if parent exists. */
if (errno == ENOENT) {
@@ -1809,8 +1803,7 @@ static int do_get_perms(const void *ctx, struct connection *conn,
char *strings;
unsigned int len;
- node = get_node_canonicalized(conn, ctx, onearg(in), NULL, XS_PERM_READ,
- true);
+ node = get_node(conn, ctx, onearg(in), NULL, XS_PERM_READ, true);
if (!node)
return errno;
@@ -1853,8 +1846,8 @@ static int do_set_perms(const void *ctx, struct connection *conn,
return ENOENT;
/* We must own node to do this (tools can do this too). */
- node = get_node_canonicalized(conn, ctx, in->buffer, &name,
- XS_PERM_WRITE | XS_PERM_OWNER, true);
+ node = get_node(conn, ctx, in->buffer, &name,
+ XS_PERM_WRITE | XS_PERM_OWNER, true);
if (!node)
return errno;
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 16/19] tools/xenstore: rework get_node()
2023-08-14 7:47 ` [PATCH v4 16/19] tools/xenstore: rework get_node() Juergen Gross
@ 2023-08-18 11:14 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-18 11:14 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:47, Juergen Gross wrote:
> Today get_node_canonicalized() is the only caller of get_node().
>
> In order to prepare introducing a get_node() variant returning a
> pointer to const struct node, do the following restructuring:
>
> - move the call of read_node() from get_node() into
> get_node_canonicalized()
>
> - rename get_node() to get_node_chk_perm()
>
> - rename get_node_canonicalized() to get_node()
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 17/19] tools/xenstore: introduce get_node_const()
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (15 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 16/19] tools/xenstore: rework get_node() Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 11:16 ` Julien Grall
2023-08-14 7:47 ` [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h Juergen Gross
` (2 subsequent siblings)
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Julien Grall, Anthony PERARD
Add a variant of get_node() returning a const struct node pointer.
Note that all callers of this new variant don't supply a pointer where
to store the canonical node name, while all callers needing a non-const
node do supply this pointer. This results in an asymmetric
simplification of the two variants.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V3:
- new approach (Julien Grall)
---
tools/xenstore/xenstored_core.c | 35 ++++++++++++++++++++++-----------
1 file changed, 24 insertions(+), 11 deletions(-)
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstore/xenstored_core.c
index 9098b7eee2..7de4df2f28 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstore/xenstored_core.c
@@ -1301,11 +1301,8 @@ static struct node *get_node(struct connection *conn, const void *ctx,
const char *name, const char **canonical_name,
unsigned int perm, bool allow_special)
{
- const char *tmp_name;
struct node *node;
- if (!canonical_name)
- canonical_name = &tmp_name;
*canonical_name = canonicalize(conn, ctx, name, allow_special);
if (!*canonical_name)
return NULL;
@@ -1316,12 +1313,28 @@ static struct node *get_node(struct connection *conn, const void *ctx,
? node : NULL;
}
+static const struct node *get_node_const(struct connection *conn,
+ const void *ctx, const char *name,
+ unsigned int perm, bool allow_special)
+{
+ const char *tmp_name;
+ const struct node *node;
+
+ tmp_name = canonicalize(conn, ctx, name, allow_special);
+ if (!tmp_name)
+ return NULL;
+
+ node = read_node_const(conn, ctx, tmp_name);
+
+ return get_node_chk_perm(conn, ctx, node, tmp_name, perm) ? node : NULL;
+}
+
static int send_directory(const void *ctx, struct connection *conn,
struct buffered_data *in)
{
- struct node *node;
+ const struct node *node;
- node = get_node(conn, ctx, onearg(in), NULL, XS_PERM_READ, false);
+ node = get_node_const(conn, ctx, onearg(in), XS_PERM_READ, false);
if (!node)
return errno;
@@ -1335,14 +1348,14 @@ static int send_directory_part(const void *ctx, struct connection *conn,
{
unsigned int off, len, maxlen, genlen;
char *child, *data;
- struct node *node;
+ const struct node *node;
char gen[24];
if (xenstore_count_strings(in->buffer, in->used) != 2)
return EINVAL;
/* First arg is node name. */
- node = get_node(conn, ctx, in->buffer, NULL, XS_PERM_READ, false);
+ node = get_node_const(conn, ctx, in->buffer, XS_PERM_READ, false);
if (!node)
return errno;
@@ -1389,9 +1402,9 @@ static int send_directory_part(const void *ctx, struct connection *conn,
static int do_read(const void *ctx, struct connection *conn,
struct buffered_data *in)
{
- struct node *node;
+ const struct node *node;
- node = get_node(conn, ctx, onearg(in), NULL, XS_PERM_READ, false);
+ node = get_node_const(conn, ctx, onearg(in), XS_PERM_READ, false);
if (!node)
return errno;
@@ -1799,11 +1812,11 @@ static int do_rm(const void *ctx, struct connection *conn,
static int do_get_perms(const void *ctx, struct connection *conn,
struct buffered_data *in)
{
- struct node *node;
+ const struct node *node;
char *strings;
unsigned int len;
- node = get_node(conn, ctx, onearg(in), NULL, XS_PERM_READ, true);
+ node = get_node_const(conn, ctx, onearg(in), XS_PERM_READ, true);
if (!node)
return errno;
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 17/19] tools/xenstore: introduce get_node_const()
2023-08-14 7:47 ` [PATCH v4 17/19] tools/xenstore: introduce get_node_const() Juergen Gross
@ 2023-08-18 11:16 ` Julien Grall
0 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-18 11:16 UTC (permalink / raw)
To: Juergen Gross, xen-devel; +Cc: Wei Liu, Anthony PERARD
Hi Juergen,
On 14/08/2023 08:47, Juergen Gross wrote:
> Add a variant of get_node() returning a const struct node pointer.
>
> Note that all callers of this new variant don't supply a pointer where
> to store the canonical node name, while all callers needing a non-const
> node do supply this pointer. This results in an asymmetric
> simplification of the two variants.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Julien Grall <jgrall@amazon.com>
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (16 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 17/19] tools/xenstore: introduce get_node_const() Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-14 10:34 ` Anthony PERARD
2023-08-14 11:30 ` [PATCH v4.1 " Juergen Gross
2023-08-14 7:47 ` [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory Juergen Gross
2023-08-18 12:54 ` [PATCH v4 00/19] tools/xenstore: drop TDB Julien Grall
19 siblings, 2 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Anthony PERARD, Julien Grall
Instead of adding the definition of XEN_RUN_STORED to CFLAGS in
multiple Makefiles, let configure add it to tools/config.h instead.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
V4:
- new patch
---
configure | 5 +++++
m4/paths.m4 | 1 +
tools/config.h.in | 3 +++
tools/configure | 5 +++++
tools/libs/store/Makefile | 1 -
tools/xenstore/Makefile.common | 1 -
6 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/configure b/configure
index 99f8434cbf..dd05f314f6 100755
--- a/configure
+++ b/configure
@@ -2079,6 +2079,11 @@ _ACEOF
XEN_RUN_STORED=$rundir_path/xenstored
+cat >>confdefs.h <<_ACEOF
+#define XEN_RUN_STORED "$XEN_RUN_STORED"
+_ACEOF
+
+
XEN_LIB_DIR=$localstatedir/lib/xen
diff --git a/m4/paths.m4 b/m4/paths.m4
index e4104bcce0..3f94c62efb 100644
--- a/m4/paths.m4
+++ b/m4/paths.m4
@@ -138,6 +138,7 @@ AC_DEFINE_UNQUOTED([XEN_LOG_DIR], ["$XEN_LOG_DIR"], [Xen's log dir])
XEN_RUN_STORED=$rundir_path/xenstored
AC_SUBST(XEN_RUN_STORED)
+AC_DEFINE_UNQUOTED([XEN_RUN_STORED], ["$XEN_RUN_STORED"], [Xenstore's runstate path])
XEN_LIB_DIR=$localstatedir/lib/xen
AC_SUBST(XEN_LIB_DIR)
diff --git a/tools/config.h.in b/tools/config.h.in
index 3071cb3998..41014a65ed 100644
--- a/tools/config.h.in
+++ b/tools/config.h.in
@@ -153,6 +153,9 @@
/* Xen's script dir */
#undef XEN_SCRIPT_DIR
+/* Xenstore's runstate path */
+#undef XEN_RUN_STORED
+
/* Enable large inode numbers on Mac OS X 10.5. */
#ifndef _DARWIN_USE_64_BIT_INODE
# define _DARWIN_USE_64_BIT_INODE 1
diff --git a/tools/configure b/tools/configure
index 52b4717d01..5c05fa5ea1 100755
--- a/tools/configure
+++ b/tools/configure
@@ -4060,6 +4060,11 @@ _ACEOF
XEN_RUN_STORED=$rundir_path/xenstored
+cat >>confdefs.h <<_ACEOF
+#define XEN_RUN_STORED "$XEN_RUN_STORED"
+_ACEOF
+
+
XEN_LIB_DIR=$localstatedir/lib/xen
diff --git a/tools/libs/store/Makefile b/tools/libs/store/Makefile
index c1a1508713..0649cf8307 100644
--- a/tools/libs/store/Makefile
+++ b/tools/libs/store/Makefile
@@ -18,7 +18,6 @@ include ../libs.mk
# Include configure output (config.h)
CFLAGS += -include $(XEN_ROOT)/tools/config.h
CFLAGS += $(CFLAGS_libxentoolcore)
-CFLAGS += -DXEN_RUN_STORED="\"$(XEN_RUN_STORED)\""
xs.opic: CFLAGS += -DUSE_PTHREAD
ifeq ($(CONFIG_Linux),y)
diff --git a/tools/xenstore/Makefile.common b/tools/xenstore/Makefile.common
index 3259ab51e6..41973a8a5e 100644
--- a/tools/xenstore/Makefile.common
+++ b/tools/xenstore/Makefile.common
@@ -16,7 +16,6 @@ CFLAGS += $(CFLAGS_libxenevtchn)
CFLAGS += $(CFLAGS_libxenctrl)
CFLAGS += $(CFLAGS_libxenguest)
CFLAGS += $(CFLAGS_libxentoolcore)
-CFLAGS += -DXEN_RUN_STORED="\"$(XEN_RUN_STORED)\""
ifdef CONFIG_STUBDOM
CFLAGS += -DNO_SOCKETS=1
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h
2023-08-14 7:47 ` [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h Juergen Gross
@ 2023-08-14 10:34 ` Anthony PERARD
2023-08-14 11:07 ` Juergen Gross
2023-08-14 11:30 ` [PATCH v4.1 " Juergen Gross
1 sibling, 1 reply; 40+ messages in thread
From: Anthony PERARD @ 2023-08-14 10:34 UTC (permalink / raw)
To: Juergen Gross; +Cc: xen-devel, Wei Liu, Julien Grall
On Mon, Aug 14, 2023 at 09:47:06AM +0200, Juergen Gross wrote:
> Instead of adding the definition of XEN_RUN_STORED to CFLAGS in
> multiple Makefiles, let configure add it to tools/config.h instead.
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
I think with this change, you could probably remove XEN_RUN_STORED from
"config/Paths.mk.in".
In any case, patch looks fine:
Reviewed-by: Anthony PERARD <anthony.perard@citrix.com>
Thanks,
--
Anthony PERARD
^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h
2023-08-14 10:34 ` Anthony PERARD
@ 2023-08-14 11:07 ` Juergen Gross
0 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 11:07 UTC (permalink / raw)
To: Anthony PERARD; +Cc: xen-devel, Wei Liu, Julien Grall
[-- Attachment #1.1.1: Type: text/plain, Size: 582 bytes --]
On 14.08.23 12:34, Anthony PERARD wrote:
> On Mon, Aug 14, 2023 at 09:47:06AM +0200, Juergen Gross wrote:
>> Instead of adding the definition of XEN_RUN_STORED to CFLAGS in
>> multiple Makefiles, let configure add it to tools/config.h instead.
>>
>> Signed-off-by: Juergen Gross <jgross@suse.com>
>
> I think with this change, you could probably remove XEN_RUN_STORED from
> "config/Paths.mk.in".
Ah, indeed. I'll send an updated patch (V4.1).
>
> In any case, patch looks fine:
> Reviewed-by: Anthony PERARD <anthony.perard@citrix.com>
Thanks,
Juergen
[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 3149 bytes --]
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 495 bytes --]
^ permalink raw reply [flat|nested] 40+ messages in thread
* [PATCH v4.1 18/19] tools/config: add XEN_RUN_STORED to config.h
2023-08-14 7:47 ` [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h Juergen Gross
2023-08-14 10:34 ` Anthony PERARD
@ 2023-08-14 11:30 ` Juergen Gross
1 sibling, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 11:30 UTC (permalink / raw)
To: xen-devel; +Cc: Juergen Gross, Wei Liu, Anthony PERARD, Julien Grall
Instead of adding the definition of XEN_RUN_STORED to CFLAGS in
multiple Makefiles, let configure add it to tools/config.h instead.
Signed-off-by: Juergen Gross <jgross@suse.com>
Reviewed-by: Anthony PERARD <anthony.perard@citrix.com>
---
V4:
- new patch
V4.1:
- drop XEN_RUN_STORED from config/Paths.mk.in (Anthony PERARD)
---
config/Paths.mk.in | 1 -
configure | 5 +++++
m4/paths.m4 | 1 +
tools/config.h.in | 3 +++
tools/configure | 5 +++++
tools/libs/store/Makefile | 1 -
tools/xenstore/Makefile.common | 1 -
7 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/config/Paths.mk.in b/config/Paths.mk.in
index 44bab1d748..38b1bb6b1f 100644
--- a/config/Paths.mk.in
+++ b/config/Paths.mk.in
@@ -41,7 +41,6 @@ MAN8DIR := $(mandir)/man8
XEN_RUN_DIR := @XEN_RUN_DIR@
XEN_LOG_DIR := @XEN_LOG_DIR@
XEN_LIB_DIR := @XEN_LIB_DIR@
-XEN_RUN_STORED := @XEN_RUN_STORED@
CONFIG_DIR := @CONFIG_DIR@
INITD_DIR := @INITD_DIR@
diff --git a/configure b/configure
index 99f8434cbf..dd05f314f6 100755
--- a/configure
+++ b/configure
@@ -2079,6 +2079,11 @@ _ACEOF
XEN_RUN_STORED=$rundir_path/xenstored
+cat >>confdefs.h <<_ACEOF
+#define XEN_RUN_STORED "$XEN_RUN_STORED"
+_ACEOF
+
+
XEN_LIB_DIR=$localstatedir/lib/xen
diff --git a/m4/paths.m4 b/m4/paths.m4
index e4104bcce0..3f94c62efb 100644
--- a/m4/paths.m4
+++ b/m4/paths.m4
@@ -138,6 +138,7 @@ AC_DEFINE_UNQUOTED([XEN_LOG_DIR], ["$XEN_LOG_DIR"], [Xen's log dir])
XEN_RUN_STORED=$rundir_path/xenstored
AC_SUBST(XEN_RUN_STORED)
+AC_DEFINE_UNQUOTED([XEN_RUN_STORED], ["$XEN_RUN_STORED"], [Xenstore's runstate path])
XEN_LIB_DIR=$localstatedir/lib/xen
AC_SUBST(XEN_LIB_DIR)
diff --git a/tools/config.h.in b/tools/config.h.in
index 3071cb3998..41014a65ed 100644
--- a/tools/config.h.in
+++ b/tools/config.h.in
@@ -153,6 +153,9 @@
/* Xen's script dir */
#undef XEN_SCRIPT_DIR
+/* Xenstore's runstate path */
+#undef XEN_RUN_STORED
+
/* Enable large inode numbers on Mac OS X 10.5. */
#ifndef _DARWIN_USE_64_BIT_INODE
# define _DARWIN_USE_64_BIT_INODE 1
diff --git a/tools/configure b/tools/configure
index 52b4717d01..5c05fa5ea1 100755
--- a/tools/configure
+++ b/tools/configure
@@ -4060,6 +4060,11 @@ _ACEOF
XEN_RUN_STORED=$rundir_path/xenstored
+cat >>confdefs.h <<_ACEOF
+#define XEN_RUN_STORED "$XEN_RUN_STORED"
+_ACEOF
+
+
XEN_LIB_DIR=$localstatedir/lib/xen
diff --git a/tools/libs/store/Makefile b/tools/libs/store/Makefile
index c1a1508713..0649cf8307 100644
--- a/tools/libs/store/Makefile
+++ b/tools/libs/store/Makefile
@@ -18,7 +18,6 @@ include ../libs.mk
# Include configure output (config.h)
CFLAGS += -include $(XEN_ROOT)/tools/config.h
CFLAGS += $(CFLAGS_libxentoolcore)
-CFLAGS += -DXEN_RUN_STORED="\"$(XEN_RUN_STORED)\""
xs.opic: CFLAGS += -DUSE_PTHREAD
ifeq ($(CONFIG_Linux),y)
diff --git a/tools/xenstore/Makefile.common b/tools/xenstore/Makefile.common
index 3259ab51e6..41973a8a5e 100644
--- a/tools/xenstore/Makefile.common
+++ b/tools/xenstore/Makefile.common
@@ -16,7 +16,6 @@ CFLAGS += $(CFLAGS_libxenevtchn)
CFLAGS += $(CFLAGS_libxenctrl)
CFLAGS += $(CFLAGS_libxenguest)
CFLAGS += $(CFLAGS_libxentoolcore)
-CFLAGS += -DXEN_RUN_STORED="\"$(XEN_RUN_STORED)\""
ifdef CONFIG_STUBDOM
CFLAGS += -DNO_SOCKETS=1
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread
* [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (17 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 18/19] tools/config: add XEN_RUN_STORED to config.h Juergen Gross
@ 2023-08-14 7:47 ` Juergen Gross
2023-08-18 11:22 ` Julien Grall
2023-08-18 12:54 ` [PATCH v4 00/19] tools/xenstore: drop TDB Julien Grall
19 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-14 7:47 UTC (permalink / raw)
To: xen-devel
Cc: Juergen Gross, Andrew Cooper, George Dunlap, Jan Beulich,
Julien Grall, Stefano Stabellini, Wei Liu, Anthony PERARD,
Samuel Thibault
In tools/xenstore there are living xenstored and xenstore clients.
They are no longer sharing anything apart from the "xenstore" in their
names.
Move the xenstored sources into a new directory tools/xenstored while
dropping the "xenstored_" prefix from their names. This will make it
clearer that xenstore clients and xenstored are independent from each
other.
Signed-off-by: Juergen Gross <jgross@suse.com>
---
After the large overhaul of xenstored I think such a reorg would make
sense to go into the same Xen version. Delaying it until the next
version would make potential backports for 4.18 harder.
V4:
- new patch
---
.gitignore | 2 +-
MAINTAINERS | 1 +
stubdom/Makefile | 4 +-
tools/Makefile | 1 +
tools/xenstore/Makefile | 30 ++----------
tools/xenstored/Makefile | 48 +++++++++++++++++++
tools/{xenstore => xenstored}/Makefile.common | 13 +++--
tools/{xenstore => xenstored}/README | 0
.../control.c} | 8 ++--
.../control.h} | 0
.../xenstored_core.c => xenstored/core.c} | 14 +++---
.../xenstored_core.h => xenstored/core.h} | 0
.../xenstored_domain.c => xenstored/domain.c} | 10 ++--
.../xenstored_domain.h => xenstored/domain.h} | 0
tools/{xenstore => xenstored}/hashtable.c | 0
tools/{xenstore => xenstored}/hashtable.h | 0
tools/{xenstore => xenstored}/list.h | 0
.../xenstored_lu.c => xenstored/lu.c} | 8 ++--
.../xenstored_lu.h => xenstored/lu.h} | 0
.../lu_daemon.c} | 4 +-
.../lu_minios.c} | 2 +-
.../xenstored_minios.c => xenstored/minios.c} | 2 +-
.../xenstored_osdep.h => xenstored/osdep.h} | 0
.../xenstored_posix.c => xenstored/posix.c} | 4 +-
tools/{xenstore => xenstored}/talloc.c | 0
tools/{xenstore => xenstored}/talloc.h | 0
.../{xenstore => xenstored}/talloc_guide.txt | 0
.../transaction.c} | 6 +--
.../transaction.h} | 2 +-
tools/{xenstore => xenstored}/utils.c | 0
tools/{xenstore => xenstored}/utils.h | 0
.../xenstored_watch.c => xenstored/watch.c} | 6 +--
.../xenstored_watch.h => xenstored/watch.h} | 2 +-
.../include => xenstored}/xenstore_state.h | 0
34 files changed, 98 insertions(+), 69 deletions(-)
create mode 100644 tools/xenstored/Makefile
rename tools/{xenstore => xenstored}/Makefile.common (50%)
rename tools/{xenstore => xenstored}/README (100%)
rename tools/{xenstore/xenstored_control.c => xenstored/control.c} (98%)
rename tools/{xenstore/xenstored_control.h => xenstored/control.h} (100%)
rename tools/{xenstore/xenstored_core.c => xenstored/core.c} (99%)
rename tools/{xenstore/xenstored_core.h => xenstored/core.h} (100%)
rename tools/{xenstore/xenstored_domain.c => xenstored/domain.c} (99%)
rename tools/{xenstore/xenstored_domain.h => xenstored/domain.h} (100%)
rename tools/{xenstore => xenstored}/hashtable.c (100%)
rename tools/{xenstore => xenstored}/hashtable.h (100%)
rename tools/{xenstore => xenstored}/list.h (100%)
rename tools/{xenstore/xenstored_lu.c => xenstored/lu.c} (98%)
rename tools/{xenstore/xenstored_lu.h => xenstored/lu.h} (100%)
rename tools/{xenstore/xenstored_lu_daemon.c => xenstored/lu_daemon.c} (97%)
rename tools/{xenstore/xenstored_lu_minios.c => xenstored/lu_minios.c} (98%)
rename tools/{xenstore/xenstored_minios.c => xenstored/minios.c} (97%)
rename tools/{xenstore/xenstored_osdep.h => xenstored/osdep.h} (100%)
rename tools/{xenstore/xenstored_posix.c => xenstored/posix.c} (98%)
rename tools/{xenstore => xenstored}/talloc.c (100%)
rename tools/{xenstore => xenstored}/talloc.h (100%)
rename tools/{xenstore => xenstored}/talloc_guide.txt (100%)
rename tools/{xenstore/xenstored_transaction.c => xenstored/transaction.c} (99%)
rename tools/{xenstore/xenstored_transaction.h => xenstored/transaction.h} (98%)
rename tools/{xenstore => xenstored}/utils.c (100%)
rename tools/{xenstore => xenstored}/utils.h (100%)
rename tools/{xenstore/xenstored_watch.c => xenstored/watch.c} (98%)
rename tools/{xenstore/xenstored_watch.h => xenstored/watch.h} (98%)
rename tools/{xenstore/include => xenstored}/xenstore_state.h (100%)
diff --git a/.gitignore b/.gitignore
index c1b73b0968..4314e4e7e5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -247,7 +247,7 @@ tools/xenstore/xenstore-read
tools/xenstore/xenstore-rm
tools/xenstore/xenstore-watch
tools/xenstore/xenstore-write
-tools/xenstore/xenstored
+tools/xenstored/xenstored
tools/xentop/xentop
tools/xentrace/xentrace_setsize
tools/xentrace/tbctl
diff --git a/MAINTAINERS b/MAINTAINERS
index a0805d35cd..25493999ff 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -670,6 +670,7 @@ F: tools/include/xenstore_lib.h
F: tools/include/xen-tools/xenstore-common.h
F: tools/libs/store/
F: tools/xenstore/
+F: tools/xenstored/
XENTRACE
M: George Dunlap <george.dunlap@citrix.com>
diff --git a/stubdom/Makefile b/stubdom/Makefile
index d5fb354e7e..52bf7f0e21 100644
--- a/stubdom/Makefile
+++ b/stubdom/Makefile
@@ -371,10 +371,10 @@ endef
$(foreach lib,$(STUB_LIBS),$(eval $(call BUILD_lib,$(lib))))
-xenstore/stamp: $(XEN_ROOT)/tools/xenstore/Makefile.common
+xenstore/stamp: $(XEN_ROOT)/tools/xenstored/Makefile.common
$(do_links)
-xenstorepvh/stamp: $(XEN_ROOT)/tools/xenstore/Makefile.common
+xenstorepvh/stamp: $(XEN_ROOT)/tools/xenstored/Makefile.common
$(do_links)
LINK_DIRS := xenstore xenstorepvh $(foreach dir,$(STUB_LIBS),libs-$(XEN_TARGET_ARCH)/$(dir))
diff --git a/tools/Makefile b/tools/Makefile
index 1ff90ddfa0..1b12b2ce78 100644
--- a/tools/Makefile
+++ b/tools/Makefile
@@ -9,6 +9,7 @@ SUBDIRS-y += libs
SUBDIRS-y += flask
SUBDIRS-y += fuzz
SUBDIRS-y += xenstore
+SUBDIRS-$(XENSTORE_XENSTORED) += xenstored
SUBDIRS-y += misc
SUBDIRS-y += examples
SUBDIRS-y += hotplug
diff --git a/tools/xenstore/Makefile b/tools/xenstore/Makefile
index dc39b6cb31..1c5740450a 100644
--- a/tools/xenstore/Makefile
+++ b/tools/xenstore/Makefile
@@ -1,18 +1,11 @@
XEN_ROOT=$(CURDIR)/../..
include $(XEN_ROOT)/tools/Rules.mk
-include Makefile.common
-
-xenstored: LDLIBS += $(LDLIBS_libxenevtchn)
-xenstored: LDLIBS += $(LDLIBS_libxengnttab)
-xenstored: LDLIBS += $(LDLIBS_libxenctrl)
-xenstored: LDLIBS += -lrt
-xenstored: LDLIBS += $(SOCKET_LIBS)
-
-ifeq ($(CONFIG_SYSTEMD),y)
-$(XENSTORED_OBJS-y): CFLAGS += $(SYSTEMD_CFLAGS)
-xenstored: LDLIBS += $(SYSTEMD_LIBS)
-endif
+CFLAGS += -include $(XEN_ROOT)/tools/config.h
+CFLAGS += $(CFLAGS_libxenctrl)
+CFLAGS += $(CFLAGS_libxenguest)
+CFLAGS += $(CFLAGS_libxentoolcore)
+CFLAGS += $(CFLAGS_libxenstore)
xenstore: LDLIBS += $(LDLIBS_libxenstore)
xenstore: LDLIBS += $(LDLIBS_libxentoolcore)
@@ -28,9 +21,6 @@ CLIENTS := xenstore-exists xenstore-list xenstore-read xenstore-rm xenstore-chmo
CLIENTS += xenstore-write xenstore-ls xenstore-watch
TARGETS := xenstore $(CLIENTS) xenstore-control
-ifeq ($(XENSTORE_XENSTORED),y)
-TARGETS += xenstored
-endif
.PHONY: all
all: $(TARGETS)
@@ -38,9 +28,6 @@ all: $(TARGETS)
.PHONY: clients
clients: xenstore $(CLIENTS) xenstore-control
-xenstored: $(XENSTORED_OBJS-y)
- $(CC) $(LDFLAGS) $^ $(LDLIBS) -o $@ $(APPEND_LDFLAGS)
-
$(CLIENTS): xenstore
ln -f xenstore $@
@@ -64,10 +51,6 @@ TAGS:
.PHONY: install
install: all
$(INSTALL_DIR) $(DESTDIR)$(bindir)
-ifeq ($(XENSTORE_XENSTORED),y)
- $(INSTALL_DIR) $(DESTDIR)$(sbindir)
- $(INSTALL_PROG) xenstored $(DESTDIR)$(sbindir)
-endif
$(INSTALL_PROG) xenstore-control $(DESTDIR)$(bindir)
$(INSTALL_PROG) xenstore $(DESTDIR)$(bindir)
set -e ; for c in $(CLIENTS) ; do \
@@ -79,9 +62,6 @@ uninstall:
rm -f $(addprefix $(DESTDIR)$(bindir)/, $(CLIENTS))
rm -f $(DESTDIR)$(bindir)/xenstore
rm -f $(DESTDIR)$(bindir)/xenstore-control
-ifeq ($(XENSTORE_XENSTORED),y)
- rm -f $(DESTDIR)$(sbindir)/xenstored
-endif
if [ -d $(DESTDIR)$(includedir)/xenstore-compat ]; then \
rmdir --ignore-fail-on-non-empty $(DESTDIR)$(includedir)/xenstore-compat; \
fi
diff --git a/tools/xenstored/Makefile b/tools/xenstored/Makefile
new file mode 100644
index 0000000000..f3bd3d43c4
--- /dev/null
+++ b/tools/xenstored/Makefile
@@ -0,0 +1,48 @@
+XEN_ROOT=$(CURDIR)/../..
+include $(XEN_ROOT)/tools/Rules.mk
+
+include Makefile.common
+
+xenstored: LDLIBS += $(LDLIBS_libxenevtchn)
+xenstored: LDLIBS += $(LDLIBS_libxengnttab)
+xenstored: LDLIBS += $(LDLIBS_libxenctrl)
+xenstored: LDLIBS += -lrt
+xenstored: LDLIBS += $(SOCKET_LIBS)
+
+ifeq ($(CONFIG_SYSTEMD),y)
+$(XENSTORED_OBJS-y): CFLAGS += $(SYSTEMD_CFLAGS)
+xenstored: LDLIBS += $(SYSTEMD_LIBS)
+endif
+
+TARGETS += xenstored
+
+.PHONY: all
+all: $(TARGETS)
+
+xenstored: $(XENSTORED_OBJS-y)
+ $(CC) $(LDFLAGS) $^ $(LDLIBS) -o $@ $(APPEND_LDFLAGS)
+
+.PHONY: clean
+clean::
+ $(RM) $(TARGETS) $(DEPS_RM)
+
+.PHONY: distclean
+distclean: clean
+
+.PHONY: TAGS
+TAGS:
+ etags `find . -name '*.[ch]'`
+
+.PHONY: install
+install: all
+ $(INSTALL_DIR) $(DESTDIR)$(sbindir)
+ $(INSTALL_PROG) xenstored $(DESTDIR)$(sbindir)
+
+.PHONY: uninstall
+uninstall:
+ rm -f $(DESTDIR)$(sbindir)/xenstored
+ if [ -d $(DESTDIR)$(includedir)/xenstore-compat ]; then \
+ rmdir --ignore-fail-on-non-empty $(DESTDIR)$(includedir)/xenstore-compat; \
+ fi
+
+-include $(DEPS_INCLUDE)
diff --git a/tools/xenstore/Makefile.common b/tools/xenstored/Makefile.common
similarity index 50%
rename from tools/xenstore/Makefile.common
rename to tools/xenstored/Makefile.common
index 41973a8a5e..189ab81b8d 100644
--- a/tools/xenstore/Makefile.common
+++ b/tools/xenstored/Makefile.common
@@ -1,17 +1,16 @@
# Makefile shared with stubdom
-XENSTORED_OBJS-y := xenstored_core.o xenstored_watch.o xenstored_domain.o
-XENSTORED_OBJS-y += xenstored_transaction.o xenstored_control.o xenstored_lu.o
+XENSTORED_OBJS-y := core.o watch.o domain.o
+XENSTORED_OBJS-y += transaction.o control.o lu.o
XENSTORED_OBJS-y += talloc.o utils.o hashtable.o
-XENSTORED_OBJS-$(CONFIG_Linux) += xenstored_posix.o xenstored_lu_daemon.o
-XENSTORED_OBJS-$(CONFIG_NetBSD) += xenstored_posix.o xenstored_lu_daemon.o
-XENSTORED_OBJS-$(CONFIG_FreeBSD) += xenstored_posix.o xenstored_lu_daemon.o
-XENSTORED_OBJS-$(CONFIG_MiniOS) += xenstored_minios.o xenstored_lu_minios.o
+XENSTORED_OBJS-$(CONFIG_Linux) += posix.o lu_daemon.o
+XENSTORED_OBJS-$(CONFIG_NetBSD) += posix.o lu_daemon.o
+XENSTORED_OBJS-$(CONFIG_FreeBSD) += posix.o lu_daemon.o
+XENSTORED_OBJS-$(CONFIG_MiniOS) += minios.o lu_minios.o
# Include configure output (config.h)
CFLAGS += -include $(XEN_ROOT)/tools/config.h
-CFLAGS += -I./include
CFLAGS += $(CFLAGS_libxenevtchn)
CFLAGS += $(CFLAGS_libxenctrl)
CFLAGS += $(CFLAGS_libxenguest)
diff --git a/tools/xenstore/README b/tools/xenstored/README
similarity index 100%
rename from tools/xenstore/README
rename to tools/xenstored/README
diff --git a/tools/xenstore/xenstored_control.c b/tools/xenstored/control.c
similarity index 98%
rename from tools/xenstore/xenstored_control.c
rename to tools/xenstored/control.c
index 3bdf2edc34..b2f64d674f 100644
--- a/tools/xenstore/xenstored_control.c
+++ b/tools/xenstored/control.c
@@ -27,10 +27,10 @@
#include "utils.h"
#include "talloc.h"
-#include "xenstored_core.h"
-#include "xenstored_control.h"
-#include "xenstored_domain.h"
-#include "xenstored_lu.h"
+#include "core.h"
+#include "control.h"
+#include "domain.h"
+#include "lu.h"
struct cmd_s {
char *cmd;
diff --git a/tools/xenstore/xenstored_control.h b/tools/xenstored/control.h
similarity index 100%
rename from tools/xenstore/xenstored_control.h
rename to tools/xenstored/control.h
diff --git a/tools/xenstore/xenstored_core.c b/tools/xenstored/core.c
similarity index 99%
rename from tools/xenstore/xenstored_core.c
rename to tools/xenstored/core.c
index 7de4df2f28..092de76a2e 100644
--- a/tools/xenstore/xenstored_core.c
+++ b/tools/xenstored/core.c
@@ -47,12 +47,12 @@
#include "utils.h"
#include "list.h"
#include "talloc.h"
-#include "xenstored_core.h"
-#include "xenstored_watch.h"
-#include "xenstored_transaction.h"
-#include "xenstored_domain.h"
-#include "xenstored_control.h"
-#include "xenstored_lu.h"
+#include "core.h"
+#include "watch.h"
+#include "transaction.h"
+#include "domain.h"
+#include "control.h"
+#include "lu.h"
#ifndef NO_SOCKETS
#if defined(HAVE_SYSTEMD)
@@ -64,7 +64,7 @@
#include <systemd/sd-daemon.h>
#endif
-extern xenevtchn_handle *xce_handle; /* in xenstored_domain.c */
+extern xenevtchn_handle *xce_handle; /* in domain.c */
static int xce_pollfd_idx = -1;
static struct pollfd *fds;
static unsigned int current_array_size;
diff --git a/tools/xenstore/xenstored_core.h b/tools/xenstored/core.h
similarity index 100%
rename from tools/xenstore/xenstored_core.h
rename to tools/xenstored/core.h
diff --git a/tools/xenstore/xenstored_domain.c b/tools/xenstored/domain.c
similarity index 99%
rename from tools/xenstore/xenstored_domain.c
rename to tools/xenstored/domain.c
index 1bf138c8b1..a6cd199fdc 100644
--- a/tools/xenstore/xenstored_domain.c
+++ b/tools/xenstored/domain.c
@@ -27,11 +27,11 @@
#include "utils.h"
#include "talloc.h"
-#include "xenstored_core.h"
-#include "xenstored_domain.h"
-#include "xenstored_transaction.h"
-#include "xenstored_watch.h"
-#include "xenstored_control.h"
+#include "core.h"
+#include "domain.h"
+#include "transaction.h"
+#include "watch.h"
+#include "control.h"
#include <xenevtchn.h>
#include <xenctrl.h>
diff --git a/tools/xenstore/xenstored_domain.h b/tools/xenstored/domain.h
similarity index 100%
rename from tools/xenstore/xenstored_domain.h
rename to tools/xenstored/domain.h
diff --git a/tools/xenstore/hashtable.c b/tools/xenstored/hashtable.c
similarity index 100%
rename from tools/xenstore/hashtable.c
rename to tools/xenstored/hashtable.c
diff --git a/tools/xenstore/hashtable.h b/tools/xenstored/hashtable.h
similarity index 100%
rename from tools/xenstore/hashtable.h
rename to tools/xenstored/hashtable.h
diff --git a/tools/xenstore/list.h b/tools/xenstored/list.h
similarity index 100%
rename from tools/xenstore/list.h
rename to tools/xenstored/list.h
diff --git a/tools/xenstore/xenstored_lu.c b/tools/xenstored/lu.c
similarity index 98%
rename from tools/xenstore/xenstored_lu.c
rename to tools/xenstored/lu.c
index f7f76acbf9..2f41d10c95 100644
--- a/tools/xenstore/xenstored_lu.c
+++ b/tools/xenstored/lu.c
@@ -13,10 +13,10 @@
#include <time.h>
#include "talloc.h"
-#include "xenstored_core.h"
-#include "xenstored_domain.h"
-#include "xenstored_lu.h"
-#include "xenstored_watch.h"
+#include "core.h"
+#include "domain.h"
+#include "lu.h"
+#include "watch.h"
#ifndef NO_LIVE_UPDATE
struct live_update *lu_status;
diff --git a/tools/xenstore/xenstored_lu.h b/tools/xenstored/lu.h
similarity index 100%
rename from tools/xenstore/xenstored_lu.h
rename to tools/xenstored/lu.h
diff --git a/tools/xenstore/xenstored_lu_daemon.c b/tools/xenstored/lu_daemon.c
similarity index 97%
rename from tools/xenstore/xenstored_lu_daemon.c
rename to tools/xenstored/lu_daemon.c
index 8c7522b0e1..71bcabadd3 100644
--- a/tools/xenstore/xenstored_lu_daemon.c
+++ b/tools/xenstored/lu_daemon.c
@@ -13,8 +13,8 @@
#include <xen-tools/xenstore-common.h>
#include "talloc.h"
-#include "xenstored_core.h"
-#include "xenstored_lu.h"
+#include "core.h"
+#include "lu.h"
#ifndef NO_LIVE_UPDATE
void lu_get_dump_state(struct lu_dump_state *state)
diff --git a/tools/xenstore/xenstored_lu_minios.c b/tools/xenstored/lu_minios.c
similarity index 98%
rename from tools/xenstore/xenstored_lu_minios.c
rename to tools/xenstored/lu_minios.c
index ae0483575e..ede8b4dd47 100644
--- a/tools/xenstore/xenstored_lu_minios.c
+++ b/tools/xenstored/lu_minios.c
@@ -14,7 +14,7 @@
#include <xen-tools/common-macros.h>
#include "talloc.h"
-#include "xenstored_lu.h"
+#include "lu.h"
/* Mini-OS only knows about MAP_ANON. */
#ifndef MAP_ANONYMOUS
diff --git a/tools/xenstore/xenstored_minios.c b/tools/xenstored/minios.c
similarity index 97%
rename from tools/xenstore/xenstored_minios.c
rename to tools/xenstored/minios.c
index aa384e50c8..b5c3a205e6 100644
--- a/tools/xenstore/xenstored_minios.c
+++ b/tools/xenstored/minios.c
@@ -17,7 +17,7 @@
*/
#include <sys/types.h>
#include <sys/mman.h>
-#include "xenstored_core.h"
+#include "core.h"
#include <xen/grant_table.h>
void write_pidfile(const char *pidfile)
diff --git a/tools/xenstore/xenstored_osdep.h b/tools/xenstored/osdep.h
similarity index 100%
rename from tools/xenstore/xenstored_osdep.h
rename to tools/xenstored/osdep.h
diff --git a/tools/xenstore/xenstored_posix.c b/tools/xenstored/posix.c
similarity index 98%
rename from tools/xenstore/xenstored_posix.c
rename to tools/xenstored/posix.c
index b20504d1b6..6ac45fdb45 100644
--- a/tools/xenstore/xenstored_posix.c
+++ b/tools/xenstored/posix.c
@@ -24,8 +24,8 @@
#include <sys/mman.h>
#include "utils.h"
-#include "xenstored_core.h"
-#include "xenstored_osdep.h"
+#include "core.h"
+#include "osdep.h"
void write_pidfile(const char *pidfile)
{
diff --git a/tools/xenstore/talloc.c b/tools/xenstored/talloc.c
similarity index 100%
rename from tools/xenstore/talloc.c
rename to tools/xenstored/talloc.c
diff --git a/tools/xenstore/talloc.h b/tools/xenstored/talloc.h
similarity index 100%
rename from tools/xenstore/talloc.h
rename to tools/xenstored/talloc.h
diff --git a/tools/xenstore/talloc_guide.txt b/tools/xenstored/talloc_guide.txt
similarity index 100%
rename from tools/xenstore/talloc_guide.txt
rename to tools/xenstored/talloc_guide.txt
diff --git a/tools/xenstore/xenstored_transaction.c b/tools/xenstored/transaction.c
similarity index 99%
rename from tools/xenstore/xenstored_transaction.c
rename to tools/xenstored/transaction.c
index 1f892b002d..167cd597fd 100644
--- a/tools/xenstore/xenstored_transaction.c
+++ b/tools/xenstored/transaction.c
@@ -30,9 +30,9 @@
#include <unistd.h>
#include "talloc.h"
#include "list.h"
-#include "xenstored_transaction.h"
-#include "xenstored_watch.h"
-#include "xenstored_domain.h"
+#include "transaction.h"
+#include "watch.h"
+#include "domain.h"
#include "xenstore_lib.h"
#include "utils.h"
diff --git a/tools/xenstore/xenstored_transaction.h b/tools/xenstored/transaction.h
similarity index 98%
rename from tools/xenstore/xenstored_transaction.h
rename to tools/xenstored/transaction.h
index b196b1ab07..90435b4fc9 100644
--- a/tools/xenstore/xenstored_transaction.h
+++ b/tools/xenstored/transaction.h
@@ -17,7 +17,7 @@
*/
#ifndef _XENSTORED_TRANSACTION_H
#define _XENSTORED_TRANSACTION_H
-#include "xenstored_core.h"
+#include "core.h"
enum node_access_type {
NODE_ACCESS_READ,
diff --git a/tools/xenstore/utils.c b/tools/xenstored/utils.c
similarity index 100%
rename from tools/xenstore/utils.c
rename to tools/xenstored/utils.c
diff --git a/tools/xenstore/utils.h b/tools/xenstored/utils.h
similarity index 100%
rename from tools/xenstore/utils.h
rename to tools/xenstored/utils.h
diff --git a/tools/xenstore/xenstored_watch.c b/tools/xenstored/watch.c
similarity index 98%
rename from tools/xenstore/xenstored_watch.c
rename to tools/xenstored/watch.c
index 7d4d097cf9..b66a9f1a39 100644
--- a/tools/xenstore/xenstored_watch.c
+++ b/tools/xenstored/watch.c
@@ -25,11 +25,11 @@
#include <assert.h>
#include "talloc.h"
#include "list.h"
-#include "xenstored_watch.h"
+#include "watch.h"
#include "xenstore_lib.h"
#include "utils.h"
-#include "xenstored_domain.h"
-#include "xenstored_transaction.h"
+#include "domain.h"
+#include "transaction.h"
struct watch
{
diff --git a/tools/xenstore/xenstored_watch.h b/tools/xenstored/watch.h
similarity index 98%
rename from tools/xenstore/xenstored_watch.h
rename to tools/xenstored/watch.h
index ea247997ad..d9ac6a334a 100644
--- a/tools/xenstore/xenstored_watch.h
+++ b/tools/xenstored/watch.h
@@ -19,7 +19,7 @@
#ifndef _XENSTORED_WATCH_H
#define _XENSTORED_WATCH_H
-#include "xenstored_core.h"
+#include "core.h"
int do_watch(const void *ctx, struct connection *conn,
struct buffered_data *in);
diff --git a/tools/xenstore/include/xenstore_state.h b/tools/xenstored/xenstore_state.h
similarity index 100%
rename from tools/xenstore/include/xenstore_state.h
rename to tools/xenstored/xenstore_state.h
--
2.35.3
^ permalink raw reply related [flat|nested] 40+ messages in thread* Re: [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory
2023-08-14 7:47 ` [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory Juergen Gross
@ 2023-08-18 11:22 ` Julien Grall
2023-08-18 12:14 ` Juergen Gross
0 siblings, 1 reply; 40+ messages in thread
From: Julien Grall @ 2023-08-18 11:22 UTC (permalink / raw)
To: Juergen Gross, xen-devel
Cc: Andrew Cooper, George Dunlap, Jan Beulich, Stefano Stabellini,
Wei Liu, Anthony PERARD, Samuel Thibault
Hi Juergen,
On 14/08/2023 08:47, Juergen Gross wrote:
> In tools/xenstore there are living xenstored and xenstore clients.
> They are no longer sharing anything apart from the "xenstore" in their
> names.
>
> Move the xenstored sources into a new directory tools/xenstored while
> dropping the "xenstored_" prefix from their names. This will make it
> clearer that xenstore clients and xenstored are independent from each
> other.
In term of naming, I would prefer if we follow what was done for the
console. I.e:
xenstore/client: All the clients
xenstore/daemon: C Xenstored
This would avoid the one character difference between the two directories.
What do the other thinks?
>
> Signed-off-by: Juergen Gross <jgross@suse.com>
> ---
> After the large overhaul of xenstored I think such a reorg would make
> sense to go into the same Xen version. Delaying it until the next
> version would make potential backports for 4.18 harder.
+1.
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory
2023-08-18 11:22 ` Julien Grall
@ 2023-08-18 12:14 ` Juergen Gross
2023-08-18 12:42 ` Julien Grall
0 siblings, 1 reply; 40+ messages in thread
From: Juergen Gross @ 2023-08-18 12:14 UTC (permalink / raw)
To: Julien Grall, xen-devel
Cc: Andrew Cooper, George Dunlap, Jan Beulich, Stefano Stabellini,
Wei Liu, Anthony PERARD, Samuel Thibault
[-- Attachment #1.1.1: Type: text/plain, Size: 1496 bytes --]
On 18.08.23 13:22, Julien Grall wrote:
> Hi Juergen,
>
> On 14/08/2023 08:47, Juergen Gross wrote:
>> In tools/xenstore there are living xenstored and xenstore clients.
>> They are no longer sharing anything apart from the "xenstore" in their
>> names.
>>
>> Move the xenstored sources into a new directory tools/xenstored while
>> dropping the "xenstored_" prefix from their names. This will make it
>> clearer that xenstore clients and xenstored are independent from each
>> other.
>
> In term of naming, I would prefer if we follow what was done for the console. I.e:
>
> xenstore/client: All the clients
> xenstore/daemon: C Xenstored
>
> This would avoid the one character difference between the two directories.
Yes, that would be the alternative (apart from renaming the xenstore directory
to something different, e.g. xs-clients).
The reason I was leaning towards my solution was that the clients are meant to
be used with any xenstored implementation. This wouldn't be reflected by using
a common tools/xenstore parent directory for the clients and C xenstored.
In the end I could live with your proposal, too.
>
> What do the other thinks?
>
>>
>> Signed-off-by: Juergen Gross <jgross@suse.com>
>> ---
>> After the large overhaul of xenstored I think such a reorg would make
>> sense to go into the same Xen version. Delaying it until the next
>> version would make potential backports for 4.18 harder.
>
> +1.
Thanks,
Juergen
[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 3149 bytes --]
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 495 bytes --]
^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory
2023-08-18 12:14 ` Juergen Gross
@ 2023-08-18 12:42 ` Julien Grall
2023-08-18 12:46 ` Juergen Gross
0 siblings, 1 reply; 40+ messages in thread
From: Julien Grall @ 2023-08-18 12:42 UTC (permalink / raw)
To: Juergen Gross, xen-devel
Cc: Andrew Cooper, George Dunlap, Jan Beulich, Stefano Stabellini,
Wei Liu, Anthony PERARD, Samuel Thibault
Hi Juergen,
On 18/08/2023 13:14, Juergen Gross wrote:
> On 18.08.23 13:22, Julien Grall wrote:
>> Hi Juergen,
>>
>> On 14/08/2023 08:47, Juergen Gross wrote:
>>> In tools/xenstore there are living xenstored and xenstore clients.
>>> They are no longer sharing anything apart from the "xenstore" in their
>>> names.
>>>
>>> Move the xenstored sources into a new directory tools/xenstored while
>>> dropping the "xenstored_" prefix from their names. This will make it
>>> clearer that xenstore clients and xenstored are independent from each
>>> other.
>>
>> In term of naming, I would prefer if we follow what was done for the
>> console. I.e:
>>
>> xenstore/client: All the clients
>> xenstore/daemon: C Xenstored
>>
>> This would avoid the one character difference between the two
>> directories.
>
> Yes, that would be the alternative (apart from renaming the xenstore
> directory
> to something different, e.g. xs-clients).
xs-clients would be OK. I guess you didn't suggest xenstore-clients
because it is too long?
>
> The reason I was leaning towards my solution was that the clients are
> meant to
> be used with any xenstored implementation. This wouldn't be reflected by
> using
> a common tools/xenstore parent directory for the clients and C xenstored.
You have a point. I was also trying to avoid to have too many directoy
in tools. But we already have 'qemu-trad' and 'qemu-upstream'...
>
> In the end I could live with your proposal, too.
My main concern with your proposal was the one character difference in
the name. xenstored and xs-clients/xenstore-clients would work for me.
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory
2023-08-18 12:42 ` Julien Grall
@ 2023-08-18 12:46 ` Juergen Gross
0 siblings, 0 replies; 40+ messages in thread
From: Juergen Gross @ 2023-08-18 12:46 UTC (permalink / raw)
To: Julien Grall, xen-devel
Cc: Andrew Cooper, George Dunlap, Jan Beulich, Stefano Stabellini,
Wei Liu, Anthony PERARD, Samuel Thibault
[-- Attachment #1.1.1: Type: text/plain, Size: 1973 bytes --]
On 18.08.23 14:42, Julien Grall wrote:
> Hi Juergen,
>
> On 18/08/2023 13:14, Juergen Gross wrote:
>> On 18.08.23 13:22, Julien Grall wrote:
>>> Hi Juergen,
>>>
>>> On 14/08/2023 08:47, Juergen Gross wrote:
>>>> In tools/xenstore there are living xenstored and xenstore clients.
>>>> They are no longer sharing anything apart from the "xenstore" in their
>>>> names.
>>>>
>>>> Move the xenstored sources into a new directory tools/xenstored while
>>>> dropping the "xenstored_" prefix from their names. This will make it
>>>> clearer that xenstore clients and xenstored are independent from each
>>>> other.
>>>
>>> In term of naming, I would prefer if we follow what was done for the console.
>>> I.e:
>>>
>>> xenstore/client: All the clients
>>> xenstore/daemon: C Xenstored
>>>
>>> This would avoid the one character difference between the two directories.
>>
>> Yes, that would be the alternative (apart from renaming the xenstore directory
>> to something different, e.g. xs-clients).
>
> xs-clients would be OK. I guess you didn't suggest xenstore-clients because it
> is too long?
I was more thinking about path name completion when typing. Using xs-clients
would allow to use the <tab> after the second character already. :-)
>
>>
>> The reason I was leaning towards my solution was that the clients are meant to
>> be used with any xenstored implementation. This wouldn't be reflected by using
>> a common tools/xenstore parent directory for the clients and C xenstored.
>
> You have a point. I was also trying to avoid to have too many directoy in tools.
> But we already have 'qemu-trad' and 'qemu-upstream'...
>
>>
>> In the end I could live with your proposal, too.
>
> My main concern with your proposal was the one character difference in the name.
> xenstored and xs-clients/xenstore-clients would work for me.
Okay, thanks.
With above reasoning I'm leaning towards xs-clients.
Juergen
[-- Attachment #1.1.2: OpenPGP public key --]
[-- Type: application/pgp-keys, Size: 3149 bytes --]
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 495 bytes --]
^ permalink raw reply [flat|nested] 40+ messages in thread
* Re: [PATCH v4 00/19] tools/xenstore: drop TDB
2023-08-14 7:46 [PATCH v4 00/19] tools/xenstore: drop TDB Juergen Gross
` (18 preceding siblings ...)
2023-08-14 7:47 ` [PATCH v4 19/19] tools/xenstore: move xenstored sources into dedicated directory Juergen Gross
@ 2023-08-18 12:54 ` Julien Grall
19 siblings, 0 replies; 40+ messages in thread
From: Julien Grall @ 2023-08-18 12:54 UTC (permalink / raw)
To: Juergen Gross, xen-devel
Cc: Wei Liu, Anthony PERARD, Andrew Cooper, George Dunlap,
Jan Beulich, Stefano Stabellini, Samuel Thibault
Hi Juergen,
On 14/08/2023 08:46, Juergen Gross wrote:
> Juergen Gross (19):
> tools/xenstore: make hashtable key parameter const
> tools/xenstore: let hashtable_add() fail in case of existing entry
> tools/xenstore: add hashtable_replace() function
> tools/xenstore: drop use of tdb
> tools/xenstore: remove tdb code
> tools/xenstore: let db_delete() return void
> tools/xenstore: change talloc_free() to take a const pointer
> tools/xenstore: move copying of node data out of db_fetch()
> tools/xenstore: rework struct xs_tdb_record_hdr
> tools/xenstore: don't use struct node_perms in struct node
> tools/xenstore: use struct node_hdr in struct node
> tools/xenstore: alloc new memory in domain_adjust_node_perms()
> tools/xenstore: introduce read_node_const()
> tools/xenstore: merge get_spec_node() into get_node_canonicalized()
> tools/xenstore: merge is_valid_nodename() into canonicalize()
> tools/xenstore: rework get_node()
> tools/xenstore: introduce get_node_const()
> tools/config: add XEN_RUN_STORED to config.h
I have committed up to this patch.
Cheers,
--
Julien Grall
^ permalink raw reply [flat|nested] 40+ messages in thread