[ Previous | Next | Table of Contents | Index | Library Home | Legal | Search ]

Technical Reference: Base Operating System and Extensions , Volume 2


wlm_set Subroutine

Purpose

Loads a Workload Manager (WLM) configuration into the kernel.

Library

Workload Manager Library (libwlm.a)

Syntax


#include <sys/wlm.h>


int wlm_set ( flags)


int *flags;

Description

The wlm_set subroutine is used to set, change, or query the mode of operations of WLM. The state of WLM can be:

OFF Does not classify processes, monitor or regulate resource utilization.
ON in passive mode Classifies the processes and monitors their resource usage but does no regulation.
ON in active mode Specifies the normal operating mode where WLM classifies processes, monitors and regulates the resource usage.

Parameters


flags Specifies the address of an integer interpreted in a manner similar to the versflags field of the wlmargs structure passed to the other API routines. The integer pointed to by flags should be initialized with WLM_VERSION. In addition, one or more of the following values can be or'ed to WLM_VERSION:

WLM_TEST_ON
Queries the state of WLM without altering it.

WLM_OFF
Turns WLM off.

WLM_ACTIVE
Turns WLM on in active mode or transitions from passive to active mode.

WLM_PASSIVE
Turns WLM on in passive mode or transitions from active to passive mode.

WLM_BIND_RSETS
Requests that WLM takes the resource set bindings into account.

All combinations of the flags above are not legal:

Return Values

Upon successful completion, the wlm_set subroutine returns a value of 0, and the current state of WLM is returned in the integer pointed to by flags. The return value is WLM_OFF, WLM_ACTIVE, or WLM_PASSIVE. When WLM is on in either active or passive mode, the WLM_BIND_RSETS flag is added when WLM uses resource sets bindings.

Error Codes

For a list of the possible error codes returned by the WLM API functions, see the description of the wlm.h header file.

Related Information

The wlmcntrl command.

The wlm.h header file.

The wlm_load (wlm_load Subroutine) subroutine.


[ Previous | Next | Table of Contents | Index | Library Home | Legal | Search ]