block_device_tipc.h

/*
 * Copyright (C) 2015 The Android Open Source 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.
 */

#pragma once

#include <lib/hwkey/hwkey.h>
#include <lib/tipc/tipc.h>
#include <trusty_ipc.h>

#include "aidl_service.h"
#include "block_device.h"
#include "ipc.h"
#include "tipc_ns.h"
#include "transaction.h"

struct rpmb_key;
struct block_device_tipc;

/**
 * DOC: File System Identifiers
 *
 * These file system names can be used in log messages to distinguish between
 * operations on different file systems. They are also mapped to identifiers to
 * report metrics events.
 *
 * @file_system_id_td: Tamper detect storage. Rollback or tampering by
 *                     non-secure code will be detected.
 * @file_system_id_tdea: Tamper detect early-access storage. Rollback or
 *                       tampering by non-secure code will be detected.
 *                       Available before the non-secure OS has booted if
 *                       supported by the boot loader.
 * @file_system_id_tdp: Tamper detect persistent storage. Rollback or tampering
 *                      by non-secure code will be detected. Data will persist
 *                      across device wipes.
 * @file_system_id_tp: Tamper proof storage. Non-secure code can prevent read
 *                     and write operations from succeeding, but it cannot
 *                     modify on-disk data.
 * @file_system_id_nsp: Non-secure persistent storage. Deprecated.
 */
extern const char file_system_id_td[];
extern const char file_system_id_tdea[];
extern const char file_system_id_tdp[];
extern const char file_system_id_tp[];
extern const char file_system_id_nsp[];

/**
 * struct block_device_rpmb
 * @state:       Pointer to shared state containing ipc_handle and rpmb_state
 * @dev:         Block device state
 * @base:        First block to use in rpmb partition
 * @is_userdata: Is this RPMB device tied to the state of the userdata
 * partition?
 */
struct block_device_rpmb {
    struct block_device dev;
    struct block_device_tipc* state;
    uint16_t base;
    bool is_userdata;
};

/**
 * struct block_device_ns
 * @dev:        Block device state
 * @state:      Pointer to shared state containing ipc_handle
 * @ns_handle:  Handle
 * @is_userdata: Is the backing file for this device in the (non-persistent)
 *               userdata partition?
 */
struct block_device_ns {
    struct block_device dev;
    struct block_device_tipc* state;
    ns_handle_t ns_handle;
    bool is_userdata;
};

struct client_port_context {
    struct fs* tr_state;
    struct ipc_port_context client_ctx;
};

/**
 * struct block_device_tipc
 * @ipc_handle
 */

struct block_device_tipc {
    handle_t ipc_handle;
    struct rpmb_state* rpmb_state;
    struct storage_service_aidl_context* aidl_ctx;

    struct block_device_rpmb dev_rpmb;
    struct fs tr_state_rpmb;
    struct client_port_context fs_rpmb;
    struct client_port_context fs_rpmb_boot;

#if HAS_FS_TDP
    struct block_device_ns dev_ns_tdp;
    struct block_device_rpmb dev_ns_tdp_rpmb;
    struct fs tr_state_ns_tdp;
#endif
    struct client_port_context fs_tdp;

#if HAS_FS_NSP
    struct block_device_ns dev_ns_nsp;
    struct block_device_ns dev_ns_nsp_superblock;
    struct fs tr_state_ns_nsp;
#endif
    struct client_port_context fs_nsp;

    struct block_device_ns dev_ns;
    struct block_device_rpmb dev_ns_rpmb;
    struct fs tr_state_ns;
    struct client_port_context fs_ns;
};

int block_device_tipc_init(struct block_device_tipc* state,
                           struct tipc_hset* hset,
                           struct storage_service_aidl_context* aidl_ctx,
                           handle_t ipc_handle,
                           const struct key* fs_key,
                           const struct rpmb_key* rpmb_key,
                           hwkey_session_t hwkey_session);
void block_device_tipc_uninit(struct block_device_tipc* state);