sysroots/generic-arm64/usr/include/lib/storage/storage.h - platform/prebuilts/trusty/sysroot - Git at Google

 /*
  * Copyright (C) 2015-2016 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 <lk/compiler.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <sys/types.h>
 #include <trusty_ipc.h>

 #include <interface/storage/storage.h>

 #define STORAGE_MAX_NAME_LENGTH_BYTES 159

 __BEGIN_CDECLS

 typedef handle_t storage_session_t;
 typedef uint64_t file_handle_t;
 typedef uint64_t storage_off_t;

 struct storage_open_dir_state;

 #define STORAGE_INVALID_SESSION ((storage_session_t)INVALID_IPC_HANDLE)

 /**
  * storage_ops_flags - storage related operation flags
  * @STORAGE_OP_COMPLETE: forces to commit current transaction
  */
 #define STORAGE_OP_COMPLETE 0x1U

 /**
  * storage_open_session() - Opens a storage session.
  * @session_p: pointer to location in which to store session handle
  *             in case of success.
  * @type:      One of STORAGE_CLIENT_TD_PORT, STORAGE_CLIENT_TDEA_PORT or
  *             STORAGE_CLIENT_TP_PORT.
  *
  * Return: NO_ERROR on success, or an error code < 0 on failure.
  */
 int storage_open_session(storage_session_t* session_p, const char* type);

 /**
  * storage_close_session() - Closes the session.
  * @session: the session to close
  *
  */
 void storage_close_session(storage_session_t session);

 /**
  * storage_open_file() - Opens a file
  * @session:  the storage_session_t returned from a call to storage_open_session
  * @handle_p: pointer to location in which to store file handle in case of
  *            success
  * @name:     a null-terminated string identifier of the file to open.
  *            Cannot be more than STORAGE_MAX_NAME_LENGTH_BYTES in length.
  * @flags:    A bitmask consisting any storage_file_flag value or'ed together:
  * - STORAGE_FILE_OPEN_CREATE:           if this file does not exist, create it.
  * - STORAGE_FILE_OPEN_CREATE_EXCLUSIVE: when specified, opening file with
  *                                       STORAGE_OPEN_FILE_CREATE flag will
  *                                       fail if the file already exists.
  *                                       Only meaningful if used in combination
  *                                       with STORAGE_FILE_OPEN_CREATE flag.
  * - STORAGE_FILE_OPEN_TRUNCATE: if this file already exists, discard existing
  *                               content and open it as a new file. No change
  *                               in semantics if the  file does not exist.
  * @opflags: a combination of @storage_op_flags
  *
  * Return: NO_ERROR on success, or an error code < 0 on failure.
  */
 int storage_open_file(storage_session_t session,
                       file_handle_t* handle_p,
                       const char* name,
                       uint32_t flags,
                       uint32_t opflags);

 /**
  * storage_close_file() - Closes a file.
  * @handle: the file_handle_t retrieved from storage_open_file
  *
  */
 void storage_close_file(file_handle_t handle);

 /**
  * storage_move_file - Moves/renames a file.
  * @session:    storage_session_t returned from a call to storage_open_session.
  * @handle:     file_handle_t retrieved from storage_open_file, if @flags
  *              contains STORAGE_FILE_MOVE_OPEN_FILE.
  * @old_name:   the current name of the file to move
  * @new_name:   the new name that the file should be moved to.
  * @flags:    A bitmask consisting any storage_file_flag value or'ed together:
  * - STORAGE_FILE_MOVE_CREATE:           if a file does not exist at @new_name,
  *                                       create it.
  * - STORAGE_FILE_MOVE_CREATE_EXCLUSIVE: when specified, opening file with
  *                                       STORAGE_OPEN_MOVE_CREATE flag will
  *                                       fail if the file already exists.
  *                                       Only meaningful if used in combination
  *                                       with STORAGE_FILE_MOVE_CREATE flag.
  * - STORAGE_FILE_MOVE_OPEN_FILE:   The file is already open as @handle.
  * @opflags: a combination of @storage_op_flags
  *
  * Return: 0 on success, or an error code < 0 on failure.
  */
 int storage_move_file(storage_session_t session,
                       file_handle_t handle,
                       const char* old_name,
                       const char* new_name,
                       uint32_t flags,
                       uint32_t opflags);

 /**
  * storage_delete_file - Deletes a file.
  * @session: the storage_session_t returned from a call to storage_open_session
  * @name: the name of the file to delete
  * @opflags: a combination of @storage_op_flags
  *
  * Return: 0 on success, or an error code < 0 on failure.
  */
 int storage_delete_file(storage_session_t session,
                         const char* name,
                         uint32_t opflags);

 /**
  * storage_open_dir - Open directory.
  * @session: the storage_session_t returned from a call to storage_open_session
  * @path:    Must be "" or %NULL.
  * @state:   Pointer to return state object in.
  *
  * Return: 0 on success, or an error code < 0 on failure.
  */

 int storage_open_dir(storage_session_t session,
                      const char* path,
                      struct storage_open_dir_state** state);

 /**
  * storage_close_dir() - Close open directory iterator.
  * @session: the storage_session_t returned from a call to storage_open_session
  * @state:   directory state object retrieved from storage_open_dir
  */
 void storage_close_dir(storage_session_t session,
                        struct storage_open_dir_state* state);

 /**
  * storage_read_dir() - Read a file name from directory.
  * @session:    the storage_session_t returned from a call to
  *              storage_open_session
  * @state:      directory state object retrieved from storage_open_dir
  * @flags:      storage_file_list_flag for committed, added, removed or end.
  * @name:       buffer to write file name info.
  * @name_size:  size of @name buffer.
  *
  * Return: The number of bytes written to @name if another directory entry was
  * read. Note that this is the length of the string written to @name plus one to
  * account for the terminating nul byte. Returns 0 If @flags is
  * STORAGE_FILE_LIST_END, i.e. there are no more directory entries to list.
  */
 int storage_read_dir(storage_session_t session,
                      struct storage_open_dir_state* state,
                      uint8_t* flags,
                      char* name,
                      size_t name_size);

 /**
  * storage_read() - Reads a file at a given offset.
  * @handle: the file_handle_t retrieved from storage_open_file
  * @off: the start offset from whence to read in the file
  * @buf: the buffer in which to write the data read
  * @size: the size of buf and number of bytes to read
  *
  * Return: the number of bytes read on success, negative error code on failure
  *
  */
 ssize_t storage_read(file_handle_t handle,
                      storage_off_t off,
                      void* buf,
                      size_t size);

 /**
  * storage_write() - Writes to a file at a given offset. Grows the file if
  * necessary.
  * @handle: the file_handle_t retrieved from storage_open_file
  * @off: the start offset from whence to write in the file
  * @buf: the buffer containing the data to write
  * @size: the size of buf and number of bytes to write
  * @opflags: a combination of @storage_op_flags
  *
  * Return: the number of bytes written on success, negative error code on
  * failure
  */
 ssize_t storage_write(file_handle_t handle,
                       storage_off_t off,
                       const void* buf,
                       size_t size,
                       uint32_t opflags);

 /**
  * storage_set_file_size() - Sets the size of the file.
  * @handle: the file_handle_t retrieved from storage_open_file
  * @off: the number of bytes to set as the new size of the file
  * @opflags: a combination of @storage_op_flags
  *
  * Return: NO_ERROR on success, negative error code on failure.
  */
 int storage_set_file_size(file_handle_t handle,
                           storage_off_t file_size,
                           uint32_t opflags);

 /**
  * storage_get_file_size() - Gets the size of the file.
  * @handle: the file_handle_t retrieved from storage_open_file
  * @size: pointer to storage_off_t in which to store the file size
  *
  * Return: NO_ERROR on success, negative error code on failure.
  */
 int storage_get_file_size(file_handle_t handle, storage_off_t* size);

 /**
  * storage_end_transaction: End current transaction
  * @session: the storage_session_t returned from a call to storage_open_session
  * @complete: if true, commit current transaction, discard it otherwise
  *
  * Return: 0 on success, negative error code on failure.
  */
 int storage_end_transaction(storage_session_t session, bool complete);

 __END_CDECLS
	/*
	* Copyright (C) 2015-2016 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 <lk/compiler.h>
	#include <stdbool.h>
	#include <stdint.h>
	#include <sys/types.h>
	#include <trusty_ipc.h>

	#include <interface/storage/storage.h>

	#define STORAGE_MAX_NAME_LENGTH_BYTES 159

	__BEGIN_CDECLS

	typedef handle_t storage_session_t;
	typedef uint64_t file_handle_t;
	typedef uint64_t storage_off_t;

	struct storage_open_dir_state;

	#define STORAGE_INVALID_SESSION ((storage_session_t)INVALID_IPC_HANDLE)

	/**
	* storage_ops_flags - storage related operation flags
	* @STORAGE_OP_COMPLETE: forces to commit current transaction
	*/
	#define STORAGE_OP_COMPLETE 0x1U

	/**
	* storage_open_session() - Opens a storage session.
	* @session_p: pointer to location in which to store session handle
	* in case of success.
	* @type: One of STORAGE_CLIENT_TD_PORT, STORAGE_CLIENT_TDEA_PORT or
	* STORAGE_CLIENT_TP_PORT.
	*
	* Return: NO_ERROR on success, or an error code < 0 on failure.
	*/
	int storage_open_session(storage_session_t* session_p, const char* type);

	/**
	* storage_close_session() - Closes the session.
	* @session: the session to close
	*
	*/
	void storage_close_session(storage_session_t session);

	/**
	* storage_open_file() - Opens a file
	* @session: the storage_session_t returned from a call to storage_open_session
	* @handle_p: pointer to location in which to store file handle in case of
	* success
	* @name: a null-terminated string identifier of the file to open.
	* Cannot be more than STORAGE_MAX_NAME_LENGTH_BYTES in length.
	* @flags: A bitmask consisting any storage_file_flag value or'ed together:
	* - STORAGE_FILE_OPEN_CREATE: if this file does not exist, create it.
	* - STORAGE_FILE_OPEN_CREATE_EXCLUSIVE: when specified, opening file with
	* STORAGE_OPEN_FILE_CREATE flag will
	* fail if the file already exists.
	* Only meaningful if used in combination
	* with STORAGE_FILE_OPEN_CREATE flag.
	* - STORAGE_FILE_OPEN_TRUNCATE: if this file already exists, discard existing
	* content and open it as a new file. No change
	* in semantics if the file does not exist.
	* @opflags: a combination of @storage_op_flags
	*
	* Return: NO_ERROR on success, or an error code < 0 on failure.
	*/
	int storage_open_file(storage_session_t session,
	file_handle_t* handle_p,
	const char* name,
	uint32_t flags,
	uint32_t opflags);

	/**
	* storage_close_file() - Closes a file.
	* @handle: the file_handle_t retrieved from storage_open_file
	*
	*/
	void storage_close_file(file_handle_t handle);

	/**
	* storage_move_file - Moves/renames a file.
	* @session: storage_session_t returned from a call to storage_open_session.
	* @handle: file_handle_t retrieved from storage_open_file, if @flags
	* contains STORAGE_FILE_MOVE_OPEN_FILE.
	* @old_name: the current name of the file to move
	* @new_name: the new name that the file should be moved to.
	* @flags: A bitmask consisting any storage_file_flag value or'ed together:
	* - STORAGE_FILE_MOVE_CREATE: if a file does not exist at @new_name,
	* create it.
	* - STORAGE_FILE_MOVE_CREATE_EXCLUSIVE: when specified, opening file with
	* STORAGE_OPEN_MOVE_CREATE flag will
	* fail if the file already exists.
	* Only meaningful if used in combination
	* with STORAGE_FILE_MOVE_CREATE flag.
	* - STORAGE_FILE_MOVE_OPEN_FILE: The file is already open as @handle.
	* @opflags: a combination of @storage_op_flags
	*
	* Return: 0 on success, or an error code < 0 on failure.
	*/
	int storage_move_file(storage_session_t session,
	file_handle_t handle,
	const char* old_name,
	const char* new_name,
	uint32_t flags,
	uint32_t opflags);

	/**
	* storage_delete_file - Deletes a file.
	* @session: the storage_session_t returned from a call to storage_open_session
	* @name: the name of the file to delete
	* @opflags: a combination of @storage_op_flags
	*
	* Return: 0 on success, or an error code < 0 on failure.
	*/
	int storage_delete_file(storage_session_t session,
	const char* name,
	uint32_t opflags);

	/**
	* storage_open_dir - Open directory.
	* @session: the storage_session_t returned from a call to storage_open_session
	* @path: Must be "" or %NULL.
	* @state: Pointer to return state object in.
	*
	* Return: 0 on success, or an error code < 0 on failure.
	*/

	int storage_open_dir(storage_session_t session,
	const char* path,
	struct storage_open_dir_state** state);

	/**
	* storage_close_dir() - Close open directory iterator.
	* @session: the storage_session_t returned from a call to storage_open_session
	* @state: directory state object retrieved from storage_open_dir
	*/
	void storage_close_dir(storage_session_t session,
	struct storage_open_dir_state* state);

	/**
	* storage_read_dir() - Read a file name from directory.
	* @session: the storage_session_t returned from a call to
	* storage_open_session
	* @state: directory state object retrieved from storage_open_dir
	* @flags: storage_file_list_flag for committed, added, removed or end.
	* @name: buffer to write file name info.
	* @name_size: size of @name buffer.
	*
	* Return: The number of bytes written to @name if another directory entry was
	* read. Note that this is the length of the string written to @name plus one to
	* account for the terminating nul byte. Returns 0 If @flags is
	* STORAGE_FILE_LIST_END, i.e. there are no more directory entries to list.
	*/
	int storage_read_dir(storage_session_t session,
	struct storage_open_dir_state* state,
	uint8_t* flags,
	char* name,
	size_t name_size);

	/**
	* storage_read() - Reads a file at a given offset.
	* @handle: the file_handle_t retrieved from storage_open_file
	* @off: the start offset from whence to read in the file
	* @buf: the buffer in which to write the data read
	* @size: the size of buf and number of bytes to read
	*
	* Return: the number of bytes read on success, negative error code on failure
	*
	*/
	ssize_t storage_read(file_handle_t handle,
	storage_off_t off,
	void* buf,
	size_t size);

	/**
	* storage_write() - Writes to a file at a given offset. Grows the file if
	* necessary.
	* @handle: the file_handle_t retrieved from storage_open_file
	* @off: the start offset from whence to write in the file
	* @buf: the buffer containing the data to write
	* @size: the size of buf and number of bytes to write
	* @opflags: a combination of @storage_op_flags
	*
	* Return: the number of bytes written on success, negative error code on
	* failure
	*/
	ssize_t storage_write(file_handle_t handle,
	storage_off_t off,
	const void* buf,
	size_t size,
	uint32_t opflags);

	/**
	* storage_set_file_size() - Sets the size of the file.
	* @handle: the file_handle_t retrieved from storage_open_file
	* @off: the number of bytes to set as the new size of the file
	* @opflags: a combination of @storage_op_flags
	*
	* Return: NO_ERROR on success, negative error code on failure.
	*/
	int storage_set_file_size(file_handle_t handle,
	storage_off_t file_size,
	uint32_t opflags);

	/**
	* storage_get_file_size() - Gets the size of the file.
	* @handle: the file_handle_t retrieved from storage_open_file
	* @size: pointer to storage_off_t in which to store the file size
	*
	* Return: NO_ERROR on success, negative error code on failure.
	*/
	int storage_get_file_size(file_handle_t handle, storage_off_t* size);

	/**
	* storage_end_transaction: End current transaction
	* @session: the storage_session_t returned from a call to storage_open_session
	* @complete: if true, commit current transaction, discard it otherwise
	*
	* Return: 0 on success, negative error code on failure.
	*/
	int storage_end_transaction(storage_session_t session, bool complete);

	__END_CDECLS