Implement anonymous pipes and the ability to transmit them between pr…

…ocesses using Unix Domain Sockets. Change-Id: I9c9f4ec0e99075a29c6f4d97c503e759134eb094 TESTED=Unit tests Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/257804 Commit-Queue: Brian Quinlan <bquinlan@google.com> Reviewed-by: Lasse Nielsen <lrn@google.com> Reviewed-by: Alexander Aprelev <aam@google.com>
dart-lang · Sep 13, 2022 · 2ead86a · 2ead86a
1 parent e324ada
commit 2ead86a
Show file tree

Hide file tree

Showing 25 changed files with 777 additions and 41 deletions.
diff --git a/runtime/bin/file.cc b/runtime/bin/file.cc
@@ -550,6 +550,25 @@ void FUNCTION_NAME(File_CreateLink)(Dart_NativeArguments args) {
   }
 }
 
+void FUNCTION_NAME(File_CreatePipe)(Dart_NativeArguments args) {
+  Namespace* namespc = Namespace::GetNamespace(args, 0);
+
+  File* readPipe;
+  File* writePipe;
+  if (File::CreatePipe(namespc, &readPipe, &writePipe)) {
+    Dart_Handle pipes = ThrowIfError(Dart_NewList(2));
+    Dart_Handle readHandle =
+        ThrowIfError(Dart_NewInteger(reinterpret_cast<intptr_t>(readPipe)));
+    Dart_Handle writeHandle =
+        ThrowIfError(Dart_NewInteger(reinterpret_cast<intptr_t>(writePipe)));
+    ThrowIfError(Dart_ListSetAt(pipes, 0, readHandle));
+    ThrowIfError(Dart_ListSetAt(pipes, 1, writeHandle));
+    Dart_SetReturnValue(args, pipes);
+  } else {
+    Dart_SetReturnValue(args, DartUtils::NewDartOSError());
+  }
+}
+
 void FUNCTION_NAME(File_LinkTarget)(Dart_NativeArguments args) {
   Namespace* namespc = Namespace::GetNamespace(args, 0);
   Dart_Handle path_handle = Dart_GetNativeArgument(args, 1);
@@ -915,6 +934,31 @@ CObject* File::CreateRequest(const CObjectArray& request) {
              : CObject::NewOSError();
 }
 
+CObject* File::CreatePipeRequest(const CObjectArray& request) {
+  if ((request.Length() < 1) || !request[0]->IsIntptr()) {
+    return CObject::IllegalArgumentError();
+  }
+  Namespace* namespc = CObjectToNamespacePointer(request[0]);
+  RefCntReleaseScope<Namespace> rs(namespc);
+
+  File* readPipe;
+  File* writePipe;
+  if (!CreatePipe(namespc, &readPipe, &writePipe)) {
+    return CObject::NewOSError();
+  }
+
+  CObjectArray* pipes = new CObjectArray(CObject::NewArray(2));
+  CObjectNativePointer* readHandle = new CObjectNativePointer(
+      CObject::NewNativePointer(reinterpret_cast<intptr_t>(readPipe),
+                                sizeof(*readPipe), ReleaseFile));
+  CObjectNativePointer* writeHandle = new CObjectNativePointer(
+      CObject::NewNativePointer(reinterpret_cast<intptr_t>(writePipe),
+                                sizeof(*writePipe), ReleaseFile));
+  pipes->SetAt(0, readHandle);
+  pipes->SetAt(1, writeHandle);
+  return pipes;
+}
+
 CObject* File::OpenRequest(const CObjectArray& request) {
   if ((request.Length() < 1) || !request[0]->IsIntptr()) {
     return CObject::IllegalArgumentError();

diff --git a/runtime/bin/file.h b/runtime/bin/file.h
@@ -228,17 +228,15 @@ class File : public ReferenceCounted<File> {
   // (stdin, stout or stderr).
   static File* OpenStdio(int fd);
 
-#if defined(DART_HOST_OS_FUCHSIA) || defined(DART_HOST_OS_LINUX) ||            \
-    defined(DART_HOST_OS_ANDROID) || defined(DART_HOST_OS_MACOS)
   static File* OpenFD(int fd);
-#endif
 
   static bool Exists(Namespace* namespc, const char* path);
   static bool ExistsUri(Namespace* namespc, const char* uri);
   static bool Create(Namespace* namespc, const char* path, bool exclusive);
   static bool CreateLink(Namespace* namespc,
                          const char* path,
                          const char* target);
+  static bool CreatePipe(Namespace* namespc, File** readPipe, File** writePipe);
   static bool Delete(Namespace* namespc, const char* path);
   static bool DeleteLink(Namespace* namespc, const char* path);
   static bool Rename(Namespace* namespc,
@@ -297,6 +295,7 @@ class File : public ReferenceCounted<File> {
 
   static CObject* ExistsRequest(const CObjectArray& request);
   static CObject* CreateRequest(const CObjectArray& request);
+  static CObject* CreatePipeRequest(const CObjectArray& request);
   static CObject* DeleteRequest(const CObjectArray& request);
   static CObject* RenameRequest(const CObjectArray& request);
   static CObject* CopyRequest(const CObjectArray& request);

diff --git a/runtime/bin/file_android.cc b/runtime/bin/file_android.cc
@@ -334,6 +334,17 @@ bool File::CreateLink(Namespace* namespc,
   return NO_RETRY_EXPECTED(SymlinkAt(target, ns.fd(), ns.path())) == 0;
 }
 
+bool File::CreatePipe(Namespace* namespc, File** readPipe, File** writePipe) {
+  int pipe_fds[2];
+  int status = NO_RETRY_EXPECTED(pipe(pipe_fds));
+  if (status != 0) {
+    return false;
+  }
+  *readPipe = OpenFD(pipe_fds[0]);
+  *writePipe = OpenFD(pipe_fds[1]);
+  return true;
+}
+
 File::Type File::GetType(Namespace* namespc,
                          const char* name,
                          bool follow_links) {

diff --git a/runtime/bin/file_fuchsia.cc b/runtime/bin/file_fuchsia.cc
@@ -332,6 +332,17 @@ bool File::CreateLink(Namespace* namespc,
   return NO_RETRY_EXPECTED(symlinkat(target, ns.fd(), ns.path())) == 0;
 }
 
+bool File::CreatePipe(Namespace* namespc, File** readPipe, File** writePipe) {
+  int pipe_fds[2];
+  int status = NO_RETRY_EXPECTED(pipe(pipe_fds));
+  if (status != 0) {
+    return false;
+  }
+  *readPipe = OpenFD(pipe_fds[0]);
+  *writePipe = OpenFD(pipe_fds[1]);
+  return true;
+}
+
 File::Type File::GetType(Namespace* namespc,
                          const char* name,
                          bool follow_links) {

diff --git a/runtime/bin/file_linux.cc b/runtime/bin/file_linux.cc
@@ -328,6 +328,17 @@ bool File::CreateLink(Namespace* namespc,
   return NO_RETRY_EXPECTED(symlinkat(target, ns.fd(), ns.path())) == 0;
 }
 
+bool File::CreatePipe(Namespace* namespc, File** readPipe, File** writePipe) {
+  int pipe_fds[2];
+  int status = NO_RETRY_EXPECTED(pipe(pipe_fds));
+  if (status != 0) {
+    return false;
+  }
+  *readPipe = OpenFD(pipe_fds[0]);
+  *writePipe = OpenFD(pipe_fds[1]);
+  return true;
+}
+
 File::Type File::GetType(Namespace* namespc,
                          const char* name,
                          bool follow_links) {

diff --git a/runtime/bin/file_macos.cc b/runtime/bin/file_macos.cc
@@ -371,6 +371,17 @@ bool File::CreateLink(Namespace* namespc,
   return (status == 0);
 }
 
+bool File::CreatePipe(Namespace* namespc, File** readPipe, File** writePipe) {
+  int pipe_fds[2];
+  int status = NO_RETRY_EXPECTED(pipe(pipe_fds));
+  if (status != 0) {
+    return false;
+  }
+  *readPipe = OpenFD(pipe_fds[0]);
+  *writePipe = OpenFD(pipe_fds[1]);
+  return true;
+}
+
 File::Type File::GetType(Namespace* namespc,
                          const char* pathname,
                          bool follow_links) {

diff --git a/runtime/bin/file_win.cc b/runtime/bin/file_win.cc
@@ -314,14 +314,18 @@ File* File::FileOpenW(const wchar_t* system_name, FileOpenMode mode) {
       return NULL;
     }
   }
+  return OpenFD(fd);
+}
+
+File* File::OpenFD(int fd) {
   return new File(new FileHandle(fd));
 }
 
 class StringRAII {
  public:
-  explicit StringRAII(StringRAII& origin) {
-    own_ = origin.own_;
-    s_ = origin.release();
+  explicit StringRAII(StringRAII* origin) {
+    own_ = origin->own_;
+    s_ = origin->release();
   }
 
   explicit StringRAII(const char* s) : s_(s), own_(false) {}
@@ -616,6 +620,17 @@ bool File::CreateLink(Namespace* namespc,
   return (create_status != 0);
 }
 
+bool File::CreatePipe(Namespace* namespc, File** readPipe, File** writePipe) {
+  int pipe_fds[2];
+  int status = _pipe(pipe_fds, 4096, _O_BINARY);
+  if (status != 0) {
+    return false;
+  }
+  *readPipe = OpenFD(pipe_fds[0]);
+  *writePipe = OpenFD(pipe_fds[1]);
+  return true;
+}
+
 bool File::Delete(Namespace* namespc, const char* name) {
   Utf8ToWideScope system_name(PrefixLongFilePath(name));
   int status = _wremove(system_name.wide());

diff --git a/runtime/bin/io_natives.cc b/runtime/bin/io_natives.cc
@@ -40,6 +40,7 @@ namespace bin {
   V(File_Copy, 3)                                                              \
   V(File_Create, 3)                                                            \
   V(File_CreateLink, 3)                                                        \
+  V(File_CreatePipe, 1)                                                        \
   V(File_Delete, 2)                                                            \
   V(File_DeleteLink, 2)                                                        \
   V(File_Exists, 2)                                                            \

diff --git a/runtime/bin/io_service.h b/runtime/bin/io_service.h
@@ -48,18 +48,19 @@ namespace bin {
   V(File, Identical, 28)                                                       \
   V(File, Stat, 29)                                                            \
   V(File, Lock, 30)                                                            \
-  V(Socket, Lookup, 31)                                                        \
-  V(Socket, ListInterfaces, 32)                                                \
-  V(Socket, ReverseLookup, 33)                                                 \
-  V(Directory, Create, 34)                                                     \
-  V(Directory, Delete, 35)                                                     \
-  V(Directory, Exists, 36)                                                     \
-  V(Directory, CreateTemp, 37)                                                 \
-  V(Directory, ListStart, 38)                                                  \
-  V(Directory, ListNext, 39)                                                   \
-  V(Directory, ListStop, 40)                                                   \
-  V(Directory, Rename, 41)                                                     \
-  V(SSLFilter, ProcessFilter, 42)
+  V(File, CreatePipe, 31)                                                      \
+  V(Socket, Lookup, 32)                                                        \
+  V(Socket, ListInterfaces, 33)                                                \
+  V(Socket, ReverseLookup, 34)                                                 \
+  V(Directory, Create, 35)                                                     \
+  V(Directory, Delete, 36)                                                     \
+  V(Directory, Exists, 37)                                                     \
+  V(Directory, CreateTemp, 38)                                                 \
+  V(Directory, ListStart, 39)                                                  \
+  V(Directory, ListNext, 40)                                                   \
+  V(Directory, ListStop, 41)                                                   \
+  V(Directory, Rename, 42)                                                     \
+  V(SSLFilter, ProcessFilter, 43)
 
 #define DECLARE_REQUEST(type, method, id) k##type##method##Request = id,
 

diff --git a/runtime/tests/concurrency/stress_test_list.json b/runtime/tests/concurrency/stress_test_list.json
@@ -3258,6 +3258,7 @@
     "../../../tests/standalone/io/file_non_ascii_sync_test.dart",
     "../../../tests/standalone/io/file_non_ascii_test.dart",
     "../../../tests/standalone/io/file_output_stream_test.dart",
+    "../../../tests/standalone/io/file_pipe_test.dart",
     "../../../tests/standalone/io/file_read_encoded_test.dart",
     "../../../tests/standalone/io/file_stat_test.dart",
     "../../../tests/standalone/io/file_stream_test.dart",
@@ -6580,6 +6581,7 @@
     "../../../tests/standalone_2/io/file_non_ascii_sync_test.dart",
     "../../../tests/standalone_2/io/file_non_ascii_test.dart",
     "../../../tests/standalone_2/io/file_output_stream_test.dart",
+    "../../../tests/standalone_2/io/file_pipe_test.dart",
     "../../../tests/standalone_2/io/file_read_encoded_test.dart",
     "../../../tests/standalone_2/io/file_stat_test.dart",
     "../../../tests/standalone_2/io/file_stream_test.dart",

diff --git a/sdk/lib/_internal/js_dev_runtime/patch/io_patch.dart b/sdk/lib/_internal/js_dev_runtime/patch/io_patch.dart
@@ -122,6 +122,11 @@ class _File {
     throw UnsupportedError("File._createLink");
   }
 
+  @patch
+  static List<dynamic> _createPipe(_Namespace namespace) {
+    throw UnsupportedError("File._createPipe");
+  }
+
   @patch
   static _linkTarget(_Namespace namespace, Uint8List rawPath) {
     throw UnsupportedError("File._linkTarget");
@@ -541,6 +546,16 @@ class ResourceHandle {
   factory ResourceHandle.fromStdout(Stdout stdout) {
     throw UnsupportedError("ResourceHandle.fromStdout constructor");
   }
+
+  @patch
+  factory ResourceHandle.fromReadPipe(ReadPipe pipe) {
+    throw UnsupportedError("ResourceHandle.fromReadPipe constructor");
+  }
+
+  @patch
+  factory ResourceHandle.fromWritePipe(WritePipe pipe) {
+    throw UnsupportedError("ResourceHandle.fromWritePipe constructor");
+  }
 }
 
 @patch

diff --git a/sdk/lib/_internal/js_runtime/lib/io_patch.dart b/sdk/lib/_internal/js_runtime/lib/io_patch.dart
@@ -122,6 +122,11 @@ class _File {
     throw new UnsupportedError("File._createLink");
   }
 
+  @patch
+  static List<dynamic> _createPipe(_Namespace namespace) {
+    throw UnsupportedError("File._createPipe");
+  }
+
   @patch
   static _linkTarget(_Namespace namespace, Uint8List path) {
     throw new UnsupportedError("File._linkTarget");
@@ -541,6 +546,16 @@ class ResourceHandle {
   factory ResourceHandle.fromStdout(Stdout stdout) {
     throw UnsupportedError("ResourceHandle.fromStdout constructor");
   }
+
+  @patch
+  factory ResourceHandle.fromReadPipe(ReadPipe pipe) {
+    throw UnsupportedError("ResourceHandle.fromReadPipe constructor");
+  }
+
+  @patch
+  factory ResourceHandle.fromWritePipe(WritePipe pipe) {
+    throw UnsupportedError("ResourceHandle.fromWritePipe constructor");
+  }
 }
 
 @patch

diff --git a/sdk/lib/_internal/vm/bin/file_patch.dart b/sdk/lib/_internal/vm/bin/file_patch.dart
@@ -18,6 +18,9 @@ class _File {
   external static _createLink(
       _Namespace namespace, Uint8List rawPath, String target);
   @patch
+  @pragma("vm:external-name", "File_CreatePipe")
+  external static List<dynamic> _createPipe(_Namespace namespace);
+  @patch
   @pragma("vm:external-name", "File_LinkTarget")
   external static _linkTarget(_Namespace namespace, Uint8List rawPath);
   @patch

diff --git a/sdk/lib/_internal/vm/bin/socket_patch.dart b/sdk/lib/_internal/vm/bin/socket_patch.dart
@@ -756,7 +756,8 @@ class _NativeSocket extends _NativeSocketNativeWrapper with _ServiceObject {
                 "Address family not supported by protocol family, "
                 // ...and then add some details.
                 "sourceAddress.type must be ${InternetAddressType.unix} but was "
-                "${source.type}", address: address);
+                "${source.type}",
+                address: address);
           }
           connectionResult = socket.nativeCreateUnixDomainBindConnect(
               address.address, source.address, _Namespace._namespace);
@@ -2592,6 +2593,16 @@ class ResourceHandle {
   factory ResourceHandle.fromStdout(Stdout stdout) {
     return _ResourceHandleImpl(stdout._fd);
   }
+
+  factory ResourceHandle.fromReadPipe(ReadPipe pipe) {
+    _ReadPipe rp = pipe as _ReadPipe;
+    return ResourceHandle.fromFile(rp._openedFile!);
+  }
+
+  factory ResourceHandle.fromWritePipe(WritePipe pipe) {
+    _WritePipe wp = pipe as _WritePipe;
+    return ResourceHandle.fromFile(wp._file);
+  }
 }
 
 @pragma("vm:entry-point")
@@ -2622,6 +2633,14 @@ class _ResourceHandleImpl implements ResourceHandle {
     return _RawSocket(nativeSocket);
   }
 
+  _ReadPipe toReadPipe() {
+    return _ReadPipe(toFile());
+  }
+
+  _WritePipe toWritePipe() {
+    return _WritePipe(toFile());
+  }
+
   @pragma("vm:external-name", "ResourceHandleImpl_toRawDatagramSocket")
   external RawDatagramSocket toRawDatagramSocket();
 

diff --git a/sdk/lib/_internal/wasm/lib/io_patch.dart b/sdk/lib/_internal/wasm/lib/io_patch.dart
@@ -121,6 +121,11 @@ class _File {
     throw new UnsupportedError("File._createLink");
   }
 
+  @patch
+  static List<dynamic> _createPipe(_Namespace namespace) {
+    throw UnsupportedError("File._createPipe");
+  }
+
   @patch
   static _linkTarget(_Namespace namespace, Uint8List path) {
     throw new UnsupportedError("File._linkTarget");
@@ -540,6 +545,16 @@ class ResourceHandle {
   factory ResourceHandle.fromStdout(Stdout stdout) {
     throw UnsupportedError("ResourceHandle.fromStdout constructor");
   }
+
+  @patch
+  factory ResourceHandle.fromReadPipe(ReadPipe pipe) {
+    throw UnsupportedError("ResourceHandle.fromReadPipe constructor");
+  }
+
+  @patch
+  factory ResourceHandle.fromWritePipe(WritePipe pipe) {
+    throw UnsupportedError("ResourceHandle.fromWritePipe constructor");
+  }
 }
 
 @patch