[1/2] Document cache information sysconf variables

Message ID 1507722824-9648-1-git-send-email-siddhesh@sourceware.org
State Committed
Headers

Commit Message

Siddhesh Poyarekar Oct. 11, 2017, 11:53 a.m. UTC
  Write short one line descriptions for each of the cache information sysconf
variables.

	* manual/conf.texi (_SC_LEVEL1_ICACHE_SIZE,
	_SC_LEVEL1_ICACHE_ASSOC, _SC_LEVEL1_ICACHE_LINESIZE,
	_SC_LEVEL1_DCACHE_SIZE, _SC_LEVEL1_DCACHE_ASSOC,
	_SC_LEVEL1_DCACHE_LINESIZE, _SC_LEVEL2_CACHE_SIZE,
	_SC_LEVEL2_CACHE_ASSOC, _SC_LEVEL2_CACHE_LINESIZE,
	_SC_LEVEL3_CACHE_SIZE, _SC_LEVEL3_CACHE_ASSOC,
	_SC_LEVEL3_CACHE_LINESIZE, _SC_LEVEL4_CACHE_SIZE,
	_SC_LEVEL4_CACHE_ASSOC, _SC_LEVEL4_CACHE_LINESIZE): New
	variables.
---
 manual/conf.texi | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
  

Comments

Rical Jasan Oct. 18, 2017, 5:49 a.m. UTC | #1
On 10/11/2017 04:53 AM, Siddhesh Poyarekar wrote:
> Write short one line descriptions for each of the cache information sysconf
> variables.
> 
> 	* manual/conf.texi (_SC_LEVEL1_ICACHE_SIZE,
> 	_SC_LEVEL1_ICACHE_ASSOC, _SC_LEVEL1_ICACHE_LINESIZE,
> 	_SC_LEVEL1_DCACHE_SIZE, _SC_LEVEL1_DCACHE_ASSOC,
> 	_SC_LEVEL1_DCACHE_LINESIZE, _SC_LEVEL2_CACHE_SIZE,
> 	_SC_LEVEL2_CACHE_ASSOC, _SC_LEVEL2_CACHE_LINESIZE,
> 	_SC_LEVEL3_CACHE_SIZE, _SC_LEVEL3_CACHE_ASSOC,
> 	_SC_LEVEL3_CACHE_LINESIZE, _SC_LEVEL4_CACHE_SIZE,
> 	_SC_LEVEL4_CACHE_ASSOC, _SC_LEVEL4_CACHE_LINESIZE): New
> 	variables.
> ---
>  manual/conf.texi | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 61 insertions(+)
> 
> diff --git a/manual/conf.texi b/manual/conf.texi
> index 875862c..503b240 100644
> --- a/manual/conf.texi
> +++ b/manual/conf.texi
> @@ -678,6 +678,67 @@ Inquire about the number of available physical pages in the system.
>  Inquire about the number of functions which can be registered as termination
>  functions for @code{atexit}; @pxref{Cleanups on Exit}.
>  
> +@item _SC_LEVEL1_ICACHE_SIZE
> +@standards{GNU, unistd.h}
> +Inquire about the size of the Level 1 instruction cache.
> +
> +@item _SC_LEVEL1_ICACHE_ASSOC
> +@standards{GNU, unistd.h}
> +Inquire about associativity of the Level 1 instruction cache.

I think this should be "the associativity".

> +
> +@item _SC_LEVEL1_ICACHE_LINESIZE
> +@standards{GNU, unistd.h}
> +Inquire about the line length of the Level 1 instruction cache.
> +
> +@item _SC_LEVEL1_DCACHE_SIZE
> +@standards{GNU, unistd.h}
> +Inquire about the size of the Level 1 data cache.
> +
> +@item _SC_LEVEL1_DCACHE_ASSOC
> +@standards{GNU, unistd.h}
> +Inquire about associativity of the Level 1 data cache.
> +
> +@item _SC_LEVEL1_DCACHE_LINESIZE
> +@standards{GNU, unistd.h}
> +Inquire about the line length of the Level 1 data cache.
> +
> +@item _SC_LEVEL2_CACHE_SIZE
> +@standards{GNU, unistd.h}
> +Inquire about the size of the Level 2 cache.
> +
> +@item _SC_LEVEL2_CACHE_ASSOC
> +@standards{GNU, unistd.h}
> +Inquire about associativity of the Level 2 cache.
> +
> +@item _SC_LEVEL2_CACHE_LINESIZE
> +@standards{GNU, unistd.h}
> +Inquire about the line length of the Level 2 cache.
> +
> +@item _SC_LEVEL3_CACHE_SIZE
> +@standards{GNU, unistd.h}
> +Inquire about the size of the Level 3 cache.
> +
> +@item _SC_LEVEL3_CACHE_ASSOC
> +@standards{GNU, unistd.h}
> +Inquire about associativity of the Level 3 cache.
> +
> +@item _SC_LEVEL3_CACHE_LINESIZE
> +@standards{GNU, unistd.h}
> +Inquire about the line length of the Level 3 cache.
> +
> +@item _SC_LEVEL4_CACHE_SIZE
> +@standards{GNU, unistd.h}
> +Inquire about the size of the Level 4 cache.
> +
> +@item _SC_LEVEL4_CACHE_ASSOC
> +@standards{GNU, unistd.h}
> +Inquire about associativity of the Level 4 cache.
> +
> +@item _SC_LEVEL4_CACHE_LINESIZE
> +@standards{GNU, unistd.h}
> +Inquire about the line length of the Level 4 cache.
> +
> +

Don't need the extra newline.

>  @item _SC_XOPEN_VERSION
>  @standards{X/Open, unistd.h}
>  Inquire about the parameter corresponding to @code{_XOPEN_VERSION}.

Otherwise, LGTM.

Rical
  
Siddhesh Poyarekar Oct. 23, 2017, 2:55 p.m. UTC | #2
On Wednesday 18 October 2017 11:19 AM, Rical Jasan wrote:
>>  @item _SC_XOPEN_VERSION
>>  @standards{X/Open, unistd.h}
>>  Inquire about the parameter corresponding to @code{_XOPEN_VERSION}.
> 
> Otherwise, LGTM.

Thanks, pushed with nits fixed.

Siddhesh
  

Patch

diff --git a/manual/conf.texi b/manual/conf.texi
index 875862c..503b240 100644
--- a/manual/conf.texi
+++ b/manual/conf.texi
@@ -678,6 +678,67 @@  Inquire about the number of available physical pages in the system.
 Inquire about the number of functions which can be registered as termination
 functions for @code{atexit}; @pxref{Cleanups on Exit}.
 
+@item _SC_LEVEL1_ICACHE_SIZE
+@standards{GNU, unistd.h}
+Inquire about the size of the Level 1 instruction cache.
+
+@item _SC_LEVEL1_ICACHE_ASSOC
+@standards{GNU, unistd.h}
+Inquire about associativity of the Level 1 instruction cache.
+
+@item _SC_LEVEL1_ICACHE_LINESIZE
+@standards{GNU, unistd.h}
+Inquire about the line length of the Level 1 instruction cache.
+
+@item _SC_LEVEL1_DCACHE_SIZE
+@standards{GNU, unistd.h}
+Inquire about the size of the Level 1 data cache.
+
+@item _SC_LEVEL1_DCACHE_ASSOC
+@standards{GNU, unistd.h}
+Inquire about associativity of the Level 1 data cache.
+
+@item _SC_LEVEL1_DCACHE_LINESIZE
+@standards{GNU, unistd.h}
+Inquire about the line length of the Level 1 data cache.
+
+@item _SC_LEVEL2_CACHE_SIZE
+@standards{GNU, unistd.h}
+Inquire about the size of the Level 2 cache.
+
+@item _SC_LEVEL2_CACHE_ASSOC
+@standards{GNU, unistd.h}
+Inquire about associativity of the Level 2 cache.
+
+@item _SC_LEVEL2_CACHE_LINESIZE
+@standards{GNU, unistd.h}
+Inquire about the line length of the Level 2 cache.
+
+@item _SC_LEVEL3_CACHE_SIZE
+@standards{GNU, unistd.h}
+Inquire about the size of the Level 3 cache.
+
+@item _SC_LEVEL3_CACHE_ASSOC
+@standards{GNU, unistd.h}
+Inquire about associativity of the Level 3 cache.
+
+@item _SC_LEVEL3_CACHE_LINESIZE
+@standards{GNU, unistd.h}
+Inquire about the line length of the Level 3 cache.
+
+@item _SC_LEVEL4_CACHE_SIZE
+@standards{GNU, unistd.h}
+Inquire about the size of the Level 4 cache.
+
+@item _SC_LEVEL4_CACHE_ASSOC
+@standards{GNU, unistd.h}
+Inquire about associativity of the Level 4 cache.
+
+@item _SC_LEVEL4_CACHE_LINESIZE
+@standards{GNU, unistd.h}
+Inquire about the line length of the Level 4 cache.
+
+
 @item _SC_XOPEN_VERSION
 @standards{X/Open, unistd.h}
 Inquire about the parameter corresponding to @code{_XOPEN_VERSION}.