| /****************************************************************************\ |
| * slurm_protocol_pack.h - definitions for all pack and unpack functions |
| ***************************************************************************** |
| * Copyright (C) 2002-2007 The Regents of the University of California. |
| * Copyright (C) 2008-2009 Lawrence Livermore National Security. |
| * Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER). |
| * Written by Kevin Tew <tew1@llnl.gov>. |
| * CODE-OCEC-09-009. All rights reserved. |
| * |
| * This file is part of SLURM, a resource management program. |
| * For details, see <http://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 _SLURM_PROTOCOL_PACK_H |
| #define _SLURM_PROTOCOL_PACK_H |
| |
| #if HAVE_CONFIG_H |
| # include "config.h" |
| # if HAVE_INTTYPES_H |
| # include <inttypes.h> |
| # else |
| # if HAVE_STDINT_H |
| # include <stdint.h> |
| # endif |
| # endif /* HAVE_INTTYPES_H */ |
| #else /* !HAVE_CONFIG_H */ |
| # include <inttypes.h> |
| #endif /* HAVE_CONFIG_H */ |
| |
| #include "src/common/pack.h" |
| #include "src/common/slurm_protocol_defs.h" |
| |
| /****************************/ |
| /* Message header functions */ |
| /****************************/ |
| |
| /* pack_header |
| * packs a slurm protocol header that precedes every slurm message |
| * IN header - the header structure to pack |
| * IN/OUT buffer - destination of the pack, contains pointers that are |
| * automatically updated |
| */ |
| extern void pack_header ( header_t * header , Buf buffer ); |
| |
| /* unpack_header |
| * unpacks a slurm protocol header that precedes every slurm message |
| * OUT header - the header structure to unpack |
| * IN/OUT buffer - source of the unpack data, contains pointers that are |
| * automatically updated |
| * RET 0 or error code |
| */ |
| extern int unpack_header ( header_t * header , Buf buffer ); |
| |
| |
| /**************************************************************************/ |
| /* generic case statement Pack / Unpack methods for slurm protocol bodies */ |
| /**************************************************************************/ |
| |
| /* pack_msg |
| * packs a generic slurm protocol message body |
| * IN msg - the body structure to pack (note: includes message type) |
| * IN/OUT buffer - destination of the pack, contains pointers that are |
| * automatically updated |
| * RET 0 or error code |
| */ |
| extern int pack_msg ( slurm_msg_t const * msg , Buf buffer ); |
| |
| /* unpack_msg |
| * unpacks a generic slurm protocol message body |
| * OUT msg - the body structure to unpack (note: includes message type) |
| * IN/OUT buffer - source of the unpack, contains pointers that are |
| * automatically updated |
| * RET 0 or error code |
| */ |
| extern int unpack_msg ( slurm_msg_t * msg , Buf buffer ); |
| |
| /***************************************************************************/ |
| /* specific case statement Pack / Unpack methods for slurm protocol bodies */ |
| /***************************************************************************/ |
| |
| /* pack_job_credential |
| * packs a slurm job credential |
| * IN cred - pointer to the credential |
| * IN/OUT buffer - destination of the pack, contains pointers that are |
| * automatically updated |
| */ |
| /* void pack_job_credential ( slurm_job_credential_t* cred , Buf buffer ) ;*/ |
| |
| /* unpack_job_credential |
| * unpacks a slurm job credential |
| * OUT cred - pointer to the credential pointer |
| * IN/OUT buffer - source of the unpack, contains pointers that are |
| * automatically updated |
| * RET 0 or error code |
| */ |
| /* int unpack_job_credential( slurm_job_credential_t** cred , Buf buffer ) ;*/ |
| |
| /* pack_job_step_info |
| * packs a slurm job steps info |
| * IN step - pointer to the job step info |
| * IN/OUT buffer - destination of the pack, contains pointers that are |
| * automatically updated |
| */ |
| /* void pack_job_step_info ( job_step_info_t* step, Buf buffer ); */ |
| |
| /* pack_job_step_info_members |
| * pack selected fields of the description of a job into a buffer |
| * IN job_id, step_id, user_id, start_time, partition, nodes - job info |
| * IN/OUT buffer - destination of the pack, contains pointers that are |
| * automatically updated |
| */ |
| /* void pack_job_step_info_members( uint32_t job_id, uint32_t step_id, */ |
| /* uint32_t user_id, uint32_t num_tasks, time_t start_time, */ |
| /* char *partition, char *nodes, char *name, char *network, */ |
| /* Buf buffer ); */ |
| |
| |
| extern void pack_job_step_create_response_msg( |
| job_step_create_response_msg_t * msg, Buf buffer, |
| uint16_t protocol_version); |
| extern int unpack_job_step_create_response_msg( |
| job_step_create_response_msg_t ** msg, Buf buffer, |
| uint16_t protocol_version); |
| |
| extern void pack_job_step_create_request_msg( |
| job_step_create_request_msg_t * msg, Buf buffer, |
| uint16_t protocol_version); |
| extern int unpack_job_step_create_request_msg( |
| job_step_create_request_msg_t ** msg, Buf buffer, |
| uint16_t protocol_version); |
| |
| extern void pack_multi_core_data (multi_core_data_t *multi_core, Buf buffer, |
| uint16_t protocol_version); |
| extern int unpack_multi_core_data (multi_core_data_t **multi_core, Buf buffer, |
| uint16_t protocol_version); |
| extern void slurm_pack_block_job_info(block_job_info_t *block_job_info, |
| Buf buffer, uint16_t protocol_version); |
| extern int slurm_unpack_block_info_members(block_info_t *block_info, Buf buffer, |
| uint16_t protocol_version); |
| extern int slurm_unpack_block_info_msg( |
| block_info_msg_t **block_info_msg_pptr, Buf buffer, |
| uint16_t protocol_version); |
| #endif |
