DobbyManager.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2016 Sky UK
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
 * File:   DobbyManager.h
 *
 */
#ifndef DOBBYMANAGER_H
#define DOBBYMANAGER_H
 
#include "IDobbyUtils.h"
#include "IDobbyIPCUtils.h"
#include "DobbyConfig.h"
#include "IDobbyRdkPlugin.h"
#include "IDobbyRdkLoggingPlugin.h"
#include "ContainerId.h"
#include "DobbyLogger.h"
#include "DobbyRunC.h"
#include <IIpcService.h>
 
#include <pthread.h>
 
#include <map>
#include <list>
#include <cstdint>
#include <mutex>
#include <thread>
#include <string>
#include <memory>
#include <future>
#include <functional>
#include <netinet/in.h>
#include <semaphore.h>
 
#if defined(RDK)
#  include <json/json.h>
#else
#  include <jsoncpp/json.h>
#endif
 
class IDobbyEnv;
class IDobbySettings;
class DobbyStartState;
class DobbyLegacyPluginManager;
class DobbyConfig;
 
class DobbyContainer;
 
 
// -----------------------------------------------------------------------------
class DobbyManager
{
public:
    typedef std::function<void(int32_t cd, const ContainerId& id)> ContainerStartedFunc;
    typedef std::function<void(int32_t cd, const ContainerId& id, int32_t status)> ContainerStoppedFunc;
    typedef std::function<void(int32_t cd, const ContainerId& id)> ContainerHibernatedFunc;
 
public:
    DobbyManager(const std::shared_ptr<IDobbyEnv>& env,
                 const std::shared_ptr<IDobbyUtils>& utils,
                 const std::shared_ptr<IDobbyIPCUtils>& ipcUtils,
                 const std::shared_ptr<const IDobbySettings>& settings,
                 const ContainerStartedFunc& containerStartedCb,
                 const ContainerStoppedFunc& containerStoppedCb,
                 const ContainerHibernatedFunc& containerHibernatedCb,
                 const ContainerHibernatedFunc& containerAwokenCb);
    ~DobbyManager();
 
private:
    void setupSystem();
    void setupWorkspace(const std::shared_ptr<IDobbyEnv>& env);
 
    void cleanupContainers();
    bool cleanupContainer(const DobbyRunC::ContainerListItem& container);
    void cleanupContainersShutdown();
public:
#if defined(LEGACY_COMPONENTS)
    int32_t startContainerFromSpec(const ContainerId& id,
                                   const std::string& jsonSpec,
                                   const std::list<int>& files,
                                   const std::string& command,
                                   const std::string& displaySocket,
                                   const std::vector<std::string>& envVars);
#endif //defined(LEGACY_COMPONENTS)
 
    int32_t startContainerFromBundle(const ContainerId& id,
                                     const std::string& bundlePath,
                                     const std::list<int>& files,
                                     const std::string& command,
                                     const std::string& displaySocket,
                                     const std::vector<std::string>& envVars);
 
    bool stopContainer(int32_t cd, bool withPrejudice);
 
    bool pauseContainer(int32_t cd);
    bool resumeContainer(int32_t cd);
    bool hibernateContainer(int32_t cd, const std::string& options);
    bool wakeupContainer(int32_t cd);
 
    bool addMount(int32_t cd, 
                  const std::string& source, 
                  const std::string& destination, 
                  const std::vector<std::string>& mountFlags,
                  const std::string& mountData);
 
    bool removeMount(int32_t cd, const std::string& source);
 
    bool annotate(int32_t cd, const std::string &key, const std::string &value);
    bool removeAnnotation(int32_t cd, const std::string &key);
 
    bool execInContainer(int32_t cd,
                         const std::string& options,
                         const std::string& command);
 
    std::list<std::pair<int32_t, ContainerId>> listContainers() const;
 
    int32_t stateOfContainer(int32_t cd) const;
 
    std::string statsOfContainer(int32_t cd) const;
 
public:
    std::string ociConfigOfContainer(int32_t cd) const;
 
#if defined(LEGACY_COMPONENTS)
public:
    std::string specOfContainer(int32_t cd) const;
    bool createBundle(const ContainerId& id, const std::string& jsonSpec);
#endif //defined(LEGACY_COMPONENTS)
 
private:
    void handleContainerTerminate(const ContainerId &id, const std::unique_ptr<DobbyContainer>& container, const int status);
    void onChildExit();
 
private:
    std::shared_ptr<IDobbyRdkLoggingPlugin>
            GetContainerLogger(const std::unique_ptr<DobbyContainer> &container);
 
    bool createAndStart(const ContainerId &id,
                        const std::unique_ptr<DobbyContainer> &container,
                        const std::list<int> &files);
 
    bool customiseConfig(const std::shared_ptr<DobbyConfig> &config,
                        const std::string &command,
                        const std::string &displaySocket,
                        const std::vector<std::string> &envVars);
 
    bool createAndStartContainer(const ContainerId& id,
                                 const std::unique_ptr<DobbyContainer>& container,
                                 const std::list<int>& files);
 
    bool restartContainer(const ContainerId& id,
                          const std::unique_ptr<DobbyContainer>& container);
 
private:
    ContainerStartedFunc mContainerStartedCb;
    ContainerStoppedFunc mContainerStoppedCb;
    ContainerHibernatedFunc mContainerHibernatedCb;
    ContainerHibernatedFunc mContainerAwokenCb;
 
private:
    mutable std::mutex mLock;
    std::map<ContainerId, std::unique_ptr<DobbyContainer>> mContainers;
    std::multimap<ContainerId, pid_t> mContainerExecPids;
 
private:
    bool onPostInstallationHook(const std::unique_ptr<DobbyContainer> &container);
    bool onPreCreationHook(const std::unique_ptr<DobbyContainer> &container);
    bool onPostHaltHook(const std::unique_ptr<DobbyContainer> &container);
 
#if defined(LEGACY_COMPONENTS)
private:
    bool onPostConstructionHook(const ContainerId& id,
                                const std::shared_ptr<DobbyStartState>& startState,
                                const std::unique_ptr<DobbyContainer>& container);
    bool onPreStartHook(const ContainerId& id,
                        const std::unique_ptr<DobbyContainer>& container);
    bool onPostStartHook(const ContainerId& id,
                         const std::unique_ptr<DobbyContainer>& container);
    bool onPostStopHook(const ContainerId& id,
                        const std::unique_ptr<DobbyContainer>& container);
    bool onPreDestructionHook(const ContainerId& id,
                              const std::unique_ptr<DobbyContainer>& container);
 
private:
    enum class HookType {
        PostConstruction, PreStart, PostStart, PostStop, PreDestruction };
#endif //defined(LEGACY_COMPONENTS)
 
private:
    void startRuncMonitorThread();
    void stopRuncMonitorThread();
    void runcMonitorThread();
 
    bool invalidContainerCleanupTask();
 
    bool shouldEnableSTrace(const std::shared_ptr<DobbyConfig> &config) const;
private:
    const std::shared_ptr<IDobbyEnv> mEnvironment;
    const std::shared_ptr<IDobbyUtils> mUtilities;
    const std::shared_ptr<IDobbyIPCUtils> mIPCUtilities;
    const std::shared_ptr<const IDobbySettings> mSettings;
 
private:
    std::unique_ptr<DobbyLogger> mLogger;
    std::unique_ptr<DobbyRunC> mRunc;
 
private:
    sem_t mRuncMonitorThreadStartedSem;
    std::thread mRuncMonitorThread;
    std::atomic<bool> mRuncMonitorTerminate;
    int mCleanupTaskTimerId;
 
#if defined(LEGACY_COMPONENTS)
private:
    std::unique_ptr<DobbyLegacyPluginManager> mLegacyPlugins;
#endif // defined(LEGACY_COMPONENTS)
 
};
 
 
#endif // !defined(DOBBYMANAGER_H)