IDobbyRdkPlugin.h

/*
* If not stated otherwise in this file or this component's LICENSE file the
* following copyright and licenses apply:
*
* Copyright 2020 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:   IDobbyRdkPlugin.h
 *
 */
#ifndef IDobbyRdkPlugin_H
#define IDobbyRdkPlugin_H
 
#include "DobbyRdkPluginUtils.h"
#include "rt_dobby_schema.h"
 
#if defined(DOBBY_BUILD)
#include <Logging.h>
#else
#include <Dobby/Logging.h>
#endif
 
#include <sys/types.h>
 
#include <memory>
#include <string>
#include <vector>
 
// -----------------------------------------------------------------------------
class IDobbyRdkPlugin
{
public:
    virtual ~IDobbyRdkPlugin() = default;
 
public:
    // -------------------------------------------------------------------------
    virtual std::string name() const = 0;
 
public:
    // -------------------------------------------------------------------------
    enum HintFlags : unsigned
    {
        PostInstallationFlag = (1 << 0),
        PreCreationFlag = (1 << 1),
        CreateRuntimeFlag = (1 << 2),
        CreateContainerFlag = (1 << 3),
#ifdef USE_STARTCONTAINER_HOOK
        StartContainerFlag = (1 << 4),
#endif
        PostStartFlag = (1 << 5),
        PostHaltFlag = (1 << 6),
        PostStopFlag = (1 << 7),
        Unknown = 0
    };
 
    // -------------------------------------------------------------------------
    virtual unsigned hookHints() const = 0;
 
public:
    // Dobby hook
    virtual bool postInstallation() = 0;
 
    // Dobby hook
    virtual bool preCreation() = 0;
 
    // OCI Hook
    virtual bool createRuntime() = 0;
 
    // OCI Hook
    virtual bool createContainer() = 0;
 
#ifdef USE_STARTCONTAINER_HOOK
    // OCI Hook
    virtual bool startContainer() = 0;
#endif
 
    // OCI Hook
    virtual bool postStart() = 0;
 
    // Dobby hook
    virtual bool postHalt() = 0;
 
    // OCI Hook (called after delete)
    virtual bool postStop() = 0;
 
public:
    virtual std::vector<std::string> getDependencies() const = 0;
};
 
// -----------------------------------------------------------------------------
#if __GNUC__ >= 4
#define PUBLIC_FN __attribute__((visibility("default")))
#else
#define PUBLIC_FN
#endif
 
// -----------------------------------------------------------------------------
#define REGISTER_RDK_PLUGIN(_class)                                                                                                                                                                                                    \
    extern "C" PUBLIC_FN IDobbyRdkPlugin *createIDobbyRdkPlugin(std::shared_ptr<rt_dobby_schema>& containerConfig, const std::shared_ptr<DobbyRdkPluginUtils> &utils, const std::string& rootfsPath);    \
    extern "C" PUBLIC_FN IDobbyRdkPlugin *createIDobbyRdkPlugin(std::shared_ptr<rt_dobby_schema>& containerConfig, const std::shared_ptr<DobbyRdkPluginUtils> &utils, const std::string& rootfsPath)     \
{                                                                                                                                                                                                                                      \
        return new _class(containerConfig, utils, rootfsPath);                                                                                                                                                              \
    }                                                                                                                                                                                                                                  \
    extern "C" PUBLIC_FN void destroyIDobbyRdkPlugin(_class const *_plugin);                                                                                                                                                           \
    extern "C" PUBLIC_FN void destroyIDobbyRdkPlugin(_class const *_plugin)                                                                                                                                                            \
    {                                                                                                                                                                                                                                  \
        return delete _plugin;                                                                                                                                                                                                         \
    }
 
#endif // !defined(IDobbyRdkPlugin_H)