ote_storage.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2014, NVIDIA CORPORATION. All rights reserved
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef __OTE_STORAGE_H
#define __OTE_STORAGE_H

#include <common/ote_common.h>

#define TE_STORAGE_OBJID_MAX_LEN    64

struct __te_storage_object;
typedef struct __te_storage_object *te_storage_object_t;

typedef enum {
    OTE_STORAGE_FLAG_ACCESS_READ        = 0x1,
    OTE_STORAGE_FLAG_ACCESS_WRITE       = 0x2,
    OTE_STORAGE_FLAG_ACCESS_WRITE_META  = 0x4,
} te_storage_flags_t;

te_error_t te_create_storage_object(char *name, te_storage_flags_t flags,
                te_storage_object_t *obj);

te_error_t te_open_storage_object(char *name, te_storage_flags_t flags,
                te_storage_object_t *obj);

te_error_t te_read_storage_object(te_storage_object_t obj, void *buffer,
        uint32_t size, uint32_t *count);

te_error_t te_write_storage_object(te_storage_object_t obj, const void *buffer,
        uint32_t size);

te_error_t te_get_storage_object_size(te_storage_object_t obj, uint32_t *size);

typedef enum {
    OTE_STORAGE_SEEK_WHENCE_SET = 0x1,
    OTE_STORAGE_SEEK_WHENCE_CUR = 0x2,
    OTE_STORAGE_SEEK_WHENCE_END = 0x3,
} te_storage_whence_t;

te_error_t te_seek_storage_object(te_storage_object_t obj, int32_t offset,
                te_storage_whence_t whence);

te_error_t te_trunc_storage_object(te_storage_object_t obj, uint32_t size);

te_error_t te_delete_storage_object(te_storage_object_t obj);

te_error_t te_delete_named_storage_object(const char *name);

te_error_t te_close_storage_object(te_storage_object_t obj);

#endif