Alignment.h

/*
 * Copyright (c) [2016-2018] SUSE LLC
 *
 * All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as published
 * by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, contact Novell, Inc.
 *
 * To contact Novell about this file by physical or electronic mail, you may
 * find current contact information at www.novell.com.
 */
 
 
#ifndef STORAGE_ALIGNMENT_H
#define STORAGE_ALIGNMENT_H
 
 
#include "storage/Utils/Topology.h"
#include "storage/Utils/Region.h"
#include "storage/Utils/Exception.h"
#include "storage/Utils/Swig.h"
 
 
namespace storage
{
 
    enum class AlignType
    {
        REQUIRED,

        OPTIMAL
    };
 
 
    enum class AlignPolicy
    {
        ALIGN_START_AND_END = 0,
        ALIGN_END ST_DEPRECATED = 0,

        ALIGN_START_KEEP_END = 1,
        KEEP_END ST_DEPRECATED = 1,

        ALIGN_START_KEEP_SIZE = 2,
        KEEP_SIZE ST_DEPRECATED = 2,

        KEEP_START_ALIGN_END = 3
    };
 
 
    class AlignError : public Exception
    {
    public:
        AlignError();
    };
 

    class Alignment
    {
 
    public:
 
        Alignment(const Topology& topology, AlignType align_type = AlignType::OPTIMAL);
        Alignment(const Alignment& alignment);
        Alignment(Alignment&& alignment) = default;
        ~Alignment();
 
        Alignment& operator=(const Alignment& alignment);
        Alignment& operator=(Alignment&& alignment) = default;

        bool can_be_aligned(const Region& region, AlignPolicy align_policy) const;

        Region align(const Region& region, AlignPolicy align_policy = AlignPolicy::ALIGN_START_AND_END) const;
 
        long offset() const;
 
        unsigned long grain() const;
 
    public:
 
        class Impl;
 
        Impl& get_impl();
        const Impl& get_impl() const;
 
    private:
 
        const std::unique_ptr<Impl> impl;
 
    };
 
}
 
 
#endif