diff options
Diffstat (limited to 'storage/innobase/include/os0file.h')
| -rw-r--r-- | storage/innobase/include/os0file.h | 2323 |
1 files changed, 1373 insertions, 950 deletions
diff --git a/storage/innobase/include/os0file.h b/storage/innobase/include/os0file.h index 2425a682e22..5aa1843c236 100644 --- a/storage/innobase/include/os0file.h +++ b/storage/innobase/include/os0file.h @@ -2,7 +2,7 @@ Copyright (c) 1995, 2016, Oracle and/or its affiliates. All Rights Reserved. Copyright (c) 2009, Percona Inc. -Copyright (c) 2013, 2015, MariaDB Corporation. +Copyright (c) 2013, 2016, MariaDB Corporation. Portions of this file contain modifications contributed and copyrighted by Percona Inc.. Those modifications are @@ -38,60 +38,67 @@ Created 10/21/1995 Heikki Tuuri #include "univ.i" -#ifndef __WIN__ +#ifndef _WIN32 #include <dirent.h> #include <sys/stat.h> #include <time.h> -#endif +#endif /* !_WIN32 */ /** File node of a tablespace or the log data space */ struct fil_node_t; -extern ibool os_has_said_disk_full; -/** Flag: enable debug printout for asynchronous i/o */ -extern ibool os_aio_print_debug; - -/** Number of pending os_file_pread() operations */ -extern ulint os_file_n_pending_preads; -/** Number of pending os_file_pwrite() operations */ -extern ulint os_file_n_pending_pwrites; +extern bool os_has_said_disk_full; /** Number of pending read operations */ extern ulint os_n_pending_reads; /** Number of pending write operations */ extern ulint os_n_pending_writes; -#ifdef __WIN__ +/** File offset in bytes */ +typedef ib_uint64_t os_offset_t; + +#ifdef _WIN32 + +/** +Gets the operating system version. Currently works only on Windows. +@return OS_WIN95, OS_WIN31, OS_WINNT, OS_WIN2000, OS_WINXP, OS_WINVISTA, +OS_WIN7. */ + +ulint +os_get_os_version(); + +typedef HANDLE os_file_dir_t; /*!< directory stream */ /** We define always WIN_ASYNC_IO, and check at run-time whether - the OS actually supports it: Win 95 does not, NT does. */ -#define WIN_ASYNC_IO +the OS actually supports it: Win 95 does not, NT does. */ +# define WIN_ASYNC_IO /** Use unbuffered I/O */ -#define UNIV_NON_BUFFERED_IO - -#endif +# define UNIV_NON_BUFFERED_IO -/** File offset in bytes */ -typedef ib_uint64_t os_offset_t; -#ifdef __WIN__ /** File handle */ # define os_file_t HANDLE + /** Convert a C file descriptor to a native file handle -@param fd file descriptor -@return native file handle */ +@param fd file descriptor +@return native file handle */ # define OS_FILE_FROM_FD(fd) (HANDLE) _get_osfhandle(fd) -#else + +#else /* _WIN32 */ + +typedef DIR* os_file_dir_t; /*!< directory stream */ + /** File handle */ typedef int os_file_t; + /** Convert a C file descriptor to a native file handle -@param fd file descriptor -@return native file handle */ +@param fd file descriptor +@return native file handle */ # define OS_FILE_FROM_FD(fd) fd -#endif -/** Umask for creating files */ -extern ulint os_innodb_umask; +#endif /* _WIN32 */ + +static const os_file_t OS_FILE_CLOSED = os_file_t(~0); /** The next value should be smaller or equal to the smallest sector size used on any disk. A log block is required to be a portion of disk which is written @@ -125,93 +132,710 @@ enum os_file_create_t { ON_ERROR_NO_EXIT is set */ }; -#define OS_FILE_READ_ONLY 333 -#define OS_FILE_READ_WRITE 444 -#define OS_FILE_READ_ALLOW_DELETE 555 /* for mysqlbackup */ +static const ulint OS_FILE_READ_ONLY = 333; +static const ulint OS_FILE_READ_WRITE = 444; +/** Used by MySQLBackup */ +static const ulint OS_FILE_READ_ALLOW_DELETE = 555; /* Options for file_create */ -#define OS_FILE_AIO 61 -#define OS_FILE_NORMAL 62 +static const ulint OS_FILE_AIO = 61; +static const ulint OS_FILE_NORMAL = 62; /* @} */ /** Types for file create @{ */ -#define OS_DATA_FILE 100 -#define OS_LOG_FILE 101 +static const ulint OS_DATA_FILE = 100; +static const ulint OS_LOG_FILE = 101; +static const ulint OS_DATA_TEMP_FILE = 102; /* @} */ /** Error codes from os_file_get_last_error @{ */ -#define OS_FILE_NAME_TOO_LONG 36 -#define OS_FILE_NOT_FOUND 71 -#define OS_FILE_DISK_FULL 72 -#define OS_FILE_ALREADY_EXISTS 73 -#define OS_FILE_PATH_ERROR 74 -#define OS_FILE_AIO_RESOURCES_RESERVED 75 /* wait for OS aio resources - to become available again */ -#define OS_FILE_SHARING_VIOLATION 76 -#define OS_FILE_ERROR_NOT_SPECIFIED 77 -#define OS_FILE_INSUFFICIENT_RESOURCE 78 -#define OS_FILE_AIO_INTERRUPTED 79 -#define OS_FILE_OPERATION_ABORTED 80 -#define OS_FILE_ACCESS_VIOLATION 81 -#define OS_FILE_OPERATION_NOT_SUPPORTED 125 -#define OS_FILE_ERROR_MAX 200 +static const ulint OS_FILE_NAME_TOO_LONG = 36; +static const ulint OS_FILE_NOT_FOUND = 71; +static const ulint OS_FILE_DISK_FULL = 72; +static const ulint OS_FILE_ALREADY_EXISTS = 73; +static const ulint OS_FILE_PATH_ERROR = 74; +/** wait for OS aio resources to become available again */ +static const ulint OS_FILE_AIO_RESOURCES_RESERVED = 75; + +static const ulint OS_FILE_SHARING_VIOLATION = 76; +static const ulint OS_FILE_ERROR_NOT_SPECIFIED = 77; +static const ulint OS_FILE_INSUFFICIENT_RESOURCE = 78; +static const ulint OS_FILE_AIO_INTERRUPTED = 79; +static const ulint OS_FILE_OPERATION_ABORTED = 80; +static const ulint OS_FILE_ACCESS_VIOLATION = 81; +static const ulint OS_FILE_OPERATION_NOT_SUPPORTED = 125; +static const ulint OS_FILE_ERROR_MAX = 200; /* @} */ -/** Types for aio operations @{ */ -#define OS_FILE_READ 10 -#define OS_FILE_WRITE 11 +/** Compression algorithm. */ +struct Compression { -#define OS_FILE_LOG 256 /* This can be ORed to type */ -/* @} */ + /** Algorithm types supported */ + enum Type { + /* Note: During recovery we don't have the compression type + because the .frm file has not been read yet. Therefore + we write the recovered pages out without compression. */ -#define OS_AIO_N_PENDING_IOS_PER_THREAD 32 /*!< Win NT does not allow more - than 64 */ + /** No compression */ + NONE = 0, + + /** Use ZLib */ + ZLIB = 1, + + /** Use LZ4 faster variant, usually lower compression. */ + LZ4 = 2 + }; + + /** Compressed page meta-data */ + struct meta_t { + + /** Version number */ + uint8_t m_version; + + /** Algorithm type */ + Type m_algorithm; + + /** Original page type */ + uint16_t m_original_type; + + /** Original page size, before compression */ + uint16_t m_original_size; + + /** Size after compression */ + uint16_t m_compressed_size; + }; + + /** Default constructor */ + Compression() : m_type(NONE) { }; + + /** Specific constructor + @param[in] type Algorithm type */ + explicit Compression(Type type) + : + m_type(type) + { +#ifdef UNIV_DEBUG + switch (m_type) { + case NONE: + case ZLIB: + case LZ4: + + default: + ut_error; + } +#endif /* UNIV_DEBUG */ + } + + /** Check the page header type field. + @param[in] page Page contents + @return true if it is a compressed page */ + static bool is_compressed_page(const byte* page) + __attribute__((warn_unused_result)); + + /** Check wether the compression algorithm is supported. + @param[in] algorithm Compression algorithm to check + @param[out] type The type that algorithm maps to + @return DB_SUCCESS or error code */ + static dberr_t check(const char* algorithm, Compression* type) + __attribute__((warn_unused_result)); + + /** Validate the algorithm string. + @param[in] algorithm Compression algorithm to check + @return DB_SUCCESS or error code */ + static dberr_t validate(const char* algorithm) + __attribute__((warn_unused_result)); + + /** Convert to a "string". + @param[in] type The compression type + @return the string representation */ + static const char* to_string(Type type) + __attribute__((warn_unused_result)); + + /** Convert the meta data to a std::string. + @param[in] meta Page Meta data + @return the string representation */ + static std::string to_string(const meta_t& meta) + __attribute__((warn_unused_result)); + + /** Deserizlise the page header compression meta-data + @param[in] header Pointer to the page header + @param[out] control Deserialised data */ + static void deserialize_header( + const byte* page, + meta_t* control); + + /** Check if the string is "empty" or "none". + @param[in] algorithm Compression algorithm to check + @return true if no algorithm requested */ + static bool is_none(const char* algorithm) + __attribute__((warn_unused_result)); + + /** Decompress the page data contents. Page type must be + FIL_PAGE_COMPRESSED, if not then the source contents are + left unchanged and DB_SUCCESS is returned. + @param[in] dblwr_recover true of double write recovery + in progress + @param[in,out] src Data read from disk, decompressed + data will be copied to this page + @param[in,out] dst Scratch area to use for decompression + @param[in] dst_len Size of the scratch area in bytes + @return DB_SUCCESS or error code */ + static dberr_t deserialize( + bool dblwr_recover, + byte* src, + byte* dst, + ulint dst_len) + __attribute__((warn_unused_result)); + + /** Compression type */ + Type m_type; +}; + +/** Types for AIO operations @{ */ + +/** No transformations during read/write, write as is. */ +#define IORequestRead IORequest(IORequest::READ) +#define IORequestWrite IORequest(IORequest::WRITE) +#define IORequestLogRead IORequest(IORequest::LOG | IORequest::READ) +#define IORequestLogWrite IORequest(IORequest::LOG | IORequest::WRITE) + +/** +The IO Context that is passed down to the low level IO code */ +class IORequest { +public: + /** Flags passed in the request, they can be ORred together. */ + enum { + READ = 1, + WRITE = 2, + + /** Double write buffer recovery. */ + DBLWR_RECOVER = 4, + + /** Enumarations below can be ORed to READ/WRITE above*/ + + /** Data file */ + DATA_FILE = 8, + + /** Log file request*/ + LOG = 16, + + /** Disable partial read warnings */ + DISABLE_PARTIAL_IO_WARNINGS = 32, + + /** Do not to wake i/o-handler threads, but the caller will do + the waking explicitly later, in this way the caller can post + several requests in a batch; NOTE that the batch must not be + so big that it exhausts the slots in AIO arrays! NOTE that + a simulated batch may introduce hidden chances of deadlocks, + because I/Os are not actually handled until all + have been posted: use with great caution! */ + DO_NOT_WAKE = 64, + + /** Ignore failed reads of non-existent pages */ + IGNORE_MISSING = 128, + + /** Use punch hole if available, only makes sense if + compression algorithm != NONE. Ignored if not set */ + PUNCH_HOLE = 256, + + /** Force raw read, do not try to compress/decompress. + This can be used to force a read and write without any + compression e.g., for redo log, merge sort temporary files + and the truncate redo log. */ + NO_COMPRESSION = 512 + + }; + + /** Default constructor */ + IORequest() + : + m_block_size(UNIV_SECTOR_SIZE), + m_type(READ), + m_compression() + { + /* No op */ + } + + /** + @param[in] type Request type, can be a value that is + ORed from the above enum */ + explicit IORequest(ulint type) + : + m_block_size(UNIV_SECTOR_SIZE), + m_type(static_cast<uint16_t>(type)), + m_compression() + { + if (is_log()) { + disable_compression(); + } + + if (!is_punch_hole_supported()) { + clear_punch_hole(); + } + } + + /** Destructor */ + ~IORequest() { } + + /** @return true if ignore missing flag is set */ + static bool ignore_missing(ulint type) + __attribute__((warn_unused_result)) + { + return((type & IGNORE_MISSING) == IGNORE_MISSING); + } + + /** @return true if it is a read request */ + bool is_read() const + __attribute__((warn_unused_result)) + { + return((m_type & READ) == READ); + } + + /** @return true if it is a write request */ + bool is_write() const + __attribute__((warn_unused_result)) + { + return((m_type & WRITE) == WRITE); + } + + /** @return true if it is a redo log write */ + bool is_log() const + __attribute__((warn_unused_result)) + { + return((m_type & LOG) == LOG); + } + + /** @return true if the simulated AIO thread should be woken up */ + bool is_wake() const + __attribute__((warn_unused_result)) + { + return((m_type & DO_NOT_WAKE) == 0); + } + + /** @return true if partial read warning disabled */ + bool is_partial_io_warning_disabled() const + __attribute__((warn_unused_result)) + { + return((m_type & DISABLE_PARTIAL_IO_WARNINGS) + == DISABLE_PARTIAL_IO_WARNINGS); + } + + /** Disable partial read warnings */ + void disable_partial_io_warnings() + { + m_type |= DISABLE_PARTIAL_IO_WARNINGS; + } + + /** @return true if missing files should be ignored */ + bool ignore_missing() const + __attribute__((warn_unused_result)) + { + return(ignore_missing(m_type)); + } + + /** @return true if punch hole should be used */ + bool punch_hole() const + __attribute__((warn_unused_result)) + { + return((m_type & PUNCH_HOLE) == PUNCH_HOLE); + } + + /** @return true if the read should be validated */ + bool validate() const + __attribute__((warn_unused_result)) + { + ut_a(is_read() ^ is_write()); + + return(!is_read() || !punch_hole()); + } + + /** Set the punch hole flag */ + void set_punch_hole() + { + if (is_punch_hole_supported()) { + m_type |= PUNCH_HOLE; + } + } + + /** Clear the do not wake flag */ + void clear_do_not_wake() + { + m_type &= ~DO_NOT_WAKE; + } + + /** Clear the punch hole flag */ + void clear_punch_hole() + { + m_type &= ~PUNCH_HOLE; + } + + /** @return the block size to use for IO */ + ulint block_size() const + __attribute__((warn_unused_result)) + { + return(m_block_size); + } + + /** Set the block size for IO + @param[in] block_size Block size to set */ + void block_size(ulint block_size) + { + m_block_size = static_cast<uint32_t>(block_size); + } + + /** Clear all compression related flags */ + void clear_compressed() + { + clear_punch_hole(); + + m_compression.m_type = Compression::NONE; + } + + /** Compare two requests + @reutrn true if the are equal */ + bool operator==(const IORequest& rhs) const + { + return(m_type == rhs.m_type); + } + + /** Set compression algorithm + @param[in] compression The compression algorithm to use */ + void compression_algorithm(Compression::Type type) + { + if (type == Compression::NONE) { + return; + } + + set_punch_hole(); + + m_compression.m_type = type; + } + + /** Get the compression algorithm. + @return the compression algorithm */ + Compression compression_algorithm() const + __attribute__((warn_unused_result)) + { + return(m_compression); + } + + /** @return true if the page should be compressed */ + bool is_compressed() const + __attribute__((warn_unused_result)) + { + return(compression_algorithm().m_type != Compression::NONE); + } + + /** @return true if the page read should not be transformed. */ + bool is_compression_enabled() const + __attribute__((warn_unused_result)) + { + return((m_type & NO_COMPRESSION) == 0); + } + + /** Disable transformations. */ + void disable_compression() + { + m_type |= NO_COMPRESSION; + } + + /** Note that the IO is for double write recovery. */ + void dblwr_recover() + { + m_type |= DBLWR_RECOVER; + } + + /** @return true if the request is from the dblwr recovery */ + bool is_dblwr_recover() const + __attribute__((warn_unused_result)) + { + return((m_type & DBLWR_RECOVER) == DBLWR_RECOVER); + } + + /** @return true if punch hole is supported */ + static bool is_punch_hole_supported() + { +#if defined(HAVE_FALLOC_PUNCH_HOLE_AND_KEEP_SIZE) || defined(_WIN32) + return(true); +#else + return(false); +#endif /* HAVE_FALLOC_PUNCH_HOLE_AND_KEEP_SIZE || _WIN32 */ + } + +private: + /* File system best block size */ + uint32_t m_block_size; + + /** Request type bit flags */ + uint16_t m_type; + + /** Compression algorithm */ + Compression m_compression; +}; -/** Modes for aio operations @{ */ -#define OS_AIO_NORMAL 21 /*!< Normal asynchronous i/o not for ibuf - pages or ibuf bitmap pages */ -#define OS_AIO_IBUF 22 /*!< Asynchronous i/o for ibuf pages or ibuf - bitmap pages */ -#define OS_AIO_LOG 23 /*!< Asynchronous i/o for the log */ -#define OS_AIO_SYNC 24 /*!< Asynchronous i/o where the calling thread - will itself wait for the i/o to complete, - doing also the job of the i/o-handler thread; - can be used for any pages, ibuf or non-ibuf. - This is used to save CPU time, as we can do - with fewer thread switches. Plain synchronous - i/o is not as good, because it must serialize - the file seek and read or write, causing a - bottleneck for parallelism. */ - -#define OS_AIO_SIMULATED_WAKE_LATER 512 /*!< This can be ORed to mode - in the call of os_aio(...), - if the caller wants to post several i/o - requests in a batch, and only after that - wake the i/o-handler thread; this has - effect only in simulated aio */ /* @} */ -#define OS_WIN31 1 /*!< Microsoft Windows 3.x */ -#define OS_WIN95 2 /*!< Microsoft Windows 95 */ -#define OS_WINNT 3 /*!< Microsoft Windows NT 3.x */ -#define OS_WIN2000 4 /*!< Microsoft Windows 2000 */ -#define OS_WINXP 5 /*!< Microsoft Windows XP - or Windows Server 2003 */ -#define OS_WINVISTA 6 /*!< Microsoft Windows Vista - or Windows Server 2008 */ -#define OS_WIN7 7 /*!< Microsoft Windows 7 - or Windows Server 2008 R2 */ +/** Sparse file size information. */ +struct os_file_size_t { + /** Total size of file in bytes */ + os_offset_t m_total_size; + + /** If it is a sparse file then this is the number of bytes + actually allocated for the file. */ + os_offset_t m_alloc_size; +}; + +/** Win NT does not allow more than 64 */ +static const ulint OS_AIO_N_PENDING_IOS_PER_THREAD = 32; +/** Modes for aio operations @{ */ +/** Normal asynchronous i/o not for ibuf pages or ibuf bitmap pages */ +static const ulint OS_AIO_NORMAL = 21; + +/** Asynchronous i/o for ibuf pages or ibuf bitmap pages */ +static const ulint OS_AIO_IBUF = 22; + +/** Asynchronous i/o for the log */ +static const ulint OS_AIO_LOG = 23; + +/** Asynchronous i/o where the calling thread will itself wait for +the i/o to complete, doing also the job of the i/o-handler thread; +can be used for any pages, ibuf or non-ibuf. This is used to save +CPU time, as we can do with fewer thread switches. Plain synchronous +I/O is not as good, because it must serialize the file seek and read +or write, causing a bottleneck for parallelism. */ +static const ulint OS_AIO_SYNC = 24; +/* @} */ extern ulint os_n_file_reads; extern ulint os_n_file_writes; extern ulint os_n_fsyncs; +/* File types for directory entry data type */ + +enum os_file_type_t { + OS_FILE_TYPE_UNKNOWN = 0, + OS_FILE_TYPE_FILE, /* regular file */ + OS_FILE_TYPE_DIR, /* directory */ + OS_FILE_TYPE_LINK, /* symbolic link */ + OS_FILE_TYPE_BLOCK /* block device */ +}; + +/* Maximum path string length in bytes when referring to tables with in the +'./databasename/tablename.ibd' path format; we can allocate at least 2 buffers +of this size from the thread stack; that is why this should not be made much +bigger than 4000 bytes. The maximum path length used by any storage engine +in the server must be at least this big. */ +#define OS_FILE_MAX_PATH 4000 + +/* MySQL 5.7 my_global.h */ +#ifndef FN_REFLEN_SE +#define FN_REFLEN_SE 4000 +#endif + +#if (FN_REFLEN_SE < OS_FILE_MAX_PATH) +# error "(FN_REFLEN_SE < OS_FILE_MAX_PATH)" +#endif + +/** Struct used in fetching information of a file in a directory */ +struct os_file_stat_t { + char name[OS_FILE_MAX_PATH]; /*!< path to a file */ + os_file_type_t type; /*!< file type */ + os_offset_t size; /*!< file size in bytes */ + os_offset_t alloc_size; /*!< Allocated size for + sparse files in bytes */ + size_t block_size; /*!< Block size to use for IO + in bytes*/ + time_t ctime; /*!< creation time */ + time_t mtime; /*!< modification time */ + time_t atime; /*!< access time */ + bool rw_perm; /*!< true if can be opened + in read-write mode. Only valid + if type == OS_FILE_TYPE_FILE */ +}; + +#ifndef UNIV_HOTBACKUP +/** Create a temporary file. This function is like tmpfile(3), but +the temporary file is created in the given parameter path. If the path +is null then it will create the file in the mysql server configuration +parameter (--tmpdir). +@param[in] path location for creating temporary file +@return temporary file handle, or NULL on error */ +UNIV_INTERN +FILE* +os_file_create_tmpfile(); + +#endif /* !UNIV_HOTBACKUP */ + +/** The os_file_opendir() function opens a directory stream corresponding to the +directory named by the dirname argument. The directory stream is positioned +at the first entry. In both Unix and Windows we automatically skip the '.' +and '..' items at the start of the directory listing. + +@param[in] dirname directory name; it must not contain a trailing + '\' or '/' +@param[in] is_fatal true if we should treat an error as a fatal + error; if we try to open symlinks then we do + not wish a fatal error if it happens not to be + a directory +@return directory stream, NULL if error */ +os_file_dir_t +os_file_opendir( + const char* dirname, + bool is_fatal); + +/** +Closes a directory stream. +@param[in] dir directory stream +@return 0 if success, -1 if failure */ +int +os_file_closedir( + os_file_dir_t dir); + +/** This function returns information of the next file in the directory. We jump +over the '.' and '..' entries in the directory. +@param[in] dirname directory name or path +@param[in] dir directory stream +@param[out] info buffer where the info is returned +@return 0 if ok, -1 if error, 1 if at the end of the directory */ +int +os_file_readdir_next_file( + const char* dirname, + os_file_dir_t dir, + os_file_stat_t* info); + +/** +This function attempts to create a directory named pathname. The new directory +gets default permissions. On Unix, the permissions are (0770 & ~umask). If the +directory exists already, nothing is done and the call succeeds, unless the +fail_if_exists arguments is true. + +@param[in] pathname directory name as null-terminated string +@param[in] fail_if_exists if true, pre-existing directory is treated + as an error. +@return true if call succeeds, false on error */ +bool +os_file_create_directory( + const char* pathname, + bool fail_if_exists); + +/** NOTE! Use the corresponding macro os_file_create_simple(), not directly +this function! +A simple function to open or create a file. +@param[in] name name of the file or path as a null-terminated + string +@param[in] create_mode create mode +@param[in] access_type OS_FILE_READ_ONLY or OS_FILE_READ_WRITE +@param[in] read_only if true read only mode checks are enforced +@param[out] success true if succeed, false if error +@return own: handle to the file, not defined if error, error number + can be retrieved with os_file_get_last_error */ +os_file_t +os_file_create_simple_func( + const char* name, + ulint create_mode, + ulint access_type, + bool read_only, + bool* success); + +/** NOTE! Use the corresponding macro +os_file_create_simple_no_error_handling(), not directly this function! +A simple function to open or create a file. +@param[in] name name of the file or path as a null-terminated string +@param[in] create_mode create mode +@param[in] access_type OS_FILE_READ_ONLY, OS_FILE_READ_WRITE, or + OS_FILE_READ_ALLOW_DELETE; the last option + is used by a backup program reading the file +@param[in] read_only if true read only mode checks are enforced +@param[out] success true if succeeded +@return own: handle to the file, not defined if error, error number + can be retrieved with os_file_get_last_error */ +os_file_t +os_file_create_simple_no_error_handling_func( + const char* name, + ulint create_mode, + ulint access_type, + bool read_only, + bool* success) + __attribute__((warn_unused_result)); + +/** Tries to disable OS caching on an opened file descriptor. +@param[in] fd file descriptor to alter +@param[in] file_name file name, used in the diagnostic message +@param[in] name "open" or "create"; used in the diagnostic + message */ +void +os_file_set_nocache( +/*================*/ + os_file_t fd, /*!< in: file descriptor to alter */ + const char* file_name, + const char* operation_name); + +/** NOTE! Use the corresponding macro os_file_create(), not directly +this function! +Opens an existing file or creates a new. +@param[in] name name of the file or path as a null-terminated + string +@param[in] create_mode create mode +@param[in] purpose OS_FILE_AIO, if asynchronous, non-buffered I/O + is desired, OS_FILE_NORMAL, if any normal file; + NOTE that it also depends on type, os_aio_.. + and srv_.. variables whether we really use + async I/O or unbuffered I/O: look in the + function source code for the exact rules +@param[in] type OS_DATA_FILE or OS_LOG_FILE +@param[in] read_only if true read only mode checks are enforced +@param[in] success true if succeeded +@return own: handle to the file, not defined if error, error number + can be retrieved with os_file_get_last_error */ +os_file_t +os_file_create_func( + const char* name, + ulint create_mode, + ulint purpose, + ulint type, + bool read_only, + bool* success) + __attribute__((warn_unused_result)); + +/** Deletes a file. The file has to be closed before calling this. +@param[in] name file path as a null-terminated string +@return true if success */ +bool +os_file_delete_func(const char* name); + +/** Deletes a file if it exists. The file has to be closed before calling this. +@param[in] name file path as a null-terminated string +@param[out] exist indicate if file pre-exist +@return true if success */ +bool +os_file_delete_if_exists_func(const char* name, bool* exist); + +/** NOTE! Use the corresponding macro os_file_rename(), not directly +this function! +Renames a file (can also move it to another directory). It is safest that the +file is closed before calling this function. +@param[in] oldpath old file path as a null-terminated string +@param[in] newpath new file path +@return true if success */ +bool +os_file_rename_func(const char* oldpath, const char* newpath); + +/** NOTE! Use the corresponding macro os_file_close(), not directly this +function! +Closes a file handle. In case of error, error number can be retrieved with +os_file_get_last_error. +@param[in] file own: handle to a file +@return true if success */ +bool +os_file_close_func(os_file_t file); + #ifdef UNIV_PFS_IO + /* Keys to register InnoDB I/O with performance schema */ -extern mysql_pfs_key_t innodb_file_data_key; -extern mysql_pfs_key_t innodb_file_log_key; -extern mysql_pfs_key_t innodb_file_temp_key; +extern mysql_pfs_key_t innodb_data_file_key; +extern mysql_pfs_key_t innodb_log_file_key; +extern mysql_pfs_key_t innodb_temp_file_key; /* Following four macros are instumentations to register various file I/O operations with performance schema. @@ -226,7 +850,7 @@ are used to register file deletion operations*/ do { \ locker = PSI_FILE_CALL(get_thread_file_name_locker)( \ state, key, op, name, &locker); \ - if (UNIV_LIKELY(locker != NULL)) { \ + if (locker != NULL) { \ PSI_FILE_CALL(start_file_open_wait)( \ locker, src_file, src_line); \ } \ @@ -234,7 +858,7 @@ do { \ # define register_pfs_file_open_end(locker, file) \ do { \ - if (UNIV_LIKELY(locker != NULL)) { \ + if (locker != NULL) { \ PSI_FILE_CALL(end_file_open_wait_and_bind_to_descriptor)(\ locker, file); \ } \ @@ -245,7 +869,7 @@ do { \ do { \ locker = PSI_FILE_CALL(get_thread_file_name_locker)( \ state, key, op, name, &locker); \ - if (UNIV_LIKELY(locker != NULL)) { \ + if (locker != NULL) { \ PSI_FILE_CALL(start_file_close_wait)( \ locker, src_file, src_line); \ } \ @@ -253,7 +877,7 @@ do { \ # define register_pfs_file_close_end(locker, result) \ do { \ - if (UNIV_LIKELY(locker != NULL)) { \ + if (locker != NULL) { \ PSI_FILE_CALL(end_file_close_wait)( \ locker, result); \ } \ @@ -264,7 +888,7 @@ do { \ do { \ locker = PSI_FILE_CALL(get_thread_file_descriptor_locker)( \ state, file, op); \ - if (UNIV_LIKELY(locker != NULL)) { \ + if (locker != NULL) { \ PSI_FILE_CALL(start_file_wait)( \ locker, count, src_file, src_line); \ } \ @@ -272,11 +896,10 @@ do { \ # define register_pfs_file_io_end(locker, count) \ do { \ - if (UNIV_LIKELY(locker != NULL)) { \ + if (locker != NULL) { \ PSI_FILE_CALL(end_file_wait)(locker, count); \ } \ } while (0) -#endif /* UNIV_PFS_IO */ /* Following macros/functions are file I/O APIs that would be performance schema instrumented if "UNIV_PFS_IO" is defined. They would point to @@ -294,39 +917,40 @@ os_file_write The wrapper functions have the prefix of "innodb_". */ -#ifdef UNIV_PFS_IO -# define os_file_create(key, name, create, purpose, type, success, atomic_writes) \ +# define os_file_create(key, name, create, purpose, type, read_only, \ + success) \ pfs_os_file_create_func(key, name, create, purpose, type, \ - success, atomic_writes, __FILE__, __LINE__) + read_only, success, __FILE__, __LINE__) -# define os_file_create_simple(key, name, create, access, success) \ +# define os_file_create_simple(key, name, create, access, \ + read_only, success) \ pfs_os_file_create_simple_func(key, name, create, access, \ - success, __FILE__, __LINE__) + read_only, success, __FILE__, __LINE__) # define os_file_create_simple_no_error_handling( \ - key, name, create_mode, access, success, atomic_writes) \ + key, name, create_mode, access, read_only, success) \ pfs_os_file_create_simple_no_error_handling_func( \ - key, name, create_mode, access, success, atomic_writes, __FILE__, __LINE__) + key, name, create_mode, access, \ + read_only, success, __FILE__, __LINE__) # define os_file_close(file) \ pfs_os_file_close_func(file, __FILE__, __LINE__) -# define os_aio(type, is_log, mode, name, file, buf, offset, \ - n, page_size, message1, message2, write_size) \ - pfs_os_aio_func(type, is_log, mode, name, file, buf, offset, \ - n, page_size, message1, message2, write_size, \ - __FILE__, __LINE__) +# define os_aio(type, mode, name, file, buf, offset, \ + n, read_only, message1, message2, wsize) \ + pfs_os_aio_func(type, mode, name, file, buf, offset, \ + n, read_only, message1, message2, wsize, \ + __FILE__, __LINE__) +# define os_file_read(type, file, buf, offset, n) \ + pfs_os_file_read_func(type, file, buf, offset, n, __FILE__, __LINE__) -# define os_file_read(file, buf, offset, n) \ - pfs_os_file_read_func(file, buf, offset, n, __FILE__, __LINE__) +# define os_file_read_no_error_handling(type, file, buf, offset, n, o) \ + pfs_os_file_read_no_error_handling_func( \ + type, file, buf, offset, n, o, __FILE__, __LINE__) -# define os_file_read_no_error_handling(file, buf, offset, n) \ - pfs_os_file_read_no_error_handling_func(file, buf, offset, n, \ - __FILE__, __LINE__) - -# define os_file_write(name, file, buf, offset, n) \ - pfs_os_file_write_func(name, file, buf, offset, \ +# define os_file_write(type, name, file, buf, offset, n) \ + pfs_os_file_write_func(type, name, file, buf, offset, \ n, __FILE__, __LINE__) # define os_file_flush(file) \ @@ -338,689 +962,511 @@ The wrapper functions have the prefix of "innodb_". */ # define os_file_delete(key, name) \ pfs_os_file_delete_func(key, name, __FILE__, __LINE__) -# define os_file_delete_if_exists(key, name) \ - pfs_os_file_delete_if_exists_func(key, name, __FILE__, __LINE__) -#else /* UNIV_PFS_IO */ - -/* If UNIV_PFS_IO is not defined, these I/O APIs point -to original un-instrumented file I/O APIs */ -# define os_file_create(key, name, create, purpose, type, success, atomic_writes) \ - os_file_create_func(name, create, purpose, type, success, atomic_writes) - -# define os_file_create_simple(key, name, create_mode, access, success) \ - os_file_create_simple_func(name, create_mode, access, success) - -# define os_file_create_simple_no_error_handling( \ - key, name, create_mode, access, success, atomic_writes) \ - os_file_create_simple_no_error_handling_func( \ - name, create_mode, access, success, atomic_writes) - -# define os_file_close(file) os_file_close_func(file) - -# define os_aio(type, is_log, mode, name, file, buf, offset, n, page_size, message1, \ - message2, write_size) \ - os_aio_func(type, is_log, mode, name, file, buf, offset, n, \ - page_size, message1, message2, write_size) - -# define os_file_read(file, buf, offset, n) \ - os_file_read_func(file, buf, offset, n) - -# define os_file_read_no_error_handling(file, buf, offset, n) \ - os_file_read_no_error_handling_func(file, buf, offset, n) - -# define os_file_write(name, file, buf, offset, n) \ - os_file_write_func(name, file, buf, offset, n) - -# define os_file_flush(file) os_file_flush_func(file) - -# define os_file_rename(key, oldpath, newpath) \ - os_file_rename_func(oldpath, newpath) - -# define os_file_delete(key, name) os_file_delete_func(name) - -# define os_file_delete_if_exists(key, name) \ - os_file_delete_if_exists_func(name) - -#endif /* UNIV_PFS_IO */ - -/* File types for directory entry data type */ - -enum os_file_type_t { - OS_FILE_TYPE_UNKNOWN = 0, - OS_FILE_TYPE_FILE, /* regular file - (or a character/block device) */ - OS_FILE_TYPE_DIR, /* directory */ - OS_FILE_TYPE_LINK /* symbolic link */ -}; - -/* Maximum path string length in bytes when referring to tables with in the -'./databasename/tablename.ibd' path format; we can allocate at least 2 buffers -of this size from the thread stack; that is why this should not be made much -bigger than 4000 bytes */ -#define OS_FILE_MAX_PATH 4000 - -/** Struct used in fetching information of a file in a directory */ -struct os_file_stat_t { - char name[OS_FILE_MAX_PATH]; /*!< path to a file */ - os_file_type_t type; /*!< file type */ - ib_int64_t size; /*!< file size */ - time_t ctime; /*!< creation time */ - time_t mtime; /*!< modification time */ - time_t atime; /*!< access time */ - bool rw_perm; /*!< true if can be opened - in read-write mode. Only valid - if type == OS_FILE_TYPE_FILE */ -}; - -#ifdef __WIN__ -typedef HANDLE os_file_dir_t; /*!< directory stream */ -#else -typedef DIR* os_file_dir_t; /*!< directory stream */ -#endif - -#ifdef __WIN__ -/***********************************************************************//** -Gets the operating system version. Currently works only on Windows. -@return OS_WIN95, OS_WIN31, OS_WINNT, OS_WIN2000, OS_WINXP, OS_WINVISTA, -OS_WIN7. */ -UNIV_INTERN -ulint -os_get_os_version(void); -/*===================*/ -#endif /* __WIN__ */ -#ifndef UNIV_HOTBACKUP -/****************************************************************//** -Creates the seek mutexes used in positioned reads and writes. */ -UNIV_INTERN -void -os_io_init_simple(void); -/*===================*/ - - -/** Create a temporary file. This function is like tmpfile(3), but -the temporary file is created in the given parameter path. If the path -is null then it will create the file in the mysql server configuration -parameter (--tmpdir). -@param[in] path location for creating temporary file -@return temporary file handle, or NULL on error */ -UNIV_INTERN -FILE* -os_file_create_tmpfile( - const char* path); - -#endif /* !UNIV_HOTBACKUP */ -/***********************************************************************//** -The os_file_opendir() function opens a directory stream corresponding to the -directory named by the dirname argument. The directory stream is positioned -at the first entry. In both Unix and Windows we automatically skip the '.' -and '..' items at the start of the directory listing. -@return directory stream, NULL if error */ -UNIV_INTERN -os_file_dir_t -os_file_opendir( -/*============*/ - const char* dirname, /*!< in: directory name; it must not - contain a trailing '\' or '/' */ - ibool error_is_fatal);/*!< in: TRUE if we should treat an - error as a fatal error; if we try to - open symlinks then we do not wish a - fatal error if it happens not to be - a directory */ -/***********************************************************************//** -Closes a directory stream. -@return 0 if success, -1 if failure */ -UNIV_INTERN -int -os_file_closedir( -/*=============*/ - os_file_dir_t dir); /*!< in: directory stream */ -/***********************************************************************//** -This function returns information of the next file in the directory. We jump -over the '.' and '..' entries in the directory. -@return 0 if ok, -1 if error, 1 if at the end of the directory */ -UNIV_INTERN -int -os_file_readdir_next_file( -/*======================*/ - const char* dirname,/*!< in: directory name or path */ - os_file_dir_t dir, /*!< in: directory stream */ - os_file_stat_t* info); /*!< in/out: buffer where the info is returned */ -/*****************************************************************//** -This function attempts to create a directory named pathname. The new directory -gets default permissions. On Unix, the permissions are (0770 & ~umask). If the -directory exists already, nothing is done and the call succeeds, unless the -fail_if_exists arguments is true. -@return TRUE if call succeeds, FALSE on error */ -UNIV_INTERN -ibool -os_file_create_directory( -/*=====================*/ - const char* pathname, /*!< in: directory name as - null-terminated string */ - ibool fail_if_exists);/*!< in: if TRUE, pre-existing directory - is treated as an error. */ -/****************************************************************//** -NOTE! Use the corresponding macro os_file_create_simple(), not directly -this function! -A simple function to open or create a file. -@return own: handle to the file, not defined if error, error number -can be retrieved with os_file_get_last_error */ -UNIV_INTERN -os_file_t -os_file_create_simple_func( -/*=======================*/ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - ulint create_mode,/*!< in: create mode */ - ulint access_type,/*!< in: OS_FILE_READ_ONLY or - OS_FILE_READ_WRITE */ - ibool* success);/*!< out: TRUE if succeed, FALSE if error */ -/****************************************************************//** -NOTE! Use the corresponding macro -os_file_create_simple_no_error_handling(), not directly this function! -A simple function to open or create a file. -@return own: handle to the file, not defined if error, error number -can be retrieved with os_file_get_last_error */ -UNIV_INTERN -os_file_t -os_file_create_simple_no_error_handling_func( -/*=========================================*/ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - ulint create_mode,/*!< in: create mode */ - ulint access_type,/*!< in: OS_FILE_READ_ONLY, - OS_FILE_READ_WRITE, or - OS_FILE_READ_ALLOW_DELETE; the last option is - used by a backup program reading the file */ - ibool* success,/*!< out: TRUE if succeed, FALSE if error */ - ulint atomic_writes)/*!< in: atomic writes table option - value */ - __attribute__((nonnull, warn_unused_result)); -/****************************************************************//** -Tries to disable OS caching on an opened file descriptor. */ -UNIV_INTERN -void -os_file_set_nocache( -/*================*/ - os_file_t fd, /*!< in: file descriptor to alter */ - const char* file_name, /*!< in: file name, used in the - diagnostic message */ - const char* operation_name);/*!< in: "open" or "create"; used in the - diagnostic message */ -/****************************************************************//** -NOTE! Use the corresponding macro os_file_create(), not directly -this function! -Opens an existing file or creates a new. -@return own: handle to the file, not defined if error, error number -can be retrieved with os_file_get_last_error */ -UNIV_INTERN -os_file_t -os_file_create_func( -/*================*/ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - ulint create_mode,/*!< in: create mode */ - ulint purpose,/*!< in: OS_FILE_AIO, if asynchronous, - non-buffered i/o is desired, - OS_FILE_NORMAL, if any normal file; - NOTE that it also depends on type, os_aio_.. - and srv_.. variables whether we really use - async i/o or unbuffered i/o: look in the - function source code for the exact rules */ - ulint type, /*!< in: OS_DATA_FILE or OS_LOG_FILE */ - ibool* success,/*!< out: TRUE if succeed, FALSE if error */ - ulint atomic_writes)/*!< in: atomic writes table option - value */ - __attribute__((nonnull, warn_unused_result)); -/***********************************************************************//** -Deletes a file. The file has to be closed before calling this. -@return TRUE if success */ -UNIV_INTERN -bool -os_file_delete_func( -/*================*/ - const char* name); /*!< in: file path as a null-terminated - string */ +# define os_file_delete_if_exists(key, name, exist) \ + pfs_os_file_delete_if_exists_func(key, name, exist, __FILE__, __LINE__) -/***********************************************************************//** -Deletes a file if it exists. The file has to be closed before calling this. -@return TRUE if success */ -UNIV_INTERN -bool -os_file_delete_if_exists_func( -/*==========================*/ - const char* name); /*!< in: file path as a null-terminated - string */ -/***********************************************************************//** -NOTE! Use the corresponding macro os_file_rename(), not directly -this function! -Renames a file (can also move it to another directory). It is safest that the -file is closed before calling this function. -@return TRUE if success */ -UNIV_INTERN -ibool -os_file_rename_func( -/*================*/ - const char* oldpath, /*!< in: old file path as a - null-terminated string */ - const char* newpath); /*!< in: new file path */ -/***********************************************************************//** -NOTE! Use the corresponding macro os_file_close(), not directly this -function! -Closes a file handle. In case of error, error number can be retrieved with -os_file_get_last_error. -@return TRUE if success */ -UNIV_INTERN -ibool -os_file_close_func( -/*===============*/ - os_file_t file); /*!< in, own: handle to a file */ - -#ifdef UNIV_PFS_IO -/****************************************************************//** -NOTE! Please use the corresponding macro os_file_create_simple(), +/** NOTE! Please use the corresponding macro os_file_create_simple(), not directly this function! A performance schema instrumented wrapper function for os_file_create_simple() which opens or creates a file. +@param[in] key Performance Schema Key +@param[in] name name of the file or path as a null-terminated + string +@param[in] create_mode create mode +@param[in] access_type OS_FILE_READ_ONLY or OS_FILE_READ_WRITE +@param[in] read_only if true read only mode checks are enforced +@param[out] success true if succeeded +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked @return own: handle to the file, not defined if error, error number -can be retrieved with os_file_get_last_error */ + can be retrieved with os_file_get_last_error */ UNIV_INLINE os_file_t pfs_os_file_create_simple_func( -/*===========================*/ - mysql_pfs_key_t key, /*!< in: Performance Schema Key */ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - ulint create_mode,/*!< in: create mode */ - ulint access_type,/*!< in: OS_FILE_READ_ONLY or - OS_FILE_READ_WRITE */ - ibool* success,/*!< out: TRUE if succeed, FALSE if error */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line)/*!< in: line where the func invoked */ - MY_ATTRIBUTE((nonnull, warn_unused_result)); - -/****************************************************************//** -NOTE! Please use the corresponding macro + mysql_pfs_key_t key, + const char* name, + ulint create_mode, + ulint access_type, + bool read_only, + bool* success, + const char* src_file, + ulint src_line) + __attribute__((warn_unused_result)); + +/** NOTE! Please use the corresponding macro os_file_create_simple_no_error_handling(), not directly this function! A performance schema instrumented wrapper function for os_file_create_simple_no_error_handling(). Add instrumentation to monitor file creation/open. +@param[in] key Performance Schema Key +@param[in] name name of the file or path as a null-terminated + string +@param[in] create_mode create mode +@param[in] access_type OS_FILE_READ_ONLY, OS_FILE_READ_WRITE, or + OS_FILE_READ_ALLOW_DELETE; the last option is + used by a backup program reading the file +@param[in] read_only if true read only mode checks are enforced +@param[out] success true if succeeded +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked @return own: handle to the file, not defined if error, error number -can be retrieved with os_file_get_last_error */ + can be retrieved with os_file_get_last_error */ UNIV_INLINE os_file_t pfs_os_file_create_simple_no_error_handling_func( -/*=============================================*/ - mysql_pfs_key_t key, /*!< in: Performance Schema Key */ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - ulint create_mode, /*!< in: file create mode */ - ulint access_type,/*!< in: OS_FILE_READ_ONLY, - OS_FILE_READ_WRITE, or - OS_FILE_READ_ALLOW_DELETE; the last option is - used by a backup program reading the file */ - ibool* success,/*!< out: TRUE if succeed, FALSE if error */ - ulint atomic_writes,/*!< in: atomic writes table option - value */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line)/*!< in: line where the func invoked */ - MY_ATTRIBUTE((nonnull, warn_unused_result)); - -/****************************************************************//** -NOTE! Please use the corresponding macro os_file_create(), not directly + mysql_pfs_key_t key, + const char* name, + ulint create_mode, + ulint access_type, + bool read_only, + bool* success, + const char* src_file, + ulint src_line) + __attribute__((warn_unused_result)); + +/** NOTE! Please use the corresponding macro os_file_create(), not directly this function! A performance schema wrapper function for os_file_create(). Add instrumentation to monitor file creation/open. +@param[in] key Performance Schema Key +@param[in] name name of the file or path as a null-terminated + string +@param[in] create_mode create mode +@param[in] purpose OS_FILE_AIO, if asynchronous, non-buffered I/O + is desired, OS_FILE_NORMAL, if any normal file; + NOTE that it also depends on type, os_aio_.. + and srv_.. variables whether we really use + async I/O or unbuffered I/O: look in the + function source code for the exact rules +@param[in] read_only if true read only mode checks are enforced +@param[out] success true if succeeded +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked @return own: handle to the file, not defined if error, error number -can be retrieved with os_file_get_last_error */ + can be retrieved with os_file_get_last_error */ UNIV_INLINE os_file_t pfs_os_file_create_func( -/*====================*/ - mysql_pfs_key_t key, /*!< in: Performance Schema Key */ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - ulint create_mode,/*!< in: file create mode */ - ulint purpose,/*!< in: OS_FILE_AIO, if asynchronous, - non-buffered i/o is desired, - OS_FILE_NORMAL, if any normal file; - NOTE that it also depends on type, os_aio_.. - and srv_.. variables whether we really use - async i/o or unbuffered i/o: look in the - function source code for the exact rules */ - ulint type, /*!< in: OS_DATA_FILE or OS_LOG_FILE */ - ibool* success,/*!< out: TRUE if succeed, FALSE if error */ - ulint atomic_writes,/*!< in: atomic writes table option - value*/ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line)/*!< in: line where the func invoked */ - MY_ATTRIBUTE((nonnull, warn_unused_result)); - -/***********************************************************************//** -NOTE! Please use the corresponding macro os_file_close(), not directly + mysql_pfs_key_t key, + const char* name, + ulint create_mode, + ulint purpose, + ulint access_type, + bool read_only, + bool* success, + const char* src_file, + ulint src_line) + __attribute__((warn_unused_result)); + +/** NOTE! Please use the corresponding macro os_file_close(), not directly this function! A performance schema instrumented wrapper function for os_file_close(). -@return TRUE if success */ +@param[in] file handle to a file +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return true if success */ UNIV_INLINE -ibool +bool pfs_os_file_close_func( -/*===================*/ - os_file_t file, /*!< in, own: handle to a file */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ -/*******************************************************************//** -NOTE! Please use the corresponding macro os_file_read(), not directly + os_file_t file, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_file_read(), not directly this function! This is the performance schema instrumented wrapper function for os_file_read() which requests a synchronous read operation. -@return TRUE if request was successful, FALSE if fail */ +@param[in, out] type IO request context +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return DB_SUCCESS if request was successful */ UNIV_INLINE -ibool +dberr_t pfs_os_file_read_func( -/*==================*/ - os_file_t file, /*!< in: handle to a file */ - void* buf, /*!< in: buffer where to read */ - os_offset_t offset, /*!< in: file offset where to read */ - ulint n, /*!< in: number of bytes to read */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ - -/*******************************************************************//** -NOTE! Please use the corresponding macro os_file_read_no_error_handling(), + IORequest& type, + os_file_t file, + void* buf, + os_offset_t offset, + ulint n, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_file_read_no_error_handling(), not directly this function! This is the performance schema instrumented wrapper function for os_file_read_no_error_handling_func() which requests a synchronous read operation. -@return TRUE if request was successful, FALSE if fail */ +@param[in, out] type IO request context +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@param[out] o number of bytes actually read +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return DB_SUCCESS if request was successful */ UNIV_INLINE -ibool +dberr_t pfs_os_file_read_no_error_handling_func( -/*====================================*/ - os_file_t file, /*!< in: handle to a file */ - void* buf, /*!< in: buffer where to read */ - os_offset_t offset, /*!< in: file offset where to read */ - ulint n, /*!< in: number of bytes to read */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ - -/*******************************************************************//** -NOTE! Please use the corresponding macro os_aio(), not directly this + IORequest& type, + os_file_t file, + void* buf, + os_offset_t offset, + ulint n, + ulint* o, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_aio(), not directly this function! Performance schema wrapper function of os_aio() which requests -an asynchronous i/o operation. -@return TRUE if request was queued successfully, FALSE if fail */ +an asynchronous I/O operation. +@param[in] type IO request context +@param[in] mode IO mode +@param[in] name Name of the file or path as NUL terminated + string +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@param[in] read_only if true read only mode checks are enforced +@param[in,out] m1 Message for the AIO handler, (can be used to + identify a completed AIO operation); ignored + if mode is OS_AIO_SYNC +@param[in,out] m2 message for the AIO handler (can be used to + identify a completed AIO operation); ignored + if mode is OS_AIO_SYNC +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return DB_SUCCESS if request was queued successfully, FALSE if fail */ UNIV_INLINE -ibool +dberr_t pfs_os_aio_func( -/*============*/ - ulint type, /*!< in: OS_FILE_READ or OS_FILE_WRITE */ - ulint is_log, /*!< in: 1 is OS_FILE_LOG or 0 */ - ulint mode, /*!< in: OS_AIO_NORMAL etc. I/O mode */ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - os_file_t file, /*!< in: handle to a file */ - void* buf, /*!< in: buffer where to read or from which - to write */ - os_offset_t offset, /*!< in: file offset where to read or write */ - ulint n, /*!< in: number of bytes to read or write */ - ulint page_size, /*!< in: page size in bytes */ - fil_node_t* message1,/*!< in: message for the aio handler - (can be used to identify a completed - aio operation); ignored if mode is - OS_AIO_SYNC */ - void* message2,/*!< in: message for the aio handler - (can be used to identify a completed - aio operation); ignored if mode is - OS_AIO_SYNC */ - ulint* write_size,/*!< in/out: Actual write size initialized - after fist successfull trim - operation for this page and if - initialized we do not trim again if - actual page size does not decrease. */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ -/*******************************************************************//** -NOTE! Please use the corresponding macro os_file_write(), not directly + IORequest& type, + ulint mode, + const char* name, + os_file_t file, + void* buf, + os_offset_t offset, + ulint n, + bool read_only, + fil_node_t* m1, + void* m2, + ulint* wsize, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_file_write(), not directly this function! This is the performance schema instrumented wrapper function for os_file_write() which requests a synchronous write operation. -@return TRUE if request was successful, FALSE if fail */ +@param[in, out] type IO request context +@param[in] name Name of the file or path as NUL terminated + string +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return DB_SUCCESS if request was successful */ UNIV_INLINE -ibool +dberr_t pfs_os_file_write_func( -/*===================*/ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - os_file_t file, /*!< in: handle to a file */ - const void* buf, /*!< in: buffer from which to write */ - os_offset_t offset, /*!< in: file offset where to write */ - ulint n, /*!< in: number of bytes to write */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ -/***********************************************************************//** -NOTE! Please use the corresponding macro os_file_flush(), not directly + IORequest& type, + const char* name, + os_file_t file, + const void* buf, + os_offset_t offset, + ulint n, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_file_flush(), not directly this function! This is the performance schema instrumented wrapper function for os_file_flush() which flushes the write buffers of a given file to the disk. Flushes the write buffers of a given file to the disk. +@param[in] file Open file handle +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked @return TRUE if success */ UNIV_INLINE -ibool +bool pfs_os_file_flush_func( -/*===================*/ - os_file_t file, /*!< in, own: handle to a file */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ + os_file_t file, + const char* src_file, + ulint src_line); -/***********************************************************************//** -NOTE! Please use the corresponding macro os_file_rename(), not directly +/** NOTE! Please use the corresponding macro os_file_rename(), not directly this function! This is the performance schema instrumented wrapper function for os_file_rename() -@return TRUE if success */ +@param[in] key Performance Schema Key +@param[in] oldpath old file path as a null-terminated string +@param[in] newpath new file path +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return true if success */ UNIV_INLINE -ibool +bool pfs_os_file_rename_func( -/*====================*/ - mysql_pfs_key_t key, /*!< in: Performance Schema Key */ - const char* oldpath,/*!< in: old file path as a null-terminated - string */ - const char* newpath,/*!< in: new file path */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ - -/***********************************************************************//** + mysql_pfs_key_t key, + const char* oldpath, + const char* newpath, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_file_delete(), not directly this function! This is the performance schema instrumented wrapper function for os_file_delete() -@return TRUE if success */ +@param[in] key Performance Schema Key +@param[in] name old file path as a null-terminated string +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return true if success */ UNIV_INLINE bool pfs_os_file_delete_func( -/*====================*/ - mysql_pfs_key_t key, /*!< in: Performance Schema Key */ - const char* name, /*!< in: old file path as a null-terminated - string */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ - -/***********************************************************************//** + mysql_pfs_key_t key, + const char* name, + const char* src_file, + ulint src_line); + +/** NOTE! Please use the corresponding macro os_file_delete_if_exists(), not directly this function! This is the performance schema instrumented wrapper function for os_file_delete_if_exists() -@return TRUE if success */ +@param[in] key Performance Schema Key +@param[in] name old file path as a null-terminated string +@param[in] exist indicate if file pre-exist +@param[in] src_file file name where func invoked +@param[in] src_line line where the func invoked +@return true if success */ UNIV_INLINE bool pfs_os_file_delete_if_exists_func( -/*==============================*/ - mysql_pfs_key_t key, /*!< in: Performance Schema Key */ - const char* name, /*!< in: old file path as a null-terminated - string */ - const char* src_file,/*!< in: file name where func invoked */ - ulint src_line);/*!< in: line where the func invoked */ + mysql_pfs_key_t key, + const char* name, + bool* exist, + const char* src_file, + ulint src_line); + +#else /* UNIV_PFS_IO */ + +/* If UNIV_PFS_IO is not defined, these I/O APIs point +to original un-instrumented file I/O APIs */ +# define os_file_create(key, name, create, purpose, type, read_only, \ + success) \ + os_file_create_func(name, create, purpose, type, read_only, \ + success) + +# define os_file_create_simple(key, name, create_mode, access, \ + read_only, success) \ + os_file_create_simple_func(name, create_mode, access, \ + read_only, success) + +# define os_file_create_simple_no_error_handling( \ + key, name, create_mode, access, read_only, success) \ + os_file_create_simple_no_error_handling_func( \ + name, create_mode, access, read_only, success) + +# define os_file_close(file) os_file_close_func(file) + +# define os_aio(type, mode, name, file, buf, offset, \ + n, read_only, message1, message2, wsize) \ + os_aio_func(type, mode, name, file, buf, offset, \ + n, read_only, message1, message2, wsize) + +# define os_file_read(type, file, buf, offset, n) \ + os_file_read_func(type, file, buf, offset, n) + +# define os_file_read_no_error_handling(type, file, buf, offset, n, o) \ + os_file_read_no_error_handling_func(type, file, buf, offset, n, o) + +# define os_file_write(type, name, file, buf, offset, n) \ + os_file_write_func(type, name, file, buf, offset, n) + +# define os_file_flush(file) os_file_flush_func(file) + +# define os_file_rename(key, oldpath, newpath) \ + os_file_rename_func(oldpath, newpath) + +# define os_file_delete(key, name) os_file_delete_func(name) + +# define os_file_delete_if_exists(key, name, exist) \ + os_file_delete_if_exists_func(name, exist) + #endif /* UNIV_PFS_IO */ #ifdef UNIV_HOTBACKUP -/***********************************************************************//** -Closes a file handle. -@return TRUE if success */ -UNIV_INTERN -ibool -os_file_close_no_error_handling( -/*============================*/ - os_file_t file); /*!< in, own: handle to a file */ +/** Closes a file handle. +@param[in] file handle to a file +@return true if success */ +bool +os_file_close_no_error_handling(os_file_t file); #endif /* UNIV_HOTBACKUP */ -/***********************************************************************//** -Gets a file size. -@return file size, or (os_offset_t) -1 on failure */ -UNIV_INTERN + +/** Gets a file size. +@param[in] file handle to a file +@return file size if OK, else set m_total_size to ~0 and m_alloc_size + to errno */ +os_file_size_t +os_file_get_size( + const char* filename) + __attribute__((warn_unused_result)); + +/** Gets a file size. +@param[in] file handle to a file +@return file size, or (os_offset_t) -1 on failure */ os_offset_t os_file_get_size( -/*=============*/ - os_file_t file) /*!< in: handle to a file */ + os_file_t file) MY_ATTRIBUTE((warn_unused_result)); -/***********************************************************************//** -Write the specified number of zeros to a newly created file. -@return TRUE if success */ -UNIV_INTERN -ibool + +/** Write the specified number of zeros to a newly created file. +@param[in] name name of the file or path as a null-terminated + string +@param[in] file handle to a file +@param[in] size file size +@param[in] read_only Enable read-only checks if true +@return true if success */ +bool os_file_set_size( -/*=============*/ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - os_file_t file, /*!< in: handle to a file */ - os_offset_t size) /*!< in: file size */ - MY_ATTRIBUTE((nonnull, warn_unused_result)); -/***********************************************************************//** -Truncates a file at its current position. -@return TRUE if success */ -UNIV_INTERN -ibool + const char* name, + os_file_t file, + os_offset_t size, + bool read_only) + __attribute__((warn_unused_result)); + +/** Truncates a file at its current position. +@param[in/out] file file to be truncated +@return true if success */ +bool os_file_set_eof( -/*============*/ FILE* file); /*!< in: file to be truncated */ -/***********************************************************************//** -NOTE! Use the corresponding macro os_file_flush(), not directly this function! + +/** Truncates a file to a specified size in bytes. Do nothing if the size +preserved is smaller or equal than current size of file. +@param[in] pathname file path +@param[in] file file to be truncated +@param[in] size size preserved in bytes +@return true if success */ +bool +os_file_truncate( + const char* pathname, + os_file_t file, + os_offset_t size); + +/** NOTE! Use the corresponding macro os_file_flush(), not directly this +function! Flushes the write buffers of a given file to the disk. -@return TRUE if success */ -UNIV_INTERN -ibool +@param[in] file handle to a file +@return true if success */ +bool os_file_flush_func( -/*===============*/ - os_file_t file); /*!< in, own: handle to a file */ -/***********************************************************************//** -Retrieves the last error number if an error occurs in a file io function. + os_file_t file); + +/** Retrieves the last error number if an error occurs in a file io function. The number should be retrieved before any other OS calls (because they may overwrite the error number). If the number is not known to this program, the OS error number + 100 is returned. -@return error number, or OS error number + 100 */ -UNIV_INTERN +@param[in] report true if we want an error message printed + for all errors +@return error number, or OS error number + 100 */ ulint os_file_get_last_error( -/*===================*/ - bool report_all_errors); /*!< in: TRUE if we want an error message - printed of all errors */ -/*******************************************************************//** -NOTE! Use the corresponding macro os_file_read(), not directly this function! + bool report); + +/** NOTE! Use the corresponding macro os_file_read(), not directly this +function! Requests a synchronous read operation. -@return TRUE if request was successful, FALSE if fail */ -UNIV_INTERN -ibool +@param[in] type IO request context +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@return DB_SUCCESS if request was successful */ +dberr_t os_file_read_func( -/*==============*/ - os_file_t file, /*!< in: handle to a file */ - void* buf, /*!< in: buffer where to read */ - os_offset_t offset, /*!< in: file offset where to read */ - ulint n); /*!< in: number of bytes to read */ -/*******************************************************************//** -Rewind file to its start, read at most size - 1 bytes from it to str, and + IORequest& type, + os_file_t file, + void* buf, + os_offset_t offset, + ulint n) + __attribute__((warn_unused_result)); + +/** Rewind file to its start, read at most size - 1 bytes from it to str, and NUL-terminate str. All errors are silently ignored. This function is -mostly meant to be used with temporary files. */ -UNIV_INTERN +mostly meant to be used with temporary files. +@param[in,out] file file to read from +@param[in,out] str buffer where to read +@param[in] size size of buffer */ void os_file_read_string( -/*================*/ - FILE* file, /*!< in: file to read from */ - char* str, /*!< in: buffer where to read */ - ulint size); /*!< in: size of buffer */ -/*******************************************************************//** -NOTE! Use the corresponding macro os_file_read_no_error_handling(), + FILE* file, + char* str, + ulint size); + +/** NOTE! Use the corresponding macro os_file_read_no_error_handling(), not directly this function! Requests a synchronous positioned read operation. This function does not do any error handling. In case of error it returns FALSE. -@return TRUE if request was successful, FALSE if fail */ -UNIV_INTERN -ibool +@param[in] type IO request context +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@param[out] o number of bytes actually read +@return DB_SUCCESS or error code */ +dberr_t os_file_read_no_error_handling_func( -/*================================*/ - os_file_t file, /*!< in: handle to a file */ - void* buf, /*!< in: buffer where to read */ - os_offset_t offset, /*!< in: file offset where to read */ - ulint n); /*!< in: number of bytes to read */ - -/*******************************************************************//** -NOTE! Use the corresponding macro os_file_write(), not directly this + IORequest& type, + os_file_t file, + void* buf, + os_offset_t offset, + ulint n, + ulint* o) + __attribute__((warn_unused_result)); + +/** NOTE! Use the corresponding macro os_file_write(), not directly this function! Requests a synchronous write operation. -@return TRUE if request was successful, FALSE if fail */ -UNIV_INTERN -ibool +@param[in,out] type IO request context +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@return DB_SUCCESS if request was successful */ +dberr_t os_file_write_func( -/*===============*/ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - os_file_t file, /*!< in: handle to a file */ - const void* buf, /*!< in: buffer from which to write */ - os_offset_t offset, /*!< in: file offset where to write */ - ulint n); /*!< in: number of bytes to write */ - -/*******************************************************************//** -Check the existence and type of the given file. -@return TRUE if call succeeded */ -UNIV_INTERN -ibool + IORequest& type, + const char* name, + os_file_t file, + const void* buf, + os_offset_t offset, + ulint n) + __attribute__((warn_unused_result)); + +/** Check the existence and type of the given file. +@param[in] path pathname of the file +@param[out] exists true if file exists +@param[out] type type of the file (if it exists) +@return true if call succeeded */ +bool os_file_status( -/*===========*/ - const char* path, /*!< in: pathname of the file */ - ibool* exists, /*!< out: TRUE if file exists */ - os_file_type_t* type); /*!< out: type of the file (if it exists) */ -/****************************************************************//** -The function os_file_dirname returns a directory component of a -null-terminated pathname string. In the usual case, dirname returns -the string up to, but not including, the final '/', and basename -is the component following the final '/'. Trailing '/' characters -are not counted as part of the pathname. - -If path does not contain a slash, dirname returns the string ".". - -Concatenating the string returned by dirname, a "/", and the basename -yields a complete pathname. - -The return value is a copy of the directory component of the pathname. -The copy is allocated from heap. It is the caller responsibility -to free it after it is no longer needed. - -The following list of examples (taken from SUSv2) shows the strings -returned by dirname and basename for different paths: - - path dirname basename - "/usr/lib" "/usr" "lib" - "/usr/" "/" "usr" - "usr" "." "usr" - "/" "/" "/" - "." "." "." - ".." "." ".." - -@return own: directory component of the pathname */ -UNIV_INTERN -char* -os_file_dirname( -/*============*/ - const char* path); /*!< in: pathname */ -/****************************************************************//** -This function returns a new path name after replacing the basename + const char* path, + bool* exists, + os_file_type_t* type); + +/** This function returns a new path name after replacing the basename in an old path with a new basename. The old_path is a full path name including the extension. The tablename is in the normal form "databasename/tablename". The new base name is found after @@ -1029,35 +1475,15 @@ the forward slash. Both input strings are null terminated. This function allocates memory to be returned. It is the callers responsibility to free the return value after it is no longer needed. -@return own: new full pathname */ -UNIV_INTERN +@param[in] old_path pathname +@param[in] new_name new file name +@return own: new full pathname */ char* os_file_make_new_pathname( -/*======================*/ - const char* old_path, /*!< in: pathname */ - const char* new_name); /*!< in: new file name */ -/****************************************************************//** -This function returns a remote path name by combining a data directory -path provided in a DATA DIRECTORY clause with the tablename which is -in the form 'database/tablename'. It strips the file basename (which -is the tablename) found after the last directory in the path provided. -The full filepath created will include the database name as a directory -under the path provided. The filename is the tablename with the '.ibd' -extension. All input and output strings are null-terminated. + const char* old_path, + const char* new_name); -This function allocates memory to be returned. It is the callers -responsibility to free the return value after it is no longer needed. - -@return own: A full pathname; data_dir_path/databasename/tablename.ibd */ -UNIV_INTERN -char* -os_file_make_remote_pathname( -/*=========================*/ - const char* data_dir_path, /*!< in: pathname */ - const char* tablename, /*!< in: tablename */ - const char* extention); /*!< in: file extention; ibd,cfg*/ -/****************************************************************//** -This function reduces a null-terminated full remote path name into +/** This function reduces a null-terminated full remote path name into the path that is sent by MySQL for DATA DIRECTORY clause. It replaces the 'databasename/tablename.ibd' found at the end of the path with just 'tablename'. @@ -1067,278 +1493,275 @@ is allocated. The caller should allocate memory for the path sent in. This function manipulates that path in place. If the path format is not as expected, just return. The result is used -to inform a SHOW CREATE TABLE command. */ -UNIV_INTERN +to inform a SHOW CREATE TABLE command. +@param[in,out] data_dir_path Full path/data_dir_path */ void os_file_make_data_dir_path( -/*========================*/ - char* data_dir_path); /*!< in/out: full path/data_dir_path */ -/****************************************************************//** -Creates all missing subdirectories along the given path. -@return TRUE if call succeeded FALSE otherwise */ -UNIV_INTERN -ibool + char* data_dir_path); + +/** Create all missing subdirectories along the given path. +@return DB_SUCCESS if OK, otherwise error code. */ +dberr_t os_file_create_subdirs_if_needed( -/*=============================*/ - const char* path); /*!< in: path name */ -/*********************************************************************** -Initializes the asynchronous io system. Creates one array each for ibuf + const char* path); + +#ifdef UNIV_ENABLE_UNIT_TEST_GET_PARENT_DIR +/* Test the function os_file_get_parent_dir. */ +void +unit_test_os_file_get_parent_dir(); +#endif /* UNIV_ENABLE_UNIT_TEST_GET_PARENT_DIR */ + +/** Initializes the asynchronous io system. Creates one array each for ibuf and log i/o. Also creates one array each for read and write where each array is divided logically into n_read_segs and n_write_segs respectively. The caller must create an i/o handler thread for each segment in these arrays. This function also creates the sync array. -No i/o handler thread needs to be created for that */ -UNIV_INTERN -ibool +No i/o handler thread needs to be created for that +@param[in] n_read_segs number of reader threads +@param[in] n_write_segs number of writer threads +@param[in] n_slots_sync number of slots in the sync aio array */ + +bool os_aio_init( -/*========*/ - ulint n_per_seg, /*<! in: maximum number of pending aio - operations allowed per segment */ - ulint n_read_segs, /*<! in: number of reader threads */ - ulint n_write_segs, /*<! in: number of writer threads */ - ulint n_slots_sync); /*<! in: number of slots in the sync aio - array */ -/*********************************************************************** + ulint n_read_segs, + ulint n_write_segs, + ulint n_slots_sync); + +/** Frees the asynchronous io system. */ -UNIV_INTERN void -os_aio_free(void); -/*=============*/ +os_aio_free(); -/*******************************************************************//** +/** NOTE! Use the corresponding macro os_aio(), not directly this function! Requests an asynchronous i/o operation. -@return TRUE if request was queued successfully, FALSE if fail */ -UNIV_INTERN -ibool +@param[in] type IO request context +@param[in] mode IO mode +@param[in] name Name of the file or path as NUL terminated + string +@param[in] file Open file handle +@param[out] buf buffer where to read +@param[in] offset file offset where to read +@param[in] n number of bytes to read +@param[in] read_only if true read only mode checks are enforced +@param[in,out] m1 Message for the AIO handler, (can be used to + identify a completed AIO operation); ignored + if mode is OS_AIO_SYNC +@param[in,out] m2 message for the AIO handler (can be used to + identify a completed AIO operation); ignored + if mode is OS_AIO_SYNC +@return DB_SUCCESS or error code */ +dberr_t os_aio_func( -/*========*/ - ulint type, /*!< in: OS_FILE_READ or OS_FILE_WRITE */ - ulint is_log, /*!< in: 1 is OS_FILE_LOG or 0 */ - ulint mode, /*!< in: OS_AIO_NORMAL, ..., possibly ORed - to OS_AIO_SIMULATED_WAKE_LATER: the - last flag advises this function not to wake - i/o-handler threads, but the caller will - do the waking explicitly later, in this - way the caller can post several requests in - a batch; NOTE that the batch must not be - so big that it exhausts the slots in aio - arrays! NOTE that a simulated batch - may introduce hidden chances of deadlocks, - because i/os are not actually handled until - all have been posted: use with great - caution! */ - const char* name, /*!< in: name of the file or path as a - null-terminated string */ - os_file_t file, /*!< in: handle to a file */ - void* buf, /*!< in: buffer where to read or from which - to write */ - os_offset_t offset, /*!< in: file offset where to read or write */ - ulint n, /*!< in: number of bytes to read or write */ - ulint page_size, /*!< in: page size in bytes */ - fil_node_t* message1,/*!< in: message for the aio handler - (can be used to identify a completed - aio operation); ignored if mode is - OS_AIO_SYNC */ - void* message2,/*!< in: message for the aio handler - (can be used to identify a completed - aio operation); ignored if mode is - OS_AIO_SYNC */ - ulint* write_size);/*!< in/out: Actual write size initialized - after fist successfull trim - operation for this page and if - initialized we do not trim again if - actual page size does not decrease. */ -/************************************************************************//** -Wakes up all async i/o threads so that they know to exit themselves in + IORequest& type, + ulint mode, + const char* name, + os_file_t file, + void* buf, + os_offset_t offset, + ulint n, + bool read_only, + fil_node_t* m1, + void* m2, + ulint* wsize); + +/** Wakes up all async i/o threads so that they know to exit themselves in shutdown. */ -UNIV_INTERN void -os_aio_wake_all_threads_at_shutdown(void); -/*=====================================*/ -/************************************************************************//** -Waits until there are no pending writes in os_aio_write_array. There can +os_aio_wake_all_threads_at_shutdown(); + +/** Waits until there are no pending writes in os_aio_write_array. There can be other, synchronous, pending writes. */ -UNIV_INTERN void -os_aio_wait_until_no_pending_writes(void); -/*=====================================*/ -/**********************************************************************//** -Wakes up simulated aio i/o-handler threads if they have something to do. */ -UNIV_INTERN +os_aio_wait_until_no_pending_writes(); + +/** Wakes up simulated aio i/o-handler threads if they have something to do. */ void -os_aio_simulated_wake_handler_threads(void); -/*=======================================*/ -/**********************************************************************//** -This function can be called if one wants to post a batch of reads and +os_aio_simulated_wake_handler_threads(); + +/** This function can be called if one wants to post a batch of reads and prefers an i/o-handler thread to handle them all at once later. You must call os_aio_simulated_wake_handler_threads later to ensure the threads are not left sleeping! */ -UNIV_INTERN void -os_aio_simulated_put_read_threads_to_sleep(void); -/*============================================*/ +os_aio_simulated_put_read_threads_to_sleep(); -#ifdef WIN_ASYNC_IO -/**********************************************************************//** -This function is only used in Windows asynchronous i/o. +/** This is the generic AIO handler interface function. Waits for an aio operation to complete. This function is used to wait the -for completed requests. The aio array of pending requests is divided +for completed requests. The AIO array of pending requests is divided into segments. The thread specifies which segment or slot it wants to wait for. NOTE: this function will also take care of freeing the aio slot, therefore no other thread is allowed to do the freeing! -@return TRUE if the aio operation succeeded */ -UNIV_INTERN -ibool -os_aio_windows_handle( -/*==================*/ - ulint segment, /*!< in: the number of the segment in the aio - arrays to wait for; segment 0 is the ibuf - i/o thread, segment 1 the log i/o thread, - then follow the non-ibuf read threads, and as - the last are the non-ibuf write threads; if - this is ULINT_UNDEFINED, then it means that - sync aio is used, and this parameter is - ignored */ - ulint pos, /*!< this parameter is used only in sync aio: - wait for the aio slot at this position */ - fil_node_t**message1, /*!< out: the messages passed with the aio - request; note that also in the case where - the aio operation failed, these output - parameters are valid and can be used to - restart the operation, for example */ - void** message2, - ulint* type); /*!< out: OS_FILE_WRITE or ..._READ */ -#endif - -/**********************************************************************//** -Does simulated aio. This function should be called by an i/o-handler -thread. -@return TRUE if the aio operation succeeded */ -UNIV_INTERN -ibool -os_aio_simulated_handle( -/*====================*/ - ulint segment, /*!< in: the number of the segment in the aio - arrays to wait for; segment 0 is the ibuf - i/o thread, segment 1 the log i/o thread, - then follow the non-ibuf read threads, and as - the last are the non-ibuf write threads */ - fil_node_t**message1, /*!< out: the messages passed with the aio - request; note that also in the case where - the aio operation failed, these output - parameters are valid and can be used to - restart the operation, for example */ - void** message2, - ulint* type); /*!< out: OS_FILE_WRITE or ..._READ */ -/**********************************************************************//** -Validates the consistency of the aio system. -@return TRUE if ok */ -UNIV_INTERN -ibool -os_aio_validate(void); -/*=================*/ -/**********************************************************************//** -Prints info of the aio arrays. */ -UNIV_INTERN +@param[in] segment the number of the segment in the aio arrays to + wait for; segment 0 is the ibuf I/O thread, + segment 1 the log I/O thread, then follow the + non-ibuf read threads, and as the last are the + non-ibuf write threads; if this is + ULINT_UNDEFINED, then it means that sync AIO + is used, and this parameter is ignored +@param[out] m1 the messages passed with the AIO request; + note that also in the case where the AIO + operation failed, these output parameters + are valid and can be used to restart the + operation, for example +@param[out] m2 callback message +@param[out] type OS_FILE_WRITE or ..._READ +@return DB_SUCCESS or error code */ +dberr_t +os_aio_handler( + ulint segment, + fil_node_t** m1, + void** m2, + IORequest* type); + +/** Prints info of the aio arrays. +@param[in/out] file file where to print */ void -os_aio_print( -/*=========*/ - FILE* file); /*!< in: file where to print */ -/**********************************************************************//** -Refreshes the statistics used to print per-second averages. */ -UNIV_INTERN +os_aio_print(FILE* file); + +/** Refreshes the statistics used to print per-second averages. */ void -os_aio_refresh_stats(void); -/*======================*/ +os_aio_refresh_stats(); -#ifdef UNIV_DEBUG -/**********************************************************************//** -Checks that all slots in the system have been freed, that is, there are +/** Checks that all slots in the system have been freed, that is, there are no pending io operations. */ -UNIV_INTERN -ibool -os_aio_all_slots_free(void); -/*=======================*/ +bool +os_aio_all_slots_free(); + +#ifdef UNIV_DEBUG + +/** Prints all pending IO +@param[in] file file where to print */ +void +os_aio_print_pending_io(FILE* file); + #endif /* UNIV_DEBUG */ -/*******************************************************************//** -This function returns information about the specified file -@return DB_SUCCESS if all OK */ -UNIV_INTERN +/** This function returns information about the specified file +@param[in] path pathname of the file +@param[in] stat_info information of a file in a directory +@param[in] check_rw_perm for testing whether the file can be opened + in RW mode +@param[in] read_only if true read only mode checks are enforced +@return DB_SUCCESS if all OK */ dberr_t os_file_get_status( -/*===============*/ - const char* path, /*!< in: pathname of the file */ - os_file_stat_t* stat_info, /*!< information of a file in a - directory */ - bool check_rw_perm); /*!< in: for testing whether the - file can be opened in RW mode */ + const char* path, + os_file_stat_t* stat_info, + bool check_rw_perm, + bool read_only); #if !defined(UNIV_HOTBACKUP) -/** Create a temporary file in the location specified by the parameter -path. If the path is null, then it will be created in tmpdir. +/** Creates a temporary file that will be deleted on close. @param[in] path location for creating temporary file @return temporary file descriptor, or < 0 on error */ -UNIV_INTERN int -innobase_mysql_tmpfile( - const char* path); +innobase_mysql_tmpfile(); #endif /* !UNIV_HOTBACKUP */ -#if defined(LINUX_NATIVE_AIO) -/************************************************************************** -This function is only used in Linux native asynchronous i/o. -Waits for an aio operation to complete. This function is used to wait the -for completed requests. The aio array of pending requests is divided -into segments. The thread specifies which segment or slot it wants to wait -for. NOTE: this function will also take care of freeing the aio slot, -therefore no other thread is allowed to do the freeing! -@return TRUE if the IO was successful */ -UNIV_INTERN -ibool -os_aio_linux_handle( -/*================*/ - ulint global_seg, /*!< in: segment number in the aio array - to wait for; segment 0 is the ibuf - i/o thread, segment 1 is log i/o thread, - then follow the non-ibuf read threads, - and the last are the non-ibuf write - threads. */ - fil_node_t**message1, /*!< out: the messages passed with the */ - void** message2, /*!< aio request; note that in case the - aio operation failed, these output - parameters are valid and can be used to - restart the operation. */ - ulint* type); /*!< out: OS_FILE_WRITE or ..._READ */ -#endif /* LINUX_NATIVE_AIO */ - -/****************************************************************//** -Does error handling when a file operation fails. -@return TRUE if we should retry the operation */ -ibool -os_file_handle_error_no_exit( -/*=========================*/ - const char* name, /*!< in: name of a file or NULL */ - const char* operation, /*!< in: operation */ - ibool on_error_silent,/*!< in: if TRUE then don't print - any message to the log. */ - const char* file, /*!< in: file name */ - const ulint line); /*!< in: line */ - -/***********************************************************************//** -Try to get number of bytes per sector from file system. -@return file block size */ -UNIV_INTERN +/** If it is a compressed page return the compressed page data + footer size +@param[in] buf Buffer to check, must include header + 10 bytes +@return ULINT_UNDEFINED if the page is not a compressed page or length + of the compressed data (including footer) if it is a compressed page */ ulint -os_file_get_block_size( -/*===================*/ - os_file_t file, /*!< in: handle to a file */ - const char* name); /*!< in: file name */ +os_file_compressed_page_size(const byte* buf); + +/** If it is a compressed page return the original page data + footer size +@param[in] buf Buffer to check, must include header + 10 bytes +@return ULINT_UNDEFINED if the page is not a compressed page or length + of the original data + footer if it is a compressed page */ +ulint +os_file_original_page_size(const byte* buf); + +/** Set the file create umask +@param[in] umask The umask to use for file creation. */ +void +os_file_set_umask(ulint umask); + +/** Free storage space associated with a section of the file. +@param[in] fh Open file handle +@param[in] off Starting offset (SEEK_SET) +@param[in] len Size of the hole +@return DB_SUCCESS or error code */ +dberr_t +os_file_punch_hole( + os_file_t fh, + os_offset_t off, + os_offset_t len) + __attribute__((warn_unused_result)); + +/** Check if the file system supports sparse files. + +Warning: On POSIX systems we try and punch a hole from offset 0 to +the system configured page size. This should only be called on an empty +file. + +Note: On Windows we use the name and on Unices we use the file handle. + +@param[in] name File name +@param[in] fh File handle for the file - if opened +@return true if the file system supports sparse files */ +bool +os_is_sparse_file_supported( + const char* path, + os_file_t fh) + __attribute__((warn_unused_result)); + +/** Decompress the page data contents. Page type must be FIL_PAGE_COMPRESSED, if +not then the source contents are left unchanged and DB_SUCCESS is returned. +@param[in] dblwr_recover true of double write recovery in progress +@param[in,out] src Data read from disk, decompressed data will be + copied to this page +@param[in,out] dst Scratch area to use for decompression +@param[in] dst_len Size of the scratch area in bytes +@return DB_SUCCESS or error code */ + +dberr_t +os_file_decompress_page( + bool dblwr_recover, + byte* src, + byte* dst, + ulint dst_len) + __attribute__((warn_unused_result)); + +/** Normalizes a directory path for the current OS: +On Windows, we convert '/' to '\', else we convert '\' to '/'. +@param[in,out] str A null-terminated directory and file path */ +void os_normalize_path(char* str); + +/** Normalizes a directory path for Windows: converts '/' to '\'. +@param[in,out] str A null-terminated Windows directory and file path */ +#ifdef _WIN32 +#define os_normalize_path_for_win(str) os_normalize_path(str) +#else +#define os_normalize_path_for_win(str) +#endif + +/* Determine if a path is an absolute path or not. +@param[in] OS directory or file path to evaluate +@retval true if an absolute path +@retval false if a relative path */ +UNIV_INLINE +bool +is_absolute_path( + const char* path) +{ + if (path[0] == OS_PATH_SEPARATOR) { + return(true); + } + +#ifdef _WIN32 + if (path[1] == ':' && path[2] == OS_PATH_SEPARATOR) { + return(true); + } +#endif /* _WIN32 */ + + return(false); +} #ifndef UNIV_NONINL #include "os0file.ic" -#endif +#endif /* UNIV_NONINL */ -#endif +#endif /* os0file_h */ |