| /*****************************************************************************\ |
| * agent.h - data structures and function definitions for parallel |
| * background communications |
| ***************************************************************************** |
| * Copyright (C) 2002-2007 The Regents of the University of California. |
| * Copyright (C) 2008 Lawrence Livermore National Security. |
| * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). |
| * Written by Morris Jette <jette@llnl.gov>, et. al. |
| * Derived from dsh written by Jim Garlick <garlick1@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. |
| \*****************************************************************************/ |
| |
| #ifndef _AGENT_H |
| #define _AGENT_H |
| |
| #include "src/slurmctld/slurmctld.h" |
| |
| #define AGENT_THREAD_COUNT 10 /* maximum active threads per agent */ |
| |
| #define LOTS_OF_AGENTS_CNT 50 |
| #define LOTS_OF_AGENTS ((get_agent_count() <= LOTS_OF_AGENTS_CNT) ? 0 : 1) |
| |
| /* Start a thread to manage queued agent requests */ |
| extern void agent_init(void); |
| |
| extern void agent_fini(void); |
| |
| /* |
| * agent - party responsible for transmitting an common RPC in parallel |
| * across a set of nodes. agent_queue_request() if immediate |
| * execution is not essential. |
| * IN pointer to agent_arg_t, which is xfree'd (including addr, |
| * hostlist and msg_args) upon completion if AGENT_IS_THREAD is set |
| * RET always NULL (function format just for use as pthread) |
| */ |
| extern void *agent(void *args); |
| |
| /* |
| * agent_queue_request - put a request on the queue for later execution or |
| * execute now if not too busy |
| * IN agent_arg_ptr - the request to enqueue |
| */ |
| extern void agent_queue_request(agent_arg_t *agent_arg_ptr); |
| |
| /* |
| * agent_trigger - Request processing of pending RPCs |
| * IN min_wait - Minimum wait time between re-issue of a pending RPC |
| * IN mail_too - Send pending email too, note this performed using a |
| * fork/waitpid, so it can take longer than just creating a pthread |
| * to send RPCs |
| * IN check_defer - force defer_list check |
| */ |
| extern void agent_trigger(int min_wait, bool mail_too, bool check_defer); |
| |
| /* agent_purge - purge all pending RPC requests */ |
| extern void agent_purge(void); |
| |
| /* get_agent_count - find out how many active agents we have */ |
| extern int get_agent_count(void); |
| |
| /* get_agent_thread_count - get count of threads spawned by agents */ |
| extern int get_agent_thread_count(void); |
| |
| /* agent_pack_pending_rpc_stats - pack counts of pending RPCs into a buffer */ |
| extern void agent_pack_pending_rpc_stats(buf_t *buffer); |
| |
| /* |
| * mail_job_info - Send e-mail notice of job state change |
| * IN job_ptr - job identification |
| * IN state_type - job transition type, see MAIL_JOB in slurm.h |
| */ |
| extern void mail_job_info(job_record_t *job_ptr, uint16_t mail_type); |
| |
| /* Return length of agent's retry_list */ |
| extern int retry_list_size(void); |
| |
| #endif /* !_AGENT_H */ |
