StorageHelper.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: Storage.h
 *
 */
#ifndef STORAGE_HELPER_H
#define STORAGE_HELPER_H
 
#include <Logging.h>
 
#include <sys/types.h>
#include <netinet/in.h>
#include <unistd.h>
#include <string>
#include <memory>
#include <map>
#include <mutex>
#include <list>
 
//#define ENABLE_TESTS 1
 
class StorageHelper
{
public:
    static int loopDeviceAssociate(int fileFd, std::string* loopDevPath);
    static int openLoopDevice(std::string* loopDevice);
    static bool attachFileToLoopDevice(int loopFd, int fileFd);
    static int attachLoopDevice(const std::string& sourceFile,
                                std::string* loopDevice);
    static bool createFileIfNeeded(const std::string& filePath,
                                    const size_t storageSize,
                                    const uid_t userId,
                                    const std::string& fileSystem);
    static void cleanMountLostAndFound(const std::string& mountPoint,
                                        const std::string& logTag);
    static std::string getLoopDevice(const std::string &backingFile);
    static int getMountOptions(const std::list<std::string> &mountOptions);
 
    // -------------------------------------------------------------------------
    static bool rmdirRecursive(int dirFd, const std::string& path);
 
    // -------------------------------------------------------------------------
    static bool rmdirContents(int dirFd, const std::string& path);
    static bool deleteRecursive(int dirfd, int depth);
 
    // Tests
#ifdef ENABLE_TESTS
    static bool Test_mkdirRecursive(const std::string& rootfsPath);
    static bool Test_openLoopDevice();
    static bool Test_attachLoopDevice(std::string& imagePath);
    static bool Test_cleanMountLostAndFound(const std::string& rootfsPath);
    static bool Test_checkWriteReadMount(const std::string& tmpPath);
#endif // ENABLE_TESTS
 
};
 
#endif // !defined(STORAGE_HELPER_H)