vasum-client-impl.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
 *
 *  Contact: Mateusz Malicki <m.malicki2@samsung.com>
 *
 *  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
 */


#ifndef VASUM_CLIENT_IMPL_HPP
#define VASUM_CLIENT_IMPL_HPP

#include "vasum-client.h"
#include "cargo-ipc/epoll/thread-dispatcher.hpp"
#include "cargo-ipc/epoll/event-poll.hpp"
#include "cargo-ipc/client.hpp"

#include <mutex>
#include <memory>
#include <functional>
#include <linux/if_link.h>

typedef std::function<void (const char *zoneId, const char *dbusAddress, void *data)> VsmZoneDbusStateFunction;

typedef struct ZoneStructure {
    char *id;
    int terminal;
    VsmZoneState state;
    char *rootfs_path;
} *Zone;

typedef struct NetdevStructure {
    char *name;
    VsmNetdevType type;
} *Netdev;

typedef struct {
    int type;
    int prefix;
    union {
        struct in_addr ipv4;
        struct in6_addr ipv6;
    } addr;
} InetAddr;


class Client final {
public:
    Client() noexcept;
    ~Client() noexcept;

    VsmStatus connectSystem() noexcept;

    VsmStatus connect(const std::string& address) noexcept;

    VsmStatus disconnect() noexcept;

    VsmStatus vsm_get_poll_fd(int* fd) noexcept;

    VsmStatus vsm_enter_eventloop(int flags, int timeout) noexcept;

    VsmStatus vsm_set_dispatcher_type(VsmDispacherType dispacher) noexcept;

    VsmStatus vsm_get_dispatcher_type(VsmDispacherType* dispacher) noexcept;

    const char* vsm_get_status_message() const noexcept;

    VsmStatus vsm_get_status() const noexcept;

    VsmStatus vsm_get_zone_dbuses(VsmArrayString* keys, VsmArrayString* values) noexcept;

    VsmStatus vsm_lock_queue() noexcept;

    VsmStatus vsm_unlock_queue() noexcept;

    VsmStatus vsm_get_zone_ids(VsmArrayString* array) noexcept;

    VsmStatus vsm_get_active_zone_id(VsmString* id) noexcept;

    VsmStatus vsm_lookup_zone_by_pid(int pid, VsmString* id) noexcept;

    VsmStatus vsm_lookup_zone_by_id(const char* id, Zone* zone) noexcept;

    VsmStatus vsm_lookup_zone_by_terminal_id(int terminal, VsmString* id) noexcept;

    VsmStatus vsm_set_active_zone(const char* id) noexcept;

    VsmStatus vsm_create_zone(const char* id, const char* tname) noexcept;

    VsmStatus vsm_destroy_zone(const char* id) noexcept;

    VsmStatus vsm_shutdown_zone(const char* id) noexcept;

    VsmStatus vsm_start_zone(const char* id) noexcept;

    VsmStatus vsm_lock_zone(const char* id) noexcept;

    VsmStatus vsm_unlock_zone(const char* id) noexcept;

    VsmStatus vsm_add_state_callback(VsmZoneDbusStateFunction zoneDbusStateCallback,
                                     void* data,
                                     VsmSubscriptionId* subscriptionId) noexcept;

    VsmStatus vsm_del_state_callback(VsmSubscriptionId subscriptionId) noexcept;

    VsmStatus vsm_grant_device(const char* id,
                               const char* device,
                               uint32_t flags) noexcept;

    VsmStatus vsm_revoke_device(const char* id, const char* device) noexcept;

    VsmStatus vsm_zone_get_netdevs(const char* zone, VsmArrayString* netdevIds) noexcept;

    VsmStatus vsm_netdev_get_ip_addr(const char* zone,
                                     const char* netdevId,
                                     std::vector<InetAddr>& addrs) noexcept;

    VsmStatus vsm_netdev_get_ipv4_addr(const char* zone,
                                       const char* netdevId,
                                       struct in_addr *addr) noexcept;

    VsmStatus vsm_netdev_get_ipv6_addr(const char* zone,
                                       const char* netdevId,
                                       struct in6_addr *addr) noexcept;

    VsmStatus vsm_netdev_add_ipv4_addr(const char* zone,
                                       const char* netdevId,
                                       struct in_addr *addr,
                                       int prefix) noexcept;

    VsmStatus vsm_netdev_add_ipv6_addr(const char* zone,
                                       const char* netdevId,
                                       struct in6_addr *addr,
                                       int prefix) noexcept;

    VsmStatus vsm_netdev_del_ipv4_addr(const char* zone,
                                      const char* netdevId,
                                      struct in_addr* addr,
                                      int prefix) noexcept;

    VsmStatus vsm_netdev_del_ipv6_addr(const char* zone,
                                      const char* netdevId,
                                      struct in6_addr* addr,
                                      int prefix) noexcept;

    VsmStatus vsm_netdev_up(const char* zone, const char* netdevId) noexcept;

    VsmStatus vsm_netdev_down(const char* zone, const char* netdevId) noexcept;

    VsmStatus vsm_create_netdev_veth(const char* zone,
                                     const char* zoneDev,
                                     const char* hostDev) noexcept;

    VsmStatus vsm_create_netdev_macvlan(const char* zone,
                                        const char* zoneDev,
                                        const char* hostDev,
                                        enum macvlan_mode mode) noexcept;

    VsmStatus vsm_create_netdev_phys(const char* zone, const char* devId) noexcept;

    VsmStatus vsm_lookup_netdev_by_name(const char* zone,
                                        const char* netdevId,
                                        Netdev* netdev) noexcept;

    VsmStatus vsm_destroy_netdev(const char* zone, const char* devId) noexcept;

    VsmStatus vsm_declare_file(const char* zone,
                               VsmFileType type,
                               const char* path,
                               int32_t flags,
                               mode_t mode,
                               VsmString* id) noexcept;

    VsmStatus vsm_declare_mount(const char* source,
                                const char* zone,
                                const char* target,
                                const char* type,
                                uint64_t flags,
                                const char* data,
                                VsmString* id) noexcept;
    VsmStatus vsm_declare_link(const char* source,
                               const char* zone,
                               const char* target,
                               VsmString* id) noexcept;

    VsmStatus vsm_list_declarations(const char* zone, VsmArrayString* declarations) noexcept;

    VsmStatus vsm_remove_declaration(const char* zone, VsmString declaration) noexcept;

    VsmStatus vsm_clean_up_zones_root() noexcept;

private:
    struct Status {
        Status();
        Status(VsmStatus status, const std::string& msg = "");
        VsmStatus mVsmStatus;
        std::string mMsg;
    };
    Status mStatus;

    mutable std::mutex mStatusMutex;
    std::unique_ptr<cargo::ipc::epoll::ThreadDispatcher> mInternalDispatcher;
    std::unique_ptr<cargo::ipc::epoll::EventPoll> mEventPoll;
    std::unique_ptr<cargo::ipc::Client> mClient;

    bool isConnected() const;
    bool isInternalDispatcherEnabled() const;
    cargo::ipc::epoll::EventPoll& getEventPoll() const;
    VsmStatus coverException(const std::function<void(void)>& worker) noexcept;
};

#endif /* VASUM_CLIENT_IMPL_HPP */