Adding upstream version 6.0.4-dfsg.upstream/6.0.4-dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 234 insertions, 0 deletions

diff --git a/src/VBox/Main/src-server/HostDnsService.h b/src/VBox/Main/src-server/HostDnsService.h
new file mode 100644
index 00000000..58c369e6
--- /dev/null
+++ b/src/VBox/Main/src-server/HostDnsService.h
@@ -0,0 +1,234 @@
+/* $Id: HostDnsService.h $ */
+/** @file
+ * Host DNS listener.
+ */
+
+/*
+ * Copyright (C) 2005-2019 Oracle Corporation
+ *
+ * This file is part of VirtualBox Open Source Edition (OSE), as
+ * available from http://www.virtualbox.org. This file is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU
+ * General Public License (GPL) as published by the Free Software
+ * Foundation, in version 2 as it comes in the "COPYING" file of the
+ * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+ */
+
+#ifndef MAIN_INCLUDED_SRC_src_server_HostDnsService_h
+#define MAIN_INCLUDED_SRC_src_server_HostDnsService_h
+#ifndef RT_WITHOUT_PRAGMA_ONCE
+# pragma once
+#endif
+#include "VirtualBoxBase.h"
+
+#include <iprt/err.h> /* VERR_IGNORED */
+#include <iprt/cpp/lock.h>
+
+#include <list>
+#include <vector>
+
+typedef std::list<com::Utf8Str> Utf8StrList;
+typedef Utf8StrList::iterator Utf8StrListIterator;
+
+class HostDnsMonitorProxy;
+typedef const HostDnsMonitorProxy *PCHostDnsMonitorProxy;
+
+class HostDnsInformation
+{
+  public:
+    static const uint32_t IGNORE_SERVER_ORDER = RT_BIT_32(0);
+    static const uint32_t IGNORE_SUFFIXES     = RT_BIT_32(1);
+
+  public:
+    std::vector<std::string> servers;
+    std::string domain;
+    std::vector<std::string> searchList;
+    bool equals(const HostDnsInformation &, uint32_t fLaxComparison = 0) const;
+};
+
+/**
+ * This class supposed to be a real DNS monitor object it should be singleton,
+ * it lifecycle starts and ends together with VBoxSVC.
+ */
+class HostDnsMonitor
+{
+    DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(HostDnsMonitor);
+
+  public:
+    static HostDnsMonitor *createHostDnsMonitor();
+    static void shutdown();
+
+    /* @note: method will wait till client call
+       HostDnsService::monitorThreadInitializationDone() */
+    virtual HRESULT init(HostDnsMonitorProxy *proxy);
+
+  protected:
+    explicit HostDnsMonitor(bool fThreaded = false);
+    virtual ~HostDnsMonitor();
+
+    void setInfo(const HostDnsInformation &);
+
+    /* this function used only if HostDnsMonitor::HostDnsMonitor(true) */
+    void monitorThreadInitializationDone();
+    virtual void monitorThreadShutdown() = 0;
+    virtual int monitorWorker() = 0;
+
+  private:
+    static DECLCALLBACK(int) threadMonitoringRoutine(RTTHREAD, void *);
+
+  protected:
+    mutable RTCLockMtx m_LockMtx;
+
+  public:
+    struct Data;
+    Data *m;
+};
+
+/**
+ * This class supposed to be a proxy for events on changing Host Name Resolving configurations.
+ */
+class HostDnsMonitorProxy
+{
+    public:
+    HostDnsMonitorProxy();
+    ~HostDnsMonitorProxy();
+    void init(VirtualBox *virtualbox);
+    void notify(const HostDnsInformation &info);
+
+    HRESULT GetNameServers(std::vector<com::Utf8Str> &aNameServers);
+    HRESULT GetDomainName(com::Utf8Str *pDomainName);
+    HRESULT GetSearchStrings(std::vector<com::Utf8Str> &aSearchStrings);
+
+  private:
+    void pollGlobalExtraData();
+    bool updateInfo(const HostDnsInformation &info);
+
+  private:
+    mutable RTCLockMtx m_LockMtx;
+
+    private:
+    struct Data;
+    Data *m;
+};
+
+# if defined(RT_OS_DARWIN) || defined(DOXYGEN_RUNNING)
+class HostDnsServiceDarwin : public HostDnsMonitor
+{
+  public:
+    HostDnsServiceDarwin();
+    ~HostDnsServiceDarwin();
+    virtual HRESULT init(HostDnsMonitorProxy *proxy);
+
+    protected:
+    virtual void monitorThreadShutdown();
+    virtual int monitorWorker();
+
+    private:
+    HRESULT updateInfo();
+    static void hostDnsServiceStoreCallback(void *store, void *arrayRef, void *info);
+    struct Data;
+    Data *m;
+};
+# endif
+# if defined(RT_OS_WINDOWS) || defined(DOXYGEN_RUNNING)
+class HostDnsServiceWin : public HostDnsMonitor
+{
+    public:
+    HostDnsServiceWin();
+    ~HostDnsServiceWin();
+    virtual HRESULT init(HostDnsMonitorProxy *proxy);
+
+    protected:
+    virtual void monitorThreadShutdown();
+    virtual int monitorWorker();
+
+    private:
+    HRESULT updateInfo();
+
+    private:
+    struct Data;
+    Data *m;
+};
+# endif
+# if defined(RT_OS_SOLARIS) || defined(RT_OS_LINUX) || defined(RT_OS_OS2) || defined(RT_OS_FREEBSD) \
+    || defined(DOXYGEN_RUNNING)
+class HostDnsServiceResolvConf: public HostDnsMonitor
+{
+  public:
+    explicit HostDnsServiceResolvConf(bool fThreaded = false) : HostDnsMonitor(fThreaded), m(NULL) {}
+    virtual ~HostDnsServiceResolvConf();
+    virtual HRESULT init(HostDnsMonitorProxy *proxy, const char *aResolvConfFileName);
+    const std::string& resolvConf() const;
+
+  protected:
+    HRESULT readResolvConf();
+    /* While not all hosts supports Hosts DNS change notifiaction
+     * default implementation offers return VERR_IGNORE.
+     */
+    virtual void monitorThreadShutdown() {}
+    virtual int monitorWorker() {return VERR_IGNORED;}
+
+  protected:
+    struct Data;
+    Data *m;
+};
+#  if defined(RT_OS_SOLARIS) || defined(DOXYGEN_RUNNING)
+/**
+ * XXX: https://blogs.oracle.com/praks/entry/file_events_notification
+ */
+class HostDnsServiceSolaris : public HostDnsServiceResolvConf
+{
+  public:
+    HostDnsServiceSolaris(){}
+    ~HostDnsServiceSolaris(){}
+    virtual HRESULT init(HostDnsMonitorProxy *proxy) {
+        return HostDnsServiceResolvConf::init(proxy, "/etc/resolv.conf");
+    }
+};
+
+#  endif
+#  if defined(RT_OS_LINUX) || defined(DOXYGEN_RUNNING)
+class HostDnsServiceLinux : public HostDnsServiceResolvConf
+{
+  public:
+    HostDnsServiceLinux():HostDnsServiceResolvConf(true){}
+    virtual ~HostDnsServiceLinux();
+    virtual HRESULT init(HostDnsMonitorProxy *proxy) {
+        return HostDnsServiceResolvConf::init(proxy, "/etc/resolv.conf");
+    }
+
+  protected:
+    virtual void monitorThreadShutdown();
+    virtual int monitorWorker();
+};
+
+#  endif
+#  if defined(RT_OS_FREEBSD) || defined(DOXYGEN_RUNNING)
+class HostDnsServiceFreebsd: public HostDnsServiceResolvConf
+{
+    public:
+    HostDnsServiceFreebsd(){}
+    ~HostDnsServiceFreebsd(){}
+    virtual HRESULT init(HostDnsMonitorProxy *proxy) {
+        return HostDnsServiceResolvConf::init(proxy, "/etc/resolv.conf");
+    }
+};
+
+#  endif
+#  if defined(RT_OS_OS2) || defined(DOXYGEN_RUNNING)
+class HostDnsServiceOs2 : public HostDnsServiceResolvConf
+{
+  public:
+    HostDnsServiceOs2(){}
+    ~HostDnsServiceOs2(){}
+    /* XXX: \\MPTN\\ETC should be taken from environment variable ETC  */
+    virtual HRESULT init(HostDnsMonitorProxy *proxy) {
+        return HostDnsServiceResolvConf::init(proxy, "\\MPTN\\ETC\\RESOLV2");
+    }
+};
+
+#  endif
+# endif
+
+#endif /* !MAIN_INCLUDED_SRC_src_server_HostDnsService_h */