OS

The Operating System interface module. More...

Collaboration diagram for OS:

Typedefs
typedef struct osapi_os_info_S	t_osInfo
	The OS information type.

Functions
t_status	os_module_supported (void)
	Declares if the module is supported on the current implementation. More...
t_status	os_cpu_getAvailable (t_cpu_nlogical *ncpus)
	Get the number of online Logical CPUs. More...
t_status	os_cpu_getPresent (t_cpu_nlogical *ncpus)
	Get the number of present/configured Logical CPUs. More...
t_status	os_cpu_getMax (t_cpu_nlogical *ncpus)
	Get the maximum number of Logical CPUs that the OS can address. More...
t_status	os_info_get (t_osInfo *info)
	Get the Operating System information. More...
t_status	os_name_get (t_osInfo *info, char **name)
	Get the OS name. More...
t_status	os_version_get (t_osInfo *info, char **version)
	Get the OS version. More...
t_status	os_release_get (t_osInfo *info, char **release)
	Get the OS release. More...
t_status	os_node_get (t_osInfo *info, char **nodename)
	Get the OS Node name. More...
t_status	os_machine_get (t_osInfo *info, char **machine)
	Get the machine name. More...
t_status	os_domain_get (t_osInfo *info, char **domainname)
	Get the machine domain name. More...
t_status	os_provider_get (t_osInfo *info, char **provider)
	Get the OS provider name (Vendor) More...
t_status	os_providerRelease_get (t_osInfo *info, char **providerRelease)
	Get the Vendor Release. More...
t_status	os_time_getBoot (t_time *tm)
	Get the OS boot time. More...
t_status	os_memory_getPageSize (uint32_t *size)
	Get the size of each OS memory page. More...
t_status	os_memory_getNumberOfPages (uint32_t *number)
	Get the number of pages in the memory. More...
t_status	os_memory_getMax (uint64_t *size)
	Get the total memory available to the OS This may not be all machine memory. More...

Detailed Description

The Operating System interface module.

---

Function Documentation

os_cpu_getAvailable()

t_status os_cpu_getAvailable

(

t_cpu_nlogical *

ncpus

)

Get the number of online Logical CPUs.

Parameters

[out]

ncpus

- Number of Logical CPUs available

Returns

Operation status

os_cpu_getMax()

t_status os_cpu_getMax

(

t_cpu_nlogical *

ncpus

)

Get the maximum number of Logical CPUs that the OS can address.

Parameters

[out]

ncpus

- Number of logical CPUs that can be managed by the OS

Returns

Operation status

os_cpu_getPresent()

t_status os_cpu_getPresent

(

t_cpu_nlogical *

ncpus

)

Get the number of present/configured Logical CPUs.

Parameters

[out]

ncpus

- Number of Logical CPUs visible by the OS

Returns

Operation status

os_domain_get()

t_status os_domain_get	(	t_osInfo *	info,
		char **	domainname
	)

Get the machine domain name.

Parameters

[in]	info	- OS Info
[out]	domainname	- Machine domain name

Returns

Operation status

os_info_get()

t_status os_info_get

(

t_osInfo *

info

)

Get the Operating System information.

Parameters

[in]

info

- OS Information

Returns

Operation status

os_machine_get()

t_status os_machine_get	(	t_osInfo *	info,
		char **	machine
	)

Get the machine name.

Parameters

[in]	info	- OS Info
[out]	machine	- Machine name

Returns

Operation status

os_memory_getMax()

t_status os_memory_getMax

(

uint64_t *

size

)

Get the total memory available to the OS This may not be all machine memory.

Parameters

[out]

size

- Size of memory

Returns

Operation status

os_memory_getNumberOfPages()

t_status os_memory_getNumberOfPages

(

uint32_t *

number

)

Get the number of pages in the memory.

Parameters

[out]

number

- Memory pages

Returns

Operation status

os_memory_getPageSize()

t_status os_memory_getPageSize

(

uint32_t *

size

)

Get the size of each OS memory page.

Parameters

[out]

size

- Size of a memory page

Returns

Operation status

os_module_supported()

t_status os_module_supported

(

void

)

Declares if the module is supported on the current implementation.

Returns

SUCCESS or FAILURE

os_name_get()

t_status os_name_get	(	t_osInfo *	info,
		char **	name
	)

Get the OS name.

Parameters

[in]	info	- OS Info
[out]	name	- OS name

Returns

Operation status

os_node_get()

t_status os_node_get	(	t_osInfo *	info,
		char **	nodename
	)

Get the OS Node name.

Parameters

[in]	info	- OS Info
[out]	nodename	- OS node name

Returns

Operation status

os_provider_get()

t_status os_provider_get	(	t_osInfo *	info,
		char **	provider
	)

Get the OS provider name (Vendor)

Parameters

[in]	info	- OS Info
[out]	provider	- Vendor name

Returns

Operation status

os_providerRelease_get()

t_status os_providerRelease_get	(	t_osInfo *	info,
		char **	providerRelease
	)

Get the Vendor Release.

Parameters

[in]	info	- OS Info
[out]	providerRelease	- Vendor release

Returns

Operation status

os_release_get()

t_status os_release_get	(	t_osInfo *	info,
		char **	release
	)

Get the OS release.

Parameters

[in]	info	- OS Info
[out]	release	- OS release

Returns

Operation status

os_time_getBoot()

t_status os_time_getBoot

(

t_time *

tm

)

Get the OS boot time.

Parameters

[out]

tm

- OS boot time

Returns

Operation status

os_version_get()

t_status os_version_get	(	t_osInfo *	info,
		char **	version
	)

Get the OS version.

Parameters

[in]	info	- OS Info
[out]	version	- OS version

Returns

Operation status