src/common/xcgroup_read_config.h

/*****************************************************************************\
 *  xcgroup_read_config.h - functions and declarations for reading cgroup.conf
 *****************************************************************************
 *  Copyright (C) 2009 CEA/DAM/DIF
 *  Written by Matthieu Hautreux <matthieu.hautreux@cea.fr>
 *  Copyright (C) 2018 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 _CGROUP_READ_CONFIG_H
#define _CGROUP_READ_CONFIG_H

#include <inttypes.h>

extern pthread_mutex_t xcgroup_config_read_mutex;

/*  Default lower bound on memory limit in MB. This is required so we
 *   don't immediately kill slurmstepd on mem cgroup creation if
 *   an administrator or user sets and absurdly low mem limit.
 */
#define XCGROUP_DEFAULT_MIN_RAM 30

/* Slurm cgroup plugins configuration parameters */
typedef struct slurm_cgroup_conf {

	bool      cgroup_automount;
	char *    cgroup_mountpoint;

	char *    cgroup_prepend;

	bool      constrain_cores;
	bool      task_affinity;

	bool      constrain_ram_space;
	float     allowed_ram_space;
	float     max_ram_percent;       /* Upper bound on memory as % of RAM*/

	uint64_t  min_ram_space;         /* Lower bound on memory limit (MB) */

	bool      constrain_kmem_space;
	float     allowed_kmem_space;
	float     max_kmem_percent;
	uint64_t  min_kmem_space;

	bool      constrain_swap_space;
	float     allowed_swap_space;
	float     max_swap_percent;      /* Upper bound on swap as % of RAM  */
	uint64_t  memory_swappiness;

	bool      constrain_devices;
	char *    allowed_devices_file;

} slurm_cgroup_conf_t;

/*
 * xcgroup_get_slurm_cgroup_conf - returns slurm_cgroup_conf_t representing the
 *      contents of the cgroup.conf file.
 *      This must have xcgroup_config_read_mutex locked before calling and while
 *      using the returned slurm_cgroup_conf_t.
 */
extern slurm_cgroup_conf_t *xcgroup_get_slurm_cgroup_conf(void);

/*
 * xcgroup_get_conf_list - load the Slurm cgroup configuration from the
 *      cgroup.conf  file and return a key pair <name,value> ordered list.
 *      xcgroup_config_read_mutex must not be locked before calling.
 * RET List with cgroup.conf <name,value> pairs if no error, NULL otherwise.
 */
extern List xcgroup_get_conf_list(void);

/*
 * Reread cgroup.conf
 *      xcgroup_config_read_mutex must not be locked before calling.
 */
extern void xcgroup_reconfig_slurm_cgroup_conf(void);

/*
 * Write the cgroup.conf file out to the stepd.
 *      xcgroup_config_read_mutex must not be locked before calling.
 */
extern int xcgroup_write_conf(int fd);

/*
 * Read in the cgroup.conf file on the slurmstepd from the slurmd.
 *      xcgroup_config_read_mutex must not be locked before calling.
 */
extern int xcgroup_read_conf(int fd);

/*
 * xcgroup_fini_slurm_cgroup_conf - when finished using the cgroup.conf file
 *      free the structure.
 *      xcgroup_config_read_mutex must not be locked before calling.
 */
extern void xcgroup_fini_slurm_cgroup_conf(void);

/* Check that memspec cgroup job confinement is configured */
extern bool xcgroup_mem_cgroup_job_confinement(void);

#endif /* !_CGROUP_READ_CONFIG_H */