| /*****************************************************************************\ |
| * srun_comm.h - definitions srun communications |
| ***************************************************************************** |
| * Copyright (C) 2002-2007 The Regents of the University of California. |
| * Copyright (C) 2008-2010 Lawrence Livermore National Security. |
| * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). |
| * Written by Morris Jette <jette@llnl.gov> et. al. |
| * CODE-OCEC-09-009. All rights reserved. |
| * |
| * This file is part of SLURM, a resource management program. |
| * For details, see <http://www.schedmd.com/slurmdocs/>. |
| * Please also read the included file: DISCLAIMER. |
| * |
| * SLURM is free software; you can redistribute it and/or modify it under |
| * the terms of the GNU General Public License as published by the Free |
| * Software Foundation; either version 2 of the License, or (at your option) |
| * any later version. |
| * |
| * In addition, as a special exception, the copyright holders give permission |
| * to link the code of portions of this program with the OpenSSL library under |
| * certain conditions as described in each individual source file, and |
| * distribute linked combinations including the two. You must obey the GNU |
| * General Public License in all respects for all of the code used other than |
| * OpenSSL. If you modify file(s) with this exception, you may extend this |
| * exception to your version of the file(s), but you are not obligated to do |
| * so. If you do not wish to do so, delete this exception statement from your |
| * version. If you delete this exception statement from all source files in |
| * the program, then also delete it here. |
| * |
| * SLURM is distributed in the hope that it will be useful, but WITHOUT ANY |
| * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
| * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
| * details. |
| * |
| * You should have received a copy of the GNU General Public License along |
| * with SLURM; if not, write to the Free Software Foundation, Inc., |
| * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| \*****************************************************************************/ |
| |
| #ifndef _HAVE_SRUN_COMM_H |
| #define _HAVE_SRUN_COMM_H |
| |
| #include <sys/types.h> |
| #include <time.h> |
| |
| #include "src/slurmctld/slurmctld.h" |
| |
| /* |
| * srun_allocate - notify srun of a resource allocation |
| * IN job_id - id of the job allocated resource |
| */ |
| extern void srun_allocate (uint32_t job_id); |
| |
| /* |
| * srun_allocate_abort - notify srun of a resource allocation failure |
| * IN job_id - id of the job allocated resource |
| */ |
| extern void srun_allocate_abort(struct job_record *job_ptr); |
| |
| /* |
| * srun_exec - request that srun execute a specific command |
| * and route it's output to stdout |
| * IN step_ptr - pointer to the slurmctld job step record |
| * IN argv - command and arguments to execute |
| */ |
| extern void srun_exec(struct step_record *step_ptr, char **argv); |
| |
| /* |
| * srun_job_complete - notify srun of a job's termination |
| * IN job_ptr - pointer to the slurmctld job record |
| */ |
| extern void srun_job_complete (struct job_record *job_ptr); |
| |
| |
| /* |
| * srun_job_suspend - notify salloc of suspend/resume operation |
| * IN job_ptr - pointer to the slurmctld job record |
| * IN op - SUSPEND_JOB or RESUME_JOB (enum suspend_opts from slurm.h) |
| * RET - true if message send, otherwise false |
| */ |
| extern bool srun_job_suspend (struct job_record *job_ptr, uint16_t op); |
| |
| /* |
| * srun_step_complete - notify srun of a job step's termination |
| * IN step_ptr - pointer to the slurmctld job step record |
| */ |
| extern void srun_step_complete (struct step_record *step_ptr); |
| |
| /* |
| * srun_step_missing - notify srun that a job step is missing from |
| * a node we expect to find it on |
| * IN step_ptr - pointer to the slurmctld job step record |
| * IN node_list - name of nodes we did not find the step on |
| */ |
| extern void srun_step_missing (struct step_record *step_ptr, |
| char *node_list); |
| |
| /* |
| * srun_step_signal - notify srun that a job step should be signalled |
| * NOTE: Needed on BlueGene/Q to signal runjob process |
| * IN step_ptr - pointer to the slurmctld job step record |
| * IN signal - signal number |
| */ |
| extern void srun_step_signal (struct step_record *step_ptr, uint16_t signal); |
| |
| /* |
| * srun_node_fail - notify srun of a node's failure |
| * IN job_id - id of job to notify |
| * IN node_name - name of failed node |
| */ |
| extern void srun_node_fail (uint32_t job_id, char *node_name); |
| |
| /* srun_ping - ping all srun commands that have not been heard from recently */ |
| extern void srun_ping (void); |
| |
| /* |
| * srun_response - note that srun has responded |
| * IN job_id - id of job responding |
| * IN step_id - id of step responding or NO_VAL if not a step |
| */ |
| extern void srun_response(uint32_t job_id, uint32_t step_id); |
| |
| /* |
| * srun_step_timeout - notify srun of a job step's imminent timeout |
| * IN step_ptr - pointer to the slurmctld step record |
| * IN timeout_val - when it is going to time out |
| */ |
| extern void srun_step_timeout(struct step_record *step_ptr, time_t timeout_val); |
| |
| /* |
| * srun_timeout - notify srun of a job's timeout |
| * IN job_ptr - pointer to the slurmctld job record |
| */ |
| extern void srun_timeout (struct job_record *job_ptr); |
| |
| /* |
| * srun_user_message - Send arbitrary message to an srun job (no job steps) |
| */ |
| extern int srun_user_message(struct job_record *job_ptr, char *msg); |
| |
| #endif /* !_HAVE_SRUN_COMM_H */ |
