runjob.c

openPBS的开放源代码

/*
*         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  [phone]                  [e-mail]
*                        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.
*/
/* $Id: runjob.c,v 1.5.4.3 2000/09/13 22:43:20 jjones Exp $ */

#include	<stdio.h>
#include	<stdlib.h>
#include	<string.h>

/* Toolkit header files */
#include "toolkit.h"
#include "gblxvars.h"

/* PBS header files */
#include        "pbs_error.h"
#include        "log.h"

extern int connector;

/*
 * run_job_on(job, queue, set_comment) :
 *
 * Run the job pointed to by 'job' in the queue on which it is enqueued.
 * If 'queue' is non-NULL, move the job to the queue before running it.  
 * If 'set_comment' is non-zero, the job comment will be changed to reflect
 * the time at which the job was started.
 */

int 
schd_run_job_on(Job *job, Queue *destq, char *exechost, int set_comment)
{
    char   *id = "schd_run_job_on";
    char    reason[128], tmp_word[20];
    char   *date;
    Queue  *srcq = NULL;
    int	    ret=0;

    /* Get the datestamp from 'ctime()'.  Remove the trailing '\n'. */
    date = ctime(&schd_TimeNow);
    date[strlen(date) - 1] = '\0';

    if (set_comment) {
	sprintf(reason, "Started on %s", date);

	if (job->flags & JFLAGS_PRIORITY) {
	    strcat(reason, " (EXPRESS/high priority job)");
	}

	if (job->flags & JFLAGS_WAITING) {
	    strcat(reason, " (long-waiting job)");
	}

	schd_comment_job(job, reason, JOB_COMMENT_REQUIRED);
    }

    /* If this is NOT a suspended job... */
    if (!(job->flags & JFLAGS_SUSPENDED)) {

        /* 
         * If a destination Queue is provided, and it is different from the 
         * source queue, then ask PBS to move the job to that queue before
         * running it.
         */
        srcq = job->queue;
    
	/*
	 * Move the job from its queue to the specified run queue.
	 */ 
        if ((destq != NULL) && (strcmp(destq->qname, srcq->qname) != 0)) {
	    if (pbs_movejob(connector, job->jobid, destq->qname, NULL)) {
		(void)sprintf(log_buffer,"move job %s to queue %s failed, %d",
		    job->jobid, destq->qname, pbs_errno);
		log_record(PBSEVENT_SYSTEM, PBS_EVENTCLASS_SERVER, 
		    id, log_buffer);
		DBPRT(("%s: %s\n", id, log_buffer));
		return (-1);
	    }
	    schd_move_job_to(job, destq);
        }

        /*
	 * Give the job handle (JOBID) to PBS to run.
	 */
        if (pbs_runjob(connector, job->jobid, exechost, NULL)) {
            (void)sprintf(log_buffer,"failed start job %s on queue %s@%s, %d",
		  job->jobid, destq->qname, exechost, pbs_errno);
	    log_record(PBSEVENT_SYSTEM, PBS_EVENTCLASS_SERVER, id,log_buffer);
	    DBPRT(("%s: %s\n", id, log_buffer));

	    /*
	     * Running failed! Move the job back to the source queue (if 
	     * applicable) before returning. This prevents jobs being left
	     * in execution queues.
	     */
	    if (srcq) {
	        DBPRT(("Attempting to move job %s back to queue %s\n", 
	           job->jobid, srcq->qname));

	        if (pbs_movejob(connector, job->jobid, srcq->qname, NULL)) {
	            (void)sprintf(log_buffer, 
	                "failed to move job %s back to queue %s, %d",
			job->jobid, srcq->qname, pbs_errno);
	            log_record(PBSEVENT_SYSTEM, PBS_EVENTCLASS_SERVER, id, 
		        log_buffer);
	            DBPRT(("%s: %s\n", id, log_buffer));
	        }
	        schd_move_job_to(job, srcq);
	    }
	    return (-1);
        }
	strcpy(tmp_word, "started");
    } 
    else {  /* it IS a suspended job */

	schd_move_job_to(job, destq);
        ret = pbs_sigjob(connector, job->jobid, "resume", NULL);
        if (ret) {
	    sprintf(log_buffer, "resume of job %s FAILED (%d)",
		job->jobid, ret);
	    return (-1);
	}
	job->flags &= ~JFLAGS_SUSPENDED;
	strcpy(tmp_word, "resumed");
    }

    /* PBS accepted the job (and presumably will run it). Log the fact. */
    (void)sprintf(log_buffer, "job %s %s on %s@%s", job->jobid, tmp_word,
	destq->qname, exechost);
    log_record(PBSEVENT_SYSTEM, PBS_EVENTCLASS_SERVER, id, log_buffer);
    DBPRT(("%s: %s\n", id, log_buffer));

    /*
     * Change the state of the local representation of the job to "Running".
     */
    job->state = 'R';

    /*
     * Account for the job on this queue's statistics.  'queued' will be
     * bumped up if the queued job was moved to a new destination queue.
     */

    job->queue->queued --;
    job->queue->running ++;

    /* The queue is no longer idle.  Unset the idle timer. */
    job->queue->idle_since = 0;

    return (0);				/* Job successfully started. */
}

/*
 * schd_charge_job(job, queue, rsrcs)
 *
 * Account for the job resources requested by 'job' in the assigned and
 * available resources in 'queue' and 'rsrcs'
 *
 * Possible side effects:
 *  - If job allocates all of some resource, the queue will be marked "FULL".
 *  - queue->empty_by time may be extended to the end of this job.
 *
 * Returns 0 on success.
 */
int
schd_charge_job(Job *job, Queue *queue, Resources *rsrcs)
{
    char   *id = "schd_charge_job";
    char   que_usr_tuple[120];
    int     i;
    struct tm *tmptr;
    time_t  when, job_ends, now;
    long    wallt;
    FairAccessList *FALptr;
    AccessEntry    *AEptr;

    /* Update the queue and resources with the job's expected usage. */
    queue->ncpus_assn  += job->ncpus;
    rsrcs->ncpus_alloc += job->ncpus;
    queue->mem_assn    += job->memory;
    rsrcs->mem_alloc   += job->memory;
    rsrcs->freemem     -= job->memory;
    rsrcs->loadave     += job->ncpus;
    rsrcs->njobs ++;

    /* Has the queue nCPU limit been reached?  If so, note it and fail. */
    if ((queue->ncpus_max != UNSPECIFIED) &&
	(queue->ncpus_max <= queue->ncpus_assn)) 
    {
	DBPRT(("%s: Queue %s CPU limit (%d) reached - mark full\n", id, 
	    queue->qname, queue->ncpus_max));
	queue->flags |= QFLAGS_FULL;
    }

    /* Has the queue memory limit been reached?  If so, note it and fail. */
    if ((queue->mem_max != UNSPECIFIED) &&
	(queue->mem_max <= queue->mem_assn)) 
    {
	DBPRT(("%s: Queue %s memory limit (%d) reached - mark full\n", id, 
	    queue->qname, queue->mem_max));
	queue->flags |= QFLAGS_FULL;
    }

    /*
     * If job specified a walltime, see if the queue "empty at" time needs
     * to be updated.  This function should only be called once we are
     * committed to running this job, so it is appropriate to update this
     * value at this point.
     */
    if (job->walltime != UNSPECIFIED) {
	job_ends = schd_TimeNow + job->walltime;

	if (job_ends > queue->empty_by)	{
	    DBPRT(("%s: Queue %s empty_by %s to %s", id, queue->qname, 
		queue->empty_by ? "bumped" : "set to", ctime(&job_ends)));

	    queue->empty_by = job_ends;
	}
    }

    /* Now update the per-User FairAccess usage table */
    for (i = 0; i < nUsers; ++i) {

	sprintf(que_usr_tuple, "%s:%s", job->owner, job->oqueue);
        if (!strcmp(que_usr_tuple, Users[i].name)) {
		Users[i].running_jobs   ++;
	}
    }

    if (!(job->flags & JFLAGS_SUSPENDED) &&
	!(job->flags & JFLAGS_CHKPTD)) {

        /* Calculate number of minutes elapsed since midnight (00:00:00). */
        time(&when);
        tmptr = localtime(&when);
        now = ((tmptr->tm_hour * 60) + tmptr->tm_min);
    
        /* convert walltime seconds to minutes */
        wallt = job->walltime / 60;
    
        /* Lastly update the per-Queue FairShare table */
        for (FALptr = schd_FairACL; FALptr != NULL; FALptr = FALptr->next) {
            for (AEptr = FALptr->entry; AEptr != NULL;  AEptr = AEptr->next) {
                if (AEptr->name) {
                        if (!strcmp(AEptr->name, job->oqueue)) {
		        AEptr->today_usage += job->ncpus * wallt;
     		        AEptr->today_max    = schd_MAX_NCPUS * now;
	            }
                }
            }
        }
    }
    return (0);
}

/* reverse the charges for this job-- used during the suspend/checkpoint
 * logic of the scheduler
 */

void
schd_UNcharge_job(Job *job, Queue *queue, Resources *rsrcs)
{
    /*char   *id = "schd_charge_job";*/
    char   que_usr_tuple[120];
    int     i;

    /* Update the queue and resources with the job's expected usage. */
    queue->ncpus_assn  -= job->ncpus;
    rsrcs->ncpus_alloc -= job->ncpus;
    queue->mem_assn    -= job->memory;
    rsrcs->mem_alloc   -= job->memory;
    rsrcs->freemem     += job->memory;
    rsrcs->loadave     -= job->ncpus;
    rsrcs->njobs   --;
    queue->running --;

    /* Now update the per-User FairAccess usage table */
    for (i = 0; i < nUsers; ++i) {
	sprintf(que_usr_tuple, "%s:%s", job->owner, job->oqueue);
        if (!strcmp(que_usr_tuple, Users[i].name)) {
		Users[i].running_jobs   --;
	}
    }
}