roots.h

/*
 * Copyright (C) 2007 The Android Open Source Project
 * Copyright (c) 2010, Code Aurora Forum. All rights reserved.
 *
 * 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 RECOVERY_ROOTS_H_
#define RECOVERY_ROOTS_H_

#include "minzip/Zip.h"
#include "mtdutils/mtdutils.h"

#ifndef SDCARD_DEVICE_PRIMARY
#define SDCARD_DEVICE_PRIMARY "/dev/block/mmcblk0p1"
#endif

#ifndef SDCARD_DEVICE_SECONDARY
#define SDCARD_DEVICE_SECONDARY "/dev/block/mmcblk0"
#endif

#ifndef SDEXT_DEVICE
#define SDEXT_DEVICE "/dev/block/mmcblk0p2"
#endif

#ifndef SDEXT_FILESYSTEM
#define SDEXT_FILESYSTEM "auto"
#endif

#ifndef DATA_DEVICE
#define DATA_DEVICE g_mtd_device
#endif

#ifndef DATA_FILESYSTEM
#define DATA_FILESYSTEM "yaffs2"
#endif

#ifndef DATADATA_DEVICE
#define DATADATA_DEVICE g_mtd_device
#endif

#ifndef DATADATA_FILESYSTEM
#define DATADATA_FILESYSTEM "yaffs2"
#endif

#ifndef CACHE_DEVICE
#define CACHE_DEVICE g_mtd_device
#endif

#ifndef CACHE_FILESYSTEM
#define CACHE_FILESYSTEM "yaffs2"
#endif

#ifndef SYSTEM_DEVICE
#define SYSTEM_DEVICE g_mtd_device
#endif

#ifndef SYSTEM_FILESYSTEM
#define SYSTEM_FILESYSTEM "yaffs2"
#endif

#ifndef DATA_FILESYSTEM_OPTIONS
#define DATA_FILESYSTEM_OPTIONS NULL
#endif

#ifndef CACHE_FILESYSTEM_OPTIONS
#define CACHE_FILESYSTEM_OPTIONS NULL
#endif

#ifndef DATADATA_FILESYSTEM_OPTIONS
#define DATADATA_FILESYSTEM_OPTIONS NULL
#endif

#ifndef SYSTEM_FILESYSTEM_OPTIONS
#define SYSTEM_FILESYSTEM_OPTIONS NULL
#endif

//////////////////////////////////////
// Steam: filesystem types and options
#define TYPE_RFS 1
#define TYPE_EXT2 2
#define TYPE_EXT4 4
#define TYPE_JFS 8
#define TYPE_DIRECTORY 64

#define TYPE_FSTYPE_MASK 127

#define TYPE_CRYPT 128
#define TYPE_LOOP 256
#define TYPE_BIND 512
#define TYPE_RFS_BAD 1024

#define TYPE_RFS_DEFAULT_MOUNT "nodev,nosuid,check=no"
#define TYPE_EXT2_DEFAULT_MOUNT "noatime,nodiratime"
#define TYPE_EXT4_DEFAULT_MOUNT "noatime,barrier=0,noauto_da_alloc"
#define TYPE_JFS_DEFAULT_MOUNT "relatime,errors=continue"
#define TYPE_RFS_BAD_DEFAULT_MOUNT "nodev,nosuid"

#define BLOCK_DATA_LOOP_SIZE 1831634944
#define BLOCK_DBDATA_LOOP_SIZE 128382976
#define BLOCK_CACHE_LOOP_SIZE 29726720

// check if block contains an encrypted partition or not
int is_encrypted_partition(const char* partition);
// opens an encrypted block
int open_encrypted_partition(const char* partition, char* secret);
// checks which filesystem is contained inside the block. returns the filsystem code
int filesystem_check(const char* partition);
// fsck's and mounts the filesystem. returns 0 if success
int check_and_mount(int fstype, const char* partition, const char* loopname, const char* mtname, char* secret);
// formats a block to the desired filesystem
int filesystem_format(int fstype, const char* partition, const char* loopname, const char* mtname, char* secret);
// asks the user what to do
int filesystem_create(const char* partition, const char* label);
// mounts a filesystem from the config, and falls back in case of failure. returns the filesystem type
int mount_from_config_or_autodetect(const char* keyname, const char* partition, const char* loopname, const char* mtname, char* secret);
// unmounts a filesystem completely
int unmount_filesystem(const char* partition);

// End of Steam stuff
//////////////////////////////////////////////////////////////

/* Any of the "root_path" arguments can be paths with relative
 * components, like "SYSTEM:a/b/c".
 */

/* Associate this package with the package root "PKG:".
 */
int register_package_root(const ZipArchive *package, const char *package_path);

/* Returns non-zero iff root_path points inside a package.
 */
int is_package_root_path(const char *root_path);

/* Takes a string like "SYSTEM:lib" and turns it into a string
 * like "/system/lib".  The translated path is put in out_buf,
 * and out_buf is returned if the translation succeeded.
 */
const char *translate_root_path(const char *root_path,
        char *out_buf, size_t out_buf_len);

/* Takes a string like "PKG:lib/libc.so" and returns a pointer to
 * the containing zip file and a path like "lib/libc.so".
 */
const char *translate_package_root_path(const char *root_path,
        char *out_buf, size_t out_buf_len, const ZipArchive **out_package);

/* Returns negative on error, positive if it's mounted, zero if it isn't.
 */
int is_root_path_mounted(const char *root_path);

int ensure_root_path_mounted(const char *root_path);

int ensure_root_path_unmounted(const char *root_path);

const MtdPartition *get_root_mtd_partition(const char *root_path);

/* "root" must be the exact name of the root; no relative path is permitted.
 * If the named root is mounted, this will attempt to unmount it first.
 */
int format_root_device(const char *root);

typedef struct {
    const char *name;
    const char *device;
    const char *device2;  // If the first one doesn't work (may be NULL)
    const char *partition_name;
    const char *mount_point;
    const char *filesystem;
    const char *filesystem_options;
} RootInfo;

#endif  // RECOVERY_ROOTS_H_