| Title | mps_arena_vm_growth is not documented |
| Status | open |
| Priority | nice |
| Assigned user | Gareth Rees |
| Organization | Ravenbrook |
| Description | In mpsavm.h [1] the external symbol mps_arena_vm_growth is declared, but this is not documented. |
| Analysis | This function sets the extendBy and extendMin values for the VM arena. What's the underlying user requirement? Looking at the original customer request [2] that led to this function, it seems that the requirement here is to extend the arena only a little at a time when address space is tight, to leave address space available for other libraries. So there is a genuine requirement here. From a design and documentation point of view, it would be nice if there were a parallel between the arena settings and the keyword arguments. At the moment we have: Keyword argument Setter function =================== ====================== COMMIT_LIMIT commit_limit_set SPARE_COMMIT_LIMIT spare_commit_limit_set PAUSE_TIME pause_time_set -- clamp/park/release -- vm_growth [*] [*] Should probably be called extend_by to match other settings. |
| How found | inspection |
| Evidence | [1] <http://www.ravenbrook.com/project/mps/master/code/mpsavm.h>[2] < https://info.ravenbrook.com/mail/2007/12/19/12-17-36/0/> |
| Observed in | 1.111.0 |
| Created by | Gareth Rees |
| Created on | 2013-03-19 11:06:24 |
| Last modified by | Gareth Rees |
| Last modified on | 2018-08-28 11:17:40 |
| History | 2013-03-19 GDR Created. 2014-04-10 GDR Analysis. |