summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/sqlite3_memory_used.3
diff options
context:
space:
mode:
Diffstat (limited to 'static/netbsd/man3/sqlite3_memory_used.3')
-rw-r--r--static/netbsd/man3/sqlite3_memory_used.362
1 files changed, 62 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3_memory_used.3 b/static/netbsd/man3/sqlite3_memory_used.3
new file mode 100644
index 00000000..dca1ebd4
--- /dev/null
+++ b/static/netbsd/man3/sqlite3_memory_used.3
@@ -0,0 +1,62 @@
+.Dd January 24, 2024
+.Dt SQLITE3_MEMORY_USED 3
+.Os
+.Sh NAME
+.Nm sqlite3_memory_used ,
+.Nm sqlite3_memory_highwater
+.Nd memory allocator statistics
+.Sh SYNOPSIS
+.In sqlite3.h
+.Ft sqlite3_int64
+.Fo sqlite3_memory_used
+.Fa "void"
+.Fc
+.Ft sqlite3_int64
+.Fo sqlite3_memory_highwater
+.Fa "int resetFlag"
+.Fc
+.Sh DESCRIPTION
+SQLite provides these two interfaces for reporting on the status of
+the
+.Fn sqlite3_malloc ,
+.Fn sqlite3_free ,
+and
+.Fn sqlite3_realloc
+routines, which form the built-in memory allocation subsystem.
+.Pp
+The
+.Fn sqlite3_memory_used
+routine returns the number of bytes of memory currently outstanding
+(malloced but not freed).
+The
+.Fn sqlite3_memory_highwater
+routine returns the maximum value of
+.Fn sqlite3_memory_used
+since the high-water mark was last reset.
+The values returned by
+.Fn sqlite3_memory_used
+and
+.Fn sqlite3_memory_highwater
+include any overhead added by SQLite in its implementation of
+.Fn sqlite3_malloc ,
+but not overhead added by the any underlying system library routines
+that
+.Fn sqlite3_malloc
+may call.
+.Pp
+The memory high-water mark is reset to the current value of
+.Fn sqlite3_memory_used
+if and only if the parameter to
+.Fn sqlite3_memory_highwater
+is true.
+The value returned by sqlite3_memory_highwater(1)
+is the high-water mark prior to the reset.
+.Sh IMPLEMENTATION NOTES
+These declarations were extracted from the
+interface documentation at line 3075.
+.Bd -literal
+SQLITE_API sqlite3_int64 sqlite3_memory_used(void);
+SQLITE_API sqlite3_int64 sqlite3_memory_highwater(int resetFlag);
+.Ed
+.Sh SEE ALSO
+.Xr sqlite3_malloc 3