src/bcast/file_bcast.h

/****************************************************************************\
 *  file_bcast.h - definitions used for file broadcast functions
 *****************************************************************************
 *  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 _FILE_BCAST_H
#define _FILE_BCAST_H

#include "slurm/slurm.h"
#include "src/common/macros.h"
#include "src/common/slurm_protocol_defs.h"

#define BCAST_FLAG_FORCE SLURM_BIT(0)
#define BCAST_FLAG_PRESERVE SLURM_BIT(1)
#define BCAST_FLAG_SEND_LIBS SLURM_BIT(2)
#define BCAST_FLAG_SHARED_OBJECT SLURM_BIT(3)
#define BCAST_FLAG_NO_JOB SLURM_BIT(4)

struct bcast_parameters {
	uint32_t block_size;
	uint16_t compress;
	char *exclude;
	char *dst_fname;
	char *exe_fname;
	uint16_t flags;
	char *node_list;
	list_t *selected_steps; /* HetJob components selected_step list. */
	slurm_selected_step_t *selected_step;
	char *src_fname;
	uint32_t step_id;
	int timeout;
	int tree_width;
	int verbose;
};

typedef struct file_bcast_info {
	void *data;		/* mmap of file data */
	int fd;			/* file descriptor */
	uint64_t file_size;	/* file size */
	char *fname;		/* filename */
	gid_t gid;		/* gid of owner */
	uint32_t job_id;	/* job id */
	uint32_t step_id;	/* step id */
	time_t last_update;	/* transfer last block received */
	int received_blocks;	/* number of blocks received */
	time_t start_time;	/* transfer start time */
	uid_t uid;		/* uid of owner */
} file_bcast_info_t;

typedef struct {
	uint32_t bcast_sent_cnt;		/* succeeded bcast count */
	int bcast_total_cnt;			/* libs in list count */
	struct bcast_parameters *params;	/* bcast parameters */
	list_t *excluded_paths;			/* excluded paths list */
	int return_code;			/* bcast_file() rc */
} foreach_shared_object_t;

extern int bcast_file(struct bcast_parameters *params);

extern int bcast_decompress_data(file_bcast_msg_t *req);

#endif