src/plugins/priority/basic/priority_basic.c - SchedMD/slurm - Git at Google

 /*****************************************************************************\
  *  priority_basic.c - NO-OP slurm priority plugin.
  *****************************************************************************
  *  Copyright (C) 2008 Lawrence Livermore National Security.
  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
  *  Written by Danny Auble <da@llnl.gov>
  *  CODE-OCEC-09-009. All rights reserved.
  *
  *  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.
 \*****************************************************************************/

 #include <inttypes.h>
 #include <math.h>
 #include <stdio.h>

 #include "slurm/slurm_errno.h"

 #include "src/interfaces/priority.h"
 #include "src/common/assoc_mgr.h"

 /* These are defined here so when we link with something other than
  * the slurmctld we will have these symbols defined.  They will get
  * overwritten when linking with the slurmctld.
  */
 #if defined (__APPLE__)
 extern list_t *job_list  __attribute__((weak_import));
 extern int slurmctld_tres_cnt __attribute__((weak_import));
 #else
 list_t *job_list = NULL;
 int slurmctld_tres_cnt = 0;
 #endif

 /*
  * These variables are required by the generic plugin interface.  If they
  * are not found in the plugin, the plugin loader will ignore it.
  *
  * plugin_name - a string giving a human-readable description of the
  * plugin.  There is no maximum length, but the symbol must refer to
  * a valid string.
  *
  * plugin_type - a string suggesting the type of the plugin or its
  * applicability to a particular form of data or method of data handling.
  * If the low-level plugin API is used, the contents of this string are
  * unimportant and may be anything.  Slurm uses the higher-level plugin
  * interface which requires this string to be of the form
  *
  *	<application>/<method>
  *
  * where <application> is a description of the intended application of
  * the plugin (e.g., "jobcomp" for Slurm job completion logging) and <method>
  * is a description of how this plugin satisfies that application.  Slurm will
  * only load job completion logging plugins if the plugin_type string has a
  * prefix of "jobcomp/".
  *
  * plugin_version - an unsigned 32-bit integer containing the Slurm version
  * (major.minor.micro combined into a single number).
  */
 const char plugin_name[]       	= "Priority BASIC plugin";
 const char plugin_type[]       	= "priority/basic";
 const uint32_t plugin_version	= SLURM_VERSION_NUMBER;

 /*
  * init() is called when the plugin is loaded, before any other functions
  * are called.  Put global initialization here.
  */
 int init ( void )
 {
 	debug("%s loaded", plugin_name);
 	return SLURM_SUCCESS;
 }

 int fini ( void )
 {
 	return SLURM_SUCCESS;
 }

 void priority_p_thread_start(void)
 {
 	return;
 }

 /*
  * The remainder of this file implements the standard Slurm priority API.
  */

 extern uint32_t priority_p_set(uint32_t last_prio, job_record_t *job_ptr)
 {
 	uint32_t new_prio = 1;

 	if (job_ptr->direct_set_prio && (job_ptr->priority > 1))
 		return job_ptr->priority;

 	if (last_prio >= 2)
 		new_prio = (last_prio - 1);

 	if (job_ptr->details) {
 		int offset = job_ptr->details->nice;
 		offset -= NICE_OFFSET;
 		if ((offset <= 0) || (new_prio > (offset+1)))
 			new_prio -= offset;
 	}

 	/* System hold is priority 0 */
 	if (new_prio < 1)
 		new_prio = 1;

 	return new_prio;
 }

 static int _foreach_job_boost_prio(void *x, void *arg)
 {
 	job_record_t *job_ptr = x;
 	uint32_t prio_boost = *(uint32_t *) arg;

 	if ((job_ptr->priority) && (job_ptr->direct_set_prio == 0))
 		job_ptr->priority += prio_boost;

 	return 0;
 }

 extern uint32_t priority_p_recover(uint32_t prio_boost)
 {
 	if (prio_boost < 1000000)
 		return 0;

 	list_for_each(job_list, _foreach_job_boost_prio, &prio_boost);

 	return prio_boost;
 }

 extern void priority_p_reconfig(bool assoc_clear)
 {
 	return;
 }

 extern void priority_p_set_assoc_usage(slurmdb_assoc_rec_t *assoc)
 {
 	return;
 }

 extern double priority_p_calc_fs_factor(long double usage_efctv,
 					long double shares_norm)
 {
 	/* This calculation is needed for sshare when ran from a
 	 * non-multifactor machine to a multifactor machine.  It
 	 * doesn't do anything on regular systems, it should always
 	 * return 0 since shares_norm will always be NO_VAL. */
 	double priority_fs;

 	xassert(!fuzzy_equal(usage_efctv, NO_VAL));

 	if ((shares_norm <= 0.0) || fuzzy_equal(shares_norm, NO_VAL))
 		priority_fs = 0.0;
 	else
 		priority_fs = pow(2.0, -(usage_efctv / shares_norm));

 	return priority_fs;
 }

 /* req_msg can be removed 2 versions after 23.02 */
 extern List priority_p_get_priority_factors_list(
 	priority_factors_request_msg_t *req_msg, uid_t uid)
 {
 	return(list_create(NULL));
 }

 extern void priority_p_job_end(job_record_t *job_ptr)
 {
 	uint64_t time_limit_secs = (uint64_t)job_ptr->time_limit * 60;
 	slurmdb_assoc_rec_t *assoc_ptr;
 	int i;
 	uint64_t *unused_tres_run_secs;
 	assoc_mgr_lock_t locks = { NO_LOCK, WRITE_LOCK, NO_LOCK,
 				   WRITE_LOCK, NO_LOCK, NO_LOCK, NO_LOCK };

 	/* No decaying in basic priority. Just remove the total secs. */
 	unused_tres_run_secs = xmalloc(sizeof(uint64_t) * slurmctld_tres_cnt);
 	for (i=0; i<slurmctld_tres_cnt; i++) {
 		if (job_ptr->tres_alloc_cnt[i] == NO_CONSUME_VAL64)
 			continue;
 		unused_tres_run_secs[i] =
 			job_ptr->tres_alloc_cnt[i] * time_limit_secs;
 	}

 	assoc_mgr_lock(&locks);
 	if (job_ptr->qos_ptr) {
 		slurmdb_qos_rec_t *qos_ptr = job_ptr->qos_ptr;
 		for (i=0; i<slurmctld_tres_cnt; i++) {
 			if (unused_tres_run_secs[i] >
 			    qos_ptr->usage->grp_used_tres_run_secs[i]) {
 				qos_ptr->usage->grp_used_tres_run_secs[i] = 0;
 				debug2("acct_policy_job_fini: "
 				       "grp_used_tres_run_secs "
 				       "underflow for qos %s tres %s",
 				       qos_ptr->name,
 				       assoc_mgr_tres_name_array[i]);
 			} else
 				qos_ptr->usage->grp_used_tres_run_secs[i] -=
 					unused_tres_run_secs[i];
 		}
 	}
 	assoc_ptr = job_ptr->assoc_ptr;
 	while (assoc_ptr) {
 		/* If the job finished early remove the extra time now. */
 		for (i=0; i<slurmctld_tres_cnt; i++) {
 			if (unused_tres_run_secs[i] >
 			    assoc_ptr->usage->grp_used_tres_run_secs[i]) {
 				assoc_ptr->usage->grp_used_tres_run_secs[i] = 0;
 				debug2("acct_policy_job_fini: "
 				       "grp_used_tres_run_secs "
 				       "underflow for account %s tres %s",
 				       assoc_ptr->acct,
 				       assoc_mgr_tres_name_array[i]);

 			} else {
 				assoc_ptr->usage->grp_used_tres_run_secs[i] -=
 					unused_tres_run_secs[i];
 				debug4("acct_policy_job_fini: job %u. "
 				       "Removed %"PRIu64" unused seconds "
 				       "from acct %s tres %s "
 				       "grp_used_tres_run_secs = %"PRIu64"",
 				       job_ptr->job_id, unused_tres_run_secs[i],
 				       assoc_ptr->acct,
 				       assoc_mgr_tres_name_array[i],
 				       assoc_ptr->usage->
 				       grp_used_tres_run_secs[i]);
 			}
 		}
 		/* now handle all the group limits of the parents */
 		assoc_ptr = assoc_ptr->usage->parent_assoc_ptr;
 	}
 	assoc_mgr_unlock(&locks);
 	xfree(unused_tres_run_secs);

 	return;
 }
	/*****************************************************************************\
	* priority_basic.c - NO-OP slurm priority plugin.
	*****************************************************************************
	* Copyright (C) 2008 Lawrence Livermore National Security.
	* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
	* Written by Danny Auble <da@llnl.gov>
	* CODE-OCEC-09-009. All rights reserved.
	*
	* 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.
	\*****************************************************************************/

	#include <inttypes.h>
	#include <math.h>
	#include <stdio.h>

	#include "slurm/slurm_errno.h"

	#include "src/interfaces/priority.h"
	#include "src/common/assoc_mgr.h"

	/* These are defined here so when we link with something other than
	* the slurmctld we will have these symbols defined. They will get
	* overwritten when linking with the slurmctld.
	*/
	#if defined (__APPLE__)
	extern list_t *job_list __attribute__((weak_import));
	extern int slurmctld_tres_cnt __attribute__((weak_import));
	#else
	list_t *job_list = NULL;
	int slurmctld_tres_cnt = 0;
	#endif

	/*
	* These variables are required by the generic plugin interface. If they
	* are not found in the plugin, the plugin loader will ignore it.
	*
	* plugin_name - a string giving a human-readable description of the
	* plugin. There is no maximum length, but the symbol must refer to
	* a valid string.
	*
	* plugin_type - a string suggesting the type of the plugin or its
	* applicability to a particular form of data or method of data handling.
	* If the low-level plugin API is used, the contents of this string are
	* unimportant and may be anything. Slurm uses the higher-level plugin
	* interface which requires this string to be of the form
	*
	* <application>/<method>
	*
	* where <application> is a description of the intended application of
	* the plugin (e.g., "jobcomp" for Slurm job completion logging) and <method>
	* is a description of how this plugin satisfies that application. Slurm will
	* only load job completion logging plugins if the plugin_type string has a
	* prefix of "jobcomp/".
	*
	* plugin_version - an unsigned 32-bit integer containing the Slurm version
	* (major.minor.micro combined into a single number).
	*/
	const char plugin_name[] = "Priority BASIC plugin";
	const char plugin_type[] = "priority/basic";
	const uint32_t plugin_version = SLURM_VERSION_NUMBER;

	/*
	* init() is called when the plugin is loaded, before any other functions
	* are called. Put global initialization here.
	*/
	int init ( void )
	{
	debug("%s loaded", plugin_name);
	return SLURM_SUCCESS;
	}

	int fini ( void )
	{
	return SLURM_SUCCESS;
	}

	void priority_p_thread_start(void)
	{
	return;
	}

	/*
	* The remainder of this file implements the standard Slurm priority API.
	*/

	extern uint32_t priority_p_set(uint32_t last_prio, job_record_t *job_ptr)
	{
	uint32_t new_prio = 1;

	if (job_ptr->direct_set_prio && (job_ptr->priority > 1))
	return job_ptr->priority;

	if (last_prio >= 2)
	new_prio = (last_prio - 1);

	if (job_ptr->details) {
	int offset = job_ptr->details->nice;
	offset -= NICE_OFFSET;
	if ((offset <= 0) \|\| (new_prio > (offset+1)))
	new_prio -= offset;
	}

	/* System hold is priority 0 */
	if (new_prio < 1)
	new_prio = 1;

	return new_prio;
	}

	static int _foreach_job_boost_prio(void x, void arg)
	{
	job_record_t *job_ptr = x;
	uint32_t prio_boost = (uint32_t ) arg;

	if ((job_ptr->priority) && (job_ptr->direct_set_prio == 0))
	job_ptr->priority += prio_boost;

	return 0;
	}

	extern uint32_t priority_p_recover(uint32_t prio_boost)
	{
	if (prio_boost < 1000000)
	return 0;

	list_for_each(job_list, _foreach_job_boost_prio, &prio_boost);

	return prio_boost;
	}

	extern void priority_p_reconfig(bool assoc_clear)
	{
	return;
	}

	extern void priority_p_set_assoc_usage(slurmdb_assoc_rec_t *assoc)
	{
	return;
	}

	extern double priority_p_calc_fs_factor(long double usage_efctv,
	long double shares_norm)
	{
	/* This calculation is needed for sshare when ran from a
	* non-multifactor machine to a multifactor machine. It
	* doesn't do anything on regular systems, it should always
	* return 0 since shares_norm will always be NO_VAL. */
	double priority_fs;

	xassert(!fuzzy_equal(usage_efctv, NO_VAL));

	if ((shares_norm <= 0.0) \|\| fuzzy_equal(shares_norm, NO_VAL))
	priority_fs = 0.0;
	else
	priority_fs = pow(2.0, -(usage_efctv / shares_norm));

	return priority_fs;
	}

	/* req_msg can be removed 2 versions after 23.02 */
	extern List priority_p_get_priority_factors_list(
	priority_factors_request_msg_t *req_msg, uid_t uid)
	{
	return(list_create(NULL));
	}

	extern void priority_p_job_end(job_record_t *job_ptr)
	{
	uint64_t time_limit_secs = (uint64_t)job_ptr->time_limit * 60;
	slurmdb_assoc_rec_t *assoc_ptr;
	int i;
	uint64_t *unused_tres_run_secs;
	assoc_mgr_lock_t locks = { NO_LOCK, WRITE_LOCK, NO_LOCK,
	WRITE_LOCK, NO_LOCK, NO_LOCK, NO_LOCK };

	/* No decaying in basic priority. Just remove the total secs. */
	unused_tres_run_secs = xmalloc(sizeof(uint64_t) * slurmctld_tres_cnt);
	for (i=0; i<slurmctld_tres_cnt; i++) {
	if (job_ptr->tres_alloc_cnt[i] == NO_CONSUME_VAL64)
	continue;
	unused_tres_run_secs[i] =
	job_ptr->tres_alloc_cnt[i] * time_limit_secs;
	}

	assoc_mgr_lock(&locks);
	if (job_ptr->qos_ptr) {
	slurmdb_qos_rec_t *qos_ptr = job_ptr->qos_ptr;
	for (i=0; i<slurmctld_tres_cnt; i++) {
	if (unused_tres_run_secs[i] >
	qos_ptr->usage->grp_used_tres_run_secs[i]) {
	qos_ptr->usage->grp_used_tres_run_secs[i] = 0;
	debug2("acct_policy_job_fini: "
	"grp_used_tres_run_secs "
	"underflow for qos %s tres %s",
	qos_ptr->name,
	assoc_mgr_tres_name_array[i]);
	} else
	qos_ptr->usage->grp_used_tres_run_secs[i] -=
	unused_tres_run_secs[i];
	}
	}
	assoc_ptr = job_ptr->assoc_ptr;
	while (assoc_ptr) {
	/* If the job finished early remove the extra time now. */
	for (i=0; i<slurmctld_tres_cnt; i++) {
	if (unused_tres_run_secs[i] >
	assoc_ptr->usage->grp_used_tres_run_secs[i]) {
	assoc_ptr->usage->grp_used_tres_run_secs[i] = 0;
	debug2("acct_policy_job_fini: "
	"grp_used_tres_run_secs "
	"underflow for account %s tres %s",
	assoc_ptr->acct,
	assoc_mgr_tres_name_array[i]);

	} else {
	assoc_ptr->usage->grp_used_tres_run_secs[i] -=
	unused_tres_run_secs[i];
	debug4("acct_policy_job_fini: job %u. "
	"Removed %"PRIu64" unused seconds "
	"from acct %s tres %s "
	"grp_used_tres_run_secs = %"PRIu64"",
	job_ptr->job_id, unused_tres_run_secs[i],
	assoc_ptr->acct,
	assoc_mgr_tres_name_array[i],
	assoc_ptr->usage->
	grp_used_tres_run_secs[i]);
	}
	}
	/* now handle all the group limits of the parents */
	assoc_ptr = assoc_ptr->usage->parent_assoc_ptr;
	}
	assoc_mgr_unlock(&locks);
	xfree(unused_tres_run_secs);

	return;
	}