/*****************************************************************************\
 *  prep.h - driver for PrEpPlugins ('Pr'olog and 'Ep'ilog)
 *****************************************************************************
 *  Copyright (C) SchedMD LLC.
 *
 *  This file is part of Slurm, a resource management program.
 *  For details, see <https://slurm.schedmd.com/>.
 *  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 _INTERFACES_PREP_H
#define _INTERFACES_PREP_H

#include "src/slurmctld/slurmctld.h"
#include "src/slurmd/slurmd/slurmd.h"

typedef struct {
	void (*prolog_slurmctld)(int rc, uint32_t job_id, bool timed_out);
	void (*epilog_slurmctld)(int rc, uint32_t job_id, bool timed_out);
} prep_callbacks_t;

typedef enum {
	PREP_REGISTER_CALLBACKS = 0,
	PREP_PROLOG,
	PREP_EPILOG,
	PREP_PROLOG_SLURMCTLD,
	PREP_EPILOG_SLURMCTLD,
	PREP_CALL_CNT,
} prep_call_type_t;

/*
 * Initialize the PrEpPlugins.
 *
 * Pass in a set of callbacks so the plugin can hook back into slurmctld.
 *
 * Returns a Slurm errno.
 */
extern int prep_g_init(prep_callbacks_t *callbacks);

/*
 * Terminate the PrEpPlugins and free associated memory.
 *
 * Returns a Slurm errno.
 */
extern int prep_g_fini(void);

/*
 **************************************************************************
 *                          P L U G I N   C A L L S                       *
 **************************************************************************
 */

/*
 * Returns a Slurm errno.
 */
extern int prep_g_prolog(job_env_t *job_env, slurm_cred_t *cred);

/*
 * Returns a Slurm errno.
 */
extern int prep_g_epilog(job_env_t *job_env, slurm_cred_t *cred);

/*
 * No return code, will update job status through job_ptr if necessary,
 * or plugins may call prep_prolog_slurmctld_callback().
 */
extern void prep_g_prolog_slurmctld(job_record_t *job_ptr);

/*
 * No return code, will update job status through job_ptr if necessary,
 * or plugins may call prep_epilog_slurmctld_callback().
 */
extern void prep_g_epilog_slurmctld(job_record_t *job_ptr);

/* Whether or not the requested prep is configured or not */
extern bool prep_g_required(prep_call_type_t type);

#endif