Merge pull request emscripten-core#13 from rstz/flexible-pthreadfs-folder

Rename special folder to `persistent/` and add support for changing the folder name

Author: rstz

pthreadfs/README.md

@@ -17,6 +17,8 @@ Alternatively, you may enable the API with Chrome's " --enable-runtime-features=
 ```
 open -a /Applications/Google\ Chrome\ Canary.app --args --enable-runtime-features=FileSystemAccessAccessHandle
 ```
+
+Both Storage Foundation API and OPFS are available as [origin trials](https://developer.chrome.com/origintrials/) in Chrome 95.
 ## Getting the code
 
 PthreadFS is available on Github in the [emscripten-pthreadfs](https://github.com/rstz/emscripten-pthreadfs) repository. All code resides in the `pthreadfs` folder. It should be usable with any up-to-date Emscripten version. 
@@ -29,15 +31,17 @@ In order to use the code in a new project, you only need the three files in the
 
 ### Code changes
 
-- PThreadFS maintains a virtual file system. The OPFS backend is mounted at `/pthreadfs/`. Only files in this folder are persisted between sessions. All other files will be stored in-memory through MEMFS.
+- PThreadFS maintains a virtual file system. The OPFS backend is mounted at `/persistent/`. Only files in this folder are persisted between sessions. All other files will be stored in-memory through MEMFS.
+
+You may specify the folder used by PThreadFS by modifying the `PTHREADFS_FOLDER` preprocessor definition, e.g. by compiling with `-DPTHREADFS_FOLDER=mypthreadfsfolder`.
 
 ### Build process changes
 
 There are two changes required to build a project with PThreadFS:
 - Compile `pthreadfs.h` and `pthreadfs.cpp` and link the resulting object to your application. Add `-pthread` to the compiler flag to include support for pthreads.
 - Add the following options to the linking step:
 ```
--pthread -O2 -s PROXY_TO_PTHREAD --js-library=library_pthreadsfs.js
+-pthread -O2 -s PROXY_TO_PTHREAD --js-library=library_pthreadfs.js
 ```
 **Example**
 If your build process was 
@@ -46,7 +50,7 @@ emcc myproject.cpp -o myproject.html
 ```
 Your new build step should be
 ```shell
-emcc -pthread -s PROXY_TO_PTHREAD -O3 --js-library=library_pthreadfs.js myproject.cpp pthreadfs.cpp -o myproject.html
+emcc -pthread -s PROXY_TO_PTHREAD -O2 --js-library=library_pthreadfs.js myproject.cpp pthreadfs.cpp -o myproject.html
 ```
 
 ### Advanced Usage
@@ -62,11 +66,11 @@ See `pthreadfs/examples/emscripten-tests/fsafs.cpp` for exemplary usage.
 
 ## Known Limitations
 
-- All files to be stored using the file system access Access Handles must be stored in the `/pthreadfs` folder.
-- Files in the `/pthreadfs` folder cannot interact through syscalls with other files (e.g. moving, copying, etc.).
+- All files to be stored using the file system access Access Handles must be stored in the `/persistent` folder.
+- Files in the `/persistent` folder cannot interact through syscalls with other files (e.g. moving, copying, etc.).
 - The code is still prototype quality and **should not be used in a production environment** yet. It is possible that the use of PThreadFS might lead to subtle bugs in other libraries.
 - PThreadFS requires PROXY_TO_PTHREAD to be active. In particular, no system calls interacting with the file system should be called from the main thread.
-- Some functionality of the Emscripten File System API is missing, such as sockets, file packager, IndexedDB integration and support for XHRequests.
+- Some functionality of the Emscripten File System API is missing, such as sockets, IndexedDB integration and support for XHRequests.
 - PThreadFS depends on C++ libraries. `EM_PTHREADFS_ASM()` cannot be used within C files.
 - Performance is good if and only if optimizations (compiler option `-O2`) are enabled and DevTools are closed.
 - Accessing the file system before `main()` is called may not work. 

pthreadfs/examples/Makefile

@@ -69,7 +69,7 @@ CFLAGS = \
 	-$(OPTIMIZATION_LEVEL) \
 	-Wall \
 	-pthread \
-	-I..
+	-I.. 
 
 CFLAGS_SQLITE = \
 	$(CFLAGS) \
@@ -144,12 +144,12 @@ preload-tests: dist/$(PRELOADTESTS)/no_pthreadfs.html dist/$(PRELOADTESTS)/prelo
 
 dist/$(PRELOADTESTS)/preload_filepackage.js: $(PRELOADFILES) $(FILE_PACKAGER)
 	mkdir -p dist/preload-tests/
-	python3 $(FILE_PACKAGER) $(addsuffix .data, $(basename $@)) --preload ./$(PRELOADTESTS)/input@/pthreadfs --use_pthreadfs --js-output=$@
+	python3 $(FILE_PACKAGER) $(addsuffix .data, $(basename $@)) --preload ./$(PRELOADTESTS)/input@/persistent --use_pthreadfs --js-output=$@
 
 dist/$(PRELOADTESTS)/preload_pthreadfs.html: $(OBJ)/preload.o $(OBJ)/pthreadfs.o dist/$(PRELOADTESTS)/preload_filepackage.js $(PTHREADFS_JS)
 	mkdir -p dist/preload-tests
 	$(EMCC) $(LINK_FLAGS) -o $@ --js-library=$(PTHREADFS_JS)  --pre-js $(word 3,$^)  $< $(word 2,$^) 
 
 dist/$(PRELOADTESTS)/no_pthreadfs.html: $(OBJ)/preload.o $(PRELOADFILES)
 	mkdir -p dist/preload-tests
-	$(EMCC) $(LINK_FLAGS) -o $@ --preload-file $(PRELOADTESTS)/input@/pthreadfs $<
+	$(EMCC) $(LINK_FLAGS) -o $@ --preload-file $(PRELOADTESTS)/input@/persistent $<

pthreadfs/examples/emscripten-tests/FAIL_early_stat64.cpp

@@ -23,7 +23,7 @@ class EarlyObject {
     puts("Start constructing EarlyObject.");
     int err;
     struct stat s;
-    err = stat("pthreadfs/", &s);
+    err = stat("persistent/", &s);
     assert(!err);
   }
 };

pthreadfs/examples/emscripten-tests/FAIL_links.cpp

@@ -14,9 +14,9 @@ int main() {
   puts("WARNING: This test will fail. Update this message if the test succeeds.");
 
   EM_PTHREADFS_ASM(
-    await PThreadFS.mkdir('pthreadfs/working');
-    await PThreadFS.mkdir('pthreadfs/test');
-    await PThreadFS.chdir('pthreadfs/working');
+    await PThreadFS.mkdir('persistent/working');
+    await PThreadFS.mkdir('persistent/test');
+    await PThreadFS.chdir('persistent/working');
     await PThreadFS.symlink('../test/../there!', 'link');
     await PThreadFS.writeFile('file', 'test');
     await PThreadFS.mkdir('folder');

pthreadfs/examples/emscripten-tests/FAIL_realpath.cpp

@@ -22,16 +22,16 @@ void setup() {
   int err;
   err = mkdir("emptyfolder", 0777);
   assert(!err);
-  err = mkdir("pthreadfs/emptypthreadfsfolder", 0777);
+  err = mkdir("persistent/emptypthreadfsfolder", 0777);
   assert(!err);
   create_file("file.txt", "Some non-pthreadfs file content", 0666);
-  create_file("pthreadfs/pthreadfile.txt", "ride into the super dangerous pthreadFS zone", 0666);
+  create_file("persistent/pthreadfile.txt", "ride into the super dangerous pthreadFS zone", 0666);
 }
 
 void cleanup() {
   rmdir("emptyfolder");
   unlink("file.txt");
-  unlink("pthreadfs/file.txt");
+  unlink("persistent/file.txt");
 }
 
 void test() {
@@ -47,18 +47,18 @@ void test() {
   assert(res);
   printf("emptyfolder/../file.txt is at %s.\n", buf);
 
-  res = realpath("pthreadfs/pthreadfile.txt", buf);
+  res = realpath("persistent/pthreadfile.txt", buf);
   assert(res);
-  printf("pthreadfs/pthreadfile.txt is at %s.\n", buf);
-  res = realpath("pthreadfs/doesnotexist.txt", buf);
+  printf("persistent/pthreadfile.txt is at %s.\n", buf);
+  res = realpath("persistent/doesnotexist.txt", buf);
   assert(!res);
-  printf("pthreadfs/doesnotexist.txt does not exist.\n");
-  res = realpath("emptyfolder/../pthreadfs/pthreadfsfile.txt", buf);
+  printf("persistent/doesnotexist.txt does not exist.\n");
+  res = realpath("emptyfolder/../persistent/pthreadfsfile.txt", buf);
   assert(res);
-  printf("emptyfolder/../pthreadfs/pthreadfsfile.txt is at %s.\n", buf);
-  res = realpath("pthreadfs/emptypthreadfsfolder/../file.txt", buf);
+  printf("emptyfolder/../persistent/pthreadfsfile.txt is at %s.\n", buf);
+  res = realpath("persistent/emptypthreadfsfolder/../file.txt", buf);
   assert(res);
-  printf("pthreadfs/emptypthreadfsfolder/../file.txt is at %s.\n", buf);
+  printf("persistent/emptypthreadfsfolder/../file.txt is at %s.\n", buf);
 
   puts("success");
 }

pthreadfs/examples/emscripten-tests/fsafs.cpp

@@ -8,12 +8,12 @@
 int main () {
   std::cout << "Proof that stdout works fine.\n";
   std::ofstream myfile;
-  myfile.open ("pthreadfs/example");
+  myfile.open ("persistent/example");
   myfile << "Writing a few characters.\n";
   myfile.close();
 
   std::string line;
-  std::ifstream myfile_read ("pthreadfs/example");
+  std::ifstream myfile_read ("persistent/example");
 
   if (myfile_read.is_open()) {
     std::getline(myfile_read, line);
@@ -22,15 +22,15 @@ int main () {
     myfile_read.close();
   }
 
-  std::ofstream stream1 ("pthreadfs/multistreamexample");
-  std::ofstream stream2 ("pthreadfs/multistreamexample");
+  std::ofstream stream1 ("persistent/multistreamexample");
+  std::ofstream stream2 ("persistent/multistreamexample");
   stream1 << "Write a line through stream1.\n";
   stream2 << "Write a line through stream2.\n";
   stream1.close();
   stream2.close();
 
-  std::remove("pthreadfs/multistreamexample"); 
-  bool can_open_deleted_file = (bool) std::ifstream("pthreadfs/multistreamexample");
+  std::remove("persistent/multistreamexample"); 
+  bool can_open_deleted_file = (bool) std::ifstream("persistent/multistreamexample");
   if(!can_open_deleted_file) { 
     std::cout << "Opening deleted file failed, as expected.\n"; 
   }

pthreadfs/examples/emscripten-tests/multiple_threads.cpp

@@ -5,13 +5,13 @@
 #include <vector>
 #include <thread>
 #include <emscripten.h>
-#include "pthreadfs.h"
+
 
 
 void threadMain(int msg) {
   size_t thread_id = std::hash<std::thread::id>{}(std::this_thread::get_id());
   std::ofstream myfile;
-  myfile.open ("pthreadfs/multi_threading_example", std::ios_base::app);
+  myfile.open ("persistent/multi_threading_example", std::ios_base::app);
   myfile << "Writing from thread " << msg << " Id: " << thread_id << "   ";
   myfile.close();
   EM_ASM({console.log(`Wrote on thread ${$0}`);}, thread_id);
@@ -20,7 +20,7 @@ void threadMain(int msg) {
 
 int main () {
   EM_ASM({console.log("Hello from main");});
-  std::remove("pthreadfs/multi_threading_example"); 
+  std::remove("persistent/multi_threading_example"); 
 
   constexpr int number_of_threads = 10;
 
@@ -34,7 +34,7 @@ int main () {
   }
 
   std::ofstream myfile;
-  myfile.open ("pthreadfs/multi_threading_example");
+  myfile.open ("persistent/multi_threading_example");
   myfile << "Writing the main thread.\n";
   myfile.close();
 

pthreadfs/examples/emscripten-tests/open_options.cpp

@@ -33,8 +33,8 @@ void create_file(const char *path, const char *buffer, int mode) {
 void setup() {
   // struct utimbuf t = {1200000000, 1200000000};
 
-  mkdir("pthreadfs/folder", 0777);
-  create_file("pthreadfs/folder/file", "abcdef", 0777);
+  mkdir("persistent/folder", 0777);
+  create_file("persistent/folder/file", "abcdef", 0777);
   //symlink("file", "folder/file-link");
 
   //utime("folder/file", &t);
@@ -44,13 +44,13 @@ void setup() {
 }
 
 void cleanup() {
-  unlink("pthreadfs/folder/file");
+  unlink("persistent/folder/file");
   // unlink("folder/file-link");
-  rmdir("pthreadfs/folder");
+  rmdir("persistent/folder");
 }
 
 void test() {
-  create_file("pthreadfs/folder/file", "blubbbbb", 0777);
+  create_file("persistent/folder/file", "blubbbbb", 0777);
 }
 
 int main() {

pthreadfs/examples/emscripten-tests/readdir.cpp

@@ -32,17 +32,17 @@ void setup() {
   assert(!err);
   err = mkdir("foobar", 0777);
   assert(!err);
-  err = mkdir("pthreadfs/readdir_test", 0777);
+  err = mkdir("persistent/readdir_test", 0777);
   create_file("foobar/file.txt", "ride into the danger zone", 0666);
-  create_file("pthreadfs/readdir_test/file.txt", "ride into the super dangerous pthreadFS zone", 0666);
+  create_file("persistent/readdir_test/file.txt", "ride into the super dangerous pthreadFS zone", 0666);
 }
 
 void cleanup() {
   rmdir("nocanread");
   unlink("foobar/file.txt");
   rmdir("foobar");
-  unlink("pthreadfs/readdir_test/file.txt");
-  rmdir("pthreadfs/readdir_test");
+  unlink("persistent/readdir_test/file.txt");
+  rmdir("persistent/readdir_test");
 }
 
 void test(const char* foldername) {
@@ -193,7 +193,7 @@ int main() {
   setup();
   test("foobar");
   test_scandir();
-  test("pthreadfs/readdir_test");
+  test("persistent/readdir_test");
   cleanup();
   return EXIT_SUCCESS;
 }

pthreadfs/examples/emscripten-tests/remove.cpp

@@ -31,18 +31,18 @@ void create_file(const char *path, const char *buffer, int mode) {
 }
 
 void setup() {
-  mkdir("pthreadfs/folder", 0777);
-  create_file("pthreadfs/folder/file", "abcdef", 0777);
+  mkdir("persistent/folder", 0777);
+  create_file("persistent/folder/file", "abcdef", 0777);
 }
 
 void cleanup() {
-  unlink("pthreadfs/folder/file");
-  rmdir("pthreadfs/folder");
+  unlink("persistent/folder/file");
+  rmdir("persistent/folder");
 }
 
 void test() {
-  remove("pthreadfs/folder/file");
-  remove("pthreadfs/folder");
+  remove("persistent/folder/file");
+  remove("persistent/folder");
   puts("success");
 }
 

pthreadfs/examples/emscripten-tests/rename.cpp

@@ -2,7 +2,7 @@
 #include <fstream>
 #include <cstdio>
 #include <emscripten.h>
-#include "pthreadfs.h"
+
 
 int main()
 {
@@ -48,36 +48,36 @@ int main()
 
   // PThreadFS file that is closed when renaming.
   std::ofstream closed_pthreadfs_file;
-  closed_pthreadfs_file.open ("pthreadfs/old_closed_pthreadfs_file");
+  closed_pthreadfs_file.open ("persistent/old_closed_pthreadfs_file");
   closed_pthreadfs_file << "Contents of closed_pthreadfs_file.";
   closed_pthreadfs_file.close();
 
-  if (std::rename("pthreadfs/old_closed_pthreadfs_file", "pthreadfs/new_closed_pthreadfs_file")) {
+  if (std::rename("persistent/old_closed_pthreadfs_file", "persistent/new_closed_pthreadfs_file")) {
     std::cout << "Error renaming closed_pthreadfs_file\n";
     return 1;
   }
   std::cout << "Rename closed_pthreadfs_file successfully\n";
   closed_pthreadfs_file.close();
 
-  if(std::remove("pthreadfs/new_closed_pthreadfs_file")) {
+  if(std::remove("persistent/new_closed_pthreadfs_file")) {
     std::cout << "Removing closed_pthreadfs_file failed\n";
     return 1;
   }
   std::cout << "Removed closed_pthreadfs_file\n";
 
   // PThreadFS file that is open when renaming.
   std::ofstream open_pthreadfs_file;
-  open_pthreadfs_file.open ("pthreadfs/old_open_pthreadfs_file");
+  open_pthreadfs_file.open ("persistent/old_open_pthreadfs_file");
   open_pthreadfs_file << "Contents of open_pthreadfs_file.";
 
-  if (std::rename("pthreadfs/old_open_pthreadfs_file", "pthreadfs/new_open_pthreadfs_file")) {
+  if (std::rename("persistent/old_open_pthreadfs_file", "persistent/new_open_pthreadfs_file")) {
     std::cout << "Error renaming open_pthreadfs_file\n";
     return 1;
   }
   std::cout << "Rename open_pthreadfs_file successfully\n";
   open_pthreadfs_file.close();
 
-  if(std::remove("pthreadfs/new_open_pthreadfs_file")) {
+  if(std::remove("persistent/new_open_pthreadfs_file")) {
     std::cout << "Removing open_pthreadfs_file failed.\n";
     std::cout << "This is expected when using the OPFS backend.\n";
     return 1;