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.153.1-microsoft-standard-WSL2 #1 SMP Fri Mar 29 23:14:13 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.00
19 Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mc
20 a cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscal
21 l nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopo
22 logy tsc_reliable nonstop_tsc cpuid pni pclmulqdq vmx s
23 sse3 fma cx16 sse4_1 sse4_2 x2apic movbe popcnt tsc_dea
24 dline_timer aes xsave avx f16c rdrand hypervisor lahf_l
25 m abm 3dnowprefetch ssbd ibrs ibpb stibp ibrs_enhanced
26 tpr_shadow vnmi ept vpid ept_ad fsgsbase tsc_adjust bmi
27 1 avx2 smep bmi2 erms invpcid rdseed adx smap clflushop
28 t clwb sha_ni xsaveopt xsavec xgetbv1 xsaves avx_vnni u
29 mip waitpkg gfni vaes vpclmulqdq rdpid movdiri movdir64
30 b fsrm md_clear serialize flush_l1d arch_capabilities
31Virtualization features:
32 Virtualization: VT-x
33 Hypervisor vendor: Microsoft
34 Virtualization type: full
35Caches (sum of all):
36 L1d: 576 KiB (12 instances)
37 L1i: 384 KiB (12 instances)
38 L2: 15 MiB (12 instances)
39 L3: 30 MiB (1 instance)
40Vulnerabilities:
41 Gather data sampling: Not affected
42 Itlb multihit: Not affected
43 L1tf: Not affected
44 Mds: Not affected
45 Meltdown: Not affected
46 Mmio stale data: Not affected
47 Retbleed: Mitigation; Enhanced IBRS
48 Spec rstack overflow: Not affected
49 Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
50 and seccomp
51 Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer
52 sanitization
53 Spectre v2: Mitigation; Enhanced IBRS, IBPB conditional, RSB fillin
54 g, PBRSB-eIBRS SW sequence
55 Srbds: Not affected
56 Tsx async abort: Not affected
57
58
59[str, cache] = pm.sys.info();
60cache
61cache
62/home/amir/git/paramonte/external/paramonted/doxygen/bld/linux/amd64/csid/csvs/native/lib/mem/serial/matlab/checking/pkg/+pm/+sys/.info202411.cache
63str
64str
65Linux amir 5.15.153.1-microsoft-standard-WSL2 #1 SMP Fri Mar 29 23:14:13 UTC 2024 x86_64 x86_64 x86_64 GNU/Linux
66Architecture: x86_64
67 CPU op-mode(s): 32-bit, 64-bit
68 Address sizes: 46 bits physical, 48 bits virtual
69 Byte Order: Little Endian
70CPU(s): 24
71 On-line CPU(s) list: 0-23
72Vendor ID: GenuineIntel
73 Model name: 12th Gen Intel(R) Core(TM) i9-12950HX
74 CPU family: 6
75 Model: 151
76 Thread(s) per core: 2
77 Core(s) per socket: 12
78 Socket(s): 1
79 Stepping: 2
80 BogoMIPS: 4992.00
81 Flags: fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mc
82 a cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscal
83 l nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopo
84 logy tsc_reliable nonstop_tsc cpuid pni pclmulqdq vmx s
85 sse3 fma cx16 sse4_1 sse4_2 x2apic movbe popcnt tsc_dea
86 dline_timer aes xsave avx f16c rdrand hypervisor lahf_l
87 m abm 3dnowprefetch ssbd ibrs ibpb stibp ibrs_enhanced
88 tpr_shadow vnmi ept vpid ept_ad fsgsbase tsc_adjust bmi
89 1 avx2 smep bmi2 erms invpcid rdseed adx smap clflushop
90 t clwb sha_ni xsaveopt xsavec xgetbv1 xsaves avx_vnni u
91 mip waitpkg gfni vaes vpclmulqdq rdpid movdiri movdir64
92 b fsrm md_clear serialize flush_l1d arch_capabilities
93Virtualization features:
94 Virtualization: VT-x
95 Hypervisor vendor: Microsoft
96 Virtualization type: full
97Caches (sum of all):
98 L1d: 576 KiB (12 instances)
99 L1i: 384 KiB (12 instances)
100 L2: 15 MiB (12 instances)
101 L3: 30 MiB (1 instance)
102Vulnerabilities:
103 Gather data sampling: Not affected
104 Itlb multihit: Not affected
105 L1tf: Not affected
106 Mds: Not affected
107 Meltdown: Not affected
108 Mmio stale data: Not affected
109 Retbleed: Mitigation; Enhanced IBRS
110 Spec rstack overflow: Not affected
111 Spec store bypass: Mitigation; Speculative Store Bypass disabled via prctl
112 and seccomp
113 Spectre v1: Mitigation; usercopy/swapgs barriers and __user pointer
114 sanitization
115 Spectre v2: Mitigation; Enhanced IBRS, IBPB conditional, RSB fillin
116 g, PBRSB-eIBRS SW sequence
117 Srbds: Not affected
118 Tsx async abort: Not affected
119
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