/*****************************************************************************\ * node_features.h - Infrastructure for changing a node's features on user * demand ***************************************************************************** * Copyright (C) 2016 SchedMD LLC. * Written by Morris Jette * * This file is part of Slurm, a resource management program. * For details, see . * 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 _NODE_FEATURES_H #define _NODE_FEATURES_H #include "slurm/slurm.h" #include "src/common/bitstring.h" /* Perform plugin initialization: read configuration files, etc. */ extern int node_features_g_init(void); /* Perform plugin termination: save state, free memory, etc. */ extern int node_features_g_fini(void); /* Return count of node_feature plugins configured */ extern int node_features_g_count(void); /* Reset plugin configuration information */ extern int node_features_g_reconfig(void); /* Return TRUE if this (one) feature name is under this plugin's control */ extern bool node_features_g_changeable_feature(char *feature); /* Update active and available features on specified nodes, sets features on * all nodes is node_list is NULL */ extern int node_features_g_get_node(char *node_list); /* Test if a job's feature specification is valid */ extern int node_features_g_job_valid(char *job_features); /* * Translate a job's feature request to the node features needed at boot time. * If multiple MCDRAM or NUMA values are ORed, pick the first ones. * IN job_features - job's --constraint specification * RET features required on node reboot. Must xfree to release memory */ extern char *node_features_g_job_xlate(char *job_features); /* Return bitmap of KNL nodes, NULL if none identified */ extern bitstr_t *node_features_g_get_node_bitmap(void); /* Return count of bits in active_bitmap that are in the features bitmap */ extern int node_features_g_overlap(bitstr_t *active_bitmap); /* Return true if the plugin requires PowerSave mode for booting nodes */ extern bool node_features_g_node_power(void); /* Set's the node's active features based upon job constraints. * NOTE: Executed by the slurmd daemon. * IN active_features - New active features * RET error code */ extern int node_features_g_node_set(char *active_features); /* Get this node's current and available MCDRAM and NUMA settings from BIOS. * avail_modes IN/OUT - available modes, must be xfreed * current_mode IN/OUT - current modes, must be xfreed */ extern void node_features_g_node_state(char **avail_modes, char **current_mode); /* Note the active features associated with a set of nodes have been updated. * Specifically update the node's "hbm" GRES and "CpuBind" values as needed. * IN active_features - New active features * IN node_bitmap - bitmap of nodes changed * RET error code */ extern int node_features_g_node_update(char *active_features, bitstr_t *node_bitmap); /* * Return TRUE if the specified node update request is valid with respect * to features changes (i.e. don't permit a non-KNL node to set KNL features). * * node_ptr IN - Pointer to node_record_t record * update_node_msg IN - Pointer to update request */ extern bool node_features_g_node_update_valid(void *node_ptr, update_node_msg_t *update_node_msg); /* * Translate a node's feature specification by replacing any features associated * with this plugin in the original value with the new values, preserving * any features that are not associated with this plugin * IN new_features - newly active features * IN orig_features - original active features * IN avail_features - original available features * IN node_inx - index of node in node table * RET node's new merged features, must be xfreed */ extern char *node_features_g_node_xlate(char *new_features, char *orig_features, char *avail_features, int node_inx); /* Translate a node's new feature specification into a "standard" ordering * RET node's new merged features, must be xfreed */ extern char *node_features_g_node_xlate2(char *new_features); /* Perform set up for step launch * mem_sort IN - Trigger sort of memory pages (KNL zonesort) * numa_bitmap IN - NUMA nodes allocated to this job */ extern void node_features_g_step_config(bool mem_sort, bitstr_t *numa_bitmap); /* Determine if the specified user can modify the currently available node * features */ extern bool node_features_g_user_update(uid_t uid); /* Return estimated reboot time, in seconds */ extern uint32_t node_features_g_boot_time(void); /* * Return node "weight" field if reboot required to change mode */ extern uint32_t node_features_g_reboot_weight(void); /* Get node features plugin configuration */ extern List node_features_g_get_config(void); #endif /* !_NODE_FEATURES_H */