ParaMonte MATLAB 3.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
info.m File Reference

Go to the source code of this file.

Functions

function info ()
 Return a MATLAB string and the corresponding cache file path containing the current system information.
More...
 

Function Documentation

◆ info()

function info ( )

Return a MATLAB string and the corresponding cache file path containing the current system information.

Returns
txt : The output scalar MATLAB string containing the current system information.
cache : The output scalar MATLAB string representing the path to the cache file containing the current system information.
The returned cache file path has the form:
<DIR>/.info<YEAR><MONTH>.cache<br>
where,
  1. <DIR> is replaced by the directory containing the function pm.sys.info(),
  2. <YEAR> is replaced by the current year,
  3. <MONTH> is replaced by the current month.
This means that the cache file contents are supposed to be updated only every month if necessary.
A cache file is generated because retrieving system information is an expensive shell command-line operation.
The time expense is particularly notable on Windows systems.


Possible calling interfaces

[txt, cache] = pm.sys.info()


Example usage

1cd(fileparts(mfilename('fullpath'))); % Change working directory to source code directory.
2addpath('../../../'); % Add the ParaMonte library root directory to the search path.
3
4pm.matlab.show()
5pm.matlab.show('pm.sys.info()')
6pm.matlab.show( pm.sys.info() )
7
8pm.matlab.show()
9pm.matlab.show('[str, cache] = pm.sys.info();')
10 [str, cache] = pm.sys.info();
11pm.matlab.show('cache')
12pm.matlab.show( cache )
13pm.matlab.show('str')
14pm.matlab.show( str )
function root()
Return a scalar MATLAB string containing the root directory of the ParaMonte library package.

Example output
1
2pm.sys.info()
3Linux amir 5.15.167.4-microsoft-standard-WSL2 #1 SMP Tue Nov 5 00:21:55 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
4Architecture: x86_64
5 CPU op-mode(s): 32-bit, 64-bit
6 Address sizes: 46 bits physical, 48 bits virtual
7 Byte Order: Little Endian
8CPU(s): 24
9 On-line CPU(s) list: 0-23
10Vendor ID: GenuineIntel
11 Model name: 12th Gen Intel(R) Core(TM) i9-12950HX
12 CPU family: 6
13 Model: 151
14 Thread(s) per core: 2
15 Core(s) per socket: 12
16 Socket(s): 1
17 Stepping: 2
18 BogoMIPS: 4992.01
19 Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge m
20 ca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht sysc
21 all nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xt
22 opology tsc_reliable nonstop_tsc cpuid pni pclmulqdq v
23 mx ssse3 fma cx16 pcid sse4_1 sse4_2 x2apic movbe popc
24 nt tsc_deadline_timer aes xsave avx f16c rdrand hyperv
25 isor lahf_lm abm 3dnowprefetch invpcid_single ssbd ibr
26 s ibpb stibp ibrs_enhanced tpr_shadow vnmi ept vpid ep
27 t_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invp
28 cid rdseed adx smap clflushopt clwb sha_ni xsaveopt xs
29 avec xgetbv1 xsaves avx_vnni umip waitpkg gfni vaes vp
30 clmulqdq rdpid movdiri movdir64b fsrm md_clear seriali
31 ze flush_l1d arch_capabilities
32Virtualization features:
33 Virtualization: VT-x
34 Hypervisor vendor: Microsoft
35 Virtualization type: full
36Caches (sum of all):
37 L1d: 576 KiB (12 instances)
38 L1i: 384 KiB (12 instances)
39 L2: 15 MiB (12 instances)
40 L3: 30 MiB (1 instance)
41Vulnerabilities:
42 Gather data sampling: Not affected
43 Itlb multihit: Not affected
44 L1tf: Not affected
45 Mds: Not affected
46 Meltdown: Not affected
47 Mmio stale data: Not affected
48 Reg file data sampling: Mitigation; Clear Register File
49 Retbleed: Mitigation; Enhanced IBRS
50 Spec rstack overflow: Not affected
51 Spec store bypass: Mitigation; Speculative Store Bypass disabled via prct
52 l and seccomp
53 Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointe
54 r sanitization
55 Spectre v2: Mitigation; Enhanced / Automatic IBRS; IBPB conditiona
56 l; RSB filling; PBRSB-eIBRS SW sequence; BHI BHI_DIS_S
57 Srbds: Not affected
58 Tsx async abort: Not affected
59
60
61[str, cache] = pm.sys.info();
62cache
63cache
64/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/matlab/checking/pkg/+pm/+sys/.info202412.cache
65str
66str
67Linux amir 5.15.167.4-microsoft-standard-WSL2 #1 SMP Tue Nov 5 00:21:55 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
68Architecture: x86_64
69 CPU op-mode(s): 32-bit, 64-bit
70 Address sizes: 46 bits physical, 48 bits virtual
71 Byte Order: Little Endian
72CPU(s): 24
73 On-line CPU(s) list: 0-23
74Vendor ID: GenuineIntel
75 Model name: 12th Gen Intel(R) Core(TM) i9-12950HX
76 CPU family: 6
77 Model: 151
78 Thread(s) per core: 2
79 Core(s) per socket: 12
80 Socket(s): 1
81 Stepping: 2
82 BogoMIPS: 4992.01
83 Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge m
84 ca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht sysc
85 all nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xt
86 opology tsc_reliable nonstop_tsc cpuid pni pclmulqdq v
87 mx ssse3 fma cx16 pcid sse4_1 sse4_2 x2apic movbe popc
88 nt tsc_deadline_timer aes xsave avx f16c rdrand hyperv
89 isor lahf_lm abm 3dnowprefetch invpcid_single ssbd ibr
90 s ibpb stibp ibrs_enhanced tpr_shadow vnmi ept vpid ep
91 t_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invp
92 cid rdseed adx smap clflushopt clwb sha_ni xsaveopt xs
93 avec xgetbv1 xsaves avx_vnni umip waitpkg gfni vaes vp
94 clmulqdq rdpid movdiri movdir64b fsrm md_clear seriali
95 ze flush_l1d arch_capabilities
96Virtualization features:
97 Virtualization: VT-x
98 Hypervisor vendor: Microsoft
99 Virtualization type: full
100Caches (sum of all):
101 L1d: 576 KiB (12 instances)
102 L1i: 384 KiB (12 instances)
103 L2: 15 MiB (12 instances)
104 L3: 30 MiB (1 instance)
105Vulnerabilities:
106 Gather data sampling: Not affected
107 Itlb multihit: Not affected
108 L1tf: Not affected
109 Mds: Not affected
110 Meltdown: Not affected
111 Mmio stale data: Not affected
112 Reg file data sampling: Mitigation; Clear Register File
113 Retbleed: Mitigation; Enhanced IBRS
114 Spec rstack overflow: Not affected
115 Spec store bypass: Mitigation; Speculative Store Bypass disabled via prct
116 l and seccomp
117 Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointe
118 r sanitization
119 Spectre v2: Mitigation; Enhanced / Automatic IBRS; IBPB conditiona
120 l; RSB filling; PBRSB-eIBRS SW sequence; BHI BHI_DIS_S
121 Srbds: Not affected
122 Tsx async abort: Not affected
123
function name(in vendor)
Return the MPI library name as used in naming the ParaMonte MATLAB shared library directories.
function vendor(in name)
Return the MPI library vendor name from the input MPI name based on the internal ParaMonte shared lib...
function list()
Return a list of MATLAB strings containing the names of OS platforms supported by the ParaMonte MATLA...
function home()
Return a MATLAB string containing the absolute path to the system home directory.
function lib()
Return a scalar MATLAB string containing the path to the lib directory of the ParaMonte library packa...


Final Remarks


If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

  1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
  2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Author:
Joshua Alexander Osborne, May 21 2024, 5:31 AM, University of Texas at Arlington
Fatemeh Bagheri, May 20 2024, 1:25 PM, NASA Goddard Space Flight Center (GSFC), Washington, D.C.
Amir Shahmoradi, May 16 2016, 9:03 AM, Oden Institute for Computational Engineering and Sciences (ICES), UT Austin