[tarantool-patches] [PATCH] fio: introduce utime function

[tarantool-patches] [PATCH] fio: introduce utime function

[Oleg Babin]

From: Oleg Babin <babinoleg@mail.ru>

Closes #4323

Issue: https://github.com/tarantool/tarantool/issues/4323

@TarantoolBot document
Title: fio.utime

fio.utime (filepath [, atime [, mtime]])
Set access and modification times of a file. The first argument is the filename, the second argument (atime) is the access time, and the third argument (mtime) is the modification time. Both times are provided in seconds. If the modification time is omitted, the access time provided is used; if both times are omitted, the current time is used.
---
 src/lib/core/coio_file.c |  8 ++++
 src/lib/core/coio_file.h |  1 +
 src/lua/fio.c            | 10 ++++-
 src/lua/fio.lua          | 22 ++++++++++
 test/app/fio.result      | 90 ++++++++++++++++++++++++++++++++++++++++
 test/app/fio.test.lua    | 27 ++++++++++++
 6 files changed, 157 insertions(+), 1 deletion(-)

diff --git a/src/lib/core/coio_file.c b/src/lib/core/coio_file.c
index 3359f42bc..ba4b6d691 100644
--- a/src/lib/core/coio_file.c
+++ b/src/lib/core/coio_file.c
@@ -631,3 +631,11 @@ coio_copyfile(const char *source, const char *dest)
 	eio_req *req = eio_custom(coio_do_copyfile, 0, coio_complete, &eio);
 	return coio_wait_done(req, &eio);
 }
+
+int
+coio_utime(const char *pathname, double mtime, double atime)
+{
+	INIT_COEIO_FILE(eio);
+	eio_req *req = eio_utime(pathname, atime, mtime, 0, coio_complete, &eio);
+	return coio_wait_done(req, &eio);
+}
diff --git a/src/lib/core/coio_file.h b/src/lib/core/coio_file.h
index f2112ceed..5ff30ff7f 100644
--- a/src/lib/core/coio_file.h
+++ b/src/lib/core/coio_file.h
@@ -84,6 +84,7 @@ int	coio_tempdir(char *path, size_t path_len);
 
 int	coio_readdir(const char *path, char **buf);
 int	coio_copyfile(const char *source, const char *dest);
+int	coio_utime(const char *pathname, double mtime, double atime);
 #if defined(__cplusplus)
 } /* extern "C" */
 #endif /* defined(__cplusplus) */
diff --git a/src/lua/fio.c b/src/lua/fio.c
index 806f4256b..55fa66762 100644
--- a/src/lua/fio.c
+++ b/src/lua/fio.c
@@ -703,7 +703,14 @@ lbox_fio_copyfile(struct lua_State *L)
 	return lbox_fio_pushbool(L, coio_copyfile(source, dest) == 0);
 }
 
-
+static int
+lbox_fio_utime(struct lua_State *L)
+{
+	const char *pathname = lua_tostring(L, 1);
+	double atime = lua_tonumber(L, 2);
+	double mtime = lua_tonumber(L, 3);
+	return lbox_fio_pushbool(L, coio_utime(pathname, atime, mtime) == 0);
+}
 
 void
 tarantool_lua_fio_init(struct lua_State *L)
@@ -747,6 +754,7 @@ tarantool_lua_fio_init(struct lua_State *L)
 		{ "listdir",		lbox_fio_listdir		},
 		{ "fstat",		lbox_fio_fstat			},
 		{ "copyfile",		lbox_fio_copyfile,		},
+		{ "utime",		lbox_fio_utime			},
 		{ NULL,			NULL				}
 	};
 	luaL_register(L, NULL, internal_methods);
diff --git a/src/lua/fio.lua b/src/lua/fio.lua
index ba8c47ec0..1b69d7700 100644
--- a/src/lua/fio.lua
+++ b/src/lua/fio.lua
@@ -3,6 +3,7 @@
 local fio = require('fio')
 local ffi = require('ffi')
 local buffer = require('buffer')
+local fiber = require('fiber')
 
 ffi.cdef[[
     int umask(int mask);
@@ -468,6 +469,27 @@ fio.copytree = function(from, to)
     return true
 end
 
+local function check_time(time, name)
+    if time ~= nil and type(time) ~= 'number' then
+        error('fio.utime: '.. name .. ' should be a number', 3)
+    end
+end
+
+fio.utime = function(path, atime, mtime)
+    if type(path) ~= 'string' then
+        error('Usage: fio.utime(filepath[, atime[, mtime]])')
+    end
+
+    check_time(atime, 'atime')
+    check_time(mtime, 'mtime')
+
+    local current_time = fiber.time()
+    atime = atime or current_time
+    mtime = mtime or atime
+
+    return internal.utime(path, atime, mtime)
+end
+
 fio.path = {}
 fio.path.is_file = function(filename)
     local fs = fio.stat(filename)
diff --git a/test/app/fio.result b/test/app/fio.result
index 8819e39fa..ef21faffc 100644
--- a/test/app/fio.result
+++ b/test/app/fio.result
@@ -4,6 +4,9 @@ fio = require 'fio'
 ffi = require 'ffi'
 ---
 ...
+fiber = require 'fiber'
+---
+...
 buffer = require 'buffer'
 ---
 ...
@@ -1045,6 +1048,93 @@ fh:close()
 ---
 - true
 ...
+-- test utime
+fh = fio.open('newfile', {'O_RDWR','O_CREAT'})
+---
+...
+eps = 0.01
+---
+...
+fio.utime('newfile', 0, 0)
+---
+- true
+...
+fh:stat().atime == 0
+---
+- true
+...
+fh:stat().mtime == 0
+---
+- true
+...
+fio.utime('newfile', 1, 2)
+---
+- true
+...
+fh:stat().atime == 1
+---
+- false
+...
+fh:stat().mtime == 2
+---
+- false
+...
+fio.utime('newfile', 3)
+---
+- true
+...
+fh:stat().atime == 3
+---
+- true
+...
+fh:stat().mtime == 3
+---
+- true
+...
+current_time = fiber.time()
+---
+...
+fio.utime('newfile')
+---
+- true
+...
+fh:stat().atime - current_time < eps
+---
+- true
+...
+fh:stat().mtime - current_time < eps
+---
+- true
+...
+fio.utime(nil)
+---
+- error: 'builtin/fio.lua:480: Usage: fio.utime(filepath[, atime[, mtime]])'
+...
+fio.utime('newfile', 'string')
+---
+- error: 'fio.utime: atime should be a number'
+...
+fio.utime('newfile', 1, 'string')
+---
+- error: 'fio.utime: mtime should be a number'
+...
+fh:close()
+---
+- true
+...
+fio.unlink('newfile')
+---
+- true
+...
+fh = nil
+---
+...
+eps = nil
+---
+...
+current_time = nil
+---
+...
 -- gh-2924
 -- fio.path.exists lexists is_file, etc
 --
diff --git a/test/app/fio.test.lua b/test/app/fio.test.lua
index 6c0d2f478..474b38b05 100644
--- a/test/app/fio.test.lua
+++ b/test/app/fio.test.lua
@@ -1,5 +1,6 @@
 fio = require 'fio'
 ffi = require 'ffi'
+fiber = require 'fiber'
 buffer = require 'buffer'
 test_run = require('test_run').new()
 -- umask
@@ -341,6 +342,32 @@ fh:read(64)
 buf:recycle()
 fh:close()
 
+-- test utime
+fh = fio.open('newfile', {'O_RDWR','O_CREAT'})
+eps = 0.01
+fio.utime('newfile', 0, 0)
+fh:stat().atime == 0
+fh:stat().mtime == 0
+fio.utime('newfile', 1, 2)
+fh:stat().atime == 1
+fh:stat().mtime == 2
+fio.utime('newfile', 3)
+fh:stat().atime == 3
+fh:stat().mtime == 3
+current_time = fiber.time()
+fio.utime('newfile')
+fh:stat().atime - current_time < eps
+fh:stat().mtime - current_time < eps
+fio.utime(nil)
+fio.utime('newfile', 'string')
+fio.utime('newfile', 1, 'string')
+fh:close()
+fio.unlink('newfile')
+fh = nil
+eps = nil
+current_time = nil
+
+
 -- gh-2924
 -- fio.path.exists lexists is_file, etc
 --
-- 
2.21.0

Re: [tarantool-patches] [PATCH] fio: introduce utime function

[Vladimir Davydov]

On Fri, Jul 05, 2019 at 12:05:29PM +0300, Oleg Babin wrote:
> From: Oleg Babin <babinoleg@mail.ru>
> 
> Closes #4323
> 
> Issue: https://github.com/tarantool/tarantool/issues/4323

Conventionally, we don't include links to tickets into commit messages -
we put them after '---' so that they are omitted by git-am.

> 
> @TarantoolBot document
> Title: fio.utime
> 
> fio.utime (filepath [, atime [, mtime]])
> Set access and modification times of a file. The first argument is the filename, the second argument (atime) is the access time, and the third argument (mtime) is the modification time. Both times are provided in seconds. If the modification time is omitted, the access time provided is used; if both times are omitted, the current time is used.

Please align the text so that its width is < 72 characters - it's a part
of the commit message, after all.

> times are provided in seconds

... since the epoch, I assume. Please mention it in the doc bot request.

> diff --git a/test/app/fio.result b/test/app/fio.result
> index 8819e39fa..ef21faffc 100644
> --- a/test/app/fio.result
> +++ b/test/app/fio.result
> @@ -4,6 +4,9 @@ fio = require 'fio'
>  ffi = require 'ffi'
>  ---
>  ...
> +fiber = require 'fiber'
> +---
> +...
>  buffer = require 'buffer'
>  ---
>  ...
> @@ -1045,6 +1048,93 @@ fh:close()
>  ---
>  - true
>  ...
> +-- test utime
> +fh = fio.open('newfile', {'O_RDWR','O_CREAT'})
> +---
> +...
> +eps = 0.01
> +---
> +...
> +fio.utime('newfile', 0, 0)
> +---
> +- true
> +...
> +fh:stat().atime == 0
> +---
> +- true
> +...
> +fh:stat().mtime == 0
> +---
> +- true
> +...
> +fio.utime('newfile', 1, 2)
> +---
> +- true
> +...
> +fh:stat().atime == 1
> +---
> +- false
> +...
> +fh:stat().mtime == 2
> +---
> +- false
> +...
> +fio.utime('newfile', 3)
> +---
> +- true
> +...
> +fh:stat().atime == 3
> +---
> +- true
> +...
> +fh:stat().mtime == 3
> +---
> +- true
> +...
> +current_time = fiber.time()
> +---
> +...
> +fio.utime('newfile')
> +---
> +- true
> +...
> +fh:stat().atime - current_time < eps
> +---
> +- true
> +...
> +fh:stat().mtime - current_time < eps
> +---
> +- true
> +...

Under high CPU load (e.g. highly parallel test run), this may fail.
For instance, when I ran your test in a loop while having 50 CPU hogs
(while :; do :; done) in the background, I got a test failure:

} app/fio.test.lua                                                [ fail ]
} 
} Test failed! Result content mismatch:
} --- app/fio.result      Fri Jul  5 15:58:36 2019
} +++ app/fio.reject      Fri Jul  5 15:59:22 2019
} @@ -1100,11 +1100,11 @@
}  ...
}  fh:stat().atime - current_time < eps
}  ---
} -- true
} +- false
}  ...
}  fh:stat().mtime - current_time < eps
}  ---
} -- true
} +- false
}  ...
}  fio.utime(nil)
}  ---

Please rework the test to make sure it doesn't happen.

> +fio.utime(nil)
> +---
> +- error: 'builtin/fio.lua:480: Usage: fio.utime(filepath[, atime[, mtime]])'
> +...

Please make sure there are no source code line numbers in the result
file - otherwise we'd have to update it every time we patch fio.lua.

Take a look at "push filter" test run command. It's already used in
fio.test.lua so I guess you want to move it so that it covers your
test as well.

Other than that, the patch looks fine to me.