volume_manager/EmulatedVolume.h

/*
 * Copyright (C) 2015 The Android Open Source Project
 * Copyright (C) 2019 The LineageOS Project
 *
 * 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 ANDROID_VOLMGR_EMULATED_VOLUME_H
#define ANDROID_VOLMGR_EMULATED_VOLUME_H

#include "VolumeBase.h"

#include <cutils/multiuser.h>

struct fstab_rec;

namespace android {
namespace volmgr {

/*
 * Shared storage emulated on top of private storage.
 *
 * Knows how to spawn a FUSE daemon to synthesize permissions.  ObbVolume
 * can be stacked above it.
 *
 * This volume is always multi-user aware, but is only binds itself to
 * users when its primary storage.  This volume should never be presented
 * as secondary storage, since we're strongly encouraging developers to
 * store data local to their app.
 */
class EmulatedVolume : public VolumeBase {
  public:
    explicit EmulatedVolume(fstab_rec* rec, const std::string& subdir);
    virtual ~EmulatedVolume();

  protected:
    status_t doMount() override;
    status_t doUnmount(bool detach = false) override;
    int createMountPointRecursive(const std::string&, mode_t, uid_t, gid_t);

  private:
    std::string mSubdir;
    std::string mDevPath;
    std::string mFsType;
    unsigned long mFlags;
    std::string mFsOptions;

    DISALLOW_COPY_AND_ASSIGN(EmulatedVolume);
};

}  // namespace volmgr
}  // namespace android

#endif