1 /*****************************************************************************\
2  *  slurm_protocol_common.h - slurm communications definitions common to
3  *	all protocols
4  *****************************************************************************
5  *  Copyright (C) 2002 The Regents of the University of California.
6  *  Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
7  *  Written by Kevin Tew <tew1@llnl.gov>, et. al.
8  *  CODE-OCEC-09-009. All rights reserved.
9  *
10  *  This file is part of Slurm, a resource management program.
11  *  For details, see <https://slurm.schedmd.com/>.
12  *  Please also read the included file: DISCLAIMER.
13  *
14  *  Slurm is free software; you can redistribute it and/or modify it under
15  *  the terms of the GNU General Public License as published by the Free
16  *  Software Foundation; either version 2 of the License, or (at your option)
17  *  any later version.
18  *
19  *  In addition, as a special exception, the copyright holders give permission
20  *  to link the code of portions of this program with the OpenSSL library under
21  *  certain conditions as described in each individual source file, and
22  *  distribute linked combinations including the two. You must obey the GNU
23  *  General Public License in all respects for all of the code used other than
24  *  OpenSSL. If you modify file(s) with this exception, you may extend this
25  *  exception to your version of the file(s), but you are not obligated to do
26  *  so. If you do not wish to do so, delete this exception statement from your
27  *  version.  If you delete this exception statement from all source files in
28  *  the program, then also delete it here.
29  *
30  *  Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
31  *  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
32  *  FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
33  *  details.
34  *
35  *  You should have received a copy of the GNU General Public License along
36  *  with Slurm; if not, write to the Free Software Foundation, Inc.,
37  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA.
38 \*****************************************************************************/
39 
40 #ifndef _SLURM_PROTOCOL_COMMON_H
41 #define _SLURM_PROTOCOL_COMMON_H
42 
43 #include "config.h"
44 
45 #include <sys/time.h>
46 #include <time.h>
47 
48 #include "slurm/slurm_errno.h"
49 
50 /* for sendto and recvfrom commands */
51 #define SLURM_PROTOCOL_NO_SEND_RECV_FLAGS 0
52 
53 /* for listen API */
54 #define SLURM_DEFAULT_LISTEN_BACKLOG 4096
55 
56 /* used in interface methods */
57 #define SLURM_PROTOCOL_FUNCTION_NOT_IMPLEMENTED -2
58 
59 /* slurm protocol header defines, based upon config.h, 16 bits */
60 /* A new SLURM_PROTOCOL_VERSION needs to be made each time the version
61  * changes so the slurmdbd can talk all versions for update messages.
62  */
63 /* NOTE: The API version can not be the same as the Slurm version.  The
64  *       version in the code is referenced as a uint16_t which if 1403 was the
65  *       api it would go over the limit.  So keep is a relatively
66  *       small number.
67  * NOTE: These values must be moved to
68  * src/plugins/accounting_storage/mysql/as_mysql_archive.c when we are
69  * done here with them since we have to support old version of archive
70  * files since they don't update once they are created.
71  */
72 #define SLURM_20_02_PROTOCOL_VERSION ((35 << 8) | 0)
73 #define SLURM_19_05_PROTOCOL_VERSION ((34 << 8) | 0)
74 #define SLURM_18_08_PROTOCOL_VERSION ((33 << 8) | 0)
75 
76 #define SLURM_PROTOCOL_VERSION SLURM_20_02_PROTOCOL_VERSION
77 #define SLURM_ONE_BACK_PROTOCOL_VERSION SLURM_19_05_PROTOCOL_VERSION
78 #define SLURM_MIN_PROTOCOL_VERSION SLURM_18_08_PROTOCOL_VERSION
79 
80 #if 0
81 /* Old Slurm versions kept for reference only.  Slurm only actively keeps track
82  * of 2 previous versions. */
83 #define SLURM_17_11_PROTOCOL_VERSION ((32 << 8) | 0)
84 #define SLURM_17_02_PROTOCOL_VERSION ((31 << 8) | 0)
85 #define SLURM_16_05_PROTOCOL_VERSION ((30 << 8) | 0)
86 #define SLURM_15_08_PROTOCOL_VERSION ((29 << 8) | 0)
87 #define SLURM_14_11_PROTOCOL_VERSION ((28 << 8) | 0)
88 #define SLURM_14_03_PROTOCOL_VERSION ((27 << 8) | 0)
89 #define SLURM_2_6_PROTOCOL_VERSION ((26 << 8) | 0)
90 #define SLURM_2_5_PROTOCOL_VERSION ((25 << 8) | 0)
91 #define SLURM_2_4_PROTOCOL_VERSION ((24 << 8) | 0)
92 #define SLURM_2_3_PROTOCOL_VERSION ((23 << 8) | 0)
93 #define SLURM_2_2_PROTOCOL_VERSION ((22 << 8) | 0)
94 #define SLURM_2_1_PROTOCOL_VERSION ((21 << 8) | 0)
95 #define SLURM_2_0_PROTOCOL_VERSION ((20 << 8) | 0)
96 #define SLURM_1_3_PROTOCOL_VERSION ((13 << 8) | 0)
97 #endif
98 
99 /* Below are flags for the header of a message. */
100 
101 /* Used to set flags to empty */
102 #define SLURM_PROTOCOL_NO_FLAGS 0
103 #define SLURM_GLOBAL_AUTH_KEY   0x0001
104 #define SLURMDBD_CONNECTION     0x0002
105 #define SLURM_MSG_KEEP_BUFFER   0x0004
106 #define SLURM_DROP_PRIV		0x0008
107 #define USE_BCAST_NETWORK	0x0010
108 
109 #endif
110