blob: dd1c42f2f22e40278269f75b4d3a36a97a44f3dc [file] [log] [blame]
/* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef FILE_IO_H
#define FILE_IO_H
#include "apr.h"
#include "apr_private.h"
#include "apr_general.h"
#include "apr_tables.h"
#include "apr_file_io.h"
#include "apr_file_info.h"
#include "apr_errno.h"
#include "apr_lib.h"
#include "apr_poll.h"
/* System headers the file I/O library needs */
#if APR_HAVE_FCNTL_H
#include <fcntl.h>
#endif
#if APR_HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#if APR_HAVE_ERRNO_H
#include <errno.h>
#endif
#if APR_HAVE_STRING_H
#include <string.h>
#endif
#if APR_HAVE_STRINGS_H
#include <strings.h>
#endif
#if APR_HAVE_DIRENT_H
#include <dirent.h>
#endif
#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif
#if APR_HAVE_UNISTD_H
#include <unistd.h>
#endif
#if APR_HAVE_STDIO_H
#include <stdio.h>
#endif
#if APR_HAVE_STDLIB_H
#include <stdlib.h>
#endif
#if APR_HAVE_SYS_UIO_H
#include <sys/uio.h>
#endif
#if APR_HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#include <fsio.h>
/* End System headers */
#define APR_FILE_BUFSIZE 4096
#if APR_HAS_THREADS
#define file_lock(f) do { \
if ((f)->thlock) \
apr_thread_mutex_lock((f)->thlock); \
} while (0)
#define file_unlock(f) do { \
if ((f)->thlock) \
apr_thread_mutex_unlock((f)->thlock); \
} while (0)
#else
#define file_lock(f) do {} while (0)
#define file_unlock(f) do {} while (0)
#endif
#if APR_HAS_LARGE_FILES
#define lseek(f,o,w) lseek64(f,o,w)
#define ftruncate(f,l) ftruncate64(f,l)
#endif
typedef struct stat struct_stat;
struct apr_file_t {
apr_pool_t *pool;
int filedes;
char *fname;
apr_int32_t flags;
int eof_hit;
int is_pipe;
apr_interval_time_t timeout;
int buffered;
enum {BLK_UNKNOWN, BLK_OFF, BLK_ON } blocking;
int ungetchar; /* Last char provided by an unget op. (-1 = no char)*/
/* if there is a timeout set, then this pollset is used */
apr_pollset_t *pollset;
/* Stuff for buffered mode */
char *buffer;
int bufpos; /* Read/Write position in buffer */
apr_off_t dataRead; /* amount of valid data read into buffer */
int direction; /* buffer being used for 0 = read, 1 = write */
apr_off_t filePtr; /* position in file of handle */
#if APR_HAS_THREADS
struct apr_thread_mutex_t *thlock;
#endif
};
struct apr_dir_t {
apr_pool_t *pool;
char *dirname;
DIR *dirstruct;
struct dirent *entry;
};
typedef struct apr_stat_entry_t apr_stat_entry_t;
struct apr_stat_entry_t {
struct stat info;
char *casedName;
apr_time_t expire;
NXPathCtx_t pathCtx;
};
#define MAX_SERVER_NAME 64
#define MAX_VOLUME_NAME 64
#define MAX_PATH_NAME 256
#define MAX_FILE_NAME 256
#define DRIVE_ONLY 1
/* If the user passes d: vs. D: (or //mach/share vs. //MACH/SHARE),
* we need to fold the case to canonical form. This function is
* supposed to do so.
*/
apr_status_t filepath_root_case(char **rootpath, char *root, apr_pool_t *p);
/* This function check to see of the given path includes a drive/volume
* specifier. If the _only_ parameter is set to DRIVE_ONLY then it
* check to see of the path only contains a drive/volume specifier and
* nothing else.
*/
apr_status_t filepath_has_drive(const char *rootpath, int only, apr_pool_t *p);
/* This function compares the drive/volume specifiers for each given path.
* It returns zero if they match or non-zero if not.
*/
apr_status_t filepath_compare_drive(const char *path1, const char *path2, apr_pool_t *p);
apr_status_t apr_unix_file_cleanup(void *);
apr_status_t apr_unix_child_file_cleanup(void *);
apr_status_t apr_file_flush_locked(apr_file_t *thefile);
apr_status_t apr_file_info_get_locked(apr_finfo_t *finfo, apr_int32_t wanted,
apr_file_t *thefile);
#endif /* ! FILE_IO_H */