Changeset 871 for trunk/src/emx/include/emx/io.h

Timestamp:

Nov 23, 2003, 12:31:59 AM (22 years ago)

Author:

bird

Message:

#697: Filehandle rewrite - first step.

File:

• trunk/src/emx/include/emx/io.h (modified) (3 diffs, 1 prop)

trunk/src/emx/include/emx/io.h

@@ -18 +18 @@
 #endif
 
-/* Low-level i/o */
-
+/** @defgroup   libc_ioflags    Low Level I/O Flags
+ * These low level I/O flags are kept in the fFlags member of the LIBCFH
+ * structure. The O_* flags are defined in sys/fcntl.h, the F_* flags are
+ * internal to LIBC and defined in emx/io.h.
+ * @{
+ */
+/*      O_RDONLY    0x00000000 */
+/*      O_WRONLY    0x00000001 */
+/*      O_RDWR      0x00000002 */
 /*      O_ACCMODE   0x00000003 */
-/*      O_NDELAY    0x00000004 */
+/*      O_NONBLOCK  0x00000004 */
 /*      O_APPEND    0x00000008 */
-/*      O_TEXT      0x00000010 */
-#define F_EOF       0x00000020
-#define F_TERMIO    0x00000040
-#define F_DEV       0x00000080
-/*      O_BINARY    0x00000100 */
+/* emx  O_TEXT      0x00000010 */
+/* emx  O_SIZE      0x00000020 */
+/*      free        0x00000040 */
+/*      O_(F)SYNC   0x00000080 */
+/*      O_SYNC      0x00000080 */
+/* emx  O_BINARY    0x00000100 */
 /*      O_CREAT     0x00000200 */
 /*      O_TRUNC     0x00000400 */
 /*      O_EXCL      0x00000800 */
-/*      O_NOINHERIT 0x00001000 */
-/*      O_SYNC      0x00002000 */
-/*      O_NOCTTY    0x00004000 */
-/*      O_SIZE      0x00008000 */
-#define F_SOCKET    0x10000000
-#define F_PIPE      0x20000000
-#define F_WRCRPEND  0x40000000
-#define F_CRLF      0x80000000
+/* emx  O_NOINHERIT 0x00001000 */
+/*      free        0x00002000 */
+/*      free        0x00004000 */
+/*      O_NOCTTY    0x00008000 */
+#define F_EOF       0x01000000
+#define F_TERMIO    0x02000000
+#define F_WRCRPEND  0x04000000
+#define F_CRLF      0x08000000
+/** Filetype mask. */
+#define F_TYPEMASK  0xf0000000
+/** Type - Regular file. */
+#define F_FILE      0x10000000
+/** Type - Characater device. */
+#define F_DEV       0x20000000
+/** Type - Pipe. */
+#define F_PIPE      0x30000000
+/** Type - Socket. */
+#define F_SOCKET    0x40000000
+/** @} */
 
 /* stdio */
@@ -157 +176 @@
 };
 
-extern struct streamvec _streamvec_head;
-
-extern int _io_ninherit;
-extern struct fdvec _fdvec_head;
-
-/* This is currently used only in the multi-thread libraries.  We
-   can't use and reallocate a single array because rmutex semaphores
-   cannot be moved. */
-
-struct streamvec2
-{
-  struct _file2 *vec;
-  struct streamvec2 *next;
-  int n;
-};
-
-extern struct streamvec2 _streamvec2_head;
+extern struct streamvec    *_streamvec_head;
+extern int                  _io_ninherit;
+extern struct fdvec         _fdvec_head;
 
 #if defined (_SYS_RMUTEX_H)
@@ -203 +208 @@
 #endif /* defined (_SYS_RMUTEX_H) */
 
+struct __libc_FileHandle;
+
+/**
+ * File handle Operations.
+ * (for non standard handles (like sockets))
+ */
+typedef struct __libc_FileHandleOperations
+{
+    /** Handle type. */
+    enum
+    {
+        /** Anything which is supported by the OS/2 file API.
+         * (not used at present as those handles doesn't need special ops). */
+        enmFH_File,
+        /** Socket handle. */
+        enmFH_Socket
+    }   enmType;
+
+    /** Close operation.
+     * @returns 0 on success.
+     * @returns OS/2 error code on failure.
+     * @param   pFH         Pointer to the handle structure to operate on.
+     * @param   fh          It's associated filehandle.
+     */
+    int (*pfnClose)(struct __libc_FileHandle *pFH, int fh);
+    /** Read operation.
+     * @returns 0 on success.
+     * @returns OS/2 error code on failure.
+     * @param   pFH         Pointer to the handle structure to operate on.
+     * @param   fh          It's associated filehandle.
+     * @param   pvBuf       Pointer to the buffer to read into.
+     * @param   cbRead      Number of bytes to read.
+     * @param   pcbRead     Where to store the count of bytes actually read.
+     */
+    int (*pfnRead)(struct __libc_FileHandle *pFH, int fh, void *pvBuf, size_t cbRead, size_t *pcbRead);
+    /** Write operation.
+     * @returns 0 on success.
+     * @returns OS/2 error code on failure.
+     * @param   pFH         Pointer to the handle structure to operate on.
+     * @param   fh          It's associated filehandle.
+     * @param   pvBuf       Pointer to the buffer which contains the data to write.
+     * @param   cbWrite     Number of bytes to write.
+     * @param   pcbWritten  Where to store the count of bytes actually written.
+     */
+    int (*pfnWrite)(struct __libc_FileHandle *pFH, int fh, const void *pvBuf, size_t cbWrite, size_t *pcbWritten);
+    /** Duplicate handle operation.
+     * @returns 0 on success, OS/2 error code on failure.
+     * @param   pFH         Pointer to the handle structure to operate on.
+     * @param   fh          It's associated filehandle.
+     * @param   pfhNew      Where to store the duplicate filehandle.
+     *                      The input value describe how the handle is to be
+     *                      duplicated. If it's -1 a new handle is allocated.
+     *                      Any other value will result in that value to be
+     *                      used as handle. Any existing handle with that
+     *                      value will be closed.
+     */
+    int (*pfnDuplicate)(struct __libc_FileHandle *pFH, int fh, int *pfhNew);
+    /** File Control operation.
+     * @returns 0 on success, OS/2 error code on failure.
+     * @param   pFH         Pointer to the handle structure to operate on.
+     * @param   fh          It's associated filehandle.
+     * @param   iIOControl  Which file file control operation to perform.
+     * @param   iArg        Argument which content is specific to each
+     *                      iIOControl operation.
+     * @param   prc         Where to store the value which upon success is
+     *                      returned to the caller.
+     */
+    int (*pfnFileControl)(struct __libc_FileHandle *pFH, int fh, int iIOControl, int iArg, int *prc);
+    /** I/O Control operation.
+     * @returns 0 on success, OS/2 error code on failure.
+     * @param   pFH         Pointer to the handle structure to operate on.
+     * @param   fh          It's associated filehandle.
+     * @param   iIOControl  Which I/O control operation to perform.
+     * @param   iArg        Argument which content is specific to each
+     *                      iIOControl operation.
+     * @param   prc         Where to store the value which upon success is
+     *                      returned to the caller.
+     */
+    int (*pfnIOControl)(struct __libc_FileHandle *pFH, int fh, int iIOControl, int iArg, int *prc);
+
+} LIBCFHOPS, *PLIBCFHOPS/*, const * PCLIBCFHOPS*/;
+
+
+/**
+ * Common part of a per 'file' handle structure.
+ */
+typedef struct __libc_FileHandle
+{
+    /** Handle flags.
+     * Previously represented by _files / *fd_vec->flags.
+     * @remark For thread safety update this atomically. */
+    unsigned int    fFlags;
+
+    /** Lookahead. (whoever uses that?)
+     * Previously represented by _files / *fd_vec->flags.
+     * @remark For thread safety update this atomically. */
+    int             iLookAhead;
+
+    /** Pointer to the operations one can perform on the handle.
+     * Only for special handles not supported by the OS/2 file API. */
+    PLIBCFHOPS      pOps;
+
+} LIBCFH, *PLIBCFH;
+
+int     __libc_FHEnsureHandles(int fh);
+int     __libc_FHAllocate(int fh, unsigned fFlags, int cb, PLIBCFHOPS pOps, PLIBCFH *ppFH, int *pfh);
+int     __libc_FHClose(int fh);
+PLIBCFH __libc_FH(int fh);
+
 
 int _endbuf1 (struct _FILE *);
 void _fbuf (struct _FILE *);
-int *_fd_flags (int);
-int *_fd_init (int);
-int *_fd_lookahead (int);
+#define _fd_flags(a)        please do not use this use this! ##a
+#define _fd_init(a)         please do not use this use this! ##a
+#define _fd_lookahead(a)    please do not use this use this! ##a
 struct _FILE *_openstream (struct _FILE *, __const__ char *, __const__ char *,
     int, int);