IDobbyPlugin.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:   IDobbyPlugins.h
 *
 */
#ifndef IDOBBYPLUGIN_H
#define IDOBBYPLUGIN_H
 
#include "ContainerId.h"
#include "IDobbyEnv.h"
#include "IDobbyUtils.h"
#include "IDobbyStartState.h"
 
#if defined(RDK)
#  include <json/json.h>
#else
#  include <jsoncpp/json.h>
#endif
 
#include <sys/types.h>
 
#include <string>
#include <memory>
 
 
// -----------------------------------------------------------------------------
class IDobbyPlugin
{
public:
    virtual ~IDobbyPlugin() = default;
 
public:
    // -------------------------------------------------------------------------
    virtual std::string name() const = 0;
 
public:
 
    // -------------------------------------------------------------------------
    enum HintFlags : unsigned
    {
        PostConstructionSync    = (1 << 0),
        PreStartSync            = (1 << 1),
        PostStartSync           = (1 << 2),
        PostStopSync            = (1 << 3),
        PreDestructionSync      = (1 << 4),
 
        PostConstructionAsync   = (1 << 16),
        PreStartAsync           = (1 << 17),
        PostStartAsync          = (1 << 18),
        PostStopAsync           = (1 << 19),
        PreDestructionAsync     = (1 << 20)
    };
 
    // -------------------------------------------------------------------------
    virtual unsigned hookHints() const = 0;
 
public:
 
    // -------------------------------------------------------------------------
    virtual bool postConstruction(const ContainerId& id,
                                  const std::shared_ptr<IDobbyStartState>& startupState,
                                  const std::string& rootfsPath,
                                  const Json::Value& jsonData) = 0;
 
    // -------------------------------------------------------------------------
    virtual bool preStart(const ContainerId& id,
                          pid_t pid,
                          const std::string& rootfsPath,
                          const Json::Value& jsonData) = 0;
 
    // -------------------------------------------------------------------------
    virtual bool postStart(const ContainerId& id,
                           pid_t pid,
                           const std::string& rootfsPath,
                           const Json::Value& jsonData) = 0;
 
    // -------------------------------------------------------------------------
    virtual bool postStop(const ContainerId& id,
                          const std::string& rootfsPath,
                          const Json::Value& jsonData) = 0;
 
    // -------------------------------------------------------------------------
    virtual bool preDestruction(const ContainerId& id,
                                const std::string& rootfsPath,
                                const Json::Value& jsonData) = 0;
 
};
 
 
// -----------------------------------------------------------------------------
#if __GNUC__ >= 4
#   define PUBLIC_FN __attribute__ ((visibility ("default")))
#else
#   define PUBLIC_FN
#endif
 
 
// -----------------------------------------------------------------------------
#define REGISTER_DOBBY_PLUGIN(_class, _args...) \
    int PUBLIC_FN __attribute__((weak)) __ai_debug_log_level = 0; \
    void PUBLIC_FN __attribute__((weak)) \
    __ai_debug_log_printf(int level, const char *file, const char *func, \
                          int line, const char *fmt, ...) \
    { } \
    void PUBLIC_FN __attribute__((weak)) \
    __ai_debug_log_sys_printf(int err, int level, const char *file, \
                              const char *func, int line, const char *fmt, ...) \
    { } \
    \
    extern "C" PUBLIC_FN IDobbyPlugin* createIDobbyPlugin(const std::shared_ptr<IDobbyEnv>& env, \
                                                          const std::shared_ptr<IDobbyUtils>& utils); \
    extern "C" PUBLIC_FN IDobbyPlugin* createIDobbyPlugin(const std::shared_ptr<IDobbyEnv>& env, \
                                                          const std::shared_ptr<IDobbyUtils>& utils) \
    { \
        return new _class(std::dynamic_pointer_cast<IDobbyEnv>(env), \
                          std::dynamic_pointer_cast<IDobbyUtils>(utils), \
                          ##_args); \
    } \
    extern "C" PUBLIC_FN void destroyIDobbyPlugin(_class const* _plugin); \
    extern "C" PUBLIC_FN void destroyIDobbyPlugin(_class const* _plugin) \
    { \
        return delete _plugin; \
    }
 
 
 
#endif // !defined(IDOBBYPLUGIN_H)