/* $Id: toolkit.h,v 1.1.6.1 2000/08/09 00:18:46 hender Exp $ *//**         OpenPBS (Portable Batch System) v2.3 Software License* * Copyright (c) 1999-2000 Veridian Information Solutions, Inc.* All rights reserved.* * ---------------------------------------------------------------------------* For a license to use or redistribute the OpenPBS software under conditions* other than those described below, or to purchase support for this software,* please contact Veridian Systems, PBS Products Department ("Licensor") at:* *    www.OpenPBS.org  +1 650 967-4675                  sales@OpenPBS.org*                        877 902-4PBS (US toll-free)* ---------------------------------------------------------------------------* * This license covers use of the OpenPBS v2.3 software (the "Software") at* your site or location, and, for certain users, redistribution of the* Software to other sites and locations.  Use and redistribution of* OpenPBS v2.3 in source and binary forms, with or without modification,* are permitted provided that all of the following conditions are met.* After December 31, 2001, only conditions 3-6 must be met:* * 1. Commercial and/or non-commercial use of the Software is permitted*    provided a current software registration is on file at www.OpenPBS.org.*    If use of this software contributes to a publication, product, or*    service, proper attribution must be given; see www.OpenPBS.org/credit.html* * 2. Redistribution in any form is only permitted for non-commercial,*    non-profit purposes.  There can be no charge for the Software or any*    software incorporating the Software.  Further, there can be no*    expectation of revenue generated as a consequence of redistributing*    the Software.* * 3. Any Redistribution of source code must retain the above copyright notice*    and the acknowledgment contained in paragraph 6, this list of conditions*    and the disclaimer contained in paragraph 7.* * 4. Any Redistribution in binary form must reproduce the above copyright*    notice and the acknowledgment contained in paragraph 6, this list of*    conditions and the disclaimer contained in paragraph 7 in the*    documentation and/or other materials provided with the distribution.* * 5. Redistributions in any form must be accompanied by information on how to*    obtain complete source code for the OpenPBS software and any*    modifications and/or additions to the OpenPBS software.  The source code*    must either be included in the distribution or be available for no more*    than the cost of distribution plus a nominal fee, and all modifications*    and additions to the Software must be freely redistributable by any party*    (including Licensor) without restriction.* * 6. All advertising materials mentioning features or use of the Software must*    display the following acknowledgment:* *     "This product includes software developed by NASA Ames Research Center,*     Lawrence Livermore National Laboratory, and Veridian Information *     Solutions, Inc.*     Visit www.OpenPBS.org for OpenPBS software support,*     products, and information."* * 7. DISCLAIMER OF WARRANTY* * THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. ANY EXPRESS* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT* ARE EXPRESSLY DISCLAIMED.* * IN NO EVENT SHALL VERIDIAN CORPORATION, ITS AFFILIATED COMPANIES, OR THE* U.S. GOVERNMENT OR ANY OF ITS AGENCIES BE LIABLE FOR ANY DIRECT OR INDIRECT,* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.* * This license will be governed by the laws of the Commonwealth of Virginia,* without reference to its choice of law rules.*/#ifndef TOOLKIT_H_#define TOOLKIT_H_#include <sys/types.h>#include <time.h>			/* For time_t declaration. */#include "pbs_ifl.h"#define	UNSPECIFIED -1#include "bitfield.h"/* * Location of the accounting HOLIDAYS file. */#ifndef HOLIDAYS_FILE#define HOLIDAYS_FILE "/usr/lib/acct/holidays"#endif /* ! HOLIDAYS_FILE *//* * It may take this long for mom to kill a job that runs over its expected * run time (i.e. a "1:00:00" job may run for up to 5 minutes longer than * the expected hour).  When this is the case, the time left for the job to * complete becomes negative.  Since this is clearly bogus, and there is no * way to tell when PBS will actually terminate the job, adjust the time * remaining for any job that has passed its expected completion time to * be JOB_OVERTIME_SLOP seconds in the future. */#define JOB_OVERTIME_SLOP	(3 * 60)/* * Lengths of strings to allocate for holding dates and time in the following * formats.  Used for scheduled outages. */#define DATE_LENGTH	10	/* length of "MM/DD/YYYY" */#define TIME_LENGTH	5	/* length of "HH:MM" */#ifndef MAX#define MAX(a,b) ((a) > (b) ? (a) : (b))#endif /* ! MAX */#ifndef MIN#define MIN(a,b) ((a) < (b) ? (a) : (b))#endif /* ! MIN *//* * Macro to compute the number of nodes required to supply the CPU an * memory requested.  Note that the MB_PER_NODE definition reflects the * physical configuration of the machine. * * !!!   MB_PER_NODE may vary if different memory configurations are * !!!   installed on the systems.  This value is currently correct * !!!   for all Origins at NAS, but may not be correct in all cases. */#define MB_PER_NODE	    ((size_t)256*1024*1024)#define PE_PER_NODE	    2#define NODES_FROM_MEM(mem) (int)(((mem) + MB_PER_NODE - 1) / MB_PER_NODE)#define NODES_FROM_CPU(cpu) (int)(((cpu) + PE_PER_NODE - 1) / PE_PER_NODE)#define NODES_REQD(cpu,mem) (int)MAX(NODES_FROM_CPU(cpu),NODES_FROM_MEM(mem))/* * One of the more time-consuming activities in the scheduler is modifying * the job comments (since it requires a round trip with the server on each * comment).  In order to reduce the impact this commenting has on the time * that each scheduling iteration takes, comment jobs only the first time * they are seen, or after their last modification time ages to more than  * MIN_COMMENT_AGE seconds old. */#define MIN_COMMENT_AGE		(5 * 60)/* Valid state count search strings */#define SC_TRANSIT "Transit"#define SC_QUEUED  "Queued"#define SC_HELD    "Held"#define	SC_WAITING "Waiting"#define	SC_RUNNING "Running"#define	SC_EXITING "Exiting"/*  * Typedef's for external PBS declarations.  */typedef struct batch_status Batch_Status;typedef struct attrl AttrList;typedef struct attropl AttrOpList;struct job {    struct job *next;    /*      * The following attributes are strdup()'d and must be freed before      * the last handle to the job is given up.     */    char   *jobid;		/* Opaque job identifier.             */    char   *owner;		/* Username of owner of this job.     */    char   *host;		/* Host from whence this job came.    */    char   *exechost;		/* Host on which this job is running. */    char   *group;		/* Group of the owner of this job.    */    char   *comment;		/* Current comment on this job.       */    char   *oqueue;		/* Originating queue name. 	      */    char   *pelabel;		/* Requested PE label		      */    /*     * This value is strdup()'d when a batch_struct is converted to      * a Job struct.  When the Job is claimed by a queue, the 'queue'     * field is pointed to its owner.  'qname' is then free()'d and     * pointed to the queue->qname field.     */    char   *qname;		/* Name of queue this job lives in.   */    struct queue *queue;	/* Back pointer to queue struct.      */#if PE_MASK != 0    Bitfield nodemask;		/* set when moving to execution queue */#endif /* PE_MASK */        char    flags; 		/* Flags for the state of this job:   *//* * JFLAGS_INTERACTIVE:	Job is an "interactive" job (i.e. "qsub -I") * JFLAGS_QNAME_LOCAL:	Job->qname points to a piece of storage, i.e. *			    it is not a reference to a Queue->qname. * JFLAGS_WAITING:      Job is an "outstanding waiting" job, i.e it has *                          been waiting for so long (MAX_QUEUED_TIME) *			    we need to go to heroic measures to make *			    sure it runs. * JFLAGS_FIRST_SEEN:	Job has arrived since the last scheduler run. * JFLAGS_PRIORITY:	Job came from a high-priority queue. * JFLAGS_DEDICATED:	Job came from a dedicated time queue. */#define JFLAGS_INTERACTIVE	(1 << 0)#define JFLAGS_QNAME_LOCAL	(1 << 1)#define JFLAGS_WAITING	        (1 << 2)#define JFLAGS_FIRST_SEEN       (1 << 3)#define JFLAGS_PRIORITY	        (1 << 4)#define JFLAGS_DEDICATED        (1 << 5)    int     nodes;		/* Number of nodes requested by job.  */    time_t  walltime;		/* Wallclock time the job requested.  */    time_t  walltime_used;	/* Wallclock time used by the job.    */    int     time_queued;        /* How many secs since job queued.    */    int     eligible;           /* How many secs job eligible to run. */    int     time_left;		/* How many secs remain for this job. */    int	    time_until_eligible;/* How many secs until job is eligible*/				/*   -1 = not eligible in foreseeable */				/*       future (eg. no allocation)   */    time_t  mtime;		/* When this job was last modified.   */    char    state;		/* Is the job Running, Queued, etc    */    int     priority;		/* Priority of Job, inherited from Q  */    int	    session;		/* Session ID of running job	      */    int	    total_delay;	/* Total secs job has been bumped from*/				/*   its original earliest runtime    */};typedef struct job Job;struct useracl {    struct useracl *next;    char    user[PBS_MAXUSER + 1];    char   *host;};typedef struct useracl UserAcl;/* This structure is used to hold information about a queue. */struct queue {    /* The following fields are retained across scheduling interations. */    char   *qname;		/* Pointer to queuename for this info */    char   *exechost;		/* Host on which this queue executes. */    time_t  idle_since;		/* The time this queue last went idle */    int     observe_pt;		/* Observe primetime for this queue?  */    /* These fields are recomputed for each run of the scheduler. */    struct resources *rsrcs;	/* Resources for this execution host. *//* * Flags for the internal state of the queue: * *   QFLAGS_STOPPED:	Queue is stopped -- do not attempt to run jobs on it. *   QFLAGS_DISABLED:	Queue is disabled -- do not queue or run jobs on it. *   QFLAGS_FULL:	Queue has jobs running that consume all of at least *				one of the queue's limited resources. *   QFLAGS_MAXRUN:	Queue has enough jobs running.  Resources may or may *				not be available, but don't run more jobs. *   QFLAGS_DRAINING:	Queue is being drained, possibly to run a long-waiting *				large job. *   QFLAGS_USER_ACL:	Queue has an active user access control list. *   QFLAGS_NPT_JOBS:	Some jobs would have been runnable on this queue if *				primetime were not being observed. */    int     flags;		/* Flags for this queue (see above).  */#define QFLAGS_STOPPED		(1 << 0)#define QFLAGS_DISABLED 	(1 << 1)#define QFLAGS_FULL	 	(1 << 2)#define QFLAGS_MAXRUN	 	(1 << 3)#define QFLAGS_DRAINING	 	(1 << 4)#define QFLAGS_USER_ACL		(1 << 6)#define QFLAGS_NPT_JOBS		(1 << 8)    time_t  empty_by;		/* When this queue will be empty      */    time_t  drain_by;		/* When this queue will be drained    */				/*   enough to run the waiting job    */    Job    *jobs;		/* Pointer to list of jobs on queue   */    UserAcl *useracl;		/* Linked list of user ACL's          */    int     running;		/* Num jobs running                   */    int     queued;		/* Num jobs queued                    */