Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions basis-library/mpl/file.sig
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ sig
exception Closed

val openFile: string -> t
val openFileWriteable: string -> int -> {file : t, file_size: int}
val closeFile: t -> unit
val size: t -> int

Expand All @@ -21,4 +22,7 @@ sig

val readChars: t -> int -> char ArraySlice.slice -> unit
val readWord8s: t -> int -> Word8.word ArraySlice.slice -> unit
val writeChar : {file: t, file_offset: int, array_slice_offset: int} -> char -> unit
val writeWord8s : {file: t, file_offset: int, array_slice_offset: int} -> Word8.word ArraySlice.slice -> unit
Copy link
Copy Markdown
Collaborator

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 n gives us a file of n bytes. So, then, writeChar should be able to pass a single offset, somewhere in the range [0,n).

Copy link
Copy Markdown
Author

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_offset and the array slice.

The new interfaces are

  val writeChar : {file: t, file_offset: int} -> char -> unit
  val writeWord8s : {file: t, file_offset: int} -> Word8.word ArraySlice.slice -> unit


end
35 changes: 35 additions & 0 deletions basis-library/mpl/file.sml
Original file line number Diff line number Diff line change
Expand Up @@ -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])
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious, what happens here if the file already exists? Does createf behave like openf in that case?

Copy link
Copy Markdown
Author

@pranav1344 pranav1344 Feb 17, 2026

Choose a reason for hiding this comment

The 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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this just be final_size ?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The 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 file_size and then append it to the file, the code then returns the increased size of the file mapped to the memory as well as the "offset" from there user can start writing to the file. I've renamed this variable to buffer_size for better clarity on what the code is trying to do.

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)
Expand Down Expand Up @@ -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
4 changes: 4 additions & 0 deletions basis-library/primitive/prim-mpl.sml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,12 @@ struct
Pointer.t * Char8.t array * C_Size.word * C_Size.word -> unit;
val copyWord8sToBuffer = _import "GC_memcpyToBuffer" runtime private:
Pointer.t * Word8.word array * C_Size.word * C_Size.word -> unit;
val copyWord8sFromBuffer = _import "GC_memcpyFromBuffer" runtime private:
Pointer.t * Word8.word array * C_Size.word * C_Size.word -> unit;
val mmapFileReadable = _import "GC_mmapFileReadable" runtime private:
C_Int.int * C_Size.word -> Pointer.t;
val mmapFileWriteable = _import "GC_mmapFileWriteable" runtime private:
C_Int.int * C_Size.word -> Pointer.t;
val release = _import "GC_release" runtime private:
Pointer.t * C_Size.word -> unit;
end
Expand Down
24 changes: 24 additions & 0 deletions examples/lib/WriteFile.sml
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
5 changes: 5 additions & 0 deletions runtime/gc/virtual-memory.c
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ void GC_memcpyToBuffer(pointer src, pointer buffer, size_t offset, size_t length
GC_memcpy(src, buffer + offset, length);
}

void GC_memcpyFromBuffer(pointer des, pointer buffer, size_t offset, size_t length) {
GC_memcpy(buffer + offset, des, length);
}


static inline void GC_memmove (pointer src, pointer dst, size_t size) {
if (DEBUG_DETAILED)
fprintf (stderr, "GC_memmove ("FMTPTR", "FMTPTR", %"PRIuMAX")\n",
Expand Down
1 change: 1 addition & 0 deletions runtime/platform.h
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ PRIVATE __attribute__ ((noreturn)) void MLton_heapCheckTooLarge (void);
PRIVATE void GC_displayMem (void);

PRIVATE void GC_memcpyToBuffer(pointer src, pointer buffer, size_t offset, size_t length);
PRIVATE void GC_memcpyFromBuffer(pointer des, pointer buffer, size_t offset, size_t length);

PRIVATE void *GC_mmapFileReadable (int fd, size_t size);
PRIVATE void *GC_mmapAnon (void *start, size_t length);
Expand Down
4 changes: 4 additions & 0 deletions runtime/platform/mmap.c
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ static inline void *mmapFileReadable (int fd, size_t size) {
return mmap (0, size, PROT_READ, MAP_PRIVATE, fd, 0);
}

static inline void *mmapFileWriteable (int fd, size_t size) {
return mmap (0, size, PROT_WRITE, MAP_SHARED, fd, 0);
}

static inline void *mmapAnonFlags (void *start, size_t length, int flags) {
return mmap (start, length, PROT_READ | PROT_WRITE,
MAP_PRIVATE | MAP_ANON | flags, -1, 0);
Expand Down
4 changes: 4 additions & 0 deletions runtime/platform/use-mmap.c
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ void *GC_mmapFileReadable (int fd, size_t size) {
return mmapFileReadable(fd, size);
}

void *GC_mmapFileWriteable (int fd, size_t size) {
return mmapFileWriteable(fd, size);
}

void *GC_mmapAnon (void *start, size_t length) {
return mmapAnon (start, length);
}
Expand Down