Using and Administering

ll_get_jobs Subroutine

Purpose

This subroutine, available to any user, returns information about all jobs in the LoadLeveler job queue.

Library

LoadLeveler API library libllapi.a

Syntax

  #include "llapi.h"
 
  int ll_get_jobs(LL_get_jobs_info *);

Parameters

ptr

Specifies the pointer to the LL_get_jobs_info structure that was allocated by the caller. The LL_get_jobs_info members are:

int version_num

Represents the version number of the LL_start_job_info structure. This should be set to LL_PROC_VERSION.

int numJobs

Represents the number of entries in the array.

LL_job **JobList

Represents the pointer to an array of LL_job structures. The LL_job structure is defined in llapi.h.

Description

The LL_get_jobs_info structure contains an array of LL_job structures indicating each job in the LoadLeveler system.

Some job information, such as the start time of the job, is not available to this API. (It is recommended that you use the dispatch time, which is available, in place of the start time.) Also, some accounting information is not available to this API.

Return Values

This subroutines returns a value of zero when successful. Otherwise, it returns an integer value defined in the llapi.h file.

Error Values

-1

There is an error in the input parameter.

-2

The API cannot connect to the central manager.

-3

The API cannot allocate memory.

-4

A configuration error occurred.

Examples

Makefiles and examples which use this subroutine are located in the samples/llsch subdirectory of the release directory.

Related Information

Subroutines: ll_free_jobs, ll_free_nodes, ll_get_nodes.