]> git.proxmox.com Git - mirror_edk2.git/blame - StdLibPrivateInternalFiles/Include/kfile.h
StdLib: Add multi-byte character support. The normal "narrow" character set is now...
[mirror_edk2.git] / StdLibPrivateInternalFiles / Include / kfile.h
CommitLineData
b00771f5 1/** @file\r
2 The EFI kernel's interpretation of a "file".\r
3\r
4 Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials are licensed and made available\r
6 under the terms and conditions of the BSD License which accompanies this\r
7 distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php.\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13 * Copyright (c) 1982, 1986, 1989, 1993\r
14 * The Regents of the University of California. All rights reserved.\r
15 *\r
16 * Redistribution and use in source and binary forms, with or without\r
17 * modification, are permitted provided that the following conditions\r
18 * are met:\r
19 * 1. Redistributions of source code must retain the above copyright\r
20 * notice, this list of conditions and the following disclaimer.\r
21 * 2. Redistributions in binary form must reproduce the above copyright\r
22 * notice, this list of conditions and the following disclaimer in the\r
23 * documentation and/or other materials provided with the distribution.\r
24 * 3. Neither the name of the University nor the names of its contributors\r
25 * may be used to endorse or promote products derived from this software\r
26 * without specific prior written permission.\r
27 *\r
28 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND\r
29 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
30 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
31 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE\r
32 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
37 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
38 * SUCH DAMAGE.\r
39 *\r
40 * file.h 8.3 (Berkeley) 1/9/95\r
41 NetBSD: file.h,v 1.56 2006/05/14 21:38:18 elad Exp\r
42**/\r
43#ifndef _PIF_KFILE_H_\r
44#define _PIF_KFILE_H_\r
45\r
46#include <Uefi.h>\r
47#include <Protocol/SimpleTextOut.h>\r
48#include <Protocol/SimpleFileSystem.h>\r
49\r
50#include <wchar.h>\r
76beedc0 51#include <stdarg.h>\r
b00771f5 52#include <sys/fcntl.h>\r
53#include <sys/unistd.h>\r
54\r
55struct stat;\r
56struct fileops;\r
57struct _Device_Node;\r
58\r
59/* The number of "special" character stream devices.\r
60 These include:\r
61 stdin, stdout, stderr\r
62*/\r
63#define NUM_SPECIAL 3\r
64\r
65/* Organization of the f_iflags member of the __filedes structure. */\r
66#define DTYPE_MASK 0x00000007 ///< Device Type\r
67#define DTYPE_VNODE 1 /* file */\r
68#define DTYPE_SOCKET 2 /* communications endpoint */\r
69#define DTYPE_PIPE 3 /* pipe */\r
70#define DTYPE_KQUEUE 4 /* event queue */\r
71#define DTYPE_MISC 5 /* misc file descriptor type */\r
72#define DTYPE_CRYPTO 6 /* crypto */\r
73#define DTYPE_NAMES "0", "file", "socket", "pipe", "kqueue", "misc", "crypto"\r
74\r
75#define FIF_WANTCLOSE 0x10000000 /* a close is waiting for usecount */\r
76#define FIF_DELCLOSE 0x20000000 /* Delete on close. */\r
77#define FIF_LARVAL 0x80000000 /* not fully constructed; don't use */\r
78\r
79/*\r
80 This structure must be a multiple of 8 bytes in length.\r
81*/\r
82struct __filedes {\r
f766dd76 83 off_t f_offset; /* current position in file */\r
b00771f5 84 const struct fileops *f_ops;\r
85 void *devdata; /* Device-specific data */\r
b00771f5 86 int Oflags; // From the open call\r
87 int Omode; // From the open call\r
88 int RefCount; // Reference count of opens\r
f766dd76 89 UINT32 f_flag; /* see fcntl.h */\r
90 UINT32 f_iflags; // In use if non-zero\r
b00771f5 91 UINT16 MyFD; // Which FD this is.\r
92 UINT16 Reserved_1; // Force this structure to be a multiple of 8-bytes in length\r
93};\r
94\r
95struct fileops {\r
96 /* These functions must always be implemented. */\r
97 int (EFIAPI *fo_close) (struct __filedes *filp);\r
98 ssize_t (EFIAPI *fo_read) (struct __filedes *filp, off_t *Offset, size_t Len, void *Buf);\r
99 ssize_t (EFIAPI *fo_write) (struct __filedes *filp, off_t *Offset, size_t Len, const void *Buf);\r
100\r
101 /* Call the fnullop_* version of these functions if not implemented by the device. */\r
102 int (EFIAPI *fo_fcntl) (struct __filedes *filp, UINT32 Cmd, void *p3, void *p4);\r
103 short (EFIAPI *fo_poll) (struct __filedes *filp, short Events);\r
104 int (EFIAPI *fo_flush) (struct __filedes *filp);\r
105\r
106 /* Call the fbadop_* version of these functions if not implemented by the device. */\r
107 int (EFIAPI *fo_stat) (struct __filedes *filp, struct stat *StatBuf, void *Buf);\r
76beedc0 108 int (EFIAPI *fo_ioctl) (struct __filedes *filp, ULONGN Cmd, va_list argp);\r
b00771f5 109 int (EFIAPI *fo_delete) (struct __filedes *filp);\r
110 int (EFIAPI *fo_rmdir) (struct __filedes *filp);\r
111 int (EFIAPI *fo_mkdir) (const char *path, __mode_t perms);\r
112 int (EFIAPI *fo_rename) (const char *from, const char *to);\r
113\r
114 /* Use a NULL if this function has not been implemented by the device. */\r
115 off_t (EFIAPI *fo_lseek) (struct __filedes *filp, off_t, int);\r
116};\r
117\r
118/* A generic instance structure which is valid for\r
119 for all device instance structures.\r
120\r
121 All device instance structures MUST be a multiple of 8-bytes in length.\r
122*/\r
123typedef struct {\r
124 UINT32 Cookie; ///< Special value identifying this as a valid Instance\r
125 UINT32 InstanceNum; ///< Which instance is this? Zero-based.\r
126 EFI_HANDLE Dev; ///< Pointer to either Input or Output Protocol.\r
127 struct _Device_Node *Parent; ///< Points to the parent Device Node.\r
128 struct fileops Abstraction; ///< Pointers to functions implementing this device's abstraction.\r
129 UINTN Reserved_1; // Force this to always be a multiple of 8-bytes in length\r
130} GenericInstance;\r
131\r
132/* Type of all Device-specific handler's open routines. */\r
133typedef\r
f766dd76 134 int (EFIAPI *FO_OPEN) (struct _Device_Node *This, struct __filedes *FD,\r
135 int Instance, wchar_t *Path, wchar_t *MPath);\r
b00771f5 136\r
137#define FILE_IS_USABLE(fp) (((fp)->f_iflags & \\r
138 (FIF_WANTCLOSE|FIF_LARVAL)) == 0)\r
139\r
140#define FILE_SET_MATURE(fp) \\r
141do { \\r
142 (fp)->f_iflags &= ~FIF_LARVAL; \\r
143} while (/*CONSTCOND*/0)\r
144\r
145/*\r
146 * Flags for fo_read and fo_write.\r
147 */\r
148#define FOF_UPDATE_OFFSET 0x01 /* update the file offset */\r
149\r
150__BEGIN_DECLS\r
151\r
152int fdcreate (CHAR16 *, UINT32, UINT32, BOOLEAN, VOID *, const struct fileops *);\r
153\r
154/* Commonly used fileops\r
155 fnullop_* Does nothing and returns success.\r
156 fbadop_* Does nothing and returns EPERM\r
157*/\r
f766dd76 158int EFIAPI fnullop_fcntl (struct __filedes *filp, UINT32 Cmd, void *p3, void *p4);\r
159short EFIAPI fnullop_poll (struct __filedes *filp, short Events);\r
160int EFIAPI fnullop_flush (struct __filedes *filp);\r
161\r
162int EFIAPI fbadop_stat (struct __filedes *filp, struct stat *StatBuf, void *Buf);\r
76beedc0 163int EFIAPI fbadop_ioctl (struct __filedes *filp, ULONGN Cmd, va_list argp);\r
f766dd76 164int EFIAPI fbadop_delete (struct __filedes *filp);\r
165int EFIAPI fbadop_rmdir (struct __filedes *filp);\r
166int EFIAPI fbadop_mkdir (const char *path, __mode_t perms);\r
167int EFIAPI fbadop_rename (const char *from, const char *to);\r
b00771f5 168\r
169__END_DECLS\r
170\r
171/* From the original file... */\r
172#if 0\r
173\r
174//struct proc;\r
175//struct lwp;\r
176//struct uio;\r
177//struct iovec;\r
178//struct knote;\r
179\r
180//LIST_HEAD(filelist, file);\r
181//extern struct filelist filehead; /* head of list of open files */\r
182//extern int maxfiles; /* kernel limit on # of open files */\r
183//extern int nfiles; /* actual number of open files */\r
184\r
185//extern const struct fileops vnops; /* vnode operations for files */\r
186\r
187struct fileops {\r
188 int (*fo_read) (struct file *, off_t *, struct uio *, kauth_cred_t, int);\r
189 int (*fo_write) (struct file *, off_t *, struct uio *, kauth_cred_t, int);\r
190 int (*fo_ioctl) (struct file *, u_long, void *, struct lwp *);\r
191 int (*fo_fcntl) (struct file *, u_int, void *, struct lwp *);\r
192 int (*fo_poll) (struct file *, int, struct lwp *);\r
193 int (*fo_stat) (struct file *, struct stat *, struct lwp *);\r
194 int (*fo_close) (struct file *, struct lwp *);\r
195};\r
196\r
197/*\r
198 * Kernel descriptor table.\r
199 * One entry for each open kernel vnode and socket.\r
200 */\r
201struct file {\r
202 LIST_ENTRY(file) f_list; /* list of active files */\r
203 void *f_data; /* descriptor data, e.g. vnode/socket */\r
204 const struct fileops *f_ops;\r
205 void *f_DevDesc; /* Device Descriptor pointer */\r
206 EFI_FILE_HANDLE FileHandle;\r
207 EFI_HANDLE Handle;\r
208 off_t f_offset; /* current position in file */\r
209 int f_flag; /* see fcntl.h */\r
210 UINT32 f_iflags; /* internal flags; FIF_* */\r
211 int f_advice; /* access pattern hint; UVM_ADV_* */\r
212 int f_type; /* descriptor type */\r
213 int f_usecount; /* number active users */\r
214 u_int f_count; /* reference count */\r
215 u_int f_msgcount; /* references from message queue */\r
216// kauth_cred_t f_cred; /* creds associated with descriptor */\r
217 struct simplelock f_slock;\r
218 UINT16 MyFD; /* Which FD this is. */\r
219};\r
220\r
221#ifdef DIAGNOSTIC\r
222#define FILE_USE_CHECK(fp, str) \\r
223 do { \\r
224 if ((fp)->f_usecount < 0) \\r
225 panic(str); \\r
226} while (/* CONSTCOND */ 0)\r
227#else\r
228#define FILE_USE_CHECK(fp, str) /* nothing */\r
229#endif\r
230\r
231 /*\r
232 * FILE_USE() must be called with the file lock held.\r
233 * (Typical usage is: `fp = fd_getfile(..); FILE_USE(fp);'\r
234 * and fd_getfile() returns the file locked)\r
235 *\r
236 * fp is a pointer to a __filedes structure.\r
237 */\r
238#define FILE_USE(fp) \\r
239 do { \\r
240 (fp)->f_usecount++; \\r
241 FILE_USE_CHECK((fp), "f_usecount overflow"); \\r
242 simple_unlock(&(fp)->f_slock); \\r
243 } while (/* CONSTCOND */ 0)\r
244\r
245#define FILE_UNUSE_WLOCK(fp, l, havelock) \\r
246 do { \\r
247 if (!(havelock)) \\r
248 simple_lock(&(fp)->f_slock); \\r
249 if ((fp)->f_iflags & FIF_WANTCLOSE) { \\r
250 simple_unlock(&(fp)->f_slock); \\r
251 /* Will drop usecount */ \\r
252 (void) closef((fp), (l)); \\r
253 break; \\r
254 } else { \\r
255 (fp)->f_usecount--; \\r
256 FILE_USE_CHECK((fp), "f_usecount underflow"); \\r
257 } \\r
258 simple_unlock(&(fp)->f_slock); \\r
259 } while (/* CONSTCOND */ 0)\r
260\r
261#define FILE_UNUSE(fp, l) FILE_UNUSE_WLOCK(fp, l, 0)\r
262#define FILE_UNUSE_HAVELOCK(fp, l) FILE_UNUSE_WLOCK(fp, l, 1)\r
263\r
264__BEGIN_DECLS\r
265//int dofileread (struct lwp *, int, struct file *, void *, size_t, off_t *, int, register_t *);\r
266//int dofilewrite (struct lwp *, int, struct file *, const void *, size_t, off_t *, int, register_t *);\r
267\r
268//int dofilereadv (struct lwp *, int, struct file *, const struct iovec *, int, off_t *, int, register_t *);\r
269//int dofilewritev(struct lwp *, int, struct file *, const struct iovec *, int, off_t *, int, register_t *);\r
270\r
271//int fsetown (struct proc *, pid_t *, int, const void *);\r
272//int fgetown (struct proc *, pid_t, int, void *);\r
273//void fownsignal (pid_t, int, int, int, void *);\r
274\r
275//int fdclone (struct lwp *, struct file *, int, int, const struct fileops *, void *);\r
276\r
277/* Commonly used fileops\r
278 fnullop_* Does nothing and returns success.\r
279 fbadop_* Does nothing and returns EPERM\r
280*/\r
281//int fnullop_fcntl (struct file *, u_int, void *, struct lwp *);\r
282//int fnullop_poll (struct file *, int, struct lwp *);\r
283//int fnullop_kqfilter(struct file *, struct knote *);\r
284//int fbadop_stat (struct file *, struct stat *, struct lwp *);\r
285//int fbadop_ioctl (struct file *, u_long, void *, struct lwp *);\r
286__END_DECLS\r
287\r
288#endif\r
289\r
290#endif /* _PIF_KFILE_H_ */\r