1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* Copyright (c) 2025 Ian Marco Moffett and the Osmora Team.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Hyra nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _OS_VNODE_H_
#define _OS_VNODE_H_
#include <sys/types.h>
struct vnode;
/*
* Valid vnode types
*/
typedef enum {
VREG,
VDIR,
VCHR,
VBLK
} vtype_t;
/*
* Arguments for buffer operations
*/
struct vop_buf_args {
void *buffer;
off_t offset;
size_t len;
};
/*
* Arguments for lookup() vop
*
* @component: Path component to lookup
* @vp_res: Resulting vnode pointer
*/
struct vop_lookup_args {
const char *component;
struct vnode **vp_res;
};
/*
* Operations that can be performed on a vnode
*/
struct vops {
ssize_t(*read)(struct vop_buf_args *args);
ssize_t(*write)(struct vop_buf_args *args);
int(*lookup)(struct vop_lookup_args *args);
void(*reclaim)(struct vnode *vp);
};
/*
* A virtual file node is an abstract repre
*
* @type: Vnode type
* @vops: Operations associated with vnode
* @ref: Reference counter
* @data: Filesystem specific data
*/
struct vnode {
vtype_t type;
struct vops vops;
int ref;
void *data;
};
/*
* Read the contents of a file described by a vnode into
* a buffer
*
* @vp: Vnode to read
* @buf: Buffer to read file into
* @size: Number of bytes to read
* @off: Offset to read starting at
*
* Returns the number of bytes read
*/
ssize_t vnode_read(struct vnode *vp, void *buf, size_t size, off_t off);
/*
* Lookup a sub-node within a vnode by name
*
* @vp: Vnode to scan within
* @name: Name to lookup
* @res: Result pointer is written here
*
* Returns zero on success
*/
int vnode_lookup(struct vnode *vp, const char *name, struct vnode **res);
/*
* Write data into a file described by a vnode
*
* @vp: Vnode to write
* @buf: Buffer to write from
* @size: Length of data to write
* @off: Offset to write at
*
* Returns the number of bytes written
*/
ssize_t vnode_write(struct vnode *vp, const void *buf, size_t size, off_t off);
/*
* Initialize a vnode by type
*
* @vp_res: Vnode pointer result
* @vtype: Vnode type to initialize
*
* Returns zero on success
*/
int vnode_init(struct vnode **vp_res, vtype_t type);
/*
* Release a vnode from memory
*
* @vp: Vnode to release from memory
*
* Returns the reference count if not released, zero
* on successful release.
*/
int vnode_release(struct vnode *vp);
#endif /* !_OS_VNODE_H_ */
|
