| /*****************************************************************************\ | |
| * namespace.c - namespace plugin interface. | |
| ***************************************************************************** | |
| * Copyright (C) SchedMD LLC. | |
| * Written by Morris Jette | |
| * | |
| * 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 <pthread.h> | |
| #include "src/common/plugin.h" | |
| #include "src/common/plugrack.h" | |
| #include "src/common/read_config.h" | |
| #include "src/common/slurm_protocol_api.h" | |
| #include "src/common/xmalloc.h" | |
| #include "src/common/xstring.h" | |
| #include "src/interfaces/namespace.h" | |
| #include "src/slurmd/slurmstepd/slurmstepd_job.h" | |
| typedef struct namespace_ops { | |
| int (*namespace_p_join)(slurm_step_id_t *step_id, uid_t uid, | |
| bool step_create); | |
| int (*namespace_p_join_external)(slurm_step_id_t *step_id, | |
| list_t *fd_map); | |
| int (*namespace_p_restore)(char *dir_name, bool recover); | |
| int (*namespace_p_stepd_create)(stepd_step_rec_t *step); | |
| int (*namespace_p_stepd_delete)(stepd_step_rec_t *step); | |
| int (*namespace_p_send_stepd)(int fd); | |
| int (*namespace_p_recv_stepd)(int fd); | |
| bool (*namespace_p_can_bpf)(stepd_step_rec_t *step); | |
| int (*namespace_p_setup_bpf_token)(stepd_step_rec_t *step); | |
| bool (*namespace_p_enabled)(void); | |
| } namespace_ops_t; | |
| /* | |
| * Must be synchronized with namespace_ops_t above. | |
| */ | |
| static const char *syms[] = { | |
| "namespace_p_join", | |
| "namespace_p_join_external", | |
| "namespace_p_restore", | |
| "namespace_p_stepd_create", | |
| "namespace_p_stepd_delete", | |
| "namespace_p_send_stepd", | |
| "namespace_p_recv_stepd", | |
| "namespace_p_can_bpf", | |
| "namespace_p_setup_bpf_token", | |
| "namespace_p_enabled", | |
| }; | |
| static namespace_ops_t *ops = NULL; | |
| static plugin_context_t **g_namespace_context = NULL; | |
| static int g_namespace_context_num = -1; | |
| static pthread_mutex_t g_namespace_context_lock = PTHREAD_MUTEX_INITIALIZER; | |
| /* | |
| * Initialize the job namespace plugin. | |
| * | |
| * RET - slurm error code | |
| */ | |
| extern int namespace_g_init(void) | |
| { | |
| int retval = SLURM_SUCCESS; | |
| char *plugin_type = "namespace"; | |
| char *type = NULL, *last = NULL, *plugin_list, *namespace = NULL; | |
| slurm_mutex_lock(&g_namespace_context_lock); | |
| if (g_namespace_context_num >= 0) | |
| goto done; | |
| g_namespace_context_num = 0; /* mark it before anything else */ | |
| if (!slurm_conf.namespace_plugin || !slurm_conf.namespace_plugin[0]) | |
| goto done; | |
| type = plugin_list = xstrdup(slurm_conf.namespace_plugin); | |
| while ((namespace = strtok_r(plugin_list, ",", &last))) { | |
| xrecalloc(ops, g_namespace_context_num + 1, | |
| sizeof(namespace_ops_t)); | |
| xrecalloc(g_namespace_context, g_namespace_context_num + 1, | |
| sizeof(plugin_context_t *)); | |
| if (xstrncmp(namespace, "namespace/", 10) == 0) | |
| namespace += 10; /* backward compatibility */ | |
| else if (xstrncmp(namespace, "job_container/", 14) == 0) | |
| namespace += 14; /* backward compatibility */ | |
| namespace = xstrdup_printf("namespace/%s", namespace); | |
| g_namespace_context[g_namespace_context_num] = | |
| plugin_context_create( | |
| plugin_type, namespace, | |
| (void **)&ops[g_namespace_context_num], | |
| syms, sizeof(syms)); | |
| if (!g_namespace_context[g_namespace_context_num]) { | |
| error("cannot create %s context for %s", | |
| plugin_type, namespace); | |
| xfree(namespace); | |
| retval = SLURM_ERROR; | |
| break; | |
| } | |
| xfree(namespace); | |
| g_namespace_context_num++; | |
| plugin_list = NULL; /* for next iteration */ | |
| } | |
| done: | |
| slurm_mutex_unlock(&g_namespace_context_lock); | |
| xfree(type); | |
| if (retval != SLURM_SUCCESS) | |
| namespace_g_fini(); | |
| return retval; | |
| } | |
| /* | |
| * Terminate the job namespace plugin, free memory. | |
| * | |
| * RET - slurm error code | |
| */ | |
| extern int namespace_g_fini(void) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| slurm_mutex_lock(&g_namespace_context_lock); | |
| if (!g_namespace_context) | |
| goto done; | |
| for (i = 0; i < g_namespace_context_num; i++) { | |
| if (g_namespace_context[i]) { | |
| if (plugin_context_destroy(g_namespace_context[i]) != | |
| SLURM_SUCCESS) { | |
| rc = SLURM_ERROR; | |
| } | |
| } | |
| } | |
| xfree(ops); | |
| xfree(g_namespace_context); | |
| g_namespace_context_num = -1; | |
| done: | |
| slurm_mutex_unlock(&g_namespace_context_lock); | |
| return rc; | |
| } | |
| /* | |
| * Add the calling process to the specified job's namespace. | |
| */ | |
| extern int namespace_g_join(slurm_step_id_t *step_id, uid_t uid, | |
| bool step_create) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; ((i < g_namespace_context_num) && (rc == SLURM_SUCCESS)); | |
| i++) { | |
| rc = (*(ops[i].namespace_p_join))(step_id, uid, step_create); | |
| } | |
| return rc; | |
| } | |
| /* | |
| * Allow external processes (eg. via PAM) to join the job namespace. | |
| */ | |
| extern int namespace_g_join_external(slurm_step_id_t *step_id, list_t *fd_map) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; ((i < g_namespace_context_num) && (rc == SLURM_SUCCESS)); | |
| i++) { | |
| rc = (*(ops[i].namespace_p_join_external))(step_id, fd_map); | |
| } | |
| return rc; | |
| } | |
| /* Restore namespace information */ | |
| extern int namespace_g_restore(char *dir_name, bool recover) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; ((i < g_namespace_context_num) && (rc == SLURM_SUCCESS)); | |
| i++) { | |
| rc = (*(ops[i].namespace_p_restore))(dir_name, recover); | |
| } | |
| return rc; | |
| } | |
| /* Create a namespace for the specified job, actions run in slurmstepd */ | |
| extern int namespace_g_stepd_create(stepd_step_rec_t *step) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| xassert(step->step_id.step_id == SLURM_EXTERN_CONT); | |
| for (i = 0; ((i < g_namespace_context_num) && (rc == SLURM_SUCCESS)); | |
| i++) { | |
| rc = (*(ops[i].namespace_p_stepd_create))(step); | |
| } | |
| return rc; | |
| } | |
| /* Delete the namespace for the specified job, actions run in slurmstepd */ | |
| extern int namespace_g_stepd_delete(stepd_step_rec_t *step) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| xassert(step->step_id.step_id == SLURM_EXTERN_CONT); | |
| for (i = 0; ((i < g_namespace_context_num) && (rc == SLURM_SUCCESS)); | |
| i++) { | |
| rc = (*(ops[i].namespace_p_stepd_delete))(step); | |
| } | |
| return rc; | |
| } | |
| extern int namespace_g_send_stepd(int fd) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; (i < g_namespace_context_num) && (rc == SLURM_SUCCESS); i++) | |
| rc = (*(ops[i].namespace_p_send_stepd))(fd); | |
| return rc; | |
| } | |
| extern int namespace_g_recv_stepd(int fd) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; (i < g_namespace_context_num) && (rc == SLURM_SUCCESS); i++) | |
| rc = (*(ops[i].namespace_p_recv_stepd))(fd); | |
| return rc; | |
| } | |
| extern bool namespace_g_can_bpf(stepd_step_rec_t *step) | |
| { | |
| int i; | |
| bool rc = true; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; (i < g_namespace_context_num) && rc; i++) | |
| rc = (*(ops[i].namespace_p_can_bpf))(step); | |
| return rc; | |
| } | |
| extern int namespace_g_setup_bpf_token(stepd_step_rec_t *step) | |
| { | |
| int i, rc = SLURM_SUCCESS; | |
| xassert(g_namespace_context_num >= 0); | |
| for (i = 0; (i < g_namespace_context_num) && (rc == SLURM_SUCCESS); i++) | |
| rc = (*(ops[i].namespace_p_setup_bpf_token))(step); | |
| return rc; | |
| } | |
| extern bool namespace_g_enabled(void) | |
| { | |
| xassert(g_namespace_context_num >= 0); | |
| for (int i = 0; i < g_namespace_context_num; i++) { | |
| if ((*(ops[i].namespace_p_enabled))()) | |
| return true; | |
| } | |
| return false; | |
| } | |
| extern void slurm_free_ns_dir(ns_dir_t *ns_dir) | |
| { | |
| if (ns_dir) { | |
| xfree(ns_dir->path); | |
| xfree(ns_dir->base_path); | |
| xfree(ns_dir->opts_str); | |
| xfree(ns_dir); | |
| } | |
| } | |
| extern void slurm_free_ns_conf_members(ns_conf_t *ns_conf) | |
| { | |
| if (ns_conf) { | |
| xfree(ns_conf->basepath); | |
| xfree(ns_conf->clonensepilog); | |
| xfree(ns_conf->clonensflags_str); | |
| xfree(ns_conf->clonensscript); | |
| xfree(ns_conf->dirs); | |
| FREE_NULL_LIST(ns_conf->dir_confs); | |
| xfree(ns_conf->initscript); | |
| xfree(ns_conf->usernsscript); | |
| } | |
| } | |
| extern void slurm_free_ns_conf(ns_conf_t *ns_conf) | |
| { | |
| if (ns_conf) { | |
| slurm_free_ns_conf_members(ns_conf); | |
| xfree(ns_conf); | |
| } | |
| } | |
| extern void slurm_free_ns_node_conf(ns_node_conf_t *ns_node_conf) | |
| { | |
| if (ns_node_conf) { | |
| FREE_NULL_HOSTLIST(ns_node_conf->nodes); | |
| slurm_free_ns_conf(ns_node_conf->ns_conf); | |
| xfree(ns_node_conf); | |
| } | |
| } | |
| extern void slurm_free_ns_full_conf(ns_full_conf_t *ns_full_conf) | |
| { | |
| if (ns_full_conf) { | |
| slurm_free_ns_conf(ns_full_conf->defaults); | |
| FREE_NULL_LIST(ns_full_conf->node_confs); | |
| xfree(ns_full_conf); | |
| } | |
| } |