fluffos/docs/efun/system/function_profile.md
gesslar 1ad5953549
docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251)
* empty

* docs: validate "See Also" references, drop dead ones, document valid_ffi

Reviewed the "See Also" section of every doc and dropped man-page
cross-references whose target page does not exist (verified against the
driver source, not just the docs tree):

  - errorp, each, opcprof, dump_socket_status, extract, shadowp,
    destruct_env_of, move, inventory_visible, inventory_accessible

These name efuns/applies that no longer exist in FluffOS. keys/values now
point at the `for` construct in place of the defunct `each` efun.

valid_ffi was the one "referenced but undocumented" case: it is a real
master apply (APPLY_VALID_FFI) gating every ffi_load/symbol/prepare/
callback, so it gets a proper apply page rather than having its references
removed. Sidebar regenerated to include it.

The 13 modern markdown-link "See Also" sections were already clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-12 01:09:17 -04:00

38 lines
1 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: system / function_profile
---
# function_profile
### NAME
function_profile() - get function profiling information for an object
### SYNOPSIS
mapping *function_profile( object ob );
### DESCRIPTION
Returns function profiling information for 'ob', or this_object() if
'ob' is not specified. This is only available if the driver was com
piled with PROFILE_FUNCTIONS defined.
### RETURN VALUE
An array of mappings is returned, one for each function in 'ob', the
format of the mapping is:
([ "name" : name_of_the_function,
"calls" : number_of_calls,
/* cpu time expressed in microseconds */
"self" : cpu_time_spent_in self,
"children" : cpu_time_spent_in_children
])
The usefulness of this is tied to the resolution of the CPU clock--even
though the units are microseconds, the CPU timer resolution is often
much less
### SEE ALSO
rusage(3), time_expression(3)