1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#ifndef __PACK_H
#define __PACK_H
/*___INFO__MARK_BEGIN__*/
/*************************************************************************
*
* The Contents of this file are made available subject to the terms of
* the Sun Industry Standards Source License Version 1.2
*
* Sun Microsystems Inc., March, 2001
*
*
* Sun Industry Standards Source License Version 1.2
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.2 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2001 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
************************************************************************/
/* Portions of this code are Copyright (c) 2011 Univa Corporation. */
/*___INFO__MARK_END__*/
#ifndef __BASIS_TYPES_H
# include "basis_types.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
#include "uti/sge_bitfield.h"
#define CHUNK (1024*1024)
/****** cull/pack/-Versioncontrol ***************************************
*
* NAME
* Versioncontrol -- handling of different cull versions
*
* SYNOPSIS
* #define CULL_VERSION 0x10010000
*
* FUNCTION
* Enhancements of the product may make it necessary to change the
* way how (in which format) data is represented for spooling and
* communication.
*
* To ensure that components of different cull versions, that cannot
* communicate, cleanly reject data of a different format, a cull
* version check has been implemented.
*
* A cull version id has been introduced that will be checked when
* cull packbuffers are read.
*
* Currently the 2 highest bytes of the 4 byte integer used to
* encode version information are used for a version number.
* The 2 lower bytes could be used to encode for example a
* subversion / subprotocol like cull binary format (the current
* implementation) and XML format.
*
* NOTES
* Older Grid Engine versions that had no version controll cannot
* properly handle messages with version information.
* Therefore the version information is preceeded by a 0 value
* 4 byte integer, which will result in some sort of error handling
* for all known/used message formats.
*
* Current CULL_VERSION: 0x10020000
* Fixed a bug with packing of lObject type:
* Descriptor was sent twice.
*
* Former CULL_VERSIONs: 0x10010000
* Added information about attribute changes.
* 0x10000000
* Introduction of version control.
*
* SEE ALSO
* cull/pack/--CULL_Packing
*
****************************************************************************
*/
#define CULL_VERSION 0x10020000
typedef struct {
char *head_ptr;
char *cur_ptr;
size_t mem_size;
size_t bytes_used;
int just_count;
int version;
} sge_pack_buffer;
int
init_packbuffer(sge_pack_buffer *pb, int initial_size, int just_count);
int
init_packbuffer_from_buffer(sge_pack_buffer *pb, char *buf, u_long32 buflen);
void
clear_packbuffer(sge_pack_buffer *pb);
int pb_filled(sge_pack_buffer *pb);
int pb_unused(sge_pack_buffer *pb);
int pb_used(sge_pack_buffer *pb);
bool pb_are_equivalent(sge_pack_buffer *pb1, sge_pack_buffer *pb2);
void pb_print_to(sge_pack_buffer *pb, bool only_header, FILE*);
int repackint(register sge_pack_buffer *, register u_long32);
int packint(register sge_pack_buffer *, register u_long32);
int packint64(register sge_pack_buffer *, register u_long64);
int packdouble(register sge_pack_buffer *, double);
int packstr(register sge_pack_buffer *, register const char *);
int packbuf(sge_pack_buffer *, const char *, u_long32);
int packbitfield(sge_pack_buffer *, const bitfield *);
int unpackint(register sge_pack_buffer *, register u_long32 *);
int unpackint64(register sge_pack_buffer *, register u_long64 *);
int unpackdouble(register sge_pack_buffer *, register double *);
int unpackstr(register sge_pack_buffer *, register char **);
int unpackbuf(sge_pack_buffer *, char **, int);
int unpackbitfield(sge_pack_buffer *, bitfield *, int descr_size);
void debugpack(int on_off);
/*
these return values should be supported by all
un-/packing functions
*/
enum {
PACK_SUCCESS = 0,
PACK_ENOMEM = -1,
PACK_FORMAT = -2,
PACK_BADARG = -3,
PACK_VERSION = -4
};
const char *cull_pack_strerror(int errnum);
#ifdef __cplusplus
}
#endif
#endif /* __PACK_H */
|
