-
Danny Auble authoredDanny Auble authored
read_config.h 18.31 KiB
/*****************************************************************************
* read_config.h - definitions for reading the overall slurm configuration
* file
*****************************************************************************
* Copyright (C) 2002-2007 The Regents of the University of California.
* Copyright (C) 2008-2010 Lawrence Livermore National Security.
* Portions Copyright (C) 2008 Vijay Ramasubramanian.
* Portions Copyright (C) 2010 SchedMD <http://www.schedmd.com>.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
* Written by Morris Mette <jette1@llnl.gov>.
* 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 _READ_CONFIG_H
#define _READ_CONFIG_H
#include "src/common/list.h"
#include "src/common/slurm_protocol_defs.h"
#include "src/common/slurm_protocol_socket_common.h"
#include "src/common/parse_config.h"
extern slurm_ctl_conf_t slurmctld_conf;
extern char *default_slurm_config_file;
extern char *default_plugin_path;
extern char *default_plugstack;
#define ACCOUNTING_ENFORCE_ASSOCS 0x0001
#define ACCOUNTING_ENFORCE_LIMITS 0x0002
#define ACCOUNTING_ENFORCE_WCKEYS 0x0004
#define ACCOUNTING_ENFORCE_QOS 0x0008
#define ACCOUNTING_ENFORCE_SAFE 0x0010
#define DEFAULT_ACCOUNTING_DB "slurm_acct_db"
#define DEFAULT_ACCOUNTING_ENFORCE 0
#define DEFAULT_ACCOUNTING_STORAGE_TYPE "accounting_storage/none"
#define DEFAULT_AUTH_TYPE "auth/munge"
#define DEFAULT_BATCH_START_TIMEOUT 10
#define DEFAULT_COMPLETE_WAIT 0
#define DEFAULT_CRYPTO_TYPE "crypto/munge"
#define DEFAULT_EPILOG_MSG_TIME 2000
#define DEFAULT_FAST_SCHEDULE 1#define DEFAULT_FIRST_JOB_ID 1
#define DEFAULT_GET_ENV_TIMEOUT 2
#define DEFAULT_GROUP_INFO 600
/* NOTE: DEFAULT_INACTIVE_LIMIT must be 0 for Blue Gene/L systems */
#define DEFAULT_INACTIVE_LIMIT 0
#define DEFAULT_JOB_ACCT_GATHER_TYPE "jobacct_gather/none"
#define JOB_ACCT_GATHER_TYPE_NONE "jobacct_gather/none"
#define DEFAULT_JOB_ACCT_GATHER_FREQ 30
#define ACCOUNTING_STORAGE_TYPE_NONE "accounting_storage/none"
#define DEFAULT_DISABLE_ROOT_JOBS 0
#define DEFAULT_ENFORCE_PART_LIMITS 0
#define DEFAULT_JOB_CKPT_DIR "/var/slurm/checkpoint"
#define DEFAULT_JOB_COMP_TYPE "jobcomp/none"
#define DEFAULT_JOB_COMP_LOC "/var/log/slurm_jobcomp.log"
#define DEFAULT_JOB_COMP_DB "slurm_jobcomp_db"
#define DEFAULT_KILL_ON_BAD_EXIT 0
#define DEFAULT_KILL_TREE 0
#define DEFAULT_KILL_WAIT 30
#if defined HAVE_BG_FILES && !defined HAVE_BG_L_P
# define DEFAULT_LAUNCH_TYPE "launch/runjob"
#elif defined HAVE_LIBNRT
# define DEFAULT_LAUNCH_TYPE "launch/poe"
#elif defined HAVE_REAL_CRAY
# define DEFAULT_LAUNCH_TYPE "launch/aprun"
#else
# define DEFAULT_LAUNCH_TYPE "launch/slurm"
#endif
#define DEFAULT_MAIL_PROG "/bin/mail"
#define DEFAULT_MAX_JOB_COUNT 10000
#define DEFAULT_MAX_JOB_ID 0xffff0000
#define DEFAULT_MAX_STEP_COUNT 40000
#define DEFAULT_MEM_PER_CPU 0
#define DEFAULT_MAX_MEM_PER_CPU 0
#define DEFAULT_MIN_JOB_AGE 300
#define DEFAULT_MPI_DEFAULT "none"
#define DEFAULT_MSG_TIMEOUT 10
#ifdef HAVE_AIX /* AIX specific default configuration parameters */
# define DEFAULT_CHECKPOINT_TYPE "checkpoint/aix"
# define DEFAULT_PROCTRACK_TYPE "proctrack/aix"
#else
# define DEFAULT_CHECKPOINT_TYPE "checkpoint/none"
# if defined HAVE_REAL_CRAY/* ALPS requires cluster-unique job container IDs */
# define DEFAULT_PROCTRACK_TYPE "proctrack/sgi_job"
# else
# define DEFAULT_PROCTRACK_TYPE "proctrack/pgid"
# endif
#endif
#define DEFAULT_PREEMPT_TYPE "preempt/none"
#define DEFAULT_PRIORITY_DECAY 604800 /* 7 days */
#define DEFAULT_PRIORITY_CALC_PERIOD 300 /* in seconds */
#define DEFAULT_PRIORITY_TYPE "priority/basic"
#define DEFAULT_RECONF_KEEP_PART_STATE 0
#define DEFAULT_RETURN_TO_SERVICE 0
#define DEFAULT_RESUME_RATE 300
#define DEFAULT_RESUME_TIMEOUT 60
#define DEFAULT_SAVE_STATE_LOC "/var/spool"
#define DEFAULT_SCHEDROOTFILTER 1
#define DEFAULT_SCHEDULER_PORT 7321
#define DEFAULT_SCHED_LOG_LEVEL 0
#define DEFAULT_SCHED_TIME_SLICE 30
#define DEFAULT_SCHEDTYPE "sched/builtin"
#ifdef HAVE_BG /* Blue Gene specific default configuration parameters */
# define DEFAULT_SELECT_TYPE "select/bluegene"
#elif defined HAVE_CRAY
# define DEFAULT_SELECT_TYPE "select/cray"
#else
# define DEFAULT_SELECT_TYPE "select/linear"
#endif#define DEFAULT_SLURMCTLD_PIDFILE "/var/run/slurmctld.pid"
#define DEFAULT_SLURMCTLD_TIMEOUT 120
#define DEFAULT_SLURMD_PIDFILE "/var/run/slurmd.pid"
#define DEFAULT_SLURMD_TIMEOUT 300
#define DEFAULT_SPOOLDIR "/var/spool/slurmd"
#define DEFAULT_STORAGE_HOST "localhost"
#define DEFAULT_STORAGE_LOC "/var/log/slurm_jobacct.log"
#define DEFAULT_STORAGE_USER "root"
#define DEFAULT_STORAGE_PORT 0
#define DEFAULT_PGSQL_PORT 5432
#define DEFAULT_MYSQL_PORT 3306
#define DEFAULT_SUSPEND_RATE 60
#define DEFAULT_SUSPEND_TIME 0
#define DEFAULT_SUSPEND_TIMEOUT 30
#define DEFAULT_SWITCH_TYPE "switch/none"
#define DEFAULT_TASK_PLUGIN "task/none"
#define DEFAULT_TMP_FS "/tmp"
#if defined HAVE_3D && !defined HAVE_CRAY
# define DEFAULT_TOPOLOGY_PLUGIN "topology/3d_torus"
#else
# define DEFAULT_TOPOLOGY_PLUGIN "topology/none"
#endif
#define DEFAULT_WAIT_TIME 0
# define DEFAULT_TREE_WIDTH 50
#define DEFAULT_UNKILLABLE_TIMEOUT 60 /* seconds */
#define DEFAULT_MAX_TASKS_PER_NODE 128
typedef struct slurm_conf_frontend {
char *frontends; /* frontend node name */
char *addresses; /* frontend node address */
uint16_t port; /* frontend specific port */
char *reason; /* reason for down frontend node */
uint16_t node_state; /* enum node_states, ORed with
* NODE_STATE_NO_RESPOND if not
* responding */
} slurm_conf_frontend_t;
typedef struct slurm_conf_node {
char *nodenames;
char *hostnames;
char *addresses;
char *gres; /* arbitrary list of node's generic resources */
char *feature; /* arbitrary list of node's features */
char *port_str;
uint16_t cpus; /* count of cpus running on the node */
uint16_t boards; /* number of boards per node */
uint16_t sockets; /* number of sockets per node */
uint16_t cores; /* number of cores per CPU */
uint16_t threads; /* number of threads per core */
uint32_t real_memory; /* MB real memory on the node */
char *reason;
char *state;
uint32_t tmp_disk; /* MB total storage in TMP_FS file system */
uint32_t weight; /* arbitrary priority of node for
* scheduling work on */
} slurm_conf_node_t;
typedef struct slurm_conf_partition {
char *allow_alloc_nodes;/* comma delimited list of allowed
* allocating nodes
* NULL indicates all */
char *allow_groups; /* comma delimited list of groups,
* NULL indicates all */
char *alternate; /* name of alternate partition */
uint32_t def_mem_per_cpu; /* default MB memory per allocated CPU */
bool default_flag; /* Set if default partition */
uint32_t default_time; /* minutes or INFINITE */
uint16_t disable_root_jobs; /* if set then user root can't run
* jobs if NO_VAL use global
* default */ uint32_t grace_time; /* default grace time for partition */
bool hidden_flag; /* 1 if hidden by default */
uint16_t max_share; /* number of jobs to gang schedule */
uint32_t max_time; /* minutes or INFINITE */
uint32_t max_mem_per_cpu; /* maximum MB memory per allocated CPU */
uint32_t max_nodes; /* per job or INFINITE */
uint32_t min_nodes; /* per job */
char *name; /* name of the partition */
char *nodes; /* comma delimited list names of nodes */
uint16_t preempt_mode; /* See PREEMPT_MODE_* in slurm/slurm.h */
uint16_t priority; /* scheduling priority for jobs */
bool req_resv_flag; /* 1 if partition can only be used in a
* reservation */
bool root_only_flag;/* 1 if allocate/submit RPC can only be
issued by user root */
uint16_t state_up; /* for states see PARTITION_* in slurm.h */
uint32_t total_nodes; /* total number of nodes in the partition */
uint32_t total_cpus; /* total number of cpus in the partition */
} slurm_conf_partition_t;
typedef struct slurm_conf_downnodes {
char *nodenames;
char *reason;
char *state;
} slurm_conf_downnodes_t;
typedef struct {
char *name;
char *value;
} config_key_pair_t;
/* Destroy a front_end record built by slurm_conf_frontend_array() */
extern void destroy_frontend(void *ptr);
/*
* list_find_frontend - find an entry in the front_end list, see list.h for
* documentation
* IN key - is feature name or NULL for all features
* RET 1 if found, 0 otherwise
*/
extern int list_find_frontend (void *front_end_entry, void *key);
/*
* slurm_conf_init - load the slurm configuration from the a file.
* IN file_name - name of the slurm configuration file to be read
* If file_name is NULL, then this routine tries to use
* the value in the SLURM_CONF env variable. Failing that,
* it uses the compiled-in default file name.
* If the conf structures have already been initialized by a call to
* slurm_conf_init, any subsequent calls will do nothing until
* slurm_conf_destroy is called.
* RET SLURM_SUCCESS if conf file is initialized. If the slurm conf
* was already initialied, return SLURM_ERROR.
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern int slurm_conf_init(const char *file_name);
/*
* slurm_conf_reinit - reload the slurm configuration from a file.
* IN file_name - name of the slurm configuration file to be read
* If file_name is NULL, then this routine tries to use
* the value in the SLURM_CONF env variable. Failing that,
* it uses the compiled-in default file name.
* Unlike slurm_conf_init, slurm_conf_reinit will always reread the
* file and reinitialize the configuration structures.
* RET SLURM_SUCCESS if conf file is reinitialized, otherwise SLURM_ERROR.
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern int slurm_conf_reinit(const char *file_name);
/*
* slurm_conf_mutex_init - init the slurm_conf mutex
*/
extern void slurm_conf_mutex_init(void);
/* slurm_conf_install_fork_handlers
* installs what to do with a fork with the conf mutex
*/
void slurm_conf_install_fork_handlers(void);
/*
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern int slurm_conf_destroy(void);
extern slurm_ctl_conf_t *slurm_conf_lock(void);
extern void slurm_conf_unlock(void);
/*
* Set "ptr_array" with the pointer to an array of pointers to
* slurm_conf_frontend_t structures.
*
* Return value is the length of the array.
*/
extern int slurm_conf_frontend_array(slurm_conf_frontend_t **ptr_array[]);
/*
* Set "ptr_array" with the pointer to an array of pointers to
* slurm_conf_node_t structures.
*
* Return value is the length of the array.
*/
extern int slurm_conf_nodename_array(slurm_conf_node_t **ptr_array[]);
/*
* Set "ptr_array" with the pointer to an array of pointers to
* slurm_conf_partition_t structures.
*
* Return value is the length of the array.
*/
extern int slurm_conf_partition_array(slurm_conf_partition_t **ptr_array[]);
/*
* Set "ptr_array" with the pointer to an array of pointers to
* slurm_conf_downnodes_t structures.
*
* Return value is the length of the array.
*/
extern int slurm_conf_downnodes_array(slurm_conf_downnodes_t **ptr_array[]);
/*
* slurm_reset_alias - Reset the address and hostname of a specific node name
*/
extern void slurm_reset_alias(char *node_name, char *node_addr,
char *node_hostname);
/*
* slurm_conf_get_hostname - Return the NodeHostname for given NodeName
*
* Returned string was allocated with xmalloc(), and must be freed by
* the caller using xfree().
*
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern char *slurm_conf_get_hostname(const char *node_name);
/*
* slurm_conf_get_nodename - Return the NodeName for given NodeHostname *
* NOTE: Call xfree() to release returned value's memory.
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern char *slurm_conf_get_nodename(const char *node_hostname);
/*
* slurm_conf_get_aliases - Return all the nodes NodeName value
* associated to a given NodeHostname (usefull in case of multiple-slurmd
* to get the list of virtual nodes associated with a real node)
*
* NOTE: Call xfree() to release returned value's memory.
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern char *slurm_conf_get_aliases(const char *node_hostname);
/*
* slurm_conf_get_nodeaddr - Return the NodeAddr for given NodeHostname
*
* NOTE: Call xfree() to release returned value's memory.
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern char *slurm_conf_get_nodeaddr(const char *node_hostname);
/*
* slurm_conf_get_nodename_from_addr - Return the NodeName for given NodeAddr
*
* NOTE: Call xfree() to release returned value's memory.
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern char *slurm_conf_get_nodename_from_addr(const char *node_addr);
/*
* slurm_conf_get_aliased_nodename - Return the NodeName matching an alias
* of the local hostname
*
* Returned string was allocated with xmalloc(), and must be freed by
* the caller using xfree().
*
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern char *slurm_conf_get_aliased_nodename(void);
/*
* slurm_conf_get_port - Return the port for a given NodeName
*
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern uint16_t slurm_conf_get_port(const char *node_name);
/*
* slurm_conf_get_addr - Return the slurm_addr_t for a given NodeName in
* the parameter "address". The return code is SLURM_SUCCESS on success,
* and SLURM_FAILURE if the address lookup failed.
*
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern int slurm_conf_get_addr(const char *node_name, slurm_addr_t *address);
/*
* slurm_conf_get_cpus_bsct -
* Return the cpus, boards, sockets, cores, and threads configured for a
* given NodeName
* Returns SLURM_SUCCESS on success, SLURM_FAILURE on failure.
*
* NOTE: Caller must NOT be holding slurm_conf_lock().
*/
extern int slurm_conf_get_cpus_bsct(const char *node_name,
uint16_t *cpus, uint16_t *boards,
uint16_t *sockets, uint16_t *cores, uint16_t *threads);
/*
* init_slurm_conf - initialize or re-initialize the slurm configuration
* values defaults (NULL or NO_VAL). Note that the configuration
* file pathname (slurm_conf) is not changed.
* IN/OUT ctl_conf_ptr - pointer to data structure to be initialized
*/
extern void init_slurm_conf (slurm_ctl_conf_t *ctl_conf_ptr);
/*
* free_slurm_conf - free all storage associated with a slurm_ctl_conf_t.
* IN/OUT ctl_conf_ptr - pointer to data structure to be freed
* IN purge_node_hash - purge system-wide node hash table if set,
* set to zero if clearing private copy of config data
*/
extern void free_slurm_conf (slurm_ctl_conf_t *ctl_conf_ptr,
bool purge_node_hash);
/*
* gethostname_short - equivalent to gethostname(), but return only the first
* component of the fully qualified name (e.g. "linux123.foo.bar"
* becomes "linux123")
* NOTE: NodeName in the config may be different from real hostname.
* Use get_conf_node_name() to get the former.
*/
extern int gethostname_short (char *name, size_t len);
/*
* Replace first "%h" in path string with NodeHostname.
* Replace first "%n" in path string with NodeName.
*
* NOTE: Caller should be holding slurm_conf_lock() when calling this function.
*
* Returns an xmalloc()ed string which the caller must free with xfree().
*/
extern char *slurm_conf_expand_slurmd_path(const char *path,
const char *node_name);
/*
* debug_flags2str - convert a DebugFlags uint32_t to the equivalent string
* Returns an xmalloc()ed string which the caller must free with xfree().
*/
extern char *debug_flags2str(uint32_t debug_flags);
/*
* debug_str2flags - Convert a DebugFlags string to the equivalent uint32_t
* Returns NO_VAL if invalid
*/
extern uint32_t debug_str2flags(char *debug_flags);
/*
* reconfig_flags2str - convert a ReconfigFlags uint16_t to the equivalent string
* Returns an xmalloc()ed string which the caller must free with xfree().
*/
extern char *reconfig_flags2str(uint16_t reconfig_flags);
/*
* reconfig_str2flags - Convert a ReconfigFlags string to the equivalent uint16_t
* Returns NO_VAL if invalid
*/
extern uint16_t reconfig_str2flags(char *reconfig_flags);
extern void destroy_config_key_pair(void *object);
extern void pack_config_key_pair(void *in, uint16_t rpc_version, Buf buffer);
extern int unpack_config_key_pair(void **object, uint16_t rpc_version,
Buf buffer);
extern int sort_key_pairs(config_key_pair_t *key_a, config_key_pair_t *key_b);
#endif /* !_READ_CONFIG_H */