lslib

Application Programming Interface (API) library routines for LSF services

LSLIB routines allow application programs to contact the Load Information Manager (LIM) and Remote Execution Server (RES) daemons in order to obtain LSF services. These services include obtaining static system configuration information and dynamic load information for the hosts in distributed clusters, obtaining task placement advice from LIM, executing tasks (UNIX processes) on remote hosts with a high degree of transparency using RES, remote file operations across hosts that do not share file systems, performing remote terminal I/O and signal operations, and other related functions. You can build distributed applications on top of LSLIB to effectively exploit the resources available on the network, improving application performance and resource accessibility.

Library routines for obtaining load sharing cluster configuration information.

• ls_info
• ls_getclustername
• ls_getmastername
• ls_getmodelfactor

Library routines for obtaining host configuration information.

• ls_gethosttype
• ls_gethostmodel
• ls_gethostfactor
• ls_gethostinfo

Library routines for obtaining host load information. An application can use this information to make task placement decisions instead of using LIM's.

• ls_loadinfo
• ls_load
• ls_loadofhosts
• ls_sharedresourceinfo

Library routines implementing LIM's task placement policy. These routines include calls to obtain task placement information, and calls to adjust host load measures.

• ls_placereq
• ls_placeofhosts
• ls_loadadj

Library routines for displaying and manipulating the local and remote task lists. These lists specify the eligibility of various types of tasks for remote execution, and their resource requirement characteristics.

• ls_eligible
• ls_listrtask
• ls_listltask
• ls_insertrtask
• ls_insertltask
• ls_deletertask
• ls_deleteltask

REMOTE EXECUTION

Library routines related to remote execution, including initiation, connection and remote environment manipulation.

Library routines for establishing and querying remote connections.

• ls_connect
• ls_isconnected
• ls_findmyconnections

Library routines for executing remote tasks.

• ls_rexecv
• ls_rexecve
• ls_rtask
• ls_rtaske

Library routines for querying and manipulating stdin for remote tasks.

• ls_stdinmode
• ls_getstdin
• ls_setstdin

Wait for a remote or local task, then return its status.

• ls_rwait
• ls_rwaittid

Library routines for operations on files on remote hosts.

• ls_ropen
• ls_rread
• ls_rwrite
• ls_rlseek
• ls_rclose
• ls_rstat
• ls_rfstat
• ls_rgetmnthost
• ls_rfcontrol

Library routine for load sharing error messages.

• ls_perror
• ls_sysmsg
• ls_errlog

Library routines for administering and controlling the LSF system.

• ls_limcontrol
• ls_lockhost
• ls_unlockhost

Note:

All LSLIB routines require that the LSF header file <lsf/lsf.h> be included.

Many LSLIB APIs return a pointer to an array or structure. These data structures are in static storage or on the heap. The next time the routine is called, the storage is overwritten or freed.

Any program using LSLIB routines that change the state of the LSF system must be setuid to root if LSF_AUTH is not defined in the lsf.conf file.

Any program using LSLIB routines for remote execution services or for operations on files on remote hosts must call ls_initrex() before calling any of the other routines.

On systems which have both System V and BSD programming interfaces, LSLIB typically requires the BSD programming interface. On System V-based versions of UNIX, for example SGI IRIX, it is normally necessary to link applications using LSLIB with the BSD compatibility library.

On AFS systems, the following needs to be added to the end of your linkage specifications when linking with LSLIB (assuming your AFS library path is /usr/afsws):

For HP-UX and Solaris,

-lc -L/usr/afsws/lib -L/usr/afsws/lib/afs -lsys -lrx -llwp /usr/afsws/lib/afs/util.a

For other platforms,

-lc -L/usr/afsws/lib -L/usr/afsws/lib/afs -lsys -lrx -llwp

Files:

${LSF_ENVDIR:-/etc}/lsf.conf
$LSF_CONFDIR/lsf.shared
$LSF_CONFDIR/lsf.cluster.cluster_name
$LSF_CONFDIR/lsf.task
$LSF_CONFDIR/lsf.task.cluster_name

See also:

ls_chdir

ls_clusterinfo

ls_connect

ls_conntaskport

ls_createdir

ls_deleteltask

ls_deletertask

ls_donerex

ls_eligible

ls_errlog

ls_fdbusy

ls_findmyconnections

ls_getacctrec

ls_getclustername

ls_gethostfactor

ls_gethostinfo

ls_gethostmodel

ls_gethosttype

ls_getmastername

ls_getmnthost

ls_getmodelfactor

ls_getmyhostname

ls_getmyhostname2

ls_getstdin

ls_info

ls_initrex

ls_insertltask

ls_insertrtask

ls_isconnected

ls_limcontrol

ls_listltask

ls_listrtask

ls_load

ls_loadadj

ls_loadinfo

ls_loadofhosts

ls_lockhost

ls_perror

ls_placeofhosts

ls_placereq

ls_rclose

ls_readconfenv

ls_rescontrol

ls_resreq

ls_rexecv

ls_rexecve

ls_rfcontrol

ls_rfstat

ls_rfterminate

ls_rgetmnthost

ls_rkill

ls_rlseek

ls_ropen

ls_rread

ls_rsetenv

ls_rstat

ls_rtask

ls_rtaske

ls_rwait

ls_rwaittid

ls_rwrite

ls_setstdin

ls_sharedresourceinfo

ls_stdinmode

ls_stoprex

ls_sysmsg

ls_unlockhost