source: mainline/uspace/lib/libc/include/stdio.h@ e70edd1

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since e70edd1 was ed903174, checked in by Martin Decky <martin@…>, 15 years ago

implement support for 64bit file offsets

  • the libc API is a small deviation from standard, but we have no reason to keep a strict backward compatibility with ancient code so far
    • the basic signed 64bit offset type is called off64_t
      • lseek() and fseek() take off64_t arguments (since the argument represents a relative offset)
      • ftell() returns off64_t values (since it is a wrapper of lseek())
      • vfs_seek() implementation supports negative offsets when SEEK_CUR and SEEK_END is used
    • aoff64_t is used for internal unsigned representation of sizes (in bytes, blocks, etc.) and absolute offsets
      • mmap() and ftruncate() take aoff64_t arguments (since the full range of the absolute file offset should be used here)
      • struct stat stores the file size as aoff64_t
    • in both cases the explicit range of the types shown in the names is helpful for proper filesystem and IPC interaction
    • note: size_t should be used only for representing in-memory sizes and offsets, not device and file-related information, and vice versa
      • the code base still needs a thorough revision with respect to this rule
    • PRIdOFF64 and PRIuOFF64 can be used for printing the offsets
  • VFS_OUT_LOOKUP returns the 64bit file size in two IPC arguments
    • since all 5 IPC arguments have already been taken, the fs_handle is returned as the return value (fs_handle has only 16 bits, thus the return value can be used for both indicating errors as negative values and returning positive handles)
  • VFS_OUT_READ and VFS_OUT_WRITE use aoff64_t absolute offsets split into two IPC arguments

replace bn_t with aoff64_t as a generic 64bit bytes/block counter type

note: filesystem drivers need to be revised with respect to make sure that all out-of-range checks are correct (especially w.r.t. file and block offsets)
  • Property mode set to 100644
File size: 4.0 KB
Line 
1/*
2 * Copyright (c) 2005 Martin Decky
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_STDIO_H_
36#define LIBC_STDIO_H_
37
38#include <sys/types.h>
39#include <stdarg.h>
40#include <string.h>
41#include <adt/list.h>
42
43#define EOF (-1)
44
45/** Default size for stream I/O buffers */
46#define BUFSIZ 4096
47
48#define DEBUG(fmt, ...)se\
49 { \
50 char _buf[256]; \
51 int _n = snprintf(_buf, sizeof(_buf), fmt, ##__VA_ARGS__); \
52 if (_n > 0) \
53 (void) __SYSCALL3(SYS_KLOG, 1, (sysarg_t) _buf, str_size(_buf)); \
54 }
55
56#ifndef SEEK_SET
57 #define SEEK_SET 0
58#endif
59
60#ifndef SEEK_CUR
61 #define SEEK_CUR 1
62#endif
63
64#ifndef SEEK_END
65 #define SEEK_END 2
66#endif
67
68enum _buffer_type {
69 /** No buffering */
70 _IONBF,
71 /** Line buffering */
72 _IOLBF,
73 /** Full buffering */
74 _IOFBF
75};
76
77typedef struct {
78 /** Linked list pointer. */
79 link_t link;
80
81 /** Underlying file descriptor. */
82 int fd;
83
84 /** Error indicator. */
85 int error;
86
87 /** End-of-file indicator. */
88 int eof;
89
90 /** Klog indicator */
91 int klog;
92
93 /** Phone to the file provider */
94 int phone;
95
96 /** Buffering type */
97 enum _buffer_type btype;
98 /** Buffer */
99 uint8_t *buf;
100 /** Buffer size */
101 size_t buf_size;
102 /** Buffer I/O pointer */
103 uint8_t *buf_head;
104} FILE;
105
106extern FILE *stdin;
107extern FILE *stdout;
108extern FILE *stderr;
109
110/* Character and string input functions */
111extern int fgetc(FILE *);
112extern char *fgets(char *, size_t, FILE *);
113
114extern int getchar(void);
115extern char *gets(char *, size_t);
116
117/* Character and string output functions */
118extern int fputc(wchar_t, FILE *);
119extern int fputs(const char *, FILE *);
120
121extern int putchar(wchar_t);
122extern int puts(const char *);
123
124/* Formatted string output functions */
125extern int fprintf(FILE *, const char*, ...);
126extern int vfprintf(FILE *, const char *, va_list);
127
128extern int printf(const char *, ...);
129extern int vprintf(const char *, va_list);
130
131extern int snprintf(char *, size_t , const char *, ...);
132extern int asprintf(char **, const char *, ...);
133extern int vsnprintf(char *, size_t, const char *, va_list);
134
135/* File stream functions */
136extern FILE *fopen(const char *, const char *);
137extern FILE *fdopen(int, const char *);
138extern int fclose(FILE *);
139
140extern size_t fread(void *, size_t, size_t, FILE *);
141extern size_t fwrite(const void *, size_t, size_t, FILE *);
142
143extern int fseek(FILE *, off64_t, int);
144extern void rewind(FILE *);
145extern off64_t ftell(FILE *);
146extern int feof(FILE *);
147
148extern int fflush(FILE *);
149extern int ferror(FILE *);
150extern void clearerr(FILE *);
151
152extern void setvbuf(FILE *, void *, int, size_t);
153
154/* Misc file functions */
155extern int rename(const char *, const char *);
156
157#endif
158
159/** @}
160 */
Note: See TracBrowser for help on using the repository browser.