zone.hpp

Go to the documentation of this file.

/*
 *  Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
 *
 *  Contact: Lukasz Pawelczyk <l.pawelczyk@partner.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 SERVER_ZONE_HPP
#define SERVER_ZONE_HPP

#include "zone-config.hpp"
#include "zone-provision.hpp"

#include "lxc/zone.hpp"
#include "netdev.hpp"

#include <mutex>
#include <string>
#include <memory>
#include <thread>


namespace vasum {


enum class SchedulerLevel {
    FOREGROUND,
    BACKGROUND
};

class Zone {

public:
    typedef netdev::Attrs NetdevAttrs;

    Zone(const std::string& zoneId,
         const std::string& zonesPath,
         const std::string& zoneTemplatePath,
         const std::string& dbPath,
         const std::string& zoneTemplateDir,
         const std::string& baseRunMountPointPath);
    Zone(const Zone&) = delete;
    Zone& operator=(const Zone&) = delete;
    ~Zone();

    typedef std::function<void(bool succeeded)> StartAsyncResultCallback;

    const std::string& getId() const;

    int getPrivilege() const;

    void restore();

    void start();

    void stop(bool saveState);

    bool activateVT();

    void goForeground();

    void goBackground();

    void setDetachOnExit();

    void setDestroyOnExit();

    bool isRunning();

    bool isStopped();

    void suspend();

    void resume();

    bool isPaused();

    bool isSwitchToDefaultAfterTimeoutAllowed() const;

    int getVT() const;

    int createFile(const std::string& path, const std::int32_t flags, const std::int32_t mode);

    std::string declareFile(const int32_t& type,
                            const std::string& path,
                            const int32_t& flags,
                            const int32_t& mode);
    std::string declareMount(const std::string& source,
                             const std::string& target,
                             const std::string& type,
                             const int64_t& flags,
                             const std::string& data);
    std::string declareLink(const std::string& source,
                            const std::string& target);

    std::vector<std::string> getDeclarations() const;

    void removeDeclaration(const std::string& declarationId);

    std::string getRootPath() const;

    void createNetdevVeth(const std::string& zoneDev,
                          const std::string& hostDev);

    void createNetdevMacvlan(const std::string& zoneDev,
                             const std::string& hostDev,
                             const uint32_t& mode);

    void moveNetdev(const std::string& devId);

    void destroyNetdev(const std::string& devId);

    void setNetdevAttrs(const std::string& netdev, const NetdevAttrs& attrs);

    NetdevAttrs getNetdevAttrs(const std::string& netdev);

    std::vector<std::string> getNetdevList();

    void deleteNetdevIpAddress(const std::string& netdev, const std::string& ip);

    void setSchedulerLevel(SchedulerLevel sched);

    std::int64_t getSchedulerQuota();

private:
    ZoneConfig mConfig;
    ZoneDynamicConfig mDynamicConfig;
    std::unique_ptr<ZoneProvision> mProvision;
    mutable std::recursive_mutex mReconnectMutex;
    std::string mRunMountPoint;
    std::string mRootPath;
    std::string mDbPath;
    lxc::LxcZone mZone;
    const std::string mId;
    bool mDetachOnExit;
    bool mDestroyOnExit;

    void onNameLostCallback();
    void saveDynamicConfig();
    void updateRequestedState(const std::string& state);
    void setSchedulerParams(std::uint64_t cpuShares, std::uint64_t vcpuPeriod, std::int64_t vcpuQuota);
};


} // namespace vasum

#endif // SERVER_ZONE_HPP