[libvirt] [PATCH v2 04/12] Implement keepalive protocol in libvirt daemon
Jiri Denemark
jdenemar at redhat.com
Fri Sep 23 08:24:49 UTC 2011
---
daemon/libvirtd.aug | 4 +
daemon/libvirtd.c | 11 ++++
daemon/libvirtd.conf | 15 +++++
daemon/remote.c | 38 +++++++++++++
src/remote/remote_protocol.x | 2 +-
src/rpc/virnetserver.c | 10 +++
src/rpc/virnetserver.h | 2 +
src/rpc/virnetserverclient.c | 126 +++++++++++++++++++++++++++++++++++++++---
src/rpc/virnetserverclient.h | 6 ++
9 files changed, 204 insertions(+), 10 deletions(-)
diff --git a/daemon/libvirtd.aug b/daemon/libvirtd.aug
index ce00db5..6cd3f28 100644
--- a/daemon/libvirtd.aug
+++ b/daemon/libvirtd.aug
@@ -66,6 +66,9 @@ module Libvirtd =
let auditing_entry = int_entry "audit_level"
| bool_entry "audit_logging"
+ let keepalive_entry = int_entry "keepalive_interval"
+ | int_entry "keepalive_count"
+
(* Each enty in the config is one of the following three ... *)
let entry = network_entry
| sock_acl_entry
@@ -75,6 +78,7 @@ module Libvirtd =
| processing_entry
| logging_entry
| auditing_entry
+ | keepalive_entry
let comment = [ label "#comment" . del /#[ \t]*/ "# " . store /([^ \t\n][^\n]*)?/ . del /\n/ "\n" ]
let empty = [ label "#empty" . eol ]
diff --git a/daemon/libvirtd.c b/daemon/libvirtd.c
index d1bc3dd..4ad2b2e 100644
--- a/daemon/libvirtd.c
+++ b/daemon/libvirtd.c
@@ -146,6 +146,9 @@ struct daemonConfig {
int audit_level;
int audit_logging;
+
+ int keepalive_interval;
+ unsigned int keepalive_count;
};
enum {
@@ -899,6 +902,9 @@ daemonConfigNew(bool privileged ATTRIBUTE_UNUSED)
data->audit_level = 1;
data->audit_logging = 0;
+ data->keepalive_interval = 5;
+ data->keepalive_count = 5;
+
localhost = virGetHostname(NULL);
if (localhost == NULL) {
/* we couldn't resolve the hostname; assume that we are
@@ -1062,6 +1068,9 @@ daemonConfigLoad(struct daemonConfig *data,
GET_CONF_STR (conf, filename, log_outputs);
GET_CONF_INT (conf, filename, log_buffer_size);
+ GET_CONF_INT (conf, filename, keepalive_interval);
+ GET_CONF_INT (conf, filename, keepalive_count);
+
virConfFree (conf);
return 0;
@@ -1452,6 +1461,8 @@ int main(int argc, char **argv) {
config->max_workers,
config->prio_workers,
config->max_clients,
+ config->keepalive_interval,
+ config->keepalive_count,
config->mdns_adv ? config->mdns_name : NULL,
use_polkit_dbus,
remoteClientInitHook))) {
diff --git a/daemon/libvirtd.conf b/daemon/libvirtd.conf
index da3983e..4f6ab9f 100644
--- a/daemon/libvirtd.conf
+++ b/daemon/libvirtd.conf
@@ -366,3 +366,18 @@
# it with the output of the 'uuidgen' command and then
# uncomment this entry
#host_uuid = "00000000-0000-0000-0000-000000000000"
+
+###################################################################
+# Keepalive protocol:
+# This allows libvirtd to detect broken client connections or even
+# dead client. A keepalive message is sent to a client after
+# keepalive_interval seconds of inactivity to check if the client is
+# still responding; keepalive_count is a maximum number of keepalive
+# messages that are allowed to be sent to the client without getting
+# any response before the connection is considered broken. In other
+# words, the connection is automatically closed approximately after
+# keepalive_interval * (keepalive_count + 1) seconds since the last
+# message received from the client.
+#
+#keepalive_interval = 5
+#keepalive_count = 5
diff --git a/daemon/remote.c b/daemon/remote.c
index 245d41c..946bb7e 100644
--- a/daemon/remote.c
+++ b/daemon/remote.c
@@ -3112,6 +3112,44 @@ cleanup:
}
+static int
+remoteDispatchSupportsFeature(virNetServerPtr server ATTRIBUTE_UNUSED,
+ virNetServerClientPtr client,
+ virNetMessageHeaderPtr hdr ATTRIBUTE_UNUSED,
+ virNetMessageErrorPtr rerr,
+ remote_supports_feature_args *args,
+ remote_supports_feature_ret *ret)
+{
+ int rv = -1;
+ int supported;
+ struct daemonClientPrivate *priv =
+ virNetServerClientGetPrivateData(client);
+
+ if (!priv->conn) {
+ virNetError(VIR_ERR_INTERNAL_ERROR, "%s", _("connection not open"));
+ goto cleanup;
+ }
+
+ if (args->feature == VIR_DRV_FEATURE_PROGRAM_KEEPALIVE) {
+ supported = 1;
+ goto done;
+ }
+
+ if ((supported = virDrvSupportsFeature(priv->conn, args->feature)) < 0)
+ goto cleanup;
+
+done:
+ ret->supported = supported;
+ rv = 0;
+
+cleanup:
+ if (rv < 0)
+ virNetMessageSaveError(rerr);
+ return rv;
+}
+
+
+
/*----- Helpers. -----*/
/* get_nonnull_domain and get_nonnull_network turn an on-wire
diff --git a/src/remote/remote_protocol.x b/src/remote/remote_protocol.x
index 455e324..ac0cd0e 100644
--- a/src/remote/remote_protocol.x
+++ b/src/remote/remote_protocol.x
@@ -2307,7 +2307,7 @@ enum remote_procedure {
REMOTE_PROC_DOMAIN_GET_SCHEDULER_PARAMETERS = 57, /* skipgen autogen */
REMOTE_PROC_DOMAIN_SET_SCHEDULER_PARAMETERS = 58, /* autogen autogen */
REMOTE_PROC_GET_HOSTNAME = 59, /* autogen autogen priority:high */
- REMOTE_PROC_SUPPORTS_FEATURE = 60, /* autogen autogen priority:high */
+ REMOTE_PROC_SUPPORTS_FEATURE = 60, /* skipgen autogen priority:high */
REMOTE_PROC_DOMAIN_MIGRATE_PREPARE = 61, /* skipgen skipgen */
REMOTE_PROC_DOMAIN_MIGRATE_PERFORM = 62, /* autogen autogen */
diff --git a/src/rpc/virnetserver.c b/src/rpc/virnetserver.c
index d71ed18..34dac66 100644
--- a/src/rpc/virnetserver.c
+++ b/src/rpc/virnetserver.c
@@ -102,6 +102,9 @@ struct _virNetServer {
size_t nclients_max;
virNetServerClientPtr *clients;
+ int keepaliveInterval;
+ unsigned int keepaliveCount;
+
unsigned int quit :1;
virNetTLSContextPtr tls;
@@ -239,6 +242,9 @@ static int virNetServerDispatchNewClient(virNetServerServicePtr svc ATTRIBUTE_UN
virNetServerDispatchNewMessage,
srv);
+ virNetServerClientInitKeepAlive(client, srv->keepaliveInterval,
+ srv->keepaliveCount);
+
virNetServerUnlock(srv);
return 0;
@@ -278,6 +284,8 @@ virNetServerPtr virNetServerNew(size_t min_workers,
size_t max_workers,
size_t priority_workers,
size_t max_clients,
+ int keepaliveInterval,
+ unsigned int keepaliveCount,
const char *mdnsGroupName,
bool connectDBus ATTRIBUTE_UNUSED,
virNetServerClientInitHook clientInitHook)
@@ -299,6 +307,8 @@ virNetServerPtr virNetServerNew(size_t min_workers,
goto error;
srv->nclients_max = max_clients;
+ srv->keepaliveInterval = keepaliveInterval;
+ srv->keepaliveCount = keepaliveCount;
srv->sigwrite = srv->sigread = -1;
srv->clientInitHook = clientInitHook;
srv->privileged = geteuid() == 0 ? true : false;
diff --git a/src/rpc/virnetserver.h b/src/rpc/virnetserver.h
index cc9d039..99b65d6 100644
--- a/src/rpc/virnetserver.h
+++ b/src/rpc/virnetserver.h
@@ -41,6 +41,8 @@ virNetServerPtr virNetServerNew(size_t min_workers,
size_t max_workers,
size_t priority_workers,
size_t max_clients,
+ int keepaliveInterval,
+ unsigned int keepaliveCount,
const char *mdnsGroupName,
bool connectDBus,
virNetServerClientInitHook clientInitHook);
diff --git a/src/rpc/virnetserverclient.c b/src/rpc/virnetserverclient.c
index 412814d..9bd8914 100644
--- a/src/rpc/virnetserverclient.c
+++ b/src/rpc/virnetserverclient.c
@@ -33,6 +33,7 @@
#include "virterror_internal.h"
#include "memory.h"
#include "threads.h"
+#include "virkeepalive.h"
#define VIR_FROM_THIS VIR_FROM_RPC
#define virNetError(code, ...) \
@@ -98,6 +99,9 @@ struct _virNetServerClient
void *privateData;
virNetServerClientFreeFunc privateDataFreeFunc;
virNetServerClientCloseFunc privateDataCloseFunc;
+
+ virKeepAlivePtr keepalive;
+ int keepaliveFilter;
};
@@ -207,15 +211,14 @@ static void virNetServerClientUpdateEvent(virNetServerClientPtr client)
}
-int virNetServerClientAddFilter(virNetServerClientPtr client,
- virNetServerClientFilterFunc func,
- void *opaque)
+static int
+virNetServerClientAddFilterLocked(virNetServerClientPtr client,
+ virNetServerClientFilterFunc func,
+ void *opaque)
{
virNetServerClientFilterPtr filter;
int ret = -1;
- virNetServerClientLock(client);
-
if (VIR_ALLOC(filter) < 0) {
virReportOOMError();
goto cleanup;
@@ -231,16 +234,26 @@ int virNetServerClientAddFilter(virNetServerClientPtr client,
ret = filter->id;
cleanup:
- virNetServerClientUnlock(client);
return ret;
}
+int virNetServerClientAddFilter(virNetServerClientPtr client,
+ virNetServerClientFilterFunc func,
+ void *opaque)
+{
+ int ret;
-void virNetServerClientRemoveFilter(virNetServerClientPtr client,
- int filterID)
+ virNetServerClientLock(client);
+ ret = virNetServerClientAddFilterLocked(client, func, opaque);
+ virNetServerClientUnlock(client);
+ return ret;
+}
+
+static void
+virNetServerClientRemoveFilterLocked(virNetServerClientPtr client,
+ int filterID)
{
virNetServerClientFilterPtr tmp, prev;
- virNetServerClientLock(client);
prev = NULL;
tmp = client->filters;
@@ -257,7 +270,13 @@ void virNetServerClientRemoveFilter(virNetServerClientPtr client,
prev = tmp;
tmp = tmp->next;
}
+}
+void virNetServerClientRemoveFilter(virNetServerClientPtr client,
+ int filterID)
+{
+ virNetServerClientLock(client);
+ virNetServerClientRemoveFilterLocked(client, filterID);
virNetServerClientUnlock(client);
}
@@ -318,6 +337,7 @@ virNetServerClientPtr virNetServerClientNew(virNetSocketPtr sock,
client->readonly = readonly;
client->tlsCtxt = tls;
client->nrequests_max = nrequests_max;
+ client->keepaliveFilter = -1;
if (tls)
virNetTLSContextRef(tls);
@@ -571,6 +591,7 @@ void virNetServerClientFree(virNetServerClientPtr client)
void virNetServerClientClose(virNetServerClientPtr client)
{
virNetServerClientCloseFunc cf;
+ virKeepAlivePtr ka;
virNetServerClientLock(client);
VIR_DEBUG("client=%p refs=%d", client, client->refs);
@@ -579,6 +600,20 @@ void virNetServerClientClose(virNetServerClientPtr client)
return;
}
+ if (client->keepaliveFilter >= 0)
+ virNetServerClientRemoveFilterLocked(client, client->keepaliveFilter);
+
+ if (client->keepalive) {
+ virKeepAliveStop(client->keepalive);
+ ka = client->keepalive;
+ client->keepalive = NULL;
+ client->refs++;
+ virNetServerClientUnlock(client);
+ virKeepAliveFree(ka);
+ virNetServerClientLock(client);
+ client->refs--;
+ }
+
if (client->privateDataCloseFunc) {
cf = client->privateDataCloseFunc;
client->refs++;
@@ -976,6 +1011,7 @@ int virNetServerClientSendMessage(virNetServerClientPtr client,
VIR_DEBUG("msg=%p proc=%d len=%zu offset=%zu",
msg, msg->header.proc,
msg->bufferLength, msg->bufferOffset);
+
virNetServerClientLock(client);
if (client->sock && !client->wantClose) {
@@ -986,6 +1022,7 @@ int virNetServerClientSendMessage(virNetServerClientPtr client,
}
virNetServerClientUnlock(client);
+
return ret;
}
@@ -999,3 +1036,74 @@ bool virNetServerClientNeedAuth(virNetServerClientPtr client)
virNetServerClientUnlock(client);
return need;
}
+
+
+static void
+virNetServerClientKeepAliveDeadCB(void *opaque)
+{
+ virNetServerClientImmediateClose(opaque);
+}
+
+static int
+virNetServerClientKeepAliveSendCB(void *opaque,
+ virNetMessagePtr msg)
+{
+ return virNetServerClientSendMessage(opaque, msg);
+}
+
+static void
+virNetServerClientFreeCB(void *opaque)
+{
+ virNetServerClientFree(opaque);
+}
+
+static int
+virNetServerClientKeepAliveFilter(virNetServerClientPtr client,
+ virNetMessagePtr msg,
+ void *opaque ATTRIBUTE_UNUSED)
+{
+ if (virKeepAliveCheckMessage(client->keepalive, msg)) {
+ virNetMessageFree(msg);
+ client->nrequests--;
+ return 1;
+ }
+
+ return 0;
+}
+
+int
+virNetServerClientInitKeepAlive(virNetServerClientPtr client,
+ int interval,
+ unsigned int count)
+{
+ virKeepAlivePtr ka;
+ int ret = -1;
+
+ virNetServerClientLock(client);
+
+ if (!(ka = virKeepAliveNew(interval, count, client,
+ virNetServerClientKeepAliveSendCB,
+ virNetServerClientKeepAliveDeadCB,
+ virNetServerClientFreeCB)))
+ goto cleanup;
+ /* keepalive object has a reference to client */
+ client->refs++;
+
+ client->keepaliveFilter =
+ virNetServerClientAddFilterLocked(client,
+ virNetServerClientKeepAliveFilter,
+ NULL);
+ if (client->keepaliveFilter < 0)
+ goto cleanup;
+
+ client->keepalive = ka;
+ ka = NULL;
+
+cleanup:
+ virNetServerClientUnlock(client);
+ if (ka)
+ virKeepAliveStop(ka);
+ virKeepAliveFree(ka);
+
+ return ret;
+}
diff --git a/src/rpc/virnetserverclient.h b/src/rpc/virnetserverclient.h
index bedb179..1987c6d 100644
--- a/src/rpc/virnetserverclient.h
+++ b/src/rpc/virnetserverclient.h
@@ -99,6 +99,12 @@ bool virNetServerClientWantClose(virNetServerClientPtr client);
int virNetServerClientInit(virNetServerClientPtr client);
+int virNetServerClientInitKeepAlive(virNetServerClientPtr client,
+ int interval,
+ unsigned int count);
+bool virNetServerClientCheckKeepAlive(virNetServerClientPtr client,
+ virNetMessagePtr msg);
+
const char *virNetServerClientLocalAddrString(virNetServerClientPtr client);
const char *virNetServerClientRemoteAddrString(virNetServerClientPtr client);
--
1.7.6.1
More information about the libvir-list
mailing list