[GR-53368] Implement os.truncate

msimacek · msimacek · commit 74365d76115a · 2024-05-24T19:14:13.000Z
PullRequest: graalpython/3336
diff --git a/graalpython/com.oracle.graal.python.test/src/tests/test_posix.py b/graalpython/com.oracle.graal.python.test/src/tests/test_posix.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2018, 2023, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2018, 2024, Oracle and/or its affiliates. All rights reserved.
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 #
 # The Universal Permissive License (UPL), Version 1.0
@@ -252,6 +252,19 @@ def test_waitstatus_to_exitcode(self):
         self.assertEqual(-12, os.waitstatus_to_exitcode(0x428C))
         self.assertRaises(ValueError, os.waitstatus_to_exitcode, 0xFF)
 
+    def test_truncate(self):
+        try:
+            with open(TEST_FULL_PATH1, os.O_WRONLY | os.O_CREAT) as fd:
+                os.write(fd, b'hello world')
+            os.truncate(TEST_FULL_PATH1, 5)
+            with open(TEST_FULL_PATH1, os.O_RDONLY) as fd:
+                self.assertEqual(b'hello', os.read(fd, 100))
+        finally:
+            try:
+                os.unlink(TEST_FULL_PATH1)
+            except Exception:
+                pass
+
 
 class WithCurdirFdTests(unittest.TestCase):
 
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/PosixModuleBuiltins.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/builtins/modules/PosixModuleBuiltins.java
@@ -1192,8 +1192,9 @@ protected ArgumentClinicProvider getArgumentClinic() {
         }
 
         @Specialization
-        PNone ftruncate(VirtualFrame frame, int fd, long length,
+        static PNone ftruncate(VirtualFrame frame, int fd, long length,
                         @Bind("this") Node inliningTarget,
+                        @Bind("getPosixSupport()") PosixSupport posixSupport,
                         @CachedLibrary(limit = "1") PosixSupportLibrary posixLib,
                         @Cached SysModuleBuiltins.AuditNode auditNode,
                         @Cached GilNode gil,
@@ -1204,15 +1205,15 @@ PNone ftruncate(VirtualFrame frame, int fd, long length,
                 try {
                     gil.release(true);
                     try {
-                        posixLib.ftruncate(getPosixSupport(), fd, length);
+                        posixLib.ftruncate(posixSupport, fd, length);
                     } finally {
                         gil.acquire();
                     }
                     return PNone.NONE;
                 } catch (PosixException e) {
                     errorProfile.enter(inliningTarget);
                     if (e.getErrorCode() == OSErrorEnum.EINTR.getNumber()) {
-                        PythonContext.triggerAsyncActions(this);
+                        PythonContext.triggerAsyncActions(inliningTarget);
                     } else {
                         throw constructAndRaiseNode.get(inliningTarget).raiseOSErrorFromPosixException(frame, e);
                     }
@@ -1221,6 +1222,52 @@ PNone ftruncate(VirtualFrame frame, int fd, long length,
         }
     }
 
+    @Builtin(name = "truncate", minNumOfPositionalArgs = 2, parameterNames = {"path", "length"})
+    @ArgumentClinic(name = "path", conversionClass = PathConversionNode.class, args = {"false", "true"})
+    @ArgumentClinic(name = "length", conversionClass = OffsetConversionNode.class)
+    @GenerateNodeFactory
+    public abstract static class TruncateNode extends PythonBinaryClinicBuiltinNode {
+
+        @Override
+        protected ArgumentClinicProvider getArgumentClinic() {
+            return PosixModuleBuiltinsClinicProviders.TruncateNodeClinicProviderGen.INSTANCE;
+        }
+
+        @Specialization
+        static PNone truncate(VirtualFrame frame, PosixPath path, long length,
+                        @Bind("this") Node inliningTarget,
+                        @Bind("getPosixSupport()") PosixSupport posixSupport,
+                        @Shared @CachedLibrary(limit = "1") PosixSupportLibrary posixLib,
+                        @Shared @Cached SysModuleBuiltins.AuditNode auditNode,
+                        @Shared @Cached GilNode gil,
+                        @Shared @Cached PConstructAndRaiseNode.Lazy constructAndRaiseNode) {
+            auditNode.audit(inliningTarget, "os.truncate", path.originalObject, length);
+            try {
+                gil.release(true);
+                try {
+                    posixLib.truncate(posixSupport, path.value, length);
+                } finally {
+                    gil.acquire();
+                }
+                return PNone.NONE;
+            } catch (PosixException e) {
+                throw constructAndRaiseNode.get(inliningTarget).raiseOSErrorFromPosixException(frame, e, path.originalObject);
+            }
+        }
+
+        @Specialization
+        static PNone ftruncate(VirtualFrame frame, PosixFd fd, long length,
+                        @Bind("this") Node inliningTarget,
+                        @Bind("getPosixSupport()") PosixSupport posixSupport,
+                        @Shared @CachedLibrary(limit = "1") PosixSupportLibrary posixLib,
+                        @Shared @Cached SysModuleBuiltins.AuditNode auditNode,
+                        @Shared @Cached GilNode gil,
+                        @Cached InlinedBranchProfile errorProfile,
+                        @Shared @Cached PConstructAndRaiseNode.Lazy constructAndRaiseNode) {
+            return FtruncateNode.ftruncate(frame, fd.fd, length, inliningTarget, posixSupport, posixLib, auditNode, gil, errorProfile, constructAndRaiseNode);
+        }
+    }
+
     @Builtin(name = "fsync", minNumOfPositionalArgs = 1, parameterNames = "fd")
     @ArgumentClinic(name = "fd", conversionClass = FileDescriptorConversionNode.class)
     @GenerateNodeFactory
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/EmulatedPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/EmulatedPosixSupport.java
@@ -800,6 +800,27 @@ public void ftruncateMessage(int fd, long length,
         }
     }
 
+    @ExportMessage
+    public void truncate(Object path, long length,
+                    @Bind("$node") Node inliningTarget,
+                    @Shared("eq") @Cached TruffleString.EqualNode eqNode,
+                    @Shared("js2ts") @Cached TruffleString.FromJavaStringNode fromJavaStringNode) throws PosixException {
+        TruffleString pathname = pathToTruffleString(path, fromJavaStringNode);
+        TruffleFile file = getTruffleFile(pathname, eqNode);
+        try {
+            doTruncate(file, length);
+        } catch (Exception e) {
+            throw posixException(OSErrorEnum.fromException(e, eqNode));
+        }
+    }
+
+    @TruffleBoundary
+    private static void doTruncate(TruffleFile file, long length) throws IOException {
+        try (SeekableByteChannel channel = file.newByteChannel(Set.of(StandardOpenOption.WRITE))) {
+            channel.truncate(length);
+        }
+    }
+
     @ExportMessage(name = "fsync")
     public void fsyncMessage(int fd) throws PosixException {
         if (!fsync(fd)) {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/ImageBuildtimePosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/ImageBuildtimePosixSupport.java
@@ -268,6 +268,13 @@ final void ftruncate(int fd, long length,
         nativeLib.ftruncate(nativePosixSupport, fd, length);
     }
 
+    @ExportMessage
+    final void truncate(Object path, long length,
+                    @CachedLibrary("this.nativePosixSupport") PosixSupportLibrary nativeLib) throws PosixException {
+        checkNotInImageBuildtime();
+        nativeLib.truncate(nativePosixSupport, path, length);
+    }
+
     @ExportMessage
     final void fsync(int fd,
                     @CachedLibrary("this.nativePosixSupport") PosixSupportLibrary nativeLib) throws PosixException {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/LoggingPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/LoggingPosixSupport.java
@@ -283,6 +283,17 @@ final void ftruncate(int fd, long length,
         }
     }
 
+    @ExportMessage
+    final void truncate(Object path, long length,
+                    @CachedLibrary("this.delegate") PosixSupportLibrary lib) throws PosixException {
+        logEnter("truncate", "%s, %d", path, length);
+        try {
+            lib.truncate(delegate, path, length);
+        } catch (PosixException e) {
+            throw logException("truncate", e);
+        }
+    }
+
     @ExportMessage
     final void fsync(int fd,
                     @CachedLibrary("this.delegate") PosixSupportLibrary lib) throws PosixException {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/NFIPosixSupport.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/NFIPosixSupport.java
@@ -187,6 +187,7 @@ private enum PosixNativeFunction {
         call_select("(sint32, [sint32], sint32, [sint32], sint32, [sint32], sint32, sint64, sint64, [sint8]):sint32"),
         call_lseek("(sint32, sint64, sint32):sint64"),
         call_ftruncate("(sint32, sint64):sint32"),
+        call_truncate("([sint8], sint64):sint32"),
         call_fsync("(sint32):sint32"),
         call_flock("(sint32, sint32):sint32"),
         call_fcntl_lock("(sint32, sint32, sint32, sint32, sint64, sint64):sint32"),
@@ -685,6 +686,15 @@ public void ftruncate(int fd, long length,
         }
     }
 
+    @ExportMessage
+    public void truncate(Object path, long length,
+                    @Shared("invoke") @Cached InvokeNativeFunction invokeNode) throws PosixException {
+        int res = invokeNode.callInt(this, PosixNativeFunction.call_truncate, pathToCString(path), length);
+        if (res != 0) {
+            throw getErrnoAndThrowPosixException(invokeNode);
+        }
+    }
+
     @ExportMessage
     public void fsync(int fd,
                     @Shared("invoke") @Cached InvokeNativeFunction invokeNode) throws PosixException {
diff --git a/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/PosixSupportLibrary.java b/graalpython/com.oracle.graal.python/src/com/oracle/graal/python/runtime/PosixSupportLibrary.java
@@ -111,6 +111,8 @@ public abstract class PosixSupportLibrary extends Library {
 
     public abstract void ftruncate(Object receiver, int fd, long length) throws PosixException;
 
+    public abstract void truncate(Object receiver, Object path, long length) throws PosixException;
+
     public abstract void fsync(Object receiver, int fd) throws PosixException;
 
     public abstract void flock(Object receiver, int fd, int operation) throws PosixException;
diff --git a/graalpython/python-libposix/src/posix.c b/graalpython/python-libposix/src/posix.c
@@ -220,6 +220,10 @@ int32_t call_ftruncate(int32_t fd, int64_t length) {
     return ftruncate(fd, length);
 }
 
+int32_t call_truncate(const char* path, int64_t length) {
+    return truncate(path, length);
+}
+
 int32_t call_fsync(int32_t fd) {
     return fsync(fd);
 }

Original file line number	Diff line number	Diff line change
`@@ -220,6 +220,10 @@ int32_t call_ftruncate(int32_t fd, int64_t length) {`
`220`	`220`	`return ftruncate(fd, length);`
`221`	`221`	`}`
`222`	`222`
	`223`	`+int32_t call_truncate(const char* path, int64_t length) {`
	`224`	`+ return truncate(path, length);`
	`225`	`+}`
	`226`	`+`
`223`	`227`	`int32_t call_fsync(int32_t fd) {`
`224`	`228`	`return fsync(fd);`
`225`	`229`	`}`