source: mainline/uspace/lib/c/include/vfs/vfs.h@ a53ed3a

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since a53ed3a was b7fd2a0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 7 years ago

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.
  • Property mode set to 100644
File size: 4.4 KB
Line 
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 libc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef LIBC_VFS_H_
36#define LIBC_VFS_H_
37
38#include <stddef.h>
39#include <stdint.h>
40#include <ipc/vfs.h>
41#include <ipc/loc.h>
42#include <adt/list.h>
43#include <stdio.h>
44#include <async.h>
45#include <offset.h>
46
47#define MAX_OPEN_FILES 128
48
49enum vfs_change_state_type {
50 VFS_PASS_HANDLE
51};
52
53typedef enum {
54 KIND_FILE,
55 KIND_DIRECTORY,
56} vfs_file_kind_t;
57
58
59struct stat {
60 fs_handle_t fs_handle;
61 service_id_t service_id;
62 fs_index_t index;
63 unsigned int lnkcnt;
64 bool is_file;
65 bool is_directory;
66 aoff64_t size;
67 service_id_t service;
68};
69
70struct statfs {
71 char fs_name[FS_NAME_MAXLEN + 1];
72 uint32_t f_bsize; /* fundamental file system block size */
73 uint64_t f_blocks; /* total data blocks in file system */
74 uint64_t f_bfree; /* free blocks in fs */
75};
76
77/** List of file system types */
78typedef struct {
79 char **fstypes;
80 char *buf;
81 size_t size;
82} vfs_fstypes_t;
83
84extern errno_t vfs_fhandle(FILE *, int *);
85
86extern char *vfs_absolutize(const char *, size_t *);
87extern errno_t vfs_clone(int, int, bool, int *);
88extern errno_t vfs_cwd_get(char *path, size_t);
89extern errno_t vfs_cwd_set(const char *path);
90extern async_exch_t *vfs_exchange_begin(void);
91extern void vfs_exchange_end(async_exch_t *);
92extern errno_t vfs_fsprobe(const char *, service_id_t, vfs_fs_probe_info_t *);
93extern errno_t vfs_fstypes(vfs_fstypes_t *);
94extern void vfs_fstypes_free(vfs_fstypes_t *);
95extern errno_t vfs_link(int, const char *, vfs_file_kind_t, int *);
96extern errno_t vfs_link_path(const char *, vfs_file_kind_t, int *);
97extern errno_t vfs_lookup(const char *, int, int *);
98extern errno_t vfs_lookup_open(const char *, int, int, int *);
99extern errno_t vfs_mount_path(const char *, const char *, const char *,
100 const char *, unsigned int, unsigned int);
101extern errno_t vfs_mount(int, const char *, service_id_t, const char *, unsigned,
102 unsigned, int *);
103extern errno_t vfs_open(int, int);
104extern errno_t vfs_pass_handle(async_exch_t *, int, async_exch_t *);
105extern errno_t vfs_put(int);
106extern errno_t vfs_read(int, aoff64_t *, void *, size_t, size_t *);
107extern errno_t vfs_read_short(int, aoff64_t, void *, size_t, ssize_t *);
108extern errno_t vfs_receive_handle(bool, int *);
109extern errno_t vfs_rename_path(const char *, const char *);
110extern errno_t vfs_resize(int, aoff64_t);
111extern int vfs_root(void);
112extern errno_t vfs_root_set(int);
113extern errno_t vfs_stat(int, struct stat *);
114extern errno_t vfs_stat_path(const char *, struct stat *);
115extern errno_t vfs_statfs(int, struct statfs *);
116extern errno_t vfs_statfs_path(const char *, struct statfs *);
117extern errno_t vfs_sync(int);
118extern errno_t vfs_unlink(int, const char *, int);
119extern errno_t vfs_unlink_path(const char *);
120extern errno_t vfs_unmount(int);
121extern errno_t vfs_unmount_path(const char *);
122extern errno_t vfs_walk(int, const char *, int, int *);
123extern errno_t vfs_write(int, aoff64_t *, const void *, size_t, size_t *);
124extern errno_t vfs_write_short(int, aoff64_t, const void *, size_t, ssize_t *);
125
126#endif
127
128/** @}
129 */
Note: See TracBrowser for help on using the repository browser.