Signed-off-by: Dmitry Nesterenko <dmitry.nesterenko@virtuozzo.com> --- src/util/virhook.c | 106 +++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 97 insertions(+), 9 deletions(-) diff --git a/src/util/virhook.c b/src/util/virhook.c index 64ee9a2307..cd26c8c9bd 100644 --- a/src/util/virhook.c +++ b/src/util/virhook.c @@ -33,6 +33,7 @@ #include "virfile.h" #include "configmake.h" #include "vircommand.h" +#include "virstring.h" #define VIR_FROM_THIS VIR_FROM_HOOK @@ -141,7 +142,11 @@ static int virHooksFound = -1; static int virHookCheck(int no, const char *driver) { + int ret; + DIR *dir; + struct dirent *entry; g_autofree char *path = NULL; + g_autofree char *dir_path = NULL; if (driver == NULL) { virReportError(VIR_ERR_INTERNAL_ERROR, @@ -158,16 +163,39 @@ virHookCheck(int no, const char *driver) if (!virFileExists(path)) { VIR_DEBUG("No hook script %s", path); - return 0; + } else if (!virFileIsExecutable(path)) { + VIR_WARN("Non-executable hook script %s", path); + } else { + VIR_DEBUG("Found hook script %s", path); + return 1; } - if (!virFileIsExecutable(path)) { - VIR_WARN("Non-executable hook script %s", path); + dir_path = g_strdup_printf("%s.d", path); + if ((ret = virDirOpenIfExists(&dir, dir_path)) < 0) + return -1; + + if (!ret) { + VIR_DEBUG("No hook script dir %s", dir_path); return 0; } - VIR_DEBUG("Found hook script %s", path); - return 1; + while ((ret = virDirRead(dir, &entry, dir_path)) > 0) { + g_autofree char *entry_path = g_build_filename(dir_path, + entry->d_name, + NULL); + if (!virFileIsExecutable(entry_path)) { + VIR_WARN("Non-executable hook script %s", entry_path); + continue; + } + + VIR_DEBUG("Found hook script %s", entry_path); + ret = 1; + break; + } + + VIR_DIR_CLOSE(dir); + + return ret; } /* @@ -282,7 +310,7 @@ virRunScript(const char *path, * @input: extra input given to the script on stdin * @output: optional address of variable to store malloced result buffer * - * Implement a hook call, where the external script for the driver is + * Implement a hook call, where the external scripts for the driver is * called with the given information. This is a synchronous call, we wait for * execution completion. If @output is non-NULL, *output is guaranteed to be * allocated after successful virHookCall, and is best-effort allocated after @@ -300,11 +328,16 @@ virHookCall(int driver, const char *input, char **output) { + int ret, script_ret; + DIR *dir; + struct dirent *entry; g_autofree char *path = NULL; - g_autoptr(virCommand) cmd = NULL; + g_autofree char *dir_path = NULL; + VIR_AUTOSTRINGLIST entries = NULL; const char *drvstr; const char *opstr; const char *subopstr; + size_t i, nentries; if (output) *output = NULL; @@ -368,6 +401,61 @@ virHookCall(int driver, return -1; } - return virRunScript(path, id, opstr, subopstr, extra, - input, output); + script_ret = 1; + + if (virFileIsExecutable(path)) { + script_ret = virRunScript(path, id, opstr, subopstr, extra, + input, output); + } + + dir_path = g_strdup_printf("%s.d", path); + if ((ret = virDirOpenIfExists(&dir, dir_path)) < 0) + return -1; + + if (!ret) + return script_ret; + + while ((ret = virDirRead(dir, &entry, dir_path)) > 0) { + g_autofree char *entry_path = g_build_filename(dir_path, + entry->d_name, + NULL); + if (!virFileIsExecutable(entry_path)) + continue; + + virStringListAdd(&entries, entry_path); + } + + VIR_DIR_CLOSE(dir); + + if (ret < 0) + return -1; + + if (!entries) + return script_ret; + + nentries = virStringListLength((const char **)entries); + qsort(entries, nentries, sizeof(*entries), virStringSortCompare); + + for (i = 0; i < nentries; i++) { + int entry_ret; + char *entry_input; + g_autofree char *entry_output = NULL; + + /* Get input from previous output */ + entry_input = (!script_ret && output && + !virStringIsEmpty(*output)) ? *output : (char *)input; + entry_ret = virRunScript(entries[i], id, opstr, + subopstr, extra, entry_input, + (output) ? &entry_output : NULL); + if (entry_ret < script_ret) + script_ret = entry_ret; + + /* Replace output to new output from item */ + if (!entry_ret && output && !virStringIsEmpty(entry_output)) { + g_free(*output); + *output = g_steal_pointer(&entry_output); + } + } + + return script_ret; } -- 2.18.4

Signed-off-by: Dmitry Nesterenko <dmitry.nesterenko@virtuozzo.com> --- NEWS.rst | 6 ++++++ docs/hooks.html.in | 27 +++++++++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/NEWS.rst b/NEWS.rst index 42d159b233..18917d9e95 100644 --- a/NEWS.rst +++ b/NEWS.rst @@ -28,6 +28,12 @@ v6.5.0 (unreleased) schema for node devices was expanded to support attributes for mediated devices. + * virhook: Support hooks placed in several files + + Running all scripts from directory /etc/libvirt/hooks/<driver>.d in + alphabetical order. Hook script in old place will be executed + as first for backward compatibility. + * **Improvements** * **Bug fixes** diff --git a/docs/hooks.html.in b/docs/hooks.html.in index 7c9d3ef7f3..a38ba05522 100644 --- a/docs/hooks.html.in +++ b/docs/hooks.html.in @@ -36,6 +36,9 @@ <li>If your installation of libvirt has instead been compiled from source, it is likely to be <code>/usr/local/etc/libvirt/hooks/</code>.</li> + <li><span class="since">Since 6.5.0</span>, you can also place several + hook scripts in the directories + <code>/etc/libvirt/hooks/<driver>.d/</code>.</li> </ul> <p>To use hook scripts, you will need to create this <code>hooks</code> directory manually, place the desired hook scripts inside, then make @@ -59,6 +62,10 @@ Executed when a network is started or stopped or an interface is plugged/unplugged to/from the network</li> </ul> + <p><span class="since">Since 6.5.0</span>, you can also have + several scripts with any name in the directories + <code>/etc/libvirt/hooks/<driver>.d/</code>. They are + executed in alphabetical order after main script.</p> <br/> <h2><a id="structure">Script structure</a></h2> @@ -191,6 +198,16 @@ script returns failure or the output XML is not valid, restore of the image will be aborted. This hook may be used, e.g., to change location of disk images for restored domains.</li> + <li><span class="since">Since 6.5.0</span>, you can also place several + hook scripts in the directory + <code>/etc/libvirt/hooks/qemu.d/</code>. They are executed in + alphabetical order after main script. In this case each script also + acts as filter and can modify the domain XML and print it out on + its standart output. This script output is passed to standard input + next script in order. Empty output from any script is also identical + to copying the input XML without changing it. + In case any script returns failure common process will be aborted, + but all scripts from the directory will are executed.</li> <li><span class="since">Since 0.9.13</span>, the qemu hook script is also called when the libvirtd daemon restarts and reconnects to previously running QEMU processes. If the script fails, the @@ -274,6 +291,16 @@ script returns failure or the output XML is not valid, incoming migration will be canceled. This hook may be used, e.g., to change location of disk images for incoming domains.</li> + <li><span class="since">Since 6.5.0</span>, you can also place several + hook scripts in the directory + <code>/etc/libvirt/hooks/libxl.d/</code>. They are executed in + alphabetical order after main script. In this case each script also + acts as filter and can modify the domain XML and print it out on + its standart output. This script output is passed to standard input + next script in order. Empty output from any script is also identical + to copying the input XML without changing it. + In case any script returns failure common process will be aborted, + but all scripts from the directory will are executed.</li> <li><span class="since">Since 2.1.0</span>, the libxl hook script is also called when the libvirtd daemon restarts and reconnects to previously running Xen domains. If the script fails, the -- 2.18.4