varun-r-mallya/sysprof
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/sysprof.git synced 2025-12-31 20:36:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

libsysprof-analyze: add various docs

Browse Source 
These functions have some transfer semantics, so even though they are
private API, make sure that we document it for the future.
This commit is contained in:
Christian Hergert
2023-05-04 14:32:33 -07:00
parent 89fb7329a8
commit 17eaa7a610
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/libsysprof-analyze/sysprof-memory-map.c
View File

@ -91,6 +91,17 @@ mapped_file_bsearch (gconstpointer keyptr,
return 0;
}
/**
* sysprof_memory_map_new:
* @mapped_files: (transfer full): a #GPtrArray of #SysprofMappedFile
*
* Creates a new #SysprofMemoryMap that can be used to locate a mapped
* file which contains a particular address within a target process.
*
* You should use SysprofMemoryMapBuilder instead of this function.
*
* Returns: (transfer full): a #SysprofMemoryMap
*/
SysprofMemoryMap *
sysprof_memory_map_new (GPtrArray *mapped_files)
{
@ -107,6 +118,16 @@ sysprof_memory_map_new (GPtrArray *mapped_files)
return self;
}
/**
* sysprof_memory_map_find_at_address:
* @self: a #SysprofMemoryMap
* @address: an address
*
* Attempts to locate the #SysprofMappedFile which contains @address.
*
* Returns: (transfer none) (nullable): a #SysprofMappedFile if there
* was a mapping containing @address, otherwise %NULL.
*/
SysprofMappedFile *
sysprof_memory_map_find_at_address (SysprofMemoryMap *self,
guint64 address)