HFSS15: GetMachineListAvailableForDistribution

Purpose

Get the list of hosts allocated to the current job. A host will appear in the list multiple times if the scheduler has allocated multiple processors or cores on the host to the job. The number of times the host appears in the list is equal to the number of processors or cores of the host that are allocated to the current job. The list is a text string containing a space separated list of hostnames.

Signature

extern "C" bool FN_PREFIX_GetMachineListAvailableForDistribution(char * buffer, unsigned int* length);

Arguments

buffer: Pointer to a character buffer to contain the list of machines available for distribution or NULL.

length: Pointer to a location to contain the length of the buffer. Must be a valid pointer to an unsigned int.

Return Value

If argument buffer is NULL, then then required length of the buffer is stored in the location to which argument length points, and true is returned.

If argument buffer is not NULL, then the value to which argument length points (the buffer length) is checked. If it is large enough to contain the lists of hosts, including the terminal null byte, then the list is copied to the buffer and true is returned. If the buffer length is insufficient for the list of hosts, then the buffer is unchanged, and false is returned.

Notes

To get the list of hosts for distribution, the infrastructure first calls this function with a NULL buffer, and obtains the required length of the buffer for the list. After creating a buffer of the appropriate size, the infrastructure calls this function again, passing the pointer to the buffer in the buffer argument and a pointer to the size of the buffer in the length argument.

The hostnames in the list provided by this function shall be used in calls to LaunchProcess(). These host names must be in a format that is accepted by that function. See the section below on LaunchProcess.