update documentation

1 files changed, 13 insertions, 0 deletions

diff --git a/doc/mimalloc-doc.h b/doc/mimalloc-doc.h
index f11a97b..c9cb580 100644
--- a/doc/mimalloc-doc.h
+++ b/doc/mimalloc-doc.h
@@ -441,6 +441,19 @@ int mi_reserve_huge_os_pages_at(size_t pages, int numa_node, size_t timeout_msec
 /// Currenty only used on Windows.
 bool mi_is_redirected();
 
+/// Return process information (time and memory usage).
+/// @param user_msecs      Optional. User time in milli-seconds.
+/// @param system_msecs    Optional. System time in milli-seconds.
+/// @param current_rss     Optional. Current working set size (touched pages).
+/// @param peak_rss        Optional. Peak working set size (touched pages).
+/// @param current_commit  Optional. Current committed memory (backed by the page file).
+/// @param peak_commit     Optional. Peak committed memory (backed by the page file).
+/// @param page_faults     Optional. Count of hard page faults.
+///
+/// The \a current_rss is precise on Windows and MacOSX; other systems estimate
+/// this using \a current_commit. The \a commit is precise on Windows but estimated
+/// on other systems as the amount of read/write accessible memory reserved by mimalloc.
+void mi_process_info(size_t* user_msecs, size_t* system_msecs, size_t* current_rss, size_t* peak_rss, size_t* current_commit, size_t* peak_commit, size_t* page_faults);
 
 /// \}