/*********************************************************************** Copyright (c) 1995, 2016, Oracle and/or its affiliates. All Rights Reserved. Copyright (c) 2009, Percona Inc. Copyright (c) 2013, 2015, MariaDB Corporation. Portions of this file contain modifications contributed and copyrighted by Percona Inc.. Those modifications are gratefully acknowledged and are described briefly in the InnoDB documentation. The contributions by Percona Inc. are incorporated with their permission, and subject to the conditions contained in the file COPYING.Percona. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA ***********************************************************************/ /**************************************************//** @file include/os0file.h The interface to the operating system file io Created 10/21/1995 Heikki Tuuri *******************************************************/ #ifndef os0file_h #define os0file_h #include "univ.i" #include "trx0types.h" #ifndef __WIN__ #include #include #include #endif /** 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; /** Number of pending read operations */ extern ulint os_n_pending_reads; /** Number of pending write operations */ extern ulint os_n_pending_writes; #ifdef __WIN__ /** 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 /** Use unbuffered I/O */ #define UNIV_NON_BUFFERED_IO #endif /** File offset in bytes */ typedef ib_uint64_t os_offset_t; #ifdef __WIN__ #define SRV_PATH_SEPARATOR '\\' /** File handle */ # define os_file_t HANDLE # define os_file_invalid INVALID_HANDLE_VALUE /** Convert a C file descriptor to a native file handle @param fd file descriptor @return native file handle */ # define OS_FILE_FROM_FD(fd) (HANDLE) _get_osfhandle(fd) #else #define SRV_PATH_SEPARATOR '/' /** File handle */ typedef int os_file_t; # define os_file_invalid (-1) /** Convert a C file descriptor to a 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; /** 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 so that if the start and the end of a block get written to disk, then the whole block gets written. This should be true even in most cases of a crash: if this fails for a log block, then it is equivalent to a media failure in the log. */ #define OS_FILE_LOG_BLOCK_SIZE srv_log_block_size /** Options for os_file_create_func @{ */ enum os_file_create_t { OS_FILE_OPEN = 51, /*!< to open an existing file (if doesn't exist, error) */ OS_FILE_CREATE, /*!< to create new file (if exists, error) */ OS_FILE_OVERWRITE, /*!< to create a new file, if exists the overwrite old file */ OS_FILE_OPEN_RAW, /*!< to open a raw device or disk partition */ OS_FILE_CREATE_PATH, /*!< to create the directories */ OS_FILE_OPEN_RETRY, /*!< open with retry */ /** Flags that can be combined with the above values. Please ensure that the above values stay below 128. */ OS_FILE_ON_ERROR_NO_EXIT = 128, /*!< do not exit on unknown errors */ OS_FILE_ON_ERROR_SILENT = 256 /*!< don't print diagnostic messages to the log unless it is a fatal error, this flag is only used if 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 */ #define OS_FILE_READ_WRITE_CACHED 666 /* OS_FILE_READ_WRITE but never O_DIRECT. Only for os_file_create_simple_no_error_handling currently. */ /* Options for file_create */ #define OS_FILE_AIO 61 #define OS_FILE_NORMAL 62 /* @} */ /** Types for file create @{ */ #define OS_DATA_FILE 100 #define OS_LOG_FILE 101 /* @} */ /** 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 /* @} */ /** Types for aio operations @{ */ #define OS_FILE_READ 10 #define OS_FILE_WRITE 11 #define OS_FILE_LOG 256 /* This can be ORed to type */ /* @} */ #define OS_AIO_N_PENDING_IOS_PER_THREAD 32 /*!< Win NT does not allow more than 64 */ /** 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 */ extern ulint os_n_file_reads; extern ulint os_n_file_writes; extern ulint os_n_fsyncs; #define OS_MIN_LOG_BLOCK_SIZE 512 extern ulint srv_log_block_size; #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_file_bmp_key; /* Following four macros are instumentations to register various file I/O operations with performance schema. 1) register_pfs_file_open_begin() and register_pfs_file_open_end() are used to register file creation, opening, closing and renaming. 2) register_pfs_file_io_begin() and register_pfs_file_io_end() are used to register actual file read, write and flush 3) register_pfs_file_close_begin() and register_pfs_file_close_end() are used to register file deletion operations*/ # define register_pfs_file_open_begin(state, locker, key, op, name, \ src_file, src_line) \ do { \ locker = PSI_FILE_CALL(get_thread_file_name_locker)( \ state, key, op, name, &locker); \ if (UNIV_LIKELY(locker != NULL)) { \ PSI_FILE_CALL(start_file_open_wait)( \ locker, src_file, src_line); \ } \ } while (0) # define register_pfs_file_open_end(locker, file) \ do { \ if (UNIV_LIKELY(locker != NULL)) { \ PSI_FILE_CALL(end_file_open_wait_and_bind_to_descriptor)(\ locker, file); \ } \ } while (0) # define register_pfs_file_close_begin(state, locker, key, op, name, \ src_file, src_line) \ do { \ locker = PSI_FILE_CALL(get_thread_file_name_locker)( \ state, key, op, name, &locker); \ if (UNIV_LIKELY(locker != NULL)) { \ PSI_FILE_CALL(start_file_close_wait)( \ locker, src_file, src_line); \ } \ } while (0) # define register_pfs_file_close_end(locker, result) \ do { \ if (UNIV_LIKELY(locker != NULL)) { \ PSI_FILE_CALL(end_file_close_wait)( \ locker, result); \ } \ } while (0) # define register_pfs_file_io_begin(state, locker, file, count, op, \ src_file, src_line) \ do { \ locker = PSI_FILE_CALL(get_thread_file_descriptor_locker)( \ state, file, op); \ if (UNIV_LIKELY(locker != NULL)) { \ PSI_FILE_CALL(start_file_wait)( \ locker, count, src_file, src_line); \ } \ } while (0) # define register_pfs_file_io_end(locker, count) \ do { \ if (UNIV_LIKELY(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 wrapper functions with performance schema instrumentation in such case. os_file_create os_file_create_simple os_file_create_simple_no_error_handling os_file_close os_file_rename os_aio os_file_read os_file_read_no_error_handling 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) \ pfs_os_file_create_func(key, name, create, purpose, type, \ success, atomic_writes, __FILE__, __LINE__) # define os_file_create_simple(key, name, create, access, success) \ pfs_os_file_create_simple_func(key, name, create, access, \ success, __FILE__, __LINE__) # define os_file_create_simple_no_error_handling( \ key, name, create_mode, access, success, atomic_writes) \ pfs_os_file_create_simple_no_error_handling_func( \ key, name, create_mode, access, success, atomic_writes, __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, space_id, \ trx, write_size) \ pfs_os_aio_func(type, is_log, mode, name, file, buf, offset, \ n, page_size, message1, message2, space_id, trx, write_size, \ __FILE__, __LINE__) # define os_file_read(file, buf, offset, n) \ pfs_os_file_read_func(file, buf, offset, n, NULL, \ __FILE__, __LINE__) # define os_file_read_trx(file, buf, offset, n, trx) \ pfs_os_file_read_func(file, buf, offset, n, trx, \ __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, n, \ __FILE__, __LINE__) # define os_file_flush(file) \ pfs_os_file_flush_func(file, __FILE__, __LINE__) # define os_file_rename(key, oldpath, newpath) \ pfs_os_file_rename_func(key, oldpath, newpath, __FILE__, __LINE__) # 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, space_id, trx, write_size) \ os_aio_func(type, is_log, mode, name, file, buf, offset, n, \ page_size, message1, message2, space_id, trx, write_size) # define os_file_read(file, buf, offset, n) \ os_file_read_func(file, buf, offset, n, NULL) # define os_file_read_trx(file, buf, offset, n, trx) \ os_file_read_func(file, buf, offset, n, trx) # 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 /** 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 */ ulint atomic_writes);/*!< in: atomic writes table option value */ /****************************************************************//** 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, OS_FILE_READ_ALLOW_DELETE (used by a backup program reading the file), or OS_FILE_READ_WRITE_CACHED (disable O_DIRECT if it would be enabled otherwise) */ 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 */ /***********************************************************************//** 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(), not directly this function! A performance schema instrumented wrapper function for os_file_create_simple() which opens or creates a file. @return own: handle to the file, not defined if error, error number 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 */ 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_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. @return own: handle to the file, not defined if error, error number 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 this function! A performance schema wrapper function for os_file_create(). Add instrumentation to monitor file creation/open. @return own: handle to the file, not defined if error, error number 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 this function! A performance schema instrumented wrapper function for os_file_close(). @return TRUE if success */ UNIV_INLINE ibool 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 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 */ UNIV_INLINE ibool 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 */ trx_t* trx, /*!< in: trx */ 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(), 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 */ UNIV_INLINE ibool 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 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 */ UNIV_INLINE ibool 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 space_id, trx_t* trx, 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 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 */ UNIV_INLINE ibool 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 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. @return TRUE if success */ UNIV_INLINE ibool 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 */ /***********************************************************************//** 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 */ UNIV_INLINE ibool 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 */ /***********************************************************************//** 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 */ 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 */ /***********************************************************************//** 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 */ 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 */ #endif /* UNIV_PFS_IO */ /***********************************************************************//** 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 */ /***********************************************************************//** Gets a file size. @return file size, or (os_offset_t) -1 on failure */ UNIV_INTERN os_offset_t os_file_get_size( /*=============*/ os_file_t file) /*!< in: handle to a file */ MY_ATTRIBUTE((warn_unused_result)); /***********************************************************************//** Write the specified number of zeros to a newly created file. @return TRUE if success */ UNIV_INTERN ibool 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 os_file_set_eof( /*============*/ FILE* file); /*!< in: file to be truncated */ /***********************************************************************//** Truncates a file at the specified position. @return TRUE if success */ UNIV_INTERN ibool os_file_set_eof_at( os_file_t file, /*!< in: handle to a file */ ib_uint64_t new_len);/*!< in: new file length */ /***********************************************************************//** 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 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. 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 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! Requests a synchronous read operation. @return TRUE if request was successful, FALSE if fail */ UNIV_INTERN ibool 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 */ trx_t* trx); /*!< in: trx */ /*******************************************************************//** 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 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(), 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 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 function! Requests a synchronous write operation. @return TRUE if request was successful, FALSE if fail */ UNIV_INTERN ibool 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 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 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 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 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. 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 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'. Since the result is always smaller than the path sent in, no new memory 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 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 os_file_create_subdirs_if_needed( /*=============================*/ const char* path); /*!< in: path name */ /*********************************************************************** 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 os_aio_init( /*========*/ ulint n_per_seg, /*