source: rtems/cpukit/libcsupport/include/rtems/libio_.h @ 4d3017a

4.104.114.84.95
Last change on this file since 4d3017a was 4d3017a, checked in by Ralf Corsepius <ralf.corsepius@…>, on Dec 2, 2004 at 6:04:55 PM

Add doxygen preamble.

  • Property mode set to 100644
File size: 6.6 KB
Line 
1/**
2 * @file rtems/libio_.h
3 */
4
5/*
6 *  Libio Internal Information
7 *
8 *  COPYRIGHT (c) 1989-1999.
9 *  On-Line Applications Research Corporation (OAR).
10 *
11 *  The license and distribution terms for this file may be
12 *  found in the file LICENSE in this distribution or at
13 *  http://www.rtems.com/license/LICENSE.
14 *
15 *  $Id$
16 */
17
18#ifndef __RTEMS_LIBIO_INTERNAL__h
19#define __RTEMS_LIBIO_INTERNAL__h
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25#include <rtems.h>
26#include <rtems/libio.h>                /* include before standard IO */
27
28#include <sys/types.h>
29
30#include <errno.h>
31
32/*
33 *  Semaphore to protect the io table
34 */
35
36#define RTEMS_LIBIO_SEM         rtems_build_name('L', 'B', 'I', 'O')
37#define RTEMS_LIBIO_IOP_SEM(n)  rtems_build_name('L', 'B', 'I', n)
38
39extern rtems_id                          rtems_libio_semaphore;
40extern rtems_filesystem_file_handlers_r  rtems_filesystem_null_handlers;
41
42/*
43 *  File descriptor Table Information
44 */
45
46extern uint32_t        rtems_libio_number_iops;
47extern rtems_libio_t  *rtems_libio_iops;
48extern rtems_libio_t  *rtems_libio_last_iop;
49extern rtems_libio_t *rtems_libio_iop_freelist;
50
51/*
52 *  rtems_libio_iop
53 *
54 *  Macro to return the file descriptor pointer.
55 */
56
57#define rtems_libio_iop(_fd) \
58  ((((uint32_t  )(_fd)) < rtems_libio_number_iops) ? \
59         &rtems_libio_iops[_fd] : 0)
60
61/*
62 *  rtems_libio_iop_to_descriptor
63 *
64 *  Macro to convert an internal file descriptor pointer (iop) into
65 *  the integer file descriptor used by the "section 2" system calls.
66 */
67
68#define rtems_libio_iop_to_descriptor(_iop) \
69   ((!(_iop)) ? -1 : (_iop - rtems_libio_iops))
70
71/*
72 *  rtems_libio_check_is_open
73 *
74 *  Macro to check if a file descriptor is actually open.
75 */
76
77#define rtems_libio_check_is_open(_iop) \
78  do {                                               \
79      if (((_iop)->flags & LIBIO_FLAGS_OPEN) == 0) { \
80          errno = EBADF;                             \
81          return -1;                                 \
82      }                                              \
83  } while (0)
84
85/*
86 *  rtems_libio_check_fd
87 *
88 *  Macro to check if a file descriptor number is valid.
89 */
90
91#define rtems_libio_check_fd(_fd) \
92  do {                                                     \
93      if ((uint32_t  ) (_fd) >= rtems_libio_number_iops) { \
94          errno = EBADF;                                   \
95          return -1;                                       \
96      }                                                    \
97  } while (0)
98
99/*
100 *  rtems_libio_check_buffer
101 *
102 *  Macro to check if a buffer pointer is valid.
103 */
104
105#define rtems_libio_check_buffer(_buffer) \
106  do {                                    \
107      if ((_buffer) == 0) {               \
108          errno = EINVAL;                 \
109          return -1;                      \
110      }                                   \
111  } while (0)
112
113/*
114 *  rtems_libio_check_count
115 *
116 *  Macro to check if a count or length is valid.
117 */
118
119#define rtems_libio_check_count(_count) \
120  do {                                  \
121      if ((_count) == 0) {              \
122          return 0;                     \
123      }                                 \
124  } while (0)
125
126/*
127 *  rtems_libio_check_permissions
128 *
129 *  Macro to check if a file descriptor is open for this operation.
130 */
131
132#define rtems_libio_check_permissions(_iop, _flag)    \
133  do {                                                \
134      if (((_iop)->flags & (_flag)) == 0) {           \
135            rtems_set_errno_and_return_minus_one( EINVAL ); \
136            return -1;                                \
137      }                                               \
138  } while (0)
139
140/*
141 *  rtems_filesystem_freenode
142 *
143 *  Macro to free a node.
144 */
145
146#define rtems_filesystem_freenode( _node ) \
147  do { \
148    if ( (_node)->ops )\
149      if ( (_node)->ops->freenod_h ) \
150        (*(_node)->ops->freenod_h)( (_node) ); \
151  } while (0)
152
153/*
154 *  rtems_filesystem_is_separator
155 *
156 *  Macro to determine if a character is a path name separator.
157 *
158 *  NOTE:  This macro handles MS-DOS and UNIX style names.
159 */
160
161#define rtems_filesystem_is_separator( _ch ) \
162   ( ((_ch) == '/') || ((_ch) == '\\') || ((_ch) == '\0'))
163
164/*
165 *  rtems_filesystem_get_start_loc
166 *
167 *  Macro to determine if path is absolute or relative.
168 */
169
170#define rtems_filesystem_get_start_loc( _path, _index, _loc )  \
171  do {                                                         \
172    if ( rtems_filesystem_is_separator( (_path)[ 0 ] ) ) {     \
173      *(_loc) = rtems_filesystem_root;                         \
174      *(_index) = 1;                                           \
175    } else {                                                   \
176      *(_loc) = rtems_filesystem_current;                      \
177      *(_index) = 0;                                           \
178    }                                                          \
179  } while (0)
180
181#define rtems_filesystem_get_sym_start_loc( _path, _index, _loc )  \
182  do {                                                         \
183    if ( rtems_filesystem_is_separator( (_path)[ 0 ] ) ) {     \
184      *(_loc) = rtems_filesystem_root;                         \
185      *(_index) = 1;                                           \
186    } else {                                                   \
187      *(_index) = 0;                                           \
188    }                                                          \
189  } while (0)
190
191
192/*
193 *  External structures
194 */
195#include <rtems/userenv.h>
196
197extern rtems_user_env_t * rtems_current_user_env;
198extern rtems_user_env_t   rtems_global_user_env;
199
200/*
201 *  Instantiate a private copy of the per user information for the calling task.
202 */
203
204rtems_status_code rtems_libio_set_private_env(void);
205rtems_status_code rtems_libio_share_private_env(rtems_id task_id) ;
206
207/*
208 *  File Descriptor Routine Prototypes
209 */
210
211rtems_libio_t *rtems_libio_allocate(void);
212
213uint32_t   rtems_libio_fcntl_flags(
214  uint32_t   fcntl_flags
215);
216
217uint32_t   rtems_libio_to_fcntl_flags(
218  uint32_t   flags
219);
220
221void rtems_libio_free(
222  rtems_libio_t *iop
223);
224
225int rtems_libio_is_open_files_in_fs(
226  rtems_filesystem_mount_table_entry_t *mt_entry
227);
228
229int rtems_libio_is_file_open(
230  void  *node_access
231);
232
233/*
234 *  File System Routine Prototypes
235 */
236
237int rtems_filesystem_evaluate_path(
238  const char                        *pathname,
239  int                                flags,
240  rtems_filesystem_location_info_t  *pathloc,
241  int                                follow_link
242);
243
244int rtems_filesystem_evaluate_parent(
245  int                                flags,
246  rtems_filesystem_location_info_t  *pathloc
247);
248
249void rtems_filesystem_initialize();
250
251int init_fs_mount_table();
252
253#ifdef __cplusplus
254}
255#endif
256
257#endif
258/* end of include file */
Note: See TracBrowser for help on using the repository browser.