pm_sysInfo::getSysInfo Interface Reference

Generate and return a string containing a comprehensive report of the operating system and platform specifications. More...

Detailed Description

Generate and return a string containing a comprehensive report of the operating system and platform specifications.

The system information is obtained by first identifying the operating system and the runtime shell and then calling one of the following platform/shell-specific commands:

1. The commands uname -a + sysctl -a | grep machdep.cpu + system_profiler SPHardwareDataType on Darwin (macOS) platforms.
   
2. The commands uname -a + lscpu + cat /proc/cpuinfo on Linux or other Unix-like platforms.
3. The commands systeminfo on Windows platforms.

Parameters

[out]	failed	: The output scalar of type logical of default kind LK, that is .true. if and only if the process of fetching system information fails. (optional. If missing and a runtime error occurs, the program will halt by calling error stop.)
[in,out]	errmsg	: The input/output scalar character of default kind SK of arbitrary length type parameter. If an error occurs, errmsg will be set to a descriptive message about the nature of the runtime error. A length of LEN_IOMSG characters is likely sufficient to capture most error messages in full. (optional. It can be present only if the input argument failed is also present.)

Returns

sysInfo : The output allocatable scalar character of default kind SK containing the system information.

Possible calling interfaces ⛓

use pm_kind, only: SK
use test_pm_sys, only: getSysInfo
 
character(:, SK), allocatable :: sysInfo
 
sysInfo = getSysInfo()
sysInfo = getSysInfo(failed)
sysInfo = getSysInfo(failed, errmsg)

Remarks

The procedures under discussion are impure.

See also

getSysInfo
isKernelLinux
isKernelDarwin
isKernelWindows
kernelis_type
kernel_type

Example usage ⛓

program example
 
    use pm_kind, only: LK, IK, SK
    use pm_io, only: display_type
    use pm_sysInfo, only: getSysInfo
 
    implicit none
 
    logical(LK) :: failed
    character(255, SK)  :: errmsg
    character(:, SK), allocatable :: sysinfo
 
    type(display_type)  :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("sysinfo = getSysInfo()")
                    sysinfo = getSysInfo()
    call disp%show( sysinfo, deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("sysinfo = getSysInfo(failed)")
                    sysinfo = getSysInfo(failed)
    call disp%show( sysinfo, deliml = SK_"""" )
    call disp%show("failed ! Check if any error has occurred.")
    call disp%show( failed )
    if (failed) then
        call disp%show("SK_'error occurred.'")
        call disp%show( SK_'error occurred.' , deliml = SK_"""" )
    end if
    call disp%skip()
 
    call disp%skip()
    call disp%show("sysinfo = getSysInfo(failed, errmsg)")
                    sysinfo = getSysInfo(failed, errmsg)
    call disp%show( sysinfo, deliml = SK_"""" )
    call disp%show("failed ! Check if any error has occurred.")
    call disp%show( failed )
    if (failed) then
        call disp%show("SK_'error occurred: '//trim(errmsg)")
        call disp%show( SK_'error occurred: '//trim(errmsg) , deliml = SK_"""" )
    end if
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
sysinfo = getSysInfo()
"
Linux 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
 
Architecture:                       x86_64
CPU op-mode(s):                     32-bit, 64-bit
Address sizes:                      46 bits physical, 48 bits virtual
Byte Order:                         Little Endian
CPU(s):                             24
On-line CPU(s) list:                0-23
Vendor ID:                          GenuineIntel
Model name:                         12th Gen Intel(R) Core(TM) i9-12950HX
CPU family:                         6
Model:                              151
Thread(s) per core:                 2
Core(s) per socket:                 12
Socket(s):                          1
Stepping:                           2
BogoMIPS:                           4992.00
Flags:                              fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscall nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopology tsc_reliable nonstop_tsc cpuid pni pclmulqdq vmx ssse3 fma cx16 sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand hypervisor lahf_lm abm 3dnowprefetch ssbd ibrs ibpb stibp ibrs_enhanced tpr_shadow vnmi ept vpid ept_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid rdseed adx smap clflushopt clwb sha_ni xsaveopt xsavec xgetbv1 xsaves avx_vnni umip waitpkg gfni vaes vpclmulqdq rdpid movdiri movdir64b fsrm md_clear serialize flush_l1d arch_capabilities
Virtualization:                     VT-x
Hypervisor vendor:                  Microsoft
Virtualization type:                full
L1d cache:                          576 KiB (12 instances)
L1i cache:                          384 KiB (12 instances)
L2 cache:                           15 MiB (12 instances)
L3 cache:                           30 MiB (1 instance)
Vulnerability Gather data sampling: Not affected
Vulnerability Itlb multihit:        Not affected
Vulnerability L1tf:                 Not affected
Vulnerability Mds:                  Not affected
Vulnerability Meltdown:             Not affected
Vulnerability Mmio stale data:      Not affected
Vulnerability Retbleed:             Mitigation; Enhanced IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass:    Mitigation; Speculative Store Bypass disabled via prctl and seccomp
Vulnerability Spectre v1:           Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2:           Mitigation; Enhanced IBRS, IBPB conditional, RSB filling, PBRSB-eIBRS SW sequence
Vulnerability Srbds:                Not affected
Vulnerability Tsx async abort:      Not affected
"
 
 
sysinfo = getSysInfo(failed)
"
Linux 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
 
Architecture:                       x86_64
CPU op-mode(s):                     32-bit, 64-bit
Address sizes:                      46 bits physical, 48 bits virtual
Byte Order:                         Little Endian
CPU(s):                             24
On-line CPU(s) list:                0-23
Vendor ID:                          GenuineIntel
Model name:                         12th Gen Intel(R) Core(TM) i9-12950HX
CPU family:                         6
Model:                              151
Thread(s) per core:                 2
Core(s) per socket:                 12
Socket(s):                          1
Stepping:                           2
BogoMIPS:                           4992.00
Flags:                              fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscall nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopology tsc_reliable nonstop_tsc cpuid pni pclmulqdq vmx ssse3 fma cx16 sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand hypervisor lahf_lm abm 3dnowprefetch ssbd ibrs ibpb stibp ibrs_enhanced tpr_shadow vnmi ept vpid ept_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid rdseed adx smap clflushopt clwb sha_ni xsaveopt xsavec xgetbv1 xsaves avx_vnni umip waitpkg gfni vaes vpclmulqdq rdpid movdiri movdir64b fsrm md_clear serialize flush_l1d arch_capabilities
Virtualization:                     VT-x
Hypervisor vendor:                  Microsoft
Virtualization type:                full
L1d cache:                          576 KiB (12 instances)
L1i cache:                          384 KiB (12 instances)
L2 cache:                           15 MiB (12 instances)
L3 cache:                           30 MiB (1 instance)
Vulnerability Gather data sampling: Not affected
Vulnerability Itlb multihit:        Not affected
Vulnerability L1tf:                 Not affected
Vulnerability Mds:                  Not affected
Vulnerability Meltdown:             Not affected
Vulnerability Mmio stale data:      Not affected
Vulnerability Retbleed:             Mitigation; Enhanced IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass:    Mitigation; Speculative Store Bypass disabled via prctl and seccomp
Vulnerability Spectre v1:           Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2:           Mitigation; Enhanced IBRS, IBPB conditional, RSB filling, PBRSB-eIBRS SW sequence
Vulnerability Srbds:                Not affected
Vulnerability Tsx async abort:      Not affected
"
failed ! Check if any error has occurred.
F
 
 
sysinfo = getSysInfo(failed, errmsg)
"
Linux 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
 
Architecture:                       x86_64
CPU op-mode(s):                     32-bit, 64-bit
Address sizes:                      46 bits physical, 48 bits virtual
Byte Order:                         Little Endian
CPU(s):                             24
On-line CPU(s) list:                0-23
Vendor ID:                          GenuineIntel
Model name:                         12th Gen Intel(R) Core(TM) i9-12950HX
CPU family:                         6
Model:                              151
Thread(s) per core:                 2
Core(s) per socket:                 12
Socket(s):                          1
Stepping:                           2
BogoMIPS:                           4992.00
Flags:                              fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ss ht syscall nx pdpe1gb rdtscp lm constant_tsc rep_good nopl xtopology tsc_reliable nonstop_tsc cpuid pni pclmulqdq vmx ssse3 fma cx16 sse4_1 sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand hypervisor lahf_lm abm 3dnowprefetch ssbd ibrs ibpb stibp ibrs_enhanced tpr_shadow vnmi ept vpid ept_ad fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid rdseed adx smap clflushopt clwb sha_ni xsaveopt xsavec xgetbv1 xsaves avx_vnni umip waitpkg gfni vaes vpclmulqdq rdpid movdiri movdir64b fsrm md_clear serialize flush_l1d arch_capabilities
Virtualization:                     VT-x
Hypervisor vendor:                  Microsoft
Virtualization type:                full
L1d cache:                          576 KiB (12 instances)
L1i cache:                          384 KiB (12 instances)
L2 cache:                           15 MiB (12 instances)
L3 cache:                           30 MiB (1 instance)
Vulnerability Gather data sampling: Not affected
Vulnerability Itlb multihit:        Not affected
Vulnerability L1tf:                 Not affected
Vulnerability Mds:                  Not affected
Vulnerability Meltdown:             Not affected
Vulnerability Mmio stale data:      Not affected
Vulnerability Retbleed:             Mitigation; Enhanced IBRS
Vulnerability Spec rstack overflow: Not affected
Vulnerability Spec store bypass:    Mitigation; Speculative Store Bypass disabled via prctl and seccomp
Vulnerability Spectre v1:           Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2:           Mitigation; Enhanced IBRS, IBPB conditional, RSB filling, PBRSB-eIBRS SW sequence
Vulnerability Srbds:                Not affected
Vulnerability Tsx async abort:      Not affected
"
failed ! Check if any error has occurred.
F
 
 

Test:

test_pm_sys

Bug:

Status: Unresolved
Source: Intel LLVM Fortran Compiler ifx version 2025.0.0 20241008
Description: Intel LLVM Fortran Compiler ifx version 2025.0.0 20241008 yields the following segfault error at runtime for using the css_type array constructor syntax.
deallocate the array of origin in a call to intrinsic move_alloc:

--------------------------------------------------------------------------------
       !Segmentation violation detected at 2024-11-06 22:46:51 -0600
--------------------------------------------------------------------------------
 
Configuration:
Crash Decoding           : Disabled - No sandbox or build area path
Crash Mode               : continue (default)
Default Encoding         : UTF-8
Deployed                 : false
GNU C Library            : 2.35 stable
Graphics Driver          : Uninitialized software
Graphics card 1          : 0x1414( 0x1414 ) 0x8e Version 2.0.3.0 (0-0-0)
Graphics card 2          : 0x1414( 0x1414 ) 0x8e Version 2.0.3.0 (0-0-0)
Java Version             : Java 1.8.0_202-b08 with Oracle Corporation Java HotSpot(TM) 64-Bit Server VM mixed mode
MATLAB Architecture      : glnxa64
MATLAB Entitlement ID    : 2406435
MATLAB Root              : /usr/local/MATLAB/R2023b
MATLAB Version           : 23.2.0.2428915 (R2023b) Update 4
OpenGL                   : software
Operating System         : Ubuntu 22.04.4 LTS
Process ID               : 24027
Processor ID             : x86 Family 6 Model 151 Stepping 2, GenuineIntel
Session Key              : 4af1c654-3fca-4695-8780-e5de2107934f
Window System            : Microsoft Corporation(12010000), display :0
 
Fault Count: 1
 
 
Abnormal termination:
Segmentation violation
 
Current Thread: 'MCR 0 interpret' id 23329188607552
 
Register State(from fault):
RAX = 0000000000000000  RBX = 00001537bffc8ef8
RCX = 0000000000000001  RDX = 0000000000000000
RSP = 00001537bffc8690  RBP = 00001537bffc8710
RSI = 00001537bffc8ef8  RDI = 000002a6db74779d
 
R8 = 0000000000000000   R9 = 0000000000040002
R10 = 00001537c00d6fe8  R11 = 0000000000000000
R12 = 0000000000000000  R13 = 00000000000004e0
R14 = 0000000000000000  R15 = 00001536dba470f0
 
RIP = 00001536db95e473  EFL = 0000000000010202
 
CS = 0033   FS = 0000   GS = 0000
 
Stack Trace(from fault):
[  0] 0x00001536db95e473 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+38818931
[  1] 0x00001536db95f54e /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+38823246
[  2] 0x00001536db95e69e /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+38819486
[  3] 0x00001536da893fbe /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+21213118 pm_sysinfo_MP_getsysinfofailedmsg_+00012510
[  4] 0x00001536da890b31 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+21199665 pm_sysinfo_MP_getsysinfofailed_+00000177
[  5] 0x00001536d982d6fe /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+04015870 pm_sampling_base_rk2_MP_openfiles_+00126718
[  6] 0x00001536d980c391 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+03879825 pm_sampling_base_rk2_MP_set_+00135649
[  7] 0x00001536d9902171 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+04886897 pm_sampling_mcmc_rk2_MP_set_+00030945
[  8] 0x00001536d998e393 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+05460883 pm_sampling_dram_rk2_MP_set_+00037203
[  9] 0x00001536d9b51923 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+07309603 pm_sampling_MP_geterrparadram_rk2_+00047939
[ 10] 0x00001536d9b43448 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/libparamonte.so+07251016 runParaDRAMD+00007992
[ 11] 0x00001536f64624a9 /home/amir/git/paramonte/bin/libparamonte_matlab_linux_amd64/+pm/lib/linux/amd64/intelllvm2025/debug/shared/heap/serial/nocheck/pm_sampling.mexa64+00005289 mexFunction+00000537

Note that ifort can readily compile the above lines of code.

Remedy (as of ParaMonte Library version 2.0.0): Currently, a preprocessor fence is added specifically for Intel compilers that first allocates the vector of type css_type and then assigns the vector elements one by one.
Note that the above segfault error was discovered while testing the MATLAB interface to the ParaMonte library.
However, the nature and cause of the error is entirely contained within the Fortran programming language.

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.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Tuesday March 7, 2017, 3:09 AM, ICES, The University of Texas Austin

Definition at line 425 of file pm_sysInfo.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_sysInfo.F90