libdb.pm.in 86.6 KB
Newer Older
1
2
#!/usr/bin/perl -w

Leigh B. Stoller's avatar
Leigh B. Stoller committed
3
4
#
# EMULAB-COPYRIGHT
Leigh B. Stoller's avatar
Leigh B. Stoller committed
5
# Copyright (c) 2000-2003 University of Utah and the Flux Group.
Leigh B. Stoller's avatar
Leigh B. Stoller committed
6
7
8
# All rights reserved.
#

9
#
10
11
# A library of useful DB stuff. Mostly things that get done a lot.
# Saves typing.
12
13
14
15
16
#
# XXX: The notion of "uid" is a tad confused. A unix uid is a number,
#      while in the DB a user uid is a string (equiv to unix login).
#      Needs to be cleaned up.
#
17

18
19
20
21
package libdb;
use Exporter;
@ISA = "Exporter";
@EXPORT =
22
23
24
    qw ( NODERELOADING_PID NODERELOADING_EID NODEDEAD_PID NODEDEAD_EID
	 NODEBOOTSTATUS_OKAY NODEBOOTSTATUS_FAILED NODEBOOTSTATUS_UNKNOWN
	 NODESTARTSTATUS_NOSTATUS PROJMEMBERTRUST_NONE PROJMEMBERTRUST_USER
Leigh B. Stoller's avatar
Leigh B. Stoller committed
25
26
27
28
29
30
31
	 PROJMEMBERTRUST_ROOT PROJMEMBERTRUST_GROUPROOT
	 PROJMEMBERTRUST_PROJROOT

	 TBTrustConvert TBMinTrust TBGrpTrust TBProjTrust

	 TB_NODEACCESS_READINFO TB_NODEACCESS_MODIFYINFO
	 TB_NODEACCESS_LOADIMAGE TB_NODEACCESS_REBOOT
32
33
	 TB_NODEACCESS_POWERCYCLE TB_NODEACCESS_MODIFYVLANS
	 TB_NODEACCESS_MIN TB_NODEACCESS_MAX
Leigh B. Stoller's avatar
Leigh B. Stoller committed
34
35
36
37

	 TB_USERINFO_READINFO TB_USERINFO_MODIFYINFO
	 TB_USERINFO_MIN TB_USERINFO_MAX

38
39
	 USERSTATUS_ACTIVE USERSTATUS_FROZEN
	 USERSTATUS_UNAPPROVED USERSTATUS_UNVERIFIED USERSTATUS_NEWUSER
40

Leigh B. Stoller's avatar
Leigh B. Stoller committed
41
42
43
44
45
	 TB_EXPT_READINFO TB_EXPT_MODIFY TB_EXPT_DESTROY
	 TB_EXPT_MIN TB_EXPT_MAX

	 TB_PROJECT_READINFO TB_PROJECT_MAKEGROUP
	 TB_PROJECT_EDITGROUP TB_PROJECT_DELGROUP
Chad Barb's avatar
   
Chad Barb committed
46
	 TB_PROJECT_GROUPGRABUSERS TB_PROJECT_BESTOWGROUPROOT
Leigh B. Stoller's avatar
Leigh B. Stoller committed
47
48
49
50
51
52
53
54
55
56
57
58
59
	 TB_PROJECT_LEADGROUP TB_PROJECT_ADDUSER
	 TB_PROJECT_DELUSER TB_PROJECT_MAKEOSID
	 TB_PROJECT_DELOSID TB_PROJECT_MAKEIMAGEID TB_PROJECT_DELIMAGEID
	 TB_PROJECT_CREATEEXPT TB_PROJECT_MIN TB_PROJECT_MAX

	 TB_OSID_READINFO TB_OSID_CREATE
	 TB_OSID_DESTROY TB_OSID_MIN TB_OSID_MAX

	 TB_IMAGEID_READINFO TB_IMAGEID_MODIFYINFO
	 TB_IMAGEID_CREATE TB_IMAGEID_DESTROY
	 TB_IMAGEID_ACCESS TB_IMAGEID_MIN TB_IMAGEID_MAX
	 
	 DBLIMIT_NSFILESIZE NODERELOADPENDING_EID
60

61
62
	 EXPTSTATE_NEW EXPTSTATE_PRERUN EXPTSTATE_SWAPPED EXPTSTATE_SWAPPING
	 EXPTSTATE_ACTIVATING EXPTSTATE_ACTIVE EXPTSTATE_TESTING
63
	 EXPTSTATE_TERMINATING EXPTSTATE_TERMINATED EXPTSTATE_UPDATING
64

65
	 BATCHSTATE_POSTED BATCHSTATE_RUNNING BATCHSTATE_TERMINATING
66
67
	 BATCHSTATE_ACTIVATING BATCHSTATE_PAUSED
	 BATCHMODE_CANCELTERM BATCHMODE_CANCELSWAP
Leigh B. Stoller's avatar
Leigh B. Stoller committed
68
69
	 TBBatchState TBSetBatchState

70
71
72
	 TB_NODELOGTYPE_MISC TB_NODELOGTYPES TB_DEFAULT_NODELOGTYPE 

	 TB_DEFAULT_RELOADTYPE TB_RELOADTYPE_FRISBEE TB_RELOADTYPE_NETDISK
73

74
75
	 TB_EXPTPRIORITY_LOW TB_EXPTPRIORITY_HIGH

76
	 TB_ASSIGN_TOOFEWNODES TB_OPSPID
77

78
	 TBDB_TBEVENT_NODESTATE TBDB_TBEVENT_NODEOPMODE TBDB_TBEVENT_CONTROL
79
	 TBDB_TBEVENT_COMMAND
Chad Barb's avatar
   
Chad Barb committed
80

81
	 TBDB_NODESTATE_ISUP TBDB_NODESTATE_REBOOTING TBDB_NODESTATE_REBOOTED
82
	 TBDB_NODESTATE_SHUTDOWN TBDB_NODESTATE_BOOTING TBDB_NODESTATE_TBSETUP
83
	 TBDB_NODESTATE_RELOADSETUP TBDB_NODESTATE_RELOADING
84
	 TBDB_NODESTATE_RELOADDONE TBDB_NODESTATE_UNKNOWN
Chad Barb's avatar
   
Chad Barb committed
85

86
87
	 TBDB_NODEOPMODE_NORMAL TBDB_NODEOPMODE_DELAYING
	 TBDB_NODEOPMODE_UNKNOWNOS TBDB_NODEOPMODE_RELOADING
88
	 TBDB_NODEOPMODE_NORMALv1 TBDB_NODEOPMODE_MINIMAL
89
90
	 TBDB_NODEOPMODE_RELOAD TBDB_NODEOPMODE_DELAY
	 TBDB_NODEOPMODE_BOOTWHAT
91
	 TBDB_NODEOPMODE_ANY
92
	 TBDB_NODEOPMODE_UNKNOWN
Chad Barb's avatar
   
Chad Barb committed
93

94
	 TBDB_COMMAND_REBOOT
95
96
	 TBDB_COMMAND_POWEROFF TBDB_COMMAND_POWERON TBDB_COMMAND_POWERCYCLE

97
98
99
	 TBDB_STATED_TIMEOUT_REBOOT TBDB_STATED_TIMEOUT_NOTIFY
	 TBDB_STATED_TIMEOUT_CMDRETRY

Chad Barb's avatar
   
Chad Barb committed
100
101
102
	 TBDB_ALLOCSTATE_FREE_CLEAN TBDB_ALLOCSTATE_FREE_DIRTY
	 TBDB_ALLOCSTATE_DOWN TBDB_ALLOCSTATE_RELOAD_TO_FREE
	 TBDB_ALLOCSTATE_RELOAD_PENDING TBDB_ALLOCSTATE_RES_RELOAD
Chad Barb's avatar
   
Chad Barb committed
103
	 TBDB_ALLOCSTATE_RES_INIT_DIRTY TBDB_ALLOCSTATE_RES_INIT_CLEAN 
Chad Barb's avatar
   
Chad Barb committed
104
105
106
	 TBDB_ALLOCSTATE_RES_REBOOT_DIRTY TBDB_ALLOCSTATE_RES_REBOOT_CLEAN 
	 TBDB_ALLOCSTATE_RES_READY TBDB_ALLOCSTATE_UNKNOWN

107
108
	 TBDB_STATS_PRELOAD TBDB_STATS_START TBDB_STATS_TERMINATE
	 TBDB_STATS_SWAPIN TBDB_STATS_SWAPOUT TBDB_STATS_SWAPMODIFY
109
	 TBDB_STATS_FLAGS_IDLESWAP TBDB_STATS_FLAGS_PREMODIFY
110

111
	 TBDB_EXPT_WORKDIR
112
	 TBSetNodeEventState TBGetNodeEventState
Chad Barb's avatar
   
Chad Barb committed
113
	 TBSetNodeAllocState TBGetNodeAllocState
114
	 TBSetNodeOpMode TBGetNodeOpMode
115
116
117
118
	 TB_OSID_MBKERNEL TB_OSID_PXEBOOT TB_OSID_FRISBEE 
	 TBBootWhat TBNodeStateTimeout
	 TBDB_TBCONTROL_RESET TBDB_TBCONTROL_RELOADDONE 
	 TBDB_TBCONTROL_TIMEOUT TBDB_NO_STATE_TIMEOUT
119

120
121
	 TBDB_LOWVPORT TBDB_MAXVPORT TBDB_PORTRANGE

Leigh B. Stoller's avatar
Leigh B. Stoller committed
122
123
	 TBAdmin TBProjAccessCheck TBNodeAccessCheck TBOSIDAccessCheck
	 TBImageIDAccessCheck TBExptAccessCheck ExpLeader MarkNodeDown
124
	 SetNodeBootStatus OSFeatureSupported IsShelved NodeidToExp
125
	 UserDBInfo DBQuery DBQueryFatal DBQueryWarn DBWarn DBFatal
126
	 DBQuoteSpecial UNIX2DBUID ExpState SetExpState ProjLeader
Leigh B. Stoller's avatar
Leigh B. Stoller committed
127
	 ExpNodes DBDateTime DefaultImageID GroupLeader TBGroupUnixInfo
128
	 TBValidNodeLogType TBValidNodeName TBSetNodeLogEntry
129
	 TBSetSchedReload MapNodeOSID TBLockExp TBUnLockExp TBSetExpSwapTime
130
	 TBUnixGroupList TBOSID TBOSMaxConcurrent TBOSCountInstances
131
	 TBOSLoadMaxOkay TBImageLoadMaxOkay TBImageID ExpSwapper
132
	 TBdbfork VnameToNodeid TBExpLocked
133
	 TBIsNodeRemote TBExptSetLogFile TBExptClearLogFile TBExptGetLogFile
134
	 TBIsNodeVirtual TBControlNetIP TBPhysNodeID
135
	 TBExptOpenLogFile TBExptCloseLogFile TBExptCreateLogFile
136
	 TBNodeUpdateAccountsByPid TBNodeUpdateAccountsByType
137
	 TBNodeUpdateAccountsByUID
138
	 TBSaveExpLogFiles TBExptWorkDir TBExptUserDir TBExptLogDir
139
	 TBExptDestroy TBIPtoNodeID TBNodeBootReset TBNodeStateWait
140
	 TBLeaderMailList ExpGroup TBExptSetSwapUID
141

Chad Barb's avatar
   
Chad Barb committed
142
143
144
145
146
147
	 TBExptRemoveVirtualState TBExptBackupVirtualState 
	 TBExptRestoreVirtualState

	 TBExptRemovePhysicalState TBExptBackupPhysicalState 
	 TBExptRestorePhysicalState

148
	 TBDB_WIDEAREA_LOCALNODE
Leigh B. Stoller's avatar
Leigh B. Stoller committed
149
	 TBWideareaNodeID TBTipServers
Mac Newbold's avatar
Mac Newbold committed
150

Chad Barb's avatar
   
Chad Barb committed
151
152
	 TBSiteVarExists TBGetSiteVar

153
	 TBActivityReport GatherSwapStats GatherAssignStats
154
	 );
155

156
# Must come after package declaration!
157
use lib '@prefix@/lib';
158
use English;
159
use File::Basename;
160
use POSIX qw(strftime);
161
162
require Mysql;

163
164
165
# Configure variables
my $TB		= "@prefix@";
my $DBNAME	= "@TBDBNAME@";
166
my $TBOPS       = "@TBOPSEMAIL@";
167
168
my $EVENTSYS    = "@EVENTSYS@";
my $BOSSNODE    = "@BOSSNODE@";
169
my $TESTMODE    = @TESTMODE@;
170
my $TBOPSPID	= "emulab-ops";
Leigh B. Stoller's avatar
Leigh B. Stoller committed
171
my $SCRIPTNAME = "Unknown";
172

173
174
175
176
177
if ($EVENTSYS) {
    require event;
    import event;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
178
179
180
# Untainted scriptname for email below.
if ($PROGRAM_NAME =~ /^([-\w\.\/]+)$/) {
    $SCRIPTNAME = basename($1);
181
182
}
else {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
183
    $SCRIPTNAME = "Tainted";
184
185
}

186
#
187
188
# Set up for querying the database. Note that fork causes a reconnect
# to the DB in the child. 
189
190
#
my $DB;
191
192
193
$DBQUERY_MAXTRIES = 1;
$DBCONN_MAXTRIES  = 5;
@EXPORT_OK        = qw($DBQUERY_MAXTRIES $DBCONN_MAXTRIES);
194
195
196

sub TBDBConnect()
{
197
    my $maxtries = $DBCONN_MAXTRIES;
198
199
200
201
202
203
204
205
206

    #
    # Construct a 'username' from the name of this script and the user who
    # ran it. This is for accounting purposes.
    #
    my $name = getpwuid($UID);
    if (!$name) {
	$name = "uid$UID";
    }
207
    my $dbuser = "$SCRIPTNAME:$name:$PID";
208

209
    while ($maxtries) {
210
	$DB = Mysql->connect("localhost", $DBNAME, $dbuser, "none");
211
212
213
	if (defined($DB)) {
	    last;
	}
214
215
216
217
218
219
	$maxtries--;
	sleep(1);
    }
    if (!defined($DB)) {
	die("Cannot connect to DB after several attempts!\n");
    }
220
221
    $DB->{'dbh'}->{'PrintError'} = 0;
    $Mysql::QUIET = 1;
222
223
}
TBDBConnect();
224

225
226
sub TBdbfork()
{
227
    select(undef, undef, undef, 0.3);
228
    undef($DB);
229
    TBDBConnect();
230
231
}

232
233
234
235
236
#
# Record last DB error string.
#
my $DBErrorString = "";

237
238
239
240
241
#
# Needs to be config'ed.
#
sub TBDB_EXPT_WORKDIR()		{ "/usr/testbed/expwork"; }
    
242
243
244
245
246
#
# Define exported "constants". Basically, these are just perl subroutines
# that look like constants cause you do not need to call a perl subroutine
# with parens. That is, FOO and FOO() are the same thing.
#
247
sub NODERELOADING_PID()		{ "emulab-ops"; }
248
sub NODERELOADING_EID()		{ "reloading"; }
249
sub NODERELOADPENDING_EID()	{ "reloadpending"; }
250
251
252
253
254
255
256
257
sub NODEDEAD_PID()		{ "emulab-ops"; }
sub NODEDEAD_EID()		{ "hwdown"; }

sub NODEBOOTSTATUS_OKAY()	{ "okay" ; }
sub NODEBOOTSTATUS_FAILED()	{ "failed"; }
sub NODEBOOTSTATUS_UNKNOWN()	{ "unknown"; }
sub NODESTARTSTATUS_NOSTATUS()	{ "none"; }

258
259
260
261
262
263
264
265
266
sub EXPTSTATE_NEW()		{ "new"; }
sub EXPTSTATE_PRERUN()		{ "prerunning"; }
sub EXPTSTATE_SWAPPED()		{ "swapped"; }
sub EXPTSTATE_SWAPPING()	{ "swapping"; }
sub EXPTSTATE_ACTIVATING()	{ "activating"; }
sub EXPTSTATE_ACTIVE()		{ "active"; }
sub EXPTSTATE_TESTING()		{ "testing"; }
sub EXPTSTATE_TERMINATING()	{ "terminating"; }
sub EXPTSTATE_TERMINATED()	{ "ended"; }
267
sub EXPTSTATE_UPDATING()	{ "updating"; }
268

Leigh B. Stoller's avatar
Leigh B. Stoller committed
269
270
271
sub BATCHSTATE_POSTED()		{ "posted"; }
sub BATCHSTATE_ACTIVATING()	{ "activating"; }
sub BATCHSTATE_RUNNING()	{ "active"; }
272
sub BATCHSTATE_PAUSED()		{ "paused"; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
273
sub BATCHSTATE_TERMINATING()	{ "terminating"; }
274
275
276
# Cancel flags
sub BATCHMODE_CANCELTERM	{ 1 ;}
sub BATCHMODE_CANCELSWAP	{ 2 ;}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
277

278
279
sub USERSTATUS_ACTIVE()		{ "active"; }
sub USERSTATUS_FROZEN()		{ "frozen"; }
280
281
282
sub USERSTATUS_UNAPPROVED()	{ "unapproved"; }
sub USERSTATUS_UNVERIFIED()	{ "unverified"; }
sub USERSTATUS_NEWUSER()	{ "newuser"; }
283

284
285
286
287
288
289
#
# We want valid project membership to be non-zero for easy membership
# testing. Specific trust levels are encoded thusly.
# 
sub PROJMEMBERTRUST_NONE()	{ 0; }
sub PROJMEMBERTRUST_USER()	{ 1; }
290
sub PROJMEMBERTRUST_ROOT()	{ 2; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
291
292
293
294
295
296
297
298
299
300
301
302
303
304
sub PROJMEMBERTRUST_LOCALROOT()	{ 2; }
sub PROJMEMBERTRUST_GROUPROOT()	{ 3; }
sub PROJMEMBERTRUST_PROJROOT()	{ 4; }
sub PROJMEMBERTRUST_ADMIN()	{ 5; }

#
# Access types. Duplicated in the web interface. Make changes there too!
# 
# Things you can do to a node.
sub TB_NODEACCESS_READINFO()	{ 1; }
sub TB_NODEACCESS_MODIFYINFO()	{ 2; }
sub TB_NODEACCESS_LOADIMAGE()	{ 3; }
sub TB_NODEACCESS_REBOOT()	{ 4; }
sub TB_NODEACCESS_POWERCYCLE()	{ 5; }
305
sub TB_NODEACCESS_MODIFYVLANS()	{ 6; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
306
sub TB_NODEACCESS_MIN()		{ TB_NODEACCESS_READINFO; }
307
sub TB_NODEACCESS_MAX()		{ TB_NODEACCESS_MODIFYVLANS; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325

# User Info (modinfo web page, etc).
sub TB_USERINFO_READINFO()	{ 1; }
sub TB_USERINFO_MODIFYINFO()	{ 2; }
sub TB_USERINFO_MIN()		{ TB_USERINFO_READINFO; }
sub TB_USERINFO_MAX()		{ TB_USERINFO_MODIFYINFO; }

# Experiments (also batch experiments).
sub TB_EXPT_READINFO()		{ 1; }
sub TB_EXPT_MODIFY()		{ 2; }
sub TB_EXPT_DESTROY()		{ 3; }
sub TB_EXPT_MIN()		{ TB_EXPT_READINFO; }
sub TB_EXPT_MAX()		{ TB_EXPT_DESTROY; }

# Projects.
sub TB_PROJECT_READINFO()	{ 1; }
sub TB_PROJECT_MAKEGROUP()	{ 2; }
sub TB_PROJECT_EDITGROUP()	{ 3; }
Chad Barb's avatar
   
Chad Barb committed
326
sub TB_PROJECT_GROUPGRABUSERS() { 4; }
Chad Barb's avatar
   
Chad Barb committed
327
328
329
330
331
332
333
334
335
336
sub TB_PROJECT_BESTOWGROUPROOT(){ 5; }
sub TB_PROJECT_DELGROUP()	{ 6; }
sub TB_PROJECT_LEADGROUP()	{ 7; }
sub TB_PROJECT_ADDUSER()	{ 8; }
sub TB_PROJECT_DELUSER()	{ 9; }
sub TB_PROJECT_MAKEOSID()	{ 10; }
sub TB_PROJECT_DELOSID()	{ 11; }
sub TB_PROJECT_MAKEIMAGEID()	{ 12; }
sub TB_PROJECT_DELIMAGEID()	{ 13; }
sub TB_PROJECT_CREATEEXPT()	{ 14; }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
337
338
339
340
341
342
343
344
345
346
sub TB_PROJECT_MIN()		{ TB_PROJECT_READINFO; }
sub TB_PROJECT_MAX()		{ TB_PROJECT_CREATEEXPT; }

# OSIDs 
sub TB_OSID_READINFO()		{ 1; }
sub TB_OSID_CREATE()		{ 2; }
sub TB_OSID_DESTROY()		{ 3; }
sub TB_OSID_MIN()		{ TB_OSID_READINFO; }
sub TB_OSID_MAX()		{ TB_OSID_DESTROY; }

347
348
349
350
351
# Magic OSID constants
sub TB_OSID_MBKERNEL()          { "_KERNEL_"; } # multiboot kernel OSID
sub TB_OSID_PXEBOOT()           { "PXEBOOT"; } # osid for def pxe_boot_path
sub TB_OSID_FRISBEE()           { "PXEFRISBEE"; } 

Leigh B. Stoller's avatar
Leigh B. Stoller committed
352
# ImageIDs
353
354
355
356
357
#
# Clarification:
# READINFO is read-only access to the image and its contents
# (This is what people get for shared images)
# ACCESS means complete power over the image and its [meta]data
Leigh B. Stoller's avatar
Leigh B. Stoller committed
358
359
360
361
362
363
364
sub TB_IMAGEID_READINFO()	{ 1; }
sub TB_IMAGEID_MODIFYINFO()	{ 2; }
sub TB_IMAGEID_CREATE()		{ 3; }
sub TB_IMAGEID_DESTROY()	{ 4; }
sub TB_IMAGEID_ACCESS()		{ 5; }
sub TB_IMAGEID_MIN()		{ TB_IMAGEID_READINFO; }
sub TB_IMAGEID_MAX()		{ TB_IMAGEID_ACCESS; }
365

366
# Node Log Types
367
368
369
370
371
372
373
sub TB_NODELOGTYPE_MISC		{ "misc"; }
sub TB_NODELOGTYPES()		{ ( TB_NODELOGTYPE_MISC ) ; }
sub TB_DEFAULT_NODELOGTYPE()	{ TB_NODELOGTYPE_MISC; }

# Reload Types.
sub TB_RELOADTYPE_NETDISK()	{ "netdisk"; }
sub TB_RELOADTYPE_FRISBEE()	{ "frisbee"; }
374
sub TB_DEFAULT_RELOADTYPE()	{ TB_RELOADTYPE_FRISBEE; }
375

376
377
378
379
380
381
382
# Experiment priorities.
sub TB_EXPTPRIORITY_LOW()	{ 0; }
sub TB_EXPTPRIORITY_HIGH()	{ 20; }

# Assign exit status for too few nodes.
sub TB_ASSIGN_TOOFEWNODES()	{ 2; }

383
384
385
# System PID.
sub TB_OPSPID()			{ $TBOPSPID; }

386
#
387
388
389
390
# Events we may want to send
#
sub TBDB_TBEVENT_NODESTATE	{ "TBNODESTATE"; }
sub TBDB_TBEVENT_NODEOPMODE	{ "TBNODEOPMODE"; }
391
sub TBDB_TBEVENT_CONTROL	{ "TBCONTROL"; }
392
sub TBDB_TBEVENT_COMMAND	{ "TBCOMMAND"; }
393
394
395
396

#
# For nodes, we use this set of events.
#
397
398
399
400
401
402
403
404
405
sub TBDB_NODESTATE_ISUP()	{ "ISUP"; }
sub TBDB_NODESTATE_REBOOTED()	{ "REBOOTED"; }
sub TBDB_NODESTATE_REBOOTING()	{ "REBOOTING"; }
sub TBDB_NODESTATE_SHUTDOWN()	{ "SHUTDOWN"; }
sub TBDB_NODESTATE_BOOTING()	{ "BOOTING"; }
sub TBDB_NODESTATE_TBSETUP()	{ "TBSETUP"; }
sub TBDB_NODESTATE_RELOADSETUP() { "RELOADSETUP"; }
sub TBDB_NODESTATE_RELOADING()	{ "RELOADING"; }
sub TBDB_NODESTATE_RELOADDONE()	{ "RELOADDONE"; }
406
407
sub TBDB_NODESTATE_UNKNOWN()	{ "UNKNOWN"; };

408
sub TBDB_NODEOPMODE_ANY		{ "*"; } # A wildcard opmode
409
410
411
412
sub TBDB_NODEOPMODE_NORMAL	{ "NORMAL"; }
sub TBDB_NODEOPMODE_DELAYING	{ "DELAYING"; }
sub TBDB_NODEOPMODE_UNKNOWNOS	{ "UNKNOWNOS"; }
sub TBDB_NODEOPMODE_RELOADING	{ "RELOADING"; }
413
414
415
416
sub TBDB_NODEOPMODE_NORMALv1	{ "NORMALv1"; }
sub TBDB_NODEOPMODE_MINIMAL	{ "MINIMAL"; }
sub TBDB_NODEOPMODE_RELOAD	{ "RELOAD"; }
sub TBDB_NODEOPMODE_DELAY	{ "DELAY"; }
417
sub TBDB_NODEOPMODE_BOOTWHAT	{ "_BOOTWHAT_"; } # A redirection opmode
418
419
sub TBDB_NODEOPMODE_UNKNOWN	{ "UNKNOWN"; }

420
421
422
423
424
sub TBDB_COMMAND_REBOOT         { "REBOOT"; }
sub TBDB_COMMAND_POWEROFF       { "POWEROFF"; }
sub TBDB_COMMAND_POWERON        { "POWERON"; }
sub TBDB_COMMAND_POWERCYCLE     { "POWERCYCLE"; }

425
426
427
428
sub TBDB_STATED_TIMEOUT_REBOOT  { "REBOOT"; }
sub TBDB_STATED_TIMEOUT_NOTIFY  { "NOTIFY"; }
sub TBDB_STATED_TIMEOUT_CMDRETRY{ "CMDRETRY"; }

Chad Barb's avatar
   
Chad Barb committed
429
430
431
432
433
434
sub TBDB_ALLOCSTATE_FREE_CLEAN()       { "FREE_CLEAN"; }
sub TBDB_ALLOCSTATE_FREE_DIRTY()       { "FREE_DIRTY"; }
sub TBDB_ALLOCSTATE_DOWN()             { "DOWN"; }
sub TBDB_ALLOCSTATE_RELOAD_TO_FREE()   { "RELOAD_TO_FREE"; }
sub TBDB_ALLOCSTATE_RELOAD_PENDING()   { "RELOAD_PENDING"; }
sub TBDB_ALLOCSTATE_RES_RELOAD()       { "RES_RELOAD"; }
Chad Barb's avatar
   
Chad Barb committed
435
436
437
438
sub TBDB_ALLOCSTATE_RES_REBOOT_DIRTY() { "RES_REBOOT_DIRTY"; }
sub TBDB_ALLOCSTATE_RES_REBOOT_CLEAN() { "RES_REBOOT_CLEAN"; }
sub TBDB_ALLOCSTATE_RES_INIT_DIRTY() { "RES_INIT_DIRTY"; }
sub TBDB_ALLOCSTATE_RES_INIT_CLEAN() { "RES_INIT_CLEAN"; }
Chad Barb's avatar
   
Chad Barb committed
439
440
441
sub TBDB_ALLOCSTATE_RES_READY()        { "RES_READY"; }
sub TBDB_ALLOCSTATE_UNKNOWN()          { "UNKNOWN"; };

442
443
444
445
446
447
448
sub TBDB_TBCONTROL_RESET	{ "RESET"; }
sub TBDB_TBCONTROL_RELOADDONE	{ "RELOADDONE"; }
sub TBDB_TBCONTROL_TIMEOUT	{ "TIMEOUT"; }

# Constant we use for the timeout field when there is no timeout for a state
sub TBDB_NO_STATE_TIMEOUT	{ 0; }

449
450
451
452
453
454
#
# Node name we use in the widearea_* tables to represent a generic local node.
# All local nodes are considered to have the same network characteristcs.
#
sub TBDB_WIDEAREA_LOCALNODE     { "boss"; }

455
456
457
458
459
#
# We should list all of the DB limits.
#
sub DBLIMIT_NSFILESIZE()	{ (1024 * 16); }

460
461
462
463
464
465
466
467
468
469
470
#
# Virtual nodes must operate within a restricted port range. The range
# is effective across all virtual nodes in the experiment. When an
# experiment is swapped in, allocate a subrange from this and setup
# all the vnodes to allocate from that range. We tell the user this
# range so this they can set up their programs to operate in that range.
#
sub TBDB_LOWVPORT()		{ 30000; }
sub TBDB_MAXVPORT()		{ 60000; }
sub TBDB_PORTRANGE()		{ 256;   }

471
472
473
474
475
476
477
478
#
# STATS constants.
#
sub TBDB_STATS_PRELOAD()	{ "preload"; }
sub TBDB_STATS_START()		{ "start"; }
sub TBDB_STATS_TERMINATE()	{ "destroy"; }
sub TBDB_STATS_SWAPIN()		{ "swapin"; }
sub TBDB_STATS_SWAPOUT()	{ "swapout"; }
479
sub TBDB_STATS_SWAPMODIFY()	{ "swapmod"; }
480
sub TBDB_STATS_FLAGS_IDLESWAP()	{ 0x01; }
481
sub TBDB_STATS_FLAGS_PREMODIFY(){ 0x02; }
482

Leigh B. Stoller's avatar
Leigh B. Stoller committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
#
# Auth stuff.
#

#
# Convert a trust string to the above numeric values.
#
sub TBTrustConvert($)
{
    my($trust_string) = @_;
    my $trust_value = 0;

    #
    # Convert string to value. Perhaps the DB should have done it this way?
    # 
    if ($trust_string eq "none") {
	$trust_value = PROJMEMBERTRUST_NONE;
    }
    elsif ($trust_string eq "user") {
	$trust_value = PROJMEMBERTRUST_USER;
    }
    elsif ($trust_string eq "local_root") {
	$trust_value = PROJMEMBERTRUST_LOCALROOT;
    }
    elsif ($trust_string eq "group_root") {
	$trust_value = PROJMEMBERTRUST_GROUPROOT;
    }
    elsif ($trust_string eq "project_root") {
	$trust_value = PROJMEMBERTRUST_PROJROOT;
    }
    elsif ($trust_string eq "admin") {
	$trust_value = PROJMEMBERTRUST_ADMIN;
    }
    else {
	    die("*** Invalid trust value $trust_string!");
    }

    return $trust_value;
}

#
# Return true if the given trust string is >= to the minimum required.
# The trust value can be either numeric or a string; if a string its
# first converted to the numeric equiv.
#
sub TBMinTrust($$)
{
    my ($trust_value, $minimum) = @_;

    if ($minimum < PROJMEMBERTRUST_NONE ||
	$minimum > PROJMEMBERTRUST_ADMIN) {
	    die("*** Invalid minimum trust $minimum!");
    }

    #
    # Sleazy? How do you do a typeof in perl?
    #
    if (length($trust_value) != 1) {
	$trust_value = TBTrustConvert($trust_value);
    }
    
    return $trust_value >= $minimum;
}

#
# Determine the trust level for a uid/pid/gid. That is, each uid will have
# a different trust level depending on the project/group in question.
# Return that trust level as one of the numeric values above. 
# 
# usage: TBGrpTrust($dbuid, $pid, $gid)
#        returns numeric trust value if a group member.
#        returns PROJMEMBERTRUST_NONE if not a group member.
# 
sub TBGrpTrust($$$)
{
    my ($uid, $pid, $gid) = @_;

    #
    # No group, then use the default group.
    #
    if (! $gid) {
	$gid = $pid;
    }

    my $query_result =
	DBQueryFatal("select trust from group_membership ".
		     "where uid='$uid' and pid='$pid' and gid='$gid'");

    #
    # No membership is the same as no trust. True? Maybe an error instead?
    #
    if ($query_result->numrows == 0) {
	return PROJMEMBERTRUST_NONE;
    }

    my @row = $query_result->fetchrow_array();
    $trust_string = $row[0];

    return TBTrustConvert($trust_string);
}

#
# Determine the project trust level for a uid/pid. This is the trust level
# for the default group in the project.
#
# usage: TBProjTrust($dbuid, $pid)
#        returns numeric trust value if a project member.
#        returns PROJMEMBERTRUST_NONE if not a project member.
# 
sub TBProjTrust($$)
{
    my ($uid, $pid) = @_;
    
    return TBGrpTrust($uid, $pid, $pid);
}

599
#
600
601
# Test admin status. Optional argument is the UID or Name to test. If not
# provided, then test the current UID.
602
#
603
604
605
# XXX Argument is *either* a numeric UID, or a string name.
#
# usage: TBAdmin([int or char* uid]);
606
607
608
609
610
611
#        returns 1 if an admin type.
#        returns 0 if a mere user.
# 
sub TBAdmin(;$)
{
    my($uid) = @_;
612
    my($name);
613

614
615
616
617
    #
    # No one is considered an admin unless they have the magic environment
    # variable set (so that you have to be a bit more explict about wanting
    # admin privs.) Use the withadminprivs script to get this variable set.
618
619
    # Also check with HTTP_ at the front of the name, since this is required
    # to get it through suexec from the web scripts.
620
    #
621
    if (!($ENV{WITH_TB_ADMIN_PRIVS} || $ENV{HTTP_WITH_TB_ADMIN_PRIVS})) {
622
623
624
	return 0;
    }

625
626
627
628
    if (!defined($uid)) {
	$uid = $UID;
    }

629
630
631
632
633
634
635
636
637
638
    #
    # Test if numeric. Map to name if it is.
    # 
    if ($uid =~ /^[0-9]+$/) {
	($name) = getpwuid($uid)
	    or die "$uid not in passwd file\n";
    }
    else {
	$name = $uid;
    }
639
640

    my $query_result =
641
	DBQueryFatal("select admin from users where uid='$name'");
642
643
644
645
646
647
648
649
650

    my @row = $query_result->fetchrow_array();
    if ($row[0] == 1) {
	return 1;
    }
    return 0;
}

#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
651
652
# Project permission checks. The group id (gid) can be undef, in which case
# the pid is used (ie: a default group check is made).
653
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
654
655
656
657
658
# Usage: TBProjAccessCheck($uid, $pid, $gid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
sub TBProjAccessCheck($$$$)
659
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
660
661
    my ($uid, $pid, $gid, $access_type) = @_;
    my $mintrust;
662

Leigh B. Stoller's avatar
Leigh B. Stoller committed
663
664
665
    if ($access_type < TB_PROJECT_MIN ||
	$access_type > TB_PROJECT_MAX) {
	die("*** Invalid access type: $access_type!");
666
667
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
668
669
670
671
672
    #
    # Admins do whatever they want!
    # 
    if (TBAdmin($uid)) {
	return 1;
673
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
674
675
676
677
678
679
680
    $uid = MapNumericUID($uid);

    #
    # No group, then use the default group.
    #
    if (! defined($gid)) {
	$gid = $pid;
681
682
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
683
684
685
686
687
688
    if ($access_type == TB_PROJECT_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    elsif ($access_type == TB_PROJECT_CREATEEXPT) {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }
689
690
691
    elsif ($access_type == TB_PROJECT_DELUSER) {
	$mintrust = PROJMEMBERTRUST_PROJROOT;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
    else {
	die("*** Unexpected access type: $access_type!");
    }

    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust);
}

#
# Experiment permission checks.
#
# Usage: TBExptAccessCheck($uid, $pid, $eid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
sub TBExptAccessCheck($$$$)
{
    my ($uid, $pid, $eid, $access_type) = @_;
    my $mintrust;

    if ($access_type < TB_EXPT_MIN ||
	$access_type > TB_EXPT_MAX) {
	die("*** Invalid access type: $access_type!");
714
715
716
    }

    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
717
718
719
    # Admins do whatever they want!
    # 
    if (TBAdmin($uid)) {
720
721
	return 1;
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
722
    $uid = MapNumericUID($uid);
723

Leigh B. Stoller's avatar
Leigh B. Stoller committed
724
    my $query_result =
725
	DBQueryFatal("SELECT gid,expt_head_uid FROM experiments WHERE ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
726
727
728
729
730
731
		     "eid='$eid' and pid='$pid'");
    
    if ($query_result->numrows == 0) {
	return 0;
    }
    my @row = $query_result->fetchrow_array();
732
733
    my $gid     = $row[0];
    my $creator = $row[1];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
734

735
736
737
738
    #
    # An experiment may be destroyed by the experiment creator or the
    # project/group leader.
    # 
739
    if ($access_type == TB_EXPT_READINFO) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
740
741
742
743
744
745
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

746
747
748
749
750
751
752
    #
    # Either proper permission in the group, or group_root in the project.
    # This lets group_roots muck with other people's experiments, including
    # those in groups they do not belong to.
    #
    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust) ||
	TBMinTrust(TBGrpTrust($uid, $pid, $pid), PROJMEMBERTRUST_GROUPROOT);
Leigh B. Stoller's avatar
Leigh B. Stoller committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
}

#
# Determine if uid can access a node or list of nodes.
#
# Usage: TBNodeAccessCheck($uid, $access_type, $node_id, ...)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
sub TBNodeAccessCheck($$@)
{
    my ($uid, $access_type) = (shift, shift);
    my @nodelist = @_;
    my $mintrust;

    if ($access_type < TB_NODEACCESS_MIN ||
	$access_type > TB_NODEACCESS_MAX) {
	die("*** Invalid access type: $access_type!");
    }
772
773

    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
    # Admins do whatever they want!
    # 
    if (TBAdmin($uid)) {
	return 1;
    }
    $uid = MapNumericUID($uid);
 
    if ($access_type == TB_NODEACCESS_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

    foreach my $node (@nodelist) {
789
	my $query_result =
790
	    DBQueryFatal("select e.pid,e.gid from reserved as r ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
791
			 "left join experiments as e on ".
792
793
			 "     e.pid=r.pid and e.eid=r.eid ".
			 "where r.node_id='$node'");
794

795
	if ($query_result->numrows == 0) {
796
797
	    return 0;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
798
	my @row = $query_result->fetchrow_array();
799
800
	my $pid = $row[0];
	my $gid = $row[1];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
801

802
803
804
805
806
807
808
809
	#
	# Either proper permission in the group, or group_root in the
	# project. This lets group_roots muck with other people's
	# nodes, including those in groups they do not belong to.
	#
	if (! TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust) &&
	    ! TBMinTrust(TBGrpTrust($uid, $pid, $pid),
			 PROJMEMBERTRUST_GROUPROOT)) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
810
811
	    return 0;
	}
812
813
814
815
816
    }
    return 1;
}

#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
817
# Access checks for an OSID. Tests for tbadmin.
818
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
819
820
821
# Usage: TBOSIDAccessCheck($uid, $osid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
822
# 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
823
sub TBOSIDAccessCheck($$$)
824
{
Leigh B. Stoller's avatar
Leigh B. Stoller committed
825
826
    my ($uid, $osid, $access_type) = @_;
    my $mintrust;
827

Leigh B. Stoller's avatar
Leigh B. Stoller committed
828
829
    if ($access_type < TB_OSID_MIN || $access_type > TB_OSID_MAX) {
	die("*** Invalid access type $access_type!");
830
831
    }

Leigh B. Stoller's avatar
Leigh B. Stoller committed
832
833
834
835
836
837
838
    #
    # Admins do whatever they want!
    # 
    if (TBAdmin($uid)) {
	return 1;
    }
    $uid = MapNumericUID($uid);
839

Leigh B. Stoller's avatar
Leigh B. Stoller committed
840
841
842
843
    #
    # No GIDs yet.
    #
    my $query_result =
844
	DBQueryFatal("SELECT pid,shared FROM os_info WHERE osid='$osid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
845
    
846
    if ($query_result->numrows == 0) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
847
	return 0;
848
    }
849
    my @row = $query_result->fetchrow_array();
Leigh B. Stoller's avatar
Leigh B. Stoller committed
850
    my $pid = $row[0];
851
    my $shared = $row[1];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
852
853

    #
854
    # Global OSIDs can be read by anyone, but must be admin to read. 
Leigh B. Stoller's avatar
Leigh B. Stoller committed
855
    # 
856
    if ($shared) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
	if ($access_type == TB_OSID_READINFO) {
	    return 1;
	}
	return 0;
    }
    
    #
    # Otherwise must have proper trust in the project.
    # 
    if ($access_type == TB_OSID_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

    return TBMinTrust(TBProjTrust($uid, $pid), $mintrust);
}

#
# Access checks for an ImageID
#
# Usage: TBImageIDAccessCheck($uid, $imageid, $access_type)
#	 returns 0 if not allowed.
#        returns 1 if allowed.
# 
sub TBImageIDAccessCheck($$$)
{
    my ($uid, $imageid, $access_type) = @_;
    my $mintrust;

    if ($access_type < TB_IMAGEID_MIN || $access_type > TB_IMAGEID_MAX) {
	die("*** Invalid access type $access_type!");
890
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
891
892

    #
893
    # Admins and root do whatever they want!
Leigh B. Stoller's avatar
Leigh B. Stoller committed
894
    # 
895
    if (TBAdmin($uid) || !$UID || $UID eq "root" || $uid eq "root") {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
896
	return 1;
897
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
898
899
900
901
902
903
    $uid = MapNumericUID($uid);

    #
    # No GIDs yet.
    #
    my $query_result =
904
905
	DBQueryFatal("SELECT pid,gid,shared,global FROM images ".
		     "WHERE imageid='$imageid'");
Leigh B. Stoller's avatar
Leigh B. Stoller committed
906
907
908
    
    if ($query_result->numrows == 0) {
	return 0;
909
    }
Leigh B. Stoller's avatar
Leigh B. Stoller committed
910
911
    my @row = $query_result->fetchrow_array();
    my $pid = $row[0];
912
913
914
    my $gid = $row[1];
    my $shared = $row[2];
    my $global = $row[3];
Leigh B. Stoller's avatar
Leigh B. Stoller committed
915

916
    #
Leigh B. Stoller's avatar
Leigh B. Stoller committed
917
918
    # Global ImageIDs can be read by anyone.
    # 
919
    if ($global) {
Leigh B. Stoller's avatar
Leigh B. Stoller committed
920
921
922
923
924
925
	if ($access_type == TB_IMAGEID_READINFO) {
	    return 1;
	}
	return 0;
    }

926
    #
927
    # Otherwise must have proper trust in the pid/gid
Leigh B. Stoller's avatar
Leigh B. Stoller committed
928
929
930
    # 
    if ($access_type == TB_IMAGEID_READINFO) {
	$mintrust = PROJMEMBERTRUST_USER;
931
932
933
934
935
936
        #
        # Shared imageids are readable by anyone in the project.
        #
	if ($shared) {
	    $gid = $pid;
	}
Leigh B. Stoller's avatar
Leigh B. Stoller committed
937
938
939
940
941
    }
    else {
	$mintrust = PROJMEMBERTRUST_LOCALROOT;
    }

942
943
944
945
946
947
948
    #
    # Either proper permission in the group, or group_root in the project.
    # This lets group_roots muck with other people's experiments, including
    # those in groups they do not belong to.
    #
    return TBMinTrust(TBGrpTrust($uid, $pid, $gid), $mintrust) ||
	TBMinTrust(TBGrpTrust($uid, $pid, $pid), PROJMEMBERTRUST_GROUPROOT);
949
950
}

951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
#
# Return Project leader. First argument pid.
#
# usage: ProjLeader(char *pid)
#        returns char *leader if a valid pid.
#        returns 0 if an invalid pid.
# 
sub ProjLeader($)
{
    my($pid) = @_;

    my $query_result =
	DBQueryFatal("select head_uid from projects where pid='$pid'");

    if ($query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
#
# Return Group leader. 
#
# usage: GroupLeader(char *pid, char *gid)
#        returns char *leader if a valid pid.
#        returns 0 if an invalid pid.
# 
sub GroupLeader($$)
{
    my($pid, $gid) = @_;

    my $query_result =
	DBQueryFatal("select leader from groups where ".
		     "pid='$pid' and gid='$gid'");

    if ($query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
#
# Return Experiment leader. First argument pid. Second argument is eid.
#
# usage: ExpLeader(char *pid, char *eid)
#        returns char *leader if a valid pid/eid.
#        returns 0 if an invalid pid/eid.
# 
sub ExpLeader($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryFatal("select expt_head_uid from experiments ".
		     "where eid='$eid' and pid='$pid'");

    if ($query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
#
# Return Experiment swapper. First argument pid. Second argument is eid.
#
# usage: ExpSwapper(char *pid, char *eid)
#        returns char *swapper if a valid pid/eid.
#        returns 0 if an invalid pid/eid.
#
sub ExpSwapper($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryFatal("select expt_swap_uid from experiments ".
		     "where eid='$eid' and pid='$pid'");

    if ($query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
#
# Return a list of leaders (proj/group roots) for a given pid/gid,
# in the format of an email address list. If no gid, assumes gid=pid.
#
# usage: TBLeaderMailList($pid,[$gid])
#	 returns string like "name <email>[, name2 <email2>[, ...]]"
#
sub TBLeaderMailList($;$) {
    # Based on the php version in dbdefs.php

    my $pid = shift;
    my $gid = shift || $pid;

    # XXX: hardcode project_root and group_root here because we don't
    # have the strings in variables...
    $query_result =
    DBQueryFatal("select distinct usr_name,u.uid,usr_email from users as u ".
                 "left join group_membership as gm on gm.uid=u.uid ".
                 "where (trust='project_root' and pid='$pid') or ".
		 "(trust='group_root' and pid='$pid' and gid='$gid') ".
                 "order by trust DESC, usr_name");
    
    if ($query_result->numrows() == 0) {
	return 0;
    }
    $mailstr="";
    while (@row = $query_result->fetchrow_array()) {
	if ($mailstr ne "") { $mailstr .=", "; }
	$mailstr .= '"'.$row[0]." (".$row[1].")\" <".$row[2].">";
    }
    return $mailstr;
}

#
# Return Experiment group.
#
# usage: ExpGroup(char *pid, char *eid)
#        returns gid if a valid pid/eid.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub ExpGroup($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("select gid from experiments ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
#
# Return Experiment state.
#
# usage: ExpState(char *pid, char *eid)
#        returns state if a valid pid/eid.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub ExpState($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("select state from experiments ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

#
# Set Experiment state.
#
# usage: SetExpState(char *pid, char *eid, char *state)
#        returns 1 if okay.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub SetExpState($$$)
{
    my($pid, $eid, $state) = @_;

    my $query_result =
	DBQueryWarn("update experiments set state='$state' ".
		    "where eid='$eid' and pid='$pid'");

1138
    if (! $query_result) {
1139
1140
1141
1142
1143
	return 0;
    }
    return 1;
}

1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
#
# Set the swap in/out time for an experiment.
#
# usage: TBSetExpSwapTime(char *pid, char *eid)
#        returns 1 if okay.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub TBSetExpSwapTime($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("update experiments set expt_swapped=now() ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }
    return 1;
}

1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
#
# Lock Experiment.
#
# usage: TBLockExp(char *pid, char *eid)
#        returns 1 if okay.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub TBLockExp($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("update experiments set expt_locked=now() ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }
    return 1;
}

1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
#
# Test if Experiment is locked
#
# usage: TBExpLocked(char *pid, char *eid)
#        returns 1 if locked.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub TBExpLocked($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("select expt_locked from experiments ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }
    my @row = $query_result->fetchrow_array();
    if (! defined($row[0])) {
	return 0;
    }
    return 1;
}

1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
#
# UnLock Experiment.
#
# usage: TBUnLockExp(char *pid, char *eid)
#        returns 1 if okay.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub TBUnLockExp($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("update experiments set expt_locked=NULL ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
1230
1231
1232
1233
1234
1235
	$query_result->numrows == 0) {
	return 0;
    }
    return 1;
}

Leigh B. Stoller's avatar
Leigh B. Stoller committed
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
#
# Return BatchMode state.
#
# usage: TBBatchState(char *pid, char *eid)
#        returns state if a valid pid/eid.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub TBBatchState($$)
{
    my($pid, $eid) = @_;

    my $query_result =
	DBQueryWarn("select batchstate from experiments ".
		    "where eid='$eid' and pid='$pid' and batchmode=1");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }

    my @row = $query_result->fetchrow_array();
    return $row[0];
}

#
# Set BatctMode state.
#
# usage: SetBatchState(char *pid, char *eid, char *state)
#        returns 1 if okay.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub TBSetBatchState($$$)
{
    my($pid, $eid, $state) = @_;

    my $query_result =
	DBQueryWarn("update experiments set batchstate='$state',batchmode=1 ".
		    "where eid='$eid' and pid='$pid'");

    if (! $query_result ||
	$query_result->numrows == 0) {
	return 0;
    }
    return 1;
}

1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
#
# Return a list of all the nodes in an experiment.
#
# usage: ExpNodes(char *pid, char *eid)
#        returns the list if a valid pid/eid.
#        returns 0 if an invalid pid/eid or if an error.
# 
sub ExpNodes($$)
{
    my($pid, $eid) = @_;
    my(@row);
    my(@nodes);

    my $query_result =
	DBQueryWarn("select node_id from reserved where ".
		    "pid='$pid' and eid='$eid'");

    if (! $query_result or
	$query_result->numrows == 0) {
	return ();
    }
    while (@row = $query_result->fetchrow_array()) {
1304
1305
1306
1307
1308
1309
	$node = $row[0];

	#
	# Taint check. I do not understand this sillyness, but if I
	# taint check these node names, I avoid warnings throughout.
	# 
1310
	if ($node =~ /^([-\w]+)$/) {
1311
1312
1313
1314
1315
1316
1317
	    $node = $1;
	    
	    push(@nodes, $node);
	}
	else {
	    print "*** $0: WARNING: Bad node name: $node.\n";
	}
1318
1319
1320
1321
    }
    return @nodes;
}

1322
#
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1323
1324
1325
# Mark a node as down. We schedule a next reservation for it so that it
# remains in the users experiment through the termination so that there
# are no permission errors (say, from snmpit).
1326
1327
1328
1329
1330
1331
#
# usage: MarkNodeDown(char *nodeid)
#
sub MarkNodeDown($)
{
    my($node) = $_[0];
1332
1333
    my($pid, $eid);

1334
1335
    $pid = NODEDEAD_PID;
    $eid = NODEDEAD_EID;
1336
1337

    my $query_result =
1338
	DBQueryFatal("replace into next_reserve " .
1339
1340
		     "(node_id, pid, eid) " .
		     "values ('$node', '$pid', '$eid')");    
1341
1342
1343
1344
1345
1346

    if ($query_result->num_rows < 1) {
	DBWarn("WARNING: Could not mark $node down");
    }
}

1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
#
# Set the boot status for a node.
#
# usage: SetNodeBootStatus(char *status)
#
sub SetNodeBootStatus($$)
{
    my($node, $bstat) = @_;

    DBQueryFatal("update nodes set bootstatus='$bstat' ".
		 "where node_id='$node'");
}

1360
1361
1362
1363
1364
1365
#
# Check if a particular feature is supported by an OSID. 
#
# usage: OSFeatureSupported(char *osid, char *feature)
#        returns 1 if supported, 0 if not.
#
1366
sub OSFeatureSupported($$) {
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
    my($osid, $feature) = @_;

    my $query_result =
	DBQueryFatal("select osfeatures from os_info where osid='$osid'");

    # Invalid OSID?
    if ($query_result->numrows < 1) {
	return 0;
    }
    
    foreach my $osfeature (split(',', $query_result->fetchrow_array())) {
	if ($feature eq $osfeature) {
	    return 1;
	}
    }
    return 0;
}

1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
#
# Find out what osid a node will boot next time it comes up, 
# Usually (but not always) the currently running OS as well.
# May also return TB_OSID_MBKERNEL
#
sub TBBootWhat($;$) {
    # WARNING!!!
    #
    # DO NOT change this function without making corresponding changes to
    # the C version of this code in the bootinfo_mysql.c . They MUST
    # ALWAYS find exactly the same resulting OSID given the same inputs.
    # [The only exception is that here we must take into account 
    # *pxe_boot_path since that can specify an OS as well.]
    #
    # Boot priorities go like this:
    # NEXT_PXE_BOOT_PATH
    # PXE_BOOT_PATH
    # NEXT_BOOT_PATH        multiboot kernel
    # DEF_BOOT_PATH         multiboot kernel
    # NEXT_BOOT_OSID        osid from os_info
    # DEF_BOOT_OSID         osid from os_info
    # if all the above are null, error
    my $node = shift || return 0; # error if no node
    my $d = shift || 0; # debug flag
    my $cmd = "select path from os_info where osid='".TB_OSID_PXEBOOT."'";
    my $q = DBQueryFatal($cmd);
    my @r = $q->fetchrow_array();
    my $defpxepath = $r[0];
    $cmd = "select next_pxe_boot_path, pxe_boot_path, 
next_boot_path, def_boot_path, next_boot_osid, def_boot_osid 
from nodes where node_id = '$node'";
    $q = DBQueryFatal($cmd);
    if ($q->numrows() < 1) {
	warn("TBBootWhat: Ignoring invalid node '$node' (non-existent)\n");
	return 0;
    }
    @r = $q->fetchrow_array();
    $nextpxepath=$r[0];
    $pxepath=$r[1];
    $nextpath=$r[2];
    $defpath=$r[3];
    $nextosid=$r[4];
    $defosid=$r[5];
    print "TBBootWhat: $node => (".($nextpxepath?"nextpxe=$nextpxepath, ":"").
	( $pxepath ne $defpxepath ? "pxe=$pxepath, ":"") .
	    "np=$nextpath, dp=$defpath, no=$nextosid, do=$defosid)\n" if $d>1;
    # With PXE paths, look up the osid for the path. If none, use 
    # TB_OSID_MBKERNEL. If it is the default pxe path, just go on like normal.
    if (defined($nextpxepath) && $nextpxepath) {
	if ($nextpxepath ne $defpxepath) {
	    print "TBBootWhat: Using next_pxe_boot_path $nextpxepath\n" if $d;
	    my $cmd = "select osid from os_info where path='$nextpxepath'";
	    my $q = DBQueryFatal($cmd);
	    if ($q->numrows() > 0) {
		my @r = $q->fetchrow_array();
		my $osid = $r[0];
		return $osid;
	    } else {
		return TB_OSID_MBKERNEL;
	    }
	} # else go on as normal
    } else {
	if ($pxepath ne $defpxepath) {
	    print "TBBootWhat: Using pxe_boot_path $pxepath\n" if $d;
	    my $cmd = "select osid from os_info where path='$pxepath'";
	    my $q = DBQueryFatal($cmd);
	    if ($q->numrows() > 0) {
		my @r = $q->fetchrow_array();
		my $osid = $r[0];
		return $osid;
	    } else {
		return TB_OSID_MBKERNEL;
	    }
	} # else go on as normal
    }	
    if ((defined($nextpath) && $nextpath) || 
	(defined($defpath) && $defpath)) {
	# No OSID. Return a magic one.
	print "TBBootWhat: Using {def,next}_boot_path ${nextpath}$defpath\n" 
	    if $d;
	return TB_OSID_MBKERNEL;
    }
    if (defined($nextosid) && $nextosid) { 
	print "TBBootWhat: Using next_boot_osid $nextosid\n" if $d;
	return $nextosid; 
    }
    if (defined($defosid) && $defosid) { 
	print "TBBootWhat: Using def_boot_osid $defosid\n" if $d;
	return $defosid; 
    }
    warn("***Warning: node '$node': All boot info was null!\n");
    return TB_OSID_MBKERNEL;
}

1479
1480
1481
1482
1483
1484
#
# Ah, what a hack! I'm tired of seeing regexs for sharks scattered around
# the code. Anyway, this checks to see if a node is a shelf, and fills
# in the shelf/node, return 1 if it is. The shelf/node arguments are
# optional, if all you want to do is see if its a shelf type thing.
#
1485
# usage: IsShelved(char *nodeid, [\$shelf], [\$node])
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
#        returns 1 if the node is a shelf type thing. Optionally fills in info.
#        returns 0 if the node is just a normal kind of node.
#
sub IsShelved ($;$$) {
    my($nodeid, $shelf, $node) = @_;

    if ($nodeid =~ /sh(\d+)-(\d+)/) {
	if (defined($shelf)) {
	    $$shelf = $1;
	}
	if (defined($node)) {
	    $$node = $2;
	}
	return 1;
    }
    return 0;
}

1504
#
1505
# Map nodeid to its pid/eid/vname. vname is optional.
1506
#
1507
# usage: NodeidToExp(char *nodeid, \$pid, \$eid, \$vname)
1508
1509
1510
#        returns 1 if the node is reserved.
#        returns 0 if the node is not reserved.
#
1511
1512
sub NodeidToExp ($$$;$) {
    my($nodeid, $pid, $eid, $vname) = @_;
1513
1514

    my $query_result =
1515
1516
	DBQueryWarn("select pid,eid,vname from reserved ".
		    "where node_id='$nodeid'");
1517

1518
1519
    if (! $query_result ||
	! $query_result->num_rows) {
1520
1521
1522
1523
1524
1525
	return 0;
    }
    
    my @row = $query_result->fetchrow_array();
    $$pid = $row[0];
    $$eid = $row[1];
1526
1527
1528
1529
1530
1531
1532
1533
    if (defined($vname)) {
	if (defined($row[2])) {
	    $$vname = $row[2];
	}
	else {
	    $$vname = undef;
	}
    }
1534
1535
1536
    return 1;
}

1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
#
# Map a pid/eid/vname to its real nodename
#
# usage: VnameToNodeid(char *pid, char * eid, char *vname, \$nodeid)
#        returns 1 if the specified pid/eid/vname exists
#        returns 0 if it does not
#
sub VnameToNodeid ($$$$) {
    my($pid, $eid, $vname, $nodeid) = @_;

    my $query_result =
	DBQueryWarn("select node_id from reserved ".
		    "where pid='$pid' and eid='$eid' and vname='$vname'");

    if (! $query_result ||
	! $query_result->num_rows) {
	return 0;
    }
    
    my @row = $query_result->fetchrow_array();
    $$nodeid = $row[0];
    return 1;
}


Leigh B. Stoller's avatar
Leigh B. Stoller committed
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
#
# Get the default ImageID for a particular node, from the node_types table.
#
# usage: DefaultImageID(char *nodeid)
#        returns imageid if the node is valid and has a default imageid.
#        returns 0 if there are problems.
#
sub DefaultImageID ($) {
    my($nodeid) = @_;

    my $query_result =
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1573
1574
	DBQueryFatal("select imageid from nodes as n ".
		     "left join node_types as t on t.type=n.type ".
Leigh B. Stoller's avatar
Leigh B. Stoller committed
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
		     "where n.node_id='$nodeid'");

    if (! $query_result->num_rows) {
	return 0;
    }
    
    my @row = $query_result->fetchrow_array();
    return $row[0];
}

1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
#
# Convert user pid/name to internal imageid.
#
# usage: TBImageID(char *pid, char *imagename)
#        returns imageid if its valid.
#        returns 0 if not valid.
#
sub TBImageID ($$) {
    my($pid, $imagename) = @_;

    my $query_result =
	DBQueryFatal("select imageid from images ".
		     "where pid='$pid' and imagename='$imagename'");

    if (! $query_result->num_rows) {
	return 0;
    }
    
    my @row = $query_result->fetchrow_array();
    return $row[0];
}

#
# Convert user pid/name to internal osid.
#
# usage: TBOSID(char *pid, char *isname)
#        returns osid if its valid.
#        returns 0 if not valid.
#
sub TBOSID ($$) {
    my($pid, $osname) = @_;

    my $query_result =
	DBQueryFatal("select osid from os_info ".
		     "where pid='$pid' and osname='$osname'");

    if (! $query_result->num_rows) {
	return 0;
    }
    
    my @row = $query_result->fetchrow_array();
    return $row[0];
}

1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
#
# Returns the maximum number of concurrent instantiations of an image.
#
# usage: TBOSMaxConcurrent(char *osid)
#        returns >= 1 if there is a maximum number of concurrent instantiations
#        returns undef if there is no limi
#        returns 0 if not valid.
#
sub TBOSMaxConcurrent ($)
{
    my($osid) = @_;

    my $query_result =
	DBQueryFatal("select max_concurrent from os_info where osid='$osid'");

    if (! $query_result->num_rows) {
	return 0;
    }
    
    my @row = $query_result->fetchrow_array();
    return $row[0];
}

#
# Returns the number of nodes that are supposedly booting an OS. A list of
# nodes that should be excluded from this count can be given.
# 
# usage: TBOSCountInstances(char *osid; char *nodeid ...)
#        returns the number of nodes booting the OSID
#
sub TBOSCountInstances ($;@)
{
    my($osid,@exclude) = @_;

    my $nodelist = join(" or ",map("node_id='$_'",@exclude));
    if (!@exclude) {
	$nodelist = "0";
    }

    my $query_result = DBQueryFatal("select distinct node_id from partitions " .
	"where osid='$osid' and !($nodelist)");
    my $current_count = $query_result->num_rows();

    return $current_count;
}

#
# Check whether or not it's permissible, given max_concurrent restrictions, to
# load an OSID onto a number of nodes - the nodes themselves can be passed, so
# that they do no count twice (once in the count of current loads, and once in
# the count of potential loads.)
#
# usage: TBOSLoadMaxOkay(char *osid, int node_count; char *nodeid ... )
#        returns 1 if loading the given OS on the given number of nodes would
#            not go over the max_concurrent limit for the OS
#        returns 0 otherwise
#
sub TBOSLoadMaxOkay($$;@)
{
    my($osid,$node_count,@nodes) = @_;

    if (TBAdmin()) {
	return 1;
    }

    my $max_instances = TBOSMaxConcurrent($osid);
    if (!$max_instances) {
	return 1;
    }

    my $current_instances = TBOSCountInstances($osid,@nodes);

    if (($current_instances + $node_count) > $max_instances) {
	return 0;
    } else {
	return 1;
    }
}

#
#
# Check whether or not it's permissible, given max_concurrent restrictions, to
# load an image onto a number of nodes - simply checks all OSIDs on the image.
#
# usage: TBImageLoadMaxOkay(char *imageid, int node_count; char *nodeid ... )
#        returns 1 if loading the given image on the given number of nodes
#        	would not go over the max_concurrent limit for any OS im the
#        	image
#        returns 0 otherwise
#
sub TBImageLoadMaxOkay($$;@)
{
    my($imageid,$node_count,@nodes) = @_;

    
    my $query_result = DBQueryFatal("select part1_osid, part2_osid, " .
	"part3_osid, part4_osid from images where imageid='$imageid'");

    if ($query_result->num_rows() != 1) {
	#
	# XXX - Just pretend everything is OK, something else will presumably
	# have to check the imageid anyway
	#
	return 1;
    }

    foreach my $OS ($query_result->fetchrow()) {
1736
	if ($OS && (!TBOSLoadMaxOkay($OS,$node_count,@nodes))) {
1737
1738
1739
1740
1741
1742
1743
	    return 0;
	}
    }

    return 1;
}

1744
#
1745
# Map login (db uid) to a user_name and user_email.
1746
#
1747
# usage: UserDBInfo(char *dbuid, \$name, \$email)
1748
1749
1750