| 1 | /*
|
|---|
| 2 | * Copyright (c) 2009 Jakub Jermar
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libfs
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /**
|
|---|
| 33 | * @file
|
|---|
| 34 | */
|
|---|
| 35 |
|
|---|
| 36 | #ifndef LIBFS_LIBFS_H_
|
|---|
| 37 | #define LIBFS_LIBFS_H_
|
|---|
| 38 |
|
|---|
| 39 | #include <ipc/vfs.h>
|
|---|
| 40 | #include <offset.h>
|
|---|
| 41 | #include <async.h>
|
|---|
| 42 | #include <loc.h>
|
|---|
| 43 |
|
|---|
| 44 | typedef struct {
|
|---|
| 45 | errno_t (*fsprobe)(service_id_t, vfs_fs_probe_info_t *);
|
|---|
| 46 | errno_t (*mounted)(service_id_t, const char *, fs_index_t *, aoff64_t *);
|
|---|
| 47 | errno_t (*unmounted)(service_id_t);
|
|---|
| 48 | errno_t (*read)(service_id_t, fs_index_t, aoff64_t, size_t *);
|
|---|
| 49 | errno_t (*write)(service_id_t, fs_index_t, aoff64_t, size_t *,
|
|---|
| 50 | aoff64_t *);
|
|---|
| 51 | errno_t (*truncate)(service_id_t, fs_index_t, aoff64_t);
|
|---|
| 52 | errno_t (*close)(service_id_t, fs_index_t);
|
|---|
| 53 | errno_t (*destroy)(service_id_t, fs_index_t);
|
|---|
| 54 | errno_t (*sync)(service_id_t, fs_index_t);
|
|---|
| 55 | } vfs_out_ops_t;
|
|---|
| 56 |
|
|---|
| 57 | typedef struct {
|
|---|
| 58 | void *data; /**< Data of the file system implementation. */
|
|---|
| 59 | } fs_node_t;
|
|---|
| 60 |
|
|---|
| 61 | typedef struct {
|
|---|
| 62 | /*
|
|---|
| 63 | * The first set of methods are functions that return an integer error
|
|---|
| 64 | * code. If some additional return value is to be returned, the first
|
|---|
| 65 | * argument holds the output argument.
|
|---|
| 66 | */
|
|---|
| 67 | errno_t (*root_get)(fs_node_t **, service_id_t);
|
|---|
| 68 | errno_t (*match)(fs_node_t **, fs_node_t *, const char *);
|
|---|
| 69 | errno_t (*node_get)(fs_node_t **, service_id_t, fs_index_t);
|
|---|
| 70 | errno_t (*node_open)(fs_node_t *);
|
|---|
| 71 | errno_t (*node_put)(fs_node_t *);
|
|---|
| 72 | errno_t (*create)(fs_node_t **, service_id_t, int);
|
|---|
| 73 | errno_t (*destroy)(fs_node_t *);
|
|---|
| 74 | errno_t (*link)(fs_node_t *, fs_node_t *, const char *);
|
|---|
| 75 | errno_t (*unlink)(fs_node_t *, fs_node_t *, const char *);
|
|---|
| 76 | errno_t (*has_children)(bool *, fs_node_t *);
|
|---|
| 77 | /*
|
|---|
| 78 | * The second set of methods are usually mere getters that do not
|
|---|
| 79 | * return an integer error code.
|
|---|
| 80 | */
|
|---|
| 81 | fs_index_t (*index_get)(fs_node_t *);
|
|---|
| 82 | aoff64_t (*size_get)(fs_node_t *);
|
|---|
| 83 | unsigned int (*lnkcnt_get)(fs_node_t *);
|
|---|
| 84 | bool (*is_directory)(fs_node_t *);
|
|---|
| 85 | bool (*is_file)(fs_node_t *);
|
|---|
| 86 | service_id_t (*service_get)(fs_node_t *);
|
|---|
| 87 | errno_t (*size_block)(service_id_t, uint32_t *);
|
|---|
| 88 | errno_t (*total_block_count)(service_id_t, uint64_t *);
|
|---|
| 89 | errno_t (*free_block_count)(service_id_t, uint64_t *);
|
|---|
| 90 | } libfs_ops_t;
|
|---|
| 91 |
|
|---|
| 92 | typedef struct {
|
|---|
| 93 | int fs_handle; /**< File system handle. */
|
|---|
| 94 | uint8_t *plb_ro; /**< Read-only PLB view. */
|
|---|
| 95 | } fs_reg_t;
|
|---|
| 96 |
|
|---|
| 97 | extern errno_t fs_register(async_sess_t *, vfs_info_t *, vfs_out_ops_t *,
|
|---|
| 98 | libfs_ops_t *);
|
|---|
| 99 |
|
|---|
| 100 | extern void fs_node_initialize(fs_node_t *);
|
|---|
| 101 |
|
|---|
| 102 | extern errno_t fs_instance_create(service_id_t, void *);
|
|---|
| 103 | extern errno_t fs_instance_get(service_id_t, void **);
|
|---|
| 104 | extern errno_t fs_instance_destroy(service_id_t);
|
|---|
| 105 |
|
|---|
| 106 | #endif
|
|---|
| 107 |
|
|---|
| 108 | /** @}
|
|---|
| 109 | */
|
|---|
