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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* */
/* This file is part of the program and library */
/* SCIP --- Solving Constraint Integer Programs */
/* */
/* Copyright 2002-2022 Zuse Institute Berlin */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* */
/* You should have received a copy of the Apache-2.0 license */
/* along with SCIP; see the file LICENSE. If not visit scipopt.org. */
/* */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/**@file syncstore.h
* @ingroup PARALLEL
* @brief the function declarations for the synchronization store
* @author Leona Gottwald
* @author Stephen J. Maher
*/
/*---+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----8----+----9----+----0----+----1----+----2*/
#ifndef __SYNCSTORE_H__
#define __SYNCSTORE_H__
#include "scip/def.h"
#include "scip/type_syncstore.h"
#include "scip/type_scip.h"
#include "scip/type_retcode.h"
/** creates and captures a new synchronization store */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreCreate(
SCIP_SYNCSTORE** syncstore /**< pointer to return the created synchronization store */
);
/** releases a synchronization store */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreRelease(
SCIP_SYNCSTORE** syncstore /**< pointer to the synchronization store */
);
/** captures a synchronization store */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreCapture(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** initialize the syncstore for the given SCIP instance */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreInit(
SCIP* scip /**< SCIP main datastructure */
);
/** deinitializes the synchronization store */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreExit(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** checks whether the solve-is-stopped flag in the syncstore has been set by any thread */
SCIP_EXPORT
SCIP_Bool SCIPsyncstoreSolveIsStopped(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** sets the solve-is-stopped flag in the syncstore so that subsequent calls to
* SCIPsyncstoreSolveIsStopped will return the given value in any thread
*/
SCIP_EXPORT
void SCIPsyncstoreSetSolveIsStopped(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_Bool stopped /**< flag if the solve is stopped */
);
/** gets the upperbound from the last synchronization */
SCIP_EXPORT
SCIP_Real SCIPsyncstoreGetLastUpperbound(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** gets the lowerbound from the last synchronization */
SCIP_EXPORT
SCIP_Real SCIPsyncstoreGetLastLowerbound(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** gets the number of solutions from the last synchronization */
SCIP_EXPORT
int SCIPsyncstoreGetLastNSols(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** gets the number of boundchanges from the last synchronization */
SCIP_EXPORT
int SCIPsyncstoreGetLastNBounds(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** gets total memory used by all solvers from the last synchronization */
SCIP_EXPORT
SCIP_Longint SCIPsyncstoreGetLastMemTotal(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** gets the synchronization frequency from the last synchronization */
SCIP_EXPORT
SCIP_Real SCIPsyncstoreGetLastSyncfreq(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** get synchronization data with given number. It is the responsibility of the caller
* to only ask for a synchronization number that still exists. */
SCIP_EXPORT
SCIP_SYNCDATA* SCIPsyncstoreGetSyncdata(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_Longint syncnum /**< the number of the synchronization to start, which
* must be increasing between calls of the same thread */
);
/** get the next synchronization data that should be read and
* adjust the delay. Returns NULL if no more data should be read due to minimum delay */
SCIP_EXPORT
SCIP_SYNCDATA* SCIPsyncstoreGetNextSyncdata(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_SYNCDATA* syncdata, /**< the synchronization data */
SCIP_Real syncfreq, /**< the current synchronization frequency */
SCIP_Longint writenum, /**< number of synchronizations the solver has written to */
SCIP_Real* delay /**< pointer holding the current synchronization delay */
);
/** ensures that the given synchronization data has been written by
* all solvers upon return of this function and blocks the caller if necessary. */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreEnsureAllSynced(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** Start synchronization for the given concurrent solver.
* Needs to be followed by a call to SCIPsyncstoreFinishSync if
* the syncdata that is returned is not NULL
*/
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreStartSync(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_Longint syncnum, /**< the number of the synchronization to start, which
* must be increasing between calls of the same thread */
SCIP_SYNCDATA** syncdata /**< pointer to return the synchronization data */
);
/** finishes synchronization for the synchronization data */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncstoreFinishSync(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_SYNCDATA** syncdata /**< the synchronization data */
);
/** gets status in synchronization data */
SCIP_EXPORT
SCIP_STATUS SCIPsyncdataGetStatus(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** gets the solver that had the best status, or -1 if solve is not stopped yet */
SCIP_EXPORT
int SCIPsyncstoreGetWinner(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** how many solvers have already finished synchronizing on this sychronization data */
SCIP_EXPORT
int SCIPsyncdataGetNSynced(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** how many solvers have are running concurrently */
SCIP_EXPORT
int SCIPsyncstoreGetNSolvers(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** read amount of memory used from synchronization data */
SCIP_EXPORT
SCIP_Longint SCIPsyncdataGetMemTotal(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** read the synchronization frequency from a synchronization data */
SCIP_EXPORT
SCIP_Real SCIPsyncdataGetSyncFreq(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** read the upperbound stored in a synchronization data */
SCIP_EXPORT
SCIP_Real SCIPsyncdataGetUpperbound(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** read the lowerbound stored in a synchronization data */
SCIP_EXPORT
SCIP_Real SCIPsyncdataGetLowerbound(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** read the solutions stored in a synchronization data */
SCIP_EXPORT
void SCIPsyncdataGetSolutions(
SCIP_SYNCDATA* syncdata, /**< the synchronization data */
SCIP_Real*** solvalues, /**< pointer to return array of buffers containing the solution values */
int** solowner, /**< pointer to return array of ownerids of solutions */
int* nsols /**< pointer to return number of solutions */
);
/** read bound changes stored in the synchronization data */
SCIP_EXPORT
SCIP_BOUNDSTORE* SCIPsyncdataGetBoundChgs(
SCIP_SYNCDATA* syncdata /**< the synchronization data */
);
/** write the synchronization frequency to a synchronization data */
SCIP_EXPORT
void SCIPsyncdataSetSyncFreq(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_SYNCDATA* syncdata, /**< the synchronization data */
SCIP_Real syncfreq /**< the synchronization frequency */
);
/** set status in the synchronization data */
SCIP_EXPORT
void SCIPsyncdataSetStatus(
SCIP_SYNCDATA* syncdata, /**< the synchronization data the upperbound should be added to */
SCIP_STATUS status, /**< the status */
int solverid /**< identifier of te solver that has this status */
);
/** adds memory used to the synchronization data */
SCIP_EXPORT
void SCIPsyncdataAddMemTotal(
SCIP_SYNCDATA* syncdata, /**< the synchronization data the solution should be added to */
SCIP_Longint memtotal /**< the number of bytes used */
);
/** set upperbound to the synchronization data */
SCIP_EXPORT
void SCIPsyncdataSetUpperbound(
SCIP_SYNCDATA* syncdata, /**< the synchronization data the upperbound should be added to */
SCIP_Real upperbound /**< the upperbound */
);
/** set lowerbound to the synchronization data */
SCIP_EXPORT
void SCIPsyncdataSetLowerbound(
SCIP_SYNCDATA* syncdata, /**< the synchronization data the lowerbound should be added to */
SCIP_Real lowerbound /**< the lowerbound */
);
/** gives a buffer to store the solution values, or NULL if solution should not be stored
* because there are already better solutions stored.
*/
SCIP_EXPORT
void SCIPsyncdataGetSolutionBuffer(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_SYNCDATA* syncdata, /**< the synchronization data the solution should be added to */
SCIP_Real solobj, /**< the objective value of the solution */
int ownerid, /**< an identifier for the owner of the solution, e.g. the thread number */
SCIP_Real** buffer /**< pointer to return a buffer for the solution values, which must be set
* if the buffer is not NULL */
);
/** adds bound changes to the synchronization data */
SCIP_EXPORT
SCIP_RETCODE SCIPsyncdataAddBoundChanges(
SCIP_SYNCSTORE* syncstore, /**< the synchronization store */
SCIP_SYNCDATA* syncdata, /**< the synchronization data */
SCIP_BOUNDSTORE* boundstore /**< bound store containing the bounds to add */
);
/** is synchronization store initialized */
SCIP_EXPORT
SCIP_Bool SCIPsyncstoreIsInitialized(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
/** returns the mode of the synchronization store */
SCIP_EXPORT
SCIP_PARALLELMODE SCIPsyncstoreGetMode(
SCIP_SYNCSTORE* syncstore /**< the synchronization store */
);
#endif