Subversion Repositories HelenOS

Rev

Rev 2535 | Rev 2542 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2520 jermar 1 
/*
2 
 * Copyright (c) 2007 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 fs
30 
 * @{
31 
 */
32 
 
33 
#ifndef VFS_VFS_H_
34 
#define VFS_VFS_H_
35 
 
2523 jermar 36 
#include <ipc/ipc.h>
2529 jermar 37 
#include <libadt/list.h>
2540 jermar 38 
#include <atomic.h>
39 
#include <types.h>
2523 jermar 40 
 
2535 jermar 41 
#define dprintf(...)    printf(__VA_ARGS__)
42 
 
2523 jermar 43 
#define VFS_FIRST   FIRST_USER_METHOD
44 
 
2526 jermar 45 
#define IPC_METHOD_TO_VFS_OP(m) ((m) - VFS_FIRST)  
46 
 
2540 jermar 47 
typedef int64_t off_t;
48 
 
2520 jermar 49 
typedef enum {
2523 jermar 50 
    VFS_REGISTER = VFS_FIRST,
2520 jermar 51 
    VFS_MOUNT,
52 
    VFS_UNMOUNT,
2527 jermar 53 
    VFS_LOOKUP,
2521 jermar 54 
    VFS_OPEN,
2523 jermar 55 
    VFS_CREATE,
56 
    VFS_CLOSE,
57 
    VFS_READ,
58 
    VFS_WRITE,
59 
    VFS_SEEK,
2521 jermar 60 
    VFS_LAST,       /* keep this the last member of the enum */
2520 jermar 61 
} vfs_request_t;
62 
 
2521 jermar 63 
 
64 
/**
65 
 * An instance of this structure is associated with a particular FS operation.
66 
 * It tells VFS if the FS supports the operation or maybe if a default one
67 
 * should be used.
68 
 */
69 
typedef enum {
2523 jermar 70 
    VFS_OP_NULL = 0,
2521 jermar 71 
    VFS_OP_DEFAULT,
72 
    VFS_OP_DEFINED
73 
} vfs_op_t;
74 
 
75 
#define FS_NAME_MAXLEN  20
76 
 
77 
/**
78 
 * A structure like this is passed to VFS by each individual FS upon its
79 
 * registration. It assosiates a human-readable identifier with each
80 
 * registered FS. More importantly, through this structure, the FS announces
81 
 * what operations it supports.
82 
 */
83 
typedef struct {
2523 jermar 84 
    /** Unique identifier of the fs. */
2526 jermar 85 
    char name[FS_NAME_MAXLEN];
2523 jermar 86 
 
87 
    /** Operations. */
88 
    vfs_op_t ops[VFS_LAST - VFS_FIRST];
2521 jermar 89 
} vfs_info_t;
90 
 
2540 jermar 91 
/**
92 
 * A structure like this will be allocated for each registered file system.
93 
 */
2526 jermar 94 
typedef struct {
95 
    link_t fs_link;
96 
    vfs_info_t vfs_info;
2527 jermar 97 
    ipcarg_t phone;
2526 jermar 98 
} fs_info_t;
99 
 
2540 jermar 100 
/**
101 
 * Instances of this type represent a file system node (e.g. directory, file).
102 
 * They are abstracted away from any file system implementation and contain just
103 
 * enough bits to uniquely identify the object in its file system instance.
104 
 *
105 
 * @note    fs_handle, dev_handle and index are meant to be returned in one
106 
 *      IPC reply.
107 
 */
108 
typedef struct {
109 
    int fs_handle;      /**< Global file system ID. */
110 
    int dev_handle;     /**< Global mount device devno. */
111 
    uint64_t index;     /**< Index of the node on its file system. */
112 
} vfs_node_t;
113 
 
114 
/**
115 
 * Instances of this type represent an open file. If the file is opened by more
116 
 * than one task, there will be a separate structure allocated for each task.
117 
 */
118 
typedef struct {
119 
    vfs_node_t *node;
120 
 
121 
    /** Number of file handles referencing this file. */
122 
    atomic_t refcnt;
123 
 
124 
    /** Current position in the file. */
125 
    off_t pos;
126 
} vfs_file_t;
127 
 
2535 jermar 128 
extern link_t fs_head;
129 
 
130 
extern void vfs_register(ipc_callid_t rid, ipc_call_t *request);
131 
 
2520 jermar 132 
#endif
133 
 
134 
/**
135 
 * @}
2523 jermar 136 
 */