support iouring fttruncate (#5811)

Author: NathanFreeman

config.m4

@@ -321,6 +321,22 @@ AC_DEFUN([AC_SWOOLE_HAVE_IOURING_STATX],
     ])
 ])
 
+AC_DEFUN([AC_SWOOLE_HAVE_IOURING_FTRUNCATE],
+[
+    AC_MSG_CHECKING([for io_uring ftruncate])
+    AC_COMPILE_IFELSE([AC_LANG_PROGRAM([[
+        #define _GNU_SOURCE
+        #include <liburing.h>
+    ]], [[
+        int op = IORING_OP_FTRUNCATE;
+    ]])],[
+        AC_DEFINE([HAVE_IOURING_FTRUNCATE], 1, [have io_uring ftruncate?])
+        AC_MSG_RESULT([yes])
+    ],[
+        AC_MSG_RESULT([no])
+    ])
+])
+
 AC_DEFUN([AC_SWOOLE_CHECK_SOCKETS], [
     AC_CHECK_FUNCS([hstrerror socketpair if_nametoindex if_indextoname])
     AC_CHECK_HEADERS([netdb.h netinet/tcp.h sys/un.h sys/sockio.h])
@@ -1003,6 +1019,7 @@ EOF
 
         AC_SWOOLE_HAVE_IOURING_STATX
         AC_SWOOLE_HAVE_IOURING_FUTEX
+        AC_SWOOLE_HAVE_IOURING_FTRUNCATE
 
         PHP_EVAL_LIBLINE($URING_LIBS, SWOOLE_SHARED_LIBADD)
         PHP_EVAL_INCLINE($URING_CFLAGS)

include/swoole_coroutine_c_api.h

@@ -64,6 +64,7 @@ int swoole_coroutine_statvfs(const char *path, struct statvfs *buf);
 int swoole_coroutine_close_file(int fd);
 int swoole_coroutine_fsync(int fd);
 int swoole_coroutine_fdatasync(int fd);
+int swoole_coroutine_ftruncate(int fd, off_t length);
 /**
  * io_uring
  */
@@ -72,6 +73,7 @@ int swoole_coroutine_iouring_open(const char *pathname, int flags, mode_t mode);
 int swoole_coroutine_iouring_close_file(int fd);
 ssize_t swoole_coroutine_iouring_read(int sockfd, void *buf, size_t count);
 ssize_t swoole_coroutine_iouring_write(int sockfd, const void *buf, size_t count);
+off_t swoole_coroutine_iouring_lseek(int fd, off_t offset, int whence);
 int swoole_coroutine_iouring_rename(const char *oldpath, const char *newpath);
 int swoole_coroutine_iouring_mkdir(const char *pathname, mode_t mode);
 int swoole_coroutine_iouring_unlink(const char *pathname);
@@ -80,6 +82,9 @@ int swoole_coroutine_iouring_fstat(int fd, struct stat *statbuf);
 int swoole_coroutine_iouring_stat(const char *path, struct stat *statbuf);
 int swoole_coroutine_iouring_lstat(const char *path, struct stat *statbuf);
 #endif
+#ifdef HAVE_IOURING_FTRUNCATE
+int swoole_coroutine_iouring_ftruncate(int fd, off_t length);
+#endif
 int swoole_coroutine_iouring_rmdir(const char *pathname);
 int swoole_coroutine_iouring_fsync(int fd);
 int swoole_coroutine_iouring_fdatasync(int fd);

include/swoole_file_hook.h

@@ -24,12 +24,14 @@
 #define close_file(fd)  swoole_coroutine_iouring_close_file(fd)
 #define read(fd, buf, count) swoole_coroutine_iouring_read(fd, buf, count)
 #define write(fd, buf, count) swoole_coroutine_iouring_write(fd, buf, count)
+#define lseek(fd, offset, whence) swoole_coroutine_iouring_lseek(fd, offset, whence)
 #define rename(oldpath, newpath) swoole_coroutine_iouring_rename(oldpath, newpath)
 #define mkdir(pathname, mode) swoole_coroutine_iouring_mkdir(pathname, mode)
 #define unlink(pathname) swoole_coroutine_iouring_unlink(pathname)
 #define rmdir(pathname) swoole_coroutine_iouring_rmdir(pathname)
 #define fsync(fd) swoole_coroutine_iouring_fsync(fd)
 #define fdatasync(fd) swoole_coroutine_iouring_fdatasync(fd)
+#define ftruncate(fd, length) swoole_coroutine_iouring_ftruncate(fd, length)
 #else
 #define open(pathname, flags, mode) swoole_coroutine_open(pathname, flags, mode)
 #define close_file(fd)  swoole_coroutine_close_file(fd)
@@ -43,6 +45,7 @@
 #define rename(oldpath, newpath) swoole_coroutine_rename(oldpath, newpath)
 #define fsync(fd) swoole_coroutine_fsync(fd)
 #define fdatasync(fd) swoole_coroutine_fdatasync(fd)
+#define ftruncate(fd, length) swoole_coroutine_ftruncate(fd, length)
 #endif
 
 #ifdef HAVE_IOURING_STATX

include/swoole_iouring.h

@@ -86,6 +86,9 @@ class Iouring {
     static int futex_wait(uint32_t *futex);
     static int futex_wakeup(uint32_t *futex);
 #endif
+#ifdef HAVE_IOURING_FTRUNCATE
+    static int ftruncate(int fd, off_t length);
+#endif
 
     static std::unordered_map<std::string, int> list_all_opcode();
     static int callback(Reactor *reactor, Event *event);

src/coroutine/hook.cc

@@ -620,6 +620,16 @@ int swoole_coroutine_fdatasync(int fd) {
     return retval;
 }
 
+int swoole_coroutine_ftruncate(int fd, off_t length) {
+    if (sw_unlikely(is_no_coro())) {
+        return ftruncate(fd, length);
+    }
+
+    int retval = -1;
+    async([&]() { retval = ftruncate(fd, length); });
+    return retval;
+}
+
 #ifdef SW_USE_IOURING
 int swoole_coroutine_iouring_open(const char *pathname, int flags, mode_t mode) {
     if (sw_unlikely(is_no_coro())) {
@@ -649,6 +659,10 @@ ssize_t swoole_coroutine_iouring_write(int sockfd, const void *buf, size_t size)
     return Iouring::write(sockfd, buf, size);
 }
 
+off_t swoole_coroutine_iouring_lseek(int fd, off_t offset, int whence) {
+    return lseek(fd, offset, whence);
+}
+
 int swoole_coroutine_iouring_rename(const char *oldpath, const char *newpath) {
     if (sw_unlikely(is_no_coro())) {
         return rename(oldpath, newpath);
@@ -714,6 +728,15 @@ int swoole_coroutine_iouring_fdatasync(int fd) {
     }
     return Iouring::fdatasync(fd);
 }
+
+#ifdef HAVE_IOURING_FTRUNCATE
+int swoole_coroutine_iouring_ftruncate(int fd, off_t length) {
+    if (sw_unlikely(is_no_coro())) {
+        return ftruncate(fd, length);
+    }
+    return Iouring::ftruncate(fd, length);
+}
+#endif
 #endif
 
 SW_EXTERN_C_END

src/coroutine/iouring.cc

@@ -43,6 +43,9 @@ enum IouringOpcode {
     SW_IORING_OP_FUTEX_WAIT = IORING_OP_FUTEX_WAIT,
     SW_IORING_OP_FUTEX_WAKE = IORING_OP_FUTEX_WAKE,
 #endif
+#ifdef HAVE_IOURING_FTRUNCATE
+    SW_IORING_OP_FTRUNCATE = IORING_OP_FTRUNCATE,
+#endif
 
     SW_IORING_OP_FSTAT = 100,
     SW_IORING_OP_LSTAT = 101,
@@ -226,6 +229,10 @@ static const char *get_opcode_name(IouringOpcode opcode) {
         return "FUTEX_WAIT";
     case SW_IORING_OP_FUTEX_WAKE:
         return "FUTEX_WAKE";
+#endif
+#ifdef HAVE_IOURING_FTRUNCATE
+    case SW_IORING_OP_FTRUNCATE:
+        return "FTRUNCATE";
 #endif
     default:
         return "unknown";
@@ -307,7 +314,7 @@ bool Iouring::dispatch(IouringEvent *event) {
     case SW_IORING_OP_READ:
     case SW_IORING_OP_WRITE:
         sqe->fd = event->fd;
-        sqe->addr = (uintptr_t) (event->opcode == SW_IORING_OP_READ ? event->rbuf : event->wbuf);
+        sqe->addr = (uintptr_t)(event->opcode == SW_IORING_OP_READ ? event->rbuf : event->wbuf);
         sqe->len = event->size;
         sqe->off = -1;
         sqe->opcode = event->opcode;
@@ -384,6 +391,15 @@ bool Iouring::dispatch(IouringEvent *event) {
         sqe->futex_flags = 0;
         sqe->addr3 = FUTEX_BITSET_MATCH_ANY;
         break;
+#ifdef HAVE_IOURING_FTRUNCATE
+    case SW_IORING_OP_FTRUNCATE:
+        sqe->opcode = SW_IORING_OP_FTRUNCATE;
+        sqe->fd = event->fd;
+        sqe->off = event->size;
+        sqe->addr = 0;
+        sqe->len = 0;
+        break;
+#endif
 #endif
     default:
         abort();
@@ -476,6 +492,16 @@ int Iouring::fdatasync(int fd) {
     return static_cast<int>(execute(&event));
 }
 
+#ifdef HAVE_IOURING_FTRUNCATE
+int Iouring::ftruncate(int fd, off_t length) {
+    INIT_EVENT(SW_IORING_OP_FTRUNCATE);
+    event.fd = fd;
+    event.size = length;
+
+    return static_cast<int>(execute(&event));
+}
+#endif
+
 #ifdef HAVE_IOURING_STATX
 static void swoole_statx_to_stat(const struct statx *statxbuf, struct stat *statbuf) {
     statbuf->st_dev = (((unsigned int) statxbuf->stx_dev_major) << 8) | (unsigned int) statxbuf->stx_dev_minor;

tests/swoole_iouring/mix.phpt

@@ -70,11 +70,18 @@ run(function() use ($results) {
     for ($i = 1; $i <= 10000; $i++) {
         go(function() use ($waitGroup, $i, $results){
             $waitGroup->add();
-            file_put_contents('/tmp/file'.$i, $results[$i]);
-            Assert::true($results[$i] == file_get_contents('/tmp/file'.$i));
-            file_put_contents('/tmp/file'.$i, $results[$i], FILE_APPEND);
-            file_put_contents('/tmp/file'.$i, $results[$i], FILE_APPEND);
-            Assert::true(strlen($results[$i]) * 3 == strlen(file_get_contents('/tmp/file'.$i)));
+            $filename = '/tmp/file'.$i;
+            file_put_contents($filename, $results[$i]);
+            Assert::true($results[$i] == file_get_contents($filename));
+            file_put_contents($filename, $results[$i], FILE_APPEND);
+            file_put_contents($filename, $results[$i], FILE_APPEND);
+            Assert::true(strlen($results[$i]) * 3 == strlen(file_get_contents($filename)));
+
+            $stream = fopen($filename, 'r+');
+            $size = rand(1, filesize($filename));
+            Assert::true(ftruncate($stream, $size));
+            fclose($stream);
+            Assert::true($size == strlen(file_get_contents($filename)));
             $waitGroup->done();
         });
     }