| /*****************************************************************************\ |
| * eval_nodes.h - Determine order of nodes for job. |
| ***************************************************************************** |
| * 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 _COMMON_TOPO_EVAL_NODES_H |
| #define _COMMON_TOPO_EVAL_NODES_H |
| |
| #include "common_topo.h" |
| |
| typedef struct topo_weight_info { |
| bitstr_t *node_bitmap; |
| int node_cnt; |
| uint64_t weight; |
| } topo_weight_info_t; |
| |
| /* |
| * This is the heart of the selection process |
| * |
| * IN topo_eval-> |
| * IN/OUT avail_core - available core bitmap |
| * OUT avail_cpus - How many cpus available |
| * IN/OUT avail_res_array - available resources on the node |
| * IN cr_type - allocation type (sockets, cores, etc.) |
| * IN enforce_binding - Enforce GPU Binding or not |
| * IN first_pass - First pass through common_topo_eval_nodes() or not |
| * IN job_ptr - pointer to the job requesting resources |
| * IN max_nodes - maximum number of nodes requested |
| * IN mc_ptr - job's GRES multi-core options |
| * IN min_nodes - minimum number of nodes required |
| * IN/OUT node_map - bitmap of available/selected nodes |
| * IN prefer_alloc_nodes - prefer use of already allocated nodes |
| * IN req_nodes - number of requested nodes |
| * |
| * RET SLURM_SUCCESS or an error code |
| */ |
| extern int eval_nodes(topology_eval_t *topo_eval); |
| |
| /* |
| * Determine how many CPUs on the node can be used based upon the resource |
| * allocation unit (node, socket, core, etc.) and making sure that |
| * resources will be available for nodes considered later in the |
| * scheduling process |
| * This also check as the gres gets laid out that if restricted gpu cores are |
| * removed their are still enough cpus on the node. It returns true if the Gres |
| * requirement could be satisfied or false if not |
| */ |
| extern bool eval_nodes_cpus_to_use(topology_eval_t *topo_eval, int node_inx, |
| int64_t rem_max_cpus, int rem_nodes, |
| uint64_t *max_tasks, bool check_gres); |
| |
| /* |
| * Reduce the cores per socket to match avail_cores_per_sock set by |
| * gres_filter_sock_core(). |
| * If gres_filter_sock_core() is called then avail_cores_per_sock is reduced |
| * while the avail_core bitmap is left alone, unless a core can not be used. |
| * This is to allow for restricted cores per gpu. |
| */ |
| extern void eval_nodes_clip_socket_cores(topology_eval_t *topo_eval); |
| |
| /* |
| * Reduce the gres_max_tasks and total GRES available to a node based on |
| * what will be laid out on the node. |
| * If the GRES available gets reduced and RestrictedCoresPerGPU |
| * is used, any unusable restricted cores will be removed. |
| * If to many cores are removed such that the node is no longer usable |
| * in the allocation it returns false, else true. |
| */ |
| extern bool eval_nodes_gres(topology_eval_t *topo_eval, |
| uint64_t *maxtasks, |
| job_record_t *job_ptr, |
| node_record_t *node_ptr, |
| int rem_nodes, |
| int node_i, |
| int select_inx); |
| |
| /* |
| * Identify the specific cores and GRES available to this job on this node. |
| * The job's requirements for tasks-per-socket, cpus-per-task, etc. are |
| * not considered at this point, but must be considered later. |
| */ |
| extern void eval_nodes_select_cores(topology_eval_t *topo_eval, |
| int node_inx, int rem_nodes); |
| |
| /* Returns the maximum tasks the job allocation could have */ |
| extern uint64_t eval_nodes_set_max_tasks(job_record_t *job_ptr, |
| uint64_t max_cpus, |
| uint32_t max_nodes); |
| |
| /* |
| * Return the max amount of cpus still remaining to search for. |
| */ |
| extern int64_t eval_nodes_get_rem_max_cpus( |
| job_details_t *details_ptr, int rem_nodes); |
| |
| extern int eval_nodes_topo_weight_find(void *x, void *key); |
| extern int eval_nodes_topo_node_find(void *x, void *key); |
| extern void eval_nodes_topo_weight_free(void *x); |
| extern int eval_nodes_topo_weight_log(void *x, void *arg); |
| extern int eval_nodes_topo_weight_sort(void *x, void *y); |
| extern bool eval_nodes_enough_nodes(int avail_nodes, int rem_nodes, |
| uint32_t min_nodes, uint32_t req_nodes); |
| |
| #endif |
