Implement fsync via set_option

Author: dwgebler

ext/standard/basic_functions.stub.php

@@ -823,6 +823,9 @@ function ftell($stream): int|false {}
 /** @param resource $stream */
 function fflush($stream): bool {}
 
+/** @param resource $stream */
+function fsync($stream): bool {}
+
 /** @param resource $stream */
 function fwrite($stream, string $data, ?int $length = null): int|false {}
 

ext/standard/file.c

@@ -1170,26 +1170,6 @@ PHPAPI PHP_FUNCTION(fwrite)
 }
 /* }}} */
 
-PHPAPI PHP_FUNCTION(fsync)
-{
-	zval *res;
-	int ret;
-	php_stream *stream;
-
-	ZEND_PARSE_PARAMETERS_START(1, 1)
-		Z_PARAM_RESOURCE(res)
-	ZEND_PARSE_PARAMETERS_END();
-
-	PHP_STREAM_TO_ZVAL(stream, res);
-
-	ret = php_stream_sync(stream);
-	if (ret) {
-		RETURN_FALSE;
-	}
-	RETURN_TRUE;
-
-}
-
 /* {{{ Flushes output */
 PHPAPI PHP_FUNCTION(fflush)
 {
@@ -1487,6 +1467,34 @@ PHP_FUNCTION(unlink)
 }
 /* }}} */
 
+/* {{{ Sync file to storage. Similar to fflush() but blocks until OS buffers have flushed. */
+PHP_FUNCTION(fsync)
+{
+	zval *res;
+	int ret;
+	php_stream *stream;
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+		Z_PARAM_RESOURCE(res)
+	ZEND_PARSE_PARAMETERS_END();
+
+	PHP_STREAM_TO_ZVAL(stream, res);
+
+	if (!php_stream_sync_supported(stream)) {
+		php_error_docref(NULL, E_WARNING, "Can't fsync this stream!");
+		RETURN_FALSE;
+	}
+
+	ret = php_stream_sync(stream);
+	if (ret) {
+		RETURN_FALSE;
+	}
+	RETURN_TRUE;
+
+}
+/* }}} */
+
+
 /* {{{ Truncate file to 'size' length */
 PHP_FUNCTION(ftruncate)
 {

main/php_streams.h

@@ -125,7 +125,6 @@ typedef struct _php_stream_ops  {
 	int (*cast)(php_stream *stream, int castas, void **ret);
 	int (*stat)(php_stream *stream, php_stream_statbuf *ssb);
 	int (*set_option)(php_stream *stream, int option, int value, void *ptrparam);
-        int (*sync)(php_stream *stream);
 } php_stream_ops;
 
 typedef struct _php_stream_wrapper_ops {
@@ -338,7 +337,7 @@ PHPAPI int _php_stream_flush(php_stream *stream, int closing);
 #define php_stream_flush(stream)	_php_stream_flush((stream), 0)
 
 PHPAPI int _php_stream_sync(php_stream *stream);
-#define php_stream_sync(stream)	        _php_stream_sync((stream))
+#define php_stream_sync(stream)	    _php_stream_sync((stream))
 
 PHPAPI char *_php_stream_get_line(php_stream *stream, char *buf, size_t maxlen, size_t *returned_len);
 #define php_stream_gets(stream, buf, maxlen)	_php_stream_get_line((stream), (buf), (maxlen), NULL)
@@ -448,6 +447,14 @@ END_EXTERN_C()
 /* Enable/disable blocking reads on anonymous pipes on Windows. */
 #define PHP_STREAM_OPTION_PIPE_BLOCKING 13
 
+/* Stream can support fsync operation */
+#define PHP_STREAM_OPTION_SYNC_API		14
+#define PHP_STREAM_SYNC_SUPPORTED	0
+#define PHP_STREAM_SYNC_FSYNC 1
+
+#define php_stream_sync_supported(stream)	(_php_stream_set_option((stream), PHP_STREAM_OPTION_SYNC_API, PHP_STREAM_SYNC_SUPPORTED, NULL) == PHP_STREAM_OPTION_RETURN_OK ? 1 : 0)
+
+
 #define PHP_STREAM_OPTION_RETURN_OK			 0 /* option set OK */
 #define PHP_STREAM_OPTION_RETURN_ERR		-1 /* problem setting option */
 #define PHP_STREAM_OPTION_RETURN_NOTIMPL	-2 /* underlying stream does not implement; streams can handle it instead */

main/streams/glob_wrapper.c

@@ -190,8 +190,7 @@ const php_stream_ops  php_glob_stream_ops = {
 	php_glob_stream_rewind,
 	NULL, /* cast */
 	NULL, /* stat */
-	NULL,  /* set_option */
-	NULL
+	NULL  /* set_option */
 };
 
  /* {{{ php_glob_stream_opener */

main/streams/plain_wrapper.c

@@ -520,7 +520,6 @@ static int php_stdiop_close(php_stream *stream, int close_handle)
 	return ret;
 }
 
-//dwg
 static int php_stdiop_sync(php_stream *stream)
 {
 	php_stdio_stream_data *data = (php_stdio_stream_data*)stream->abstract;
@@ -534,7 +533,7 @@ static int php_stdiop_sync(php_stream *stream)
 		    return fsync(fileno(data->file));
 		}
 	}
-	return ret;	
+	return ret;
 }
 
 static int php_stdiop_flush(php_stream *stream)
@@ -902,6 +901,14 @@ static int php_stdiop_set_option(php_stream *stream, int option, int value, void
 #endif
 			return PHP_STREAM_OPTION_RETURN_NOTIMPL;
 
+		case PHP_STREAM_OPTION_SYNC_API:
+			switch (value) {
+				case PHP_STREAM_SYNC_SUPPORTED:
+					return fd == -1 ? PHP_STREAM_OPTION_RETURN_ERR : PHP_STREAM_OPTION_RETURN_OK;
+				case PHP_STREAM_SYNC_FSYNC:
+				    return php_stdiop_sync(stream) == 0 ? PHP_STREAM_OPTION_RETURN_OK : PHP_STREAM_OPTION_RETURN_ERR;
+			}
+
 		case PHP_STREAM_OPTION_TRUNCATE_API:
 			switch (value) {
 				case PHP_STREAM_TRUNCATE_SUPPORTED:
@@ -979,8 +986,7 @@ PHPAPI php_stream_ops	php_stream_stdio_ops = {
 	php_stdiop_seek,
 	php_stdiop_cast,
 	php_stdiop_stat,
-	php_stdiop_set_option,
-	php_stdiop_sync,
+	php_stdiop_set_option
 };
 /* }}} */
 

main/streams/streams.c

@@ -1224,15 +1224,6 @@ static ssize_t _php_stream_write_filtered(php_stream *stream, const char *buf, s
 	return consumed;
 }
 
-PHPAPI int _php_stream_sync(php_stream *stream)
-{
-	int ret = 0;
-	if (stream->ops->sync) {
-		ret = stream->ops->sync(stream);
-	}
-	return ret;
-}
-
 PHPAPI int _php_stream_flush(php_stream *stream, int closing)
 {
 	int ret = 0;
@@ -1415,6 +1406,11 @@ PHPAPI int _php_stream_set_option(php_stream *stream, int option, int value, voi
 	return ret;
 }
 
+PHPAPI int _php_stream_sync(php_stream *stream)
+{
+	return php_stream_set_option(stream, PHP_STREAM_OPTION_SYNC_API, PHP_STREAM_SYNC_FSYNC, NULL);
+}
+
 PHPAPI int _php_stream_truncate_set_size(php_stream *stream, size_t newsize)
 {
 	return php_stream_set_option(stream, PHP_STREAM_OPTION_TRUNCATE_API, PHP_STREAM_TRUNCATE_SET_SIZE, &newsize);