-
Notifications
You must be signed in to change notification settings - Fork 27
Interfaces for writing to files using mmap #237
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 2 commits
4188125
f894a16
c9a5c24
0ea3379
2c1ff5d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,6 +34,20 @@ struct | |
| (ptr, size, ref true) | ||
| end | ||
|
|
||
| fun openFileWriteable path final_size = | ||
| let | ||
| open Posix.FileSys | ||
| val file = createf (path, O_RDWR, O.append, S.flags [S.irusr, S.iwusr, S.irgrp, S.iroth]) | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm curious, what happens here if the file already exists? Does
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes. In case the file already exists, it works as openf and opens the file in append mode. The user can then start writing from where the file originally ended. |
||
| val fileSize = Position.toInt (ST.size (fstat file)) | ||
| val size = final_size + fileSize | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't this just be
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The idea was to take the size of the expected input to the file from the user in |
||
| val fd = C_Int.fromInt (SysWord.toInt (fdToWord file)) | ||
| val _ = ftruncate (file, Position.fromInt size) | ||
| val ptr = mmapFileWriteable (fd, C_Size.fromInt size) | ||
| in | ||
| Posix.IO.close file; | ||
| {file = (ptr, size, ref true), file_size = fileSize} | ||
| end | ||
|
|
||
| fun closeFile (ptr, size, stillOpen) = | ||
| if !stillOpen then | ||
| (release (ptr, C_Size.fromInt size); stillOpen := false) | ||
|
|
@@ -88,4 +102,25 @@ struct | |
| raise Closed | ||
| end | ||
|
|
||
| fun writeChar {file = (ptr, size, stillOpen), file_offset = fileSize, array_slice_offset = i} c = | ||
| if !stillOpen andalso i >= 0 andalso i < size then | ||
| MLton.Pointer.setWord8 (ptr, i + fileSize, Primitive.Char8.idToWord8 c) | ||
| else if i < 0 orelse i >= size then | ||
| raise Subscript | ||
| else | ||
| raise Closed | ||
|
|
||
| fun writeWord8s {file = (ptr, size, stillOpen), file_offset = file_offset, array_slice_offset = i} slice = | ||
| let | ||
| val (arr, j, n) = ArraySlice.base slice | ||
| val start = MLtonPointer.add (ptr, Word.fromInt file_offset) | ||
| in | ||
| if !stillOpen andalso i >= 0 andalso file_offset + (n - i) <= size then | ||
| copyWord8sFromBuffer (start, arr, C_Size.fromInt (i + j), C_Size.fromInt (n - i)) | ||
| else if i < 0 orelse i + n > size then | ||
| raise Subscript | ||
| else | ||
| raise Closed | ||
| end | ||
|
|
||
| end | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| structure WriteFile: | ||
| sig | ||
| val writeBinSeq: {filename: string, content: Word8.word Seq.t} -> unit | ||
| end = | ||
| struct | ||
|
|
||
| fun writeBinSeq {filename, content} = | ||
| let | ||
| val n = Seq.length content | ||
| val {file, file_size = oldSize} = MPL.File.openFileWriteable filename n | ||
| val k = 10000 | ||
| val m = 1 + (n-1) div k | ||
| in | ||
| ForkJoin.parfor 1 (0, m) (fn i => | ||
| let | ||
| val lo = i*k | ||
| val hi = Int.min ((i+1)*k, n) | ||
| in | ||
| MPL.File.writeWord8s { file = file , file_offset = oldSize + lo, array_slice_offset = 0} (Seq.subseq content (lo, hi-lo)) | ||
| end | ||
| ); | ||
| MPL.File.closeFile file | ||
| end | ||
| end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here I find the two offsets confusing; I think it would be easier to just pass a single offset.
My understanding is that
openFileWriteable s ngives us a file ofnbytes. So, then,writeCharshould be able to pass a single offset, somewhere in the range[0,n).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The two offsets are to handle the index to which the buffer should start writing and the second index is the index from which the array slice is supposed to write. It was a case of leaking abstraction and was probably user hostile, so I've changed the interface to take in just an offset where the file starts writing
file_offsetand the array slice.The new interfaces are