dhcpd_makeconf.in 14.4 KB
Newer Older
1
#!/usr/bin/perl -wT
Leigh Stoller's avatar
Leigh Stoller committed
2 3
#
# EMULAB-COPYRIGHT
4
# Copyright (c) 2000-2011 University of Utah and the Flux Group.
Leigh Stoller's avatar
Leigh Stoller committed
5 6
# All rights reserved.
#
7
use English;
8
use Getopt::Std;
9
use Fcntl ':flock';
10

11 12 13 14
#
# dhcpd_makeconf - helper script to create dhcpd.conf files from the database.
# The template file should look like an ordinary dhcpd.conf file, but have
# the string %%nodetype=<type> where you want entries for a set of nodes
15
# filled out. See the template file in the dhcp directory for an example.
16
#
17 18 19 20 21
sub usage {
    print "Usage: $0 [-h] [-v] [-i] [-t <templatefile>]\n";
    print "-h	Show this message\n";
    print "-v	Use virtual names, when possible, for hostnames\n";
    print "-i 	Install new config file to standard location.\n";
22
    print "-r 	Restart DHCPD after config file regeneration (with -i only)\n";
23 24 25 26
    print "Without -i, spits out a dhcpd config file on stdout, as in:\n";
    print "  $0 > dhcpd.conf\n";
    exit(1);
}
27
my $optlist = "ihvt:r";
28 29
my $install = 0;
my $vnames  = 0;
30
my $restart = 0;
31

32
#
33
# Configure variables
34
#
35
my $TBOPS       = "@TBOPSEMAIL@";
36
my $ELABINELAB  = @ELABINELAB@;
37 38 39 40 41 42 43 44

# un-taint path
$ENV{'PATH'} = '/bin:/usr/bin:/usr/sbin:/usr/local/bin';
delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};

# Turn off line buffering on output
$| = 1;

45
use lib "@prefix@/lib";
46 47
use libdb;
use libtestbed;
48
use NodeType;
49

50 51 52 53 54 55 56 57
#
# PXE boot constants
#
my $PXEBOOTDIR	    = "/tftpboot";
my $PXELINUXPREFIX  = "$PXEBOOTDIR/pxelinux";
my $PXELINUXBOOT    = "pxelinux.0";
my $PXELINUXCONFIG  = "pxelinux.cfg";

58 59 60
my $CRTLTAG	    = TBDB_IFACEROLE_CONTROL();
my $DHCPD_CONF	    = "/usr/local/etc/dhcpd.conf";
my $DHCPD_TEMPLATE  = "/usr/local/etc/dhcpd.conf.template";
61
my %servernodes	    = ();
62 63 64
my %dhcp_subbosses  = ();
my %tftp_subbosses  = ();
my %bootinfo_subbosses  = ();
65
my %singlectlnet    = ();
66 67
my $template        = $DHCPD_TEMPLATE;
my $outfile	    = "/tmp/dhcpd_makeconf.$$";
68
my $OUT		    = *STDOUT;
69 70 71
my %subboss_dhcp_servers;

sub RestartSubbossDhcp($$);
72 73
sub SetupPXEBoot($$$$);
sub ClearPXEBoot($$);
74

75
#
76 77
# Parse command arguments. Once we return from getopts, all that should
# left are the required arguments.
78
#
79 80 81 82 83 84
%options = ();
if (! getopts($optlist, \%options)) {
    usage();
}
if (defined($options{"i"})) {
    $install = 1;
85

86 87 88 89 90
    # We don't want to run this script unless its the real version.
    if ($EUID != 0) {
	die("*** $0:\n".
	    "    Must be root! Maybe its a development version?\n");
    }
91 92 93
    if (defined($options{"r"})) {
	$restart = 1;
    }
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
}
if (defined($options{"h"})) {
    usage();
}
if (defined($options{"v"})) {
    $vnames = 1;
}
if (defined($options{"t"})) {
    $template = $options{"t"};

    #
    # Untaint argument; Allow slash.
    #
    if ($template =~ /^([-\w\.\/]+)$/) {
	$template = $1;
    }
    else {
	die("Tainted template name: $template\n");
    }
}
114

115
#
116
# If we are going to actually install this file, must serialize to
117
# avoid a trashed config file.
118
#
119
if ($install) {
120 121 122 123
    if ((my $locked = TBScriptLock("dhcpd.conf", 1)) != TBSCRIPTLOCK_OKAY()) {
	exit(0)
	    if ($locked == TBSCRIPTLOCK_IGNORE);
	fatal("Could not get the lock after a long time!\n");
124
    }
125

126 127
    #
    # Open temporary output file.
128
    #
129 130 131 132
    open(OF, ">$outfile") or
	fatal("Could not open $outfile\n");
    $OUT = *OF;
}
133

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
#
# Locate all the "alternate server" nodes (inner elab boss nodes or
# inner plab PLC nodes).  We do this now rather than in the per-nodetype
# query below because the server may not be of the same type as the nodes
# they serve!
#
my $query_result =
    DBQueryWarn("select r.node_id,i.IP,r.pid,r.eid ".
		"from reserved as r ".
                "left join interfaces as i on ".
                "     r.node_id=i.node_id ".
                "where (r.inner_elab_role='boss' or ".
		"       r.inner_elab_role='boss+router' or ".
		"       r.plab_role='plc') and ".
		"      i.role='$CRTLTAG' ");
if (! $query_result) {
    fatal("Could not dhcpd data from DB!");
}
while (my %row = $query_result->fetchhash()) {
    if (defined($row{"pid"}) && defined($row{"eid"})) {
154 155 156
	my $pid = $row{"pid"};
	my $eid = $row{"eid"};
	my $tag = "${pid}:${eid}";
157

158
	$servernodes{$tag} = $row{"IP"};
159 160 161 162 163 164 165 166 167 168 169 170 171

	#
	# Need to know if this is a single or dual control network model.
	#
	my $exp_result =
	    DBQueryFatal("select elabinelab_singlenet from experiments ".
			 "where pid='$pid' and eid='$eid'");
	if ($exp_result->num_rows) {
	    $singlectlnet{$tag} = ($exp_result->fetchrow_array())[0];
	}
	else {
	    $singlectlnet{$tag} = 0;
	}
172 173 174
    }
}

175 176 177 178 179 180 181 182 183 184 185 186 187
# Slurp in all of the subboss data to know A) if we should serve the DHCP
# lease to a given node, or if the next-server field should be something
# other than the IP for boss.
$query_result =
    DBQueryWarn("select s.node_id, s.service, s.subboss_id, i.IP ".
		"from subbosses as s left join interfaces as i on ".
		"s.subboss_id=i.node_id where i.role='$CRTLTAG'");
if (! $query_result) {
    fatal("Could not dhcpd data from DB!");
}
while (my %row = $query_result->fetchhash()) {
    my $node_id = $row{"node_id"};

188 189 190 191 192 193 194
    # We need to try restarting dhcpd on *all* subbosses, just in case
    # we've moved all dhcp nodes from one subboss to another.
    # Otherwise the old server wouldn't get restarted and both the old
    # and new servers would attempt to respond to dhcp requests.

    $subboss_dhcp_servers{$row{"subboss_id"}} = 1;

195 196 197 198 199 200 201 202 203
    if ($row{"service"} eq 'tftp') {
	    $tftp_subbosses{$node_id} = $row{"IP"};
    } elsif ($row{"service"} eq 'dhcp') {
	    $dhcp_subbosses{$node_id} = $row{"IP"};
    } elsif ($row{"service"} eq 'bootinfo') {
	    $bootinfo_subbosses{$node_id} = $row{"IP"};
    }
}

204 205
open(IF,"<$template") or
    fatal("Unable to open $template for reading");
206
while (<IF>) {
207 208 209 210 211
	if (/^(\s*)range\s*;/) {
		# Comment out a null DHCPD_DYNRANGE line.
		my $spaces = $1;
		print $OUT "${spaces}#range ... ...;\n";
	} elsif (/^(\s*)\%\%nodetype=(\w+)/) {
212 213
		my $spaces = $1;
		my $nodetype = $2;
214 215

		$query_result =
216 217
		    DBQueryWarn("select n.node_id,n.type, ".
				"       n.pxe_boot_path,n.next_pxe_boot_path,".
218 219 220
				"       i.IP,i.MAC,r.pid,r.eid,r.vname, ".
				"       r.inner_elab_role,r.inner_elab_boot, ".
				"       r.plab_role,r.plab_boot ".
221 222 223 224 225 226 227 228 229 230 231 232
				"from nodes as n ".
				"left join interfaces as i on ".
				"     n.node_id=i.node_id ".
				"left join node_types as t on n.type=t.type ".
				"left join reserved as r on ".
				"     n.node_id=r.node_id ".
				"where (n.type='$nodetype' or ".
				"       t.class='$nodetype') and ".
				"      i.role='$CRTLTAG' ".
				"order BY n.priority");
		if (! $query_result) {
		    fatal("Could not dhcpd data from DB!");
233
		}
234 235 236 237 238 239

		while (my %row = $query_result->fetchhash()) {
		    my $ip  = $row{"IP"};
		    my $mac = $row{"MAC"};
		    my $node_id;
		    my $next_server = "";
240
		    my $bootinfo_server = "";
241
		    my $hostname = "";
242
		    my $dns = "";
243
		    my $booting = "";
244
		    my $filename = "";
245 246 247 248 249 250 251 252

		    if ($vnames && defined($row{"vname"})) {
			$node_id = $row{"vname"};
		    }
		    else {
			$node_id = $row{"node_id"};
		    }

253 254 255 256 257 258
		    my $tag;
		    if (defined($row{"pid"})) {
			$tag = $row{"pid"} . ":" . $row{"eid"};
		    }

		    if (defined($tag) && defined($servernodes{$tag}) &&
259 260 261 262 263 264
			(($row{"inner_elab_boot"} == 1 &&
			  defined($row{"inner_elab_role"}) &&
			  $row{"inner_elab_role"} eq "node") ||
			 ($row{"plab_boot"} == 1 &&
			  defined($row{"plab_role"}) &&
			  $row{"plab_role"} eq "node"))) {
265

Mike Hibler's avatar
Mike Hibler committed
266 267 268 269 270 271 272 273 274 275
			#
			# XXX it is not yet completely clear what all we
			# need to do, or not do, for plab nodes.
			#
			if ($row{"plab_boot"} == 1) {
			    $hostname =
				"${spaces}\toption host-name \"$node_id\";\n";
			    $next_server = "${spaces}\tnext-server " .
				$servernodes{$tag} . ";\n";
			} else {
276 277 278 279 280 281 282 283 284 285 286
			    if ($singlectlnet{$tag}) {
				$hostname = "${spaces}\toption host-name ".
				    "\"$node_id\";\n";
				$booting  = "${spaces}\tignore booting;\n";
			    }
			    else {
				$next_server = "${spaces}\tnext-server " .
				    $servernodes{$tag} . ";\n";
				$dns = "${spaces}\toption ".
				    "domain-name-servers 1.1.1.1;\n";
			    }
287
			}
288
		    }
289 290 291 292 293
		    elsif (defined $dhcp_subbosses{$node_id}) {
			$hostname =
			    "${spaces}\toption host-name \"$node_id\";\n";
	                $booting = "${spaces}\tignore booting;\n";
		    }
294 295 296
		    else {
			$hostname =
			    "${spaces}\toption host-name \"$node_id\";\n";
297

298 299 300 301
		        if (defined $tftp_subbosses{$node_id}) {
			    $next_server = "${spaces}\tnext-server " .
			        $tftp_subbosses{$node_id} . ";\n";
		        }
302

303 304 305 306
		        if (defined $bootinfo_subbosses{$node_id}) {
			    $bootinfo_server = "${spaces}\toption PXE.emulab-bootinfo " .
			        $bootinfo_subbosses{$node_id} . ";\n";
		        }
307

308
		    }
309

310 311
		    #
		    # Handle alternate boot program filename if it exists.
312 313
		    # Use mutable nodes.next_pxe_boot_path or
		    # nodes.pxe_boot_path if one is defined.
314 315 316 317
		    # Otherwise use the node_types.pxe_boot_path if it is
		    # defined.  Otherwise don't set anything (use the global
		    # default).
		    #
318 319 320 321 322
		    my $pxeboot = $row{"next_pxe_boot_path"};
		    if (!$pxeboot) {
			$pxeboot = $row{"pxe_boot_path"};
		    }
		    $filename = SetupPXEBoot($node_id, $mac, 1, $pxeboot);
323 324 325
		    if (!$filename) {
			# Get the type info for this type.
			my $nodetype = NodeType->Lookup($row{"type"});
326

327 328 329 330 331
			# Get the type specific version of pxe_boot_path
			my $nt_pxe_boot_path;
			$nodetype->pxe_boot_path(\$nt_pxe_boot_path) == 0
                            or fatal("Could not get pxe_boot_path for ".
				     "$node_id");
332

333 334 335 336 337
			$filename = SetupPXEBoot($node_id, $mac, 0,
						 $nt_pxe_boot_path);
		    }
		    if ($filename) {
			$filename = "${spaces}\tfilename \"$filename\";\n";
338
		    }
339

340 341 342 343
		    # Need to make MAC look right..
		    $mac =~ s/(..)\B/$1:/g;

		    print $OUT "${spaces}host $ip {\n";
344 345
		    print $OUT $filename
			if (defined($filename));
346
		    print $OUT $next_server;
347
		    print $OUT $bootinfo_server;
348
		    print $OUT $dns;
349
		    print $OUT $booting;
350 351 352 353
		    print $OUT "${spaces}\thardware ethernet $mac;\n";
		    print $OUT $hostname;
		    print $OUT "${spaces}\tfixed-address $ip;\n";
		    print $OUT "${spaces}}\n\n";
354 355
		}
	} else {
356 357
	    # It's a regular line
	    print $OUT $_;
358 359
	}
}
360
close(IF);
361 362 363 364 365 366 367 368 369 370 371

if ($install) {
    close(OF) or
	fatal("Could not close $outfile");

    if (-e $DHCPD_CONF) {
	system("cp -fp $DHCPD_CONF ${DHCPD_CONF}.old") == 0 or
	    fatal("Could not backup copy of ${DHCPD_CONF}");
    }
    system("mv -f $outfile $DHCPD_CONF") == 0 or
	    fatal("Could not install new ${DHCPD_CONF}");
372 373 374 375 376 377 378 379 380 381 382 383 384 385

    if ($restart) {
	$dpid = `cat /var/run/dhcpd.pid`;
	chomp($dpid);
        # untaint
	if ($dpid =~ /^([\d]+)$/) {
	    $dpid = $1;
	}
	else {
	    fatal("Bad pid for DHCPD: $dpid");
	}
	if (kill('TERM', $dpid) == 0) {
	    fatal("Could not kill(TERM) process $dpid (dhcpd): $!");
	}
386

387 388
        my $old_uid = $UID;
        $UID = $EUID;
389 390 391
        for my $subboss (keys %subboss_dhcp_servers) {
            RestartSubbossDhcp($subboss, $restart);
        }
392
        $UID = $old_uid;
393 394
    }

395
    TBScriptUnlock();
396
}
397
exit(0);
398

399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 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
#
# Special handling of pxe_boot_path argument.
# Any specified pxeboot path must start with PXEBOOTDIR (/tftpboot).
# If path starts with $PXELINUXPREFIX (/tftpboot/pxelinux/), then
# the remainder of the path identifies the pxelinux configuration file
# from $PXELINUXCONFIG (/tftpboot/pxelinux.cfg) to use. This config file
# for the node (MAC address) will be symlinked to this config file.
#
# Returns the string to be used for the "filename" option in dhcpd.conf.
#
sub SetupPXEBoot($$$$)
{
    my ($node, $mac, $clear, $str) = @_;

    # get rid of any old pxelinux magic
    if ($clear) {
	ClearPXEBoot($node, $mac);
    }

    return undef
	if (!defined($str));

    # don't allow if outside TFTP directory
    if ($str !~ /^$PXEBOOTDIR\// || $str =~ /\.\./) {
	print STDERR "$node: ignoring bogus pxe_boot_path '$str'\n";
	return undef;
    }

    # if it starts with the magic pxelinux prefix, setup a config file
    if ($str =~ /^$PXELINUXPREFIX\/(.*)$/) {
	my $cfile = $1;
	my $cpath = "$PXEBOOTDIR/$PXELINUXCONFIG";

	if (! -r "$cpath/$cfile") {
	    print STDERR "$node: ignoring invalid pxelinux config '$cfile'\n";
	    return undef;
	}

	#
	# XXX ugh. In an inner elab with an inner control network,
	# pxelinux will use the MAC address of the real control net interface
	# to construct its config file name. So we need to look that up.
	#
	if ($ELABINELAB) {
	    my $qr = DBQueryWarn("select MAC from interfaces where ".
				 " node_id='$node' and role='outer_ctrl'");
	    if ($qr && $qr->numrows) {
		my %row = $qr->fetchhash();
		if (defined($row{"MAC"})) {
		    $mac = $row{"MAC"};
		}
	    }
	}

	if ($mac =~ /^(..)(..)(..)(..)(..)(..)$/) {
	    $macname = "01-$1-$2-$3-$4-$5-$6";
	} else {
	    print STDERR "$node: ignoring unparsable MAC address '$mac'\n";
	    return undef;
	}

	if ($install) {
	    if (-e "$cpath/$macname") {
		if (!unlink("$cpath/$macname")) {
		    print STDERR "$node: could not remove old pxelinux config\n";
		    return undef;
		}
	    }
	    if (!symlink($cfile, "$cpath/$macname")) {
		print STDERR "$node: could not symlink to pxelinux config '$cfile'\n";
		return undef;
	    }
	} else {
	    print STDERR "WARNING: not changing pxelinux config for $node\n";
	}

	# return the pxelinux binary
	$str = "$PXEBOOTDIR/$PXELINUXBOOT";
    }

    return $str;
}

#
# Make sure there is no pxelinux config for the given node
#
sub ClearPXEBoot($$)
{
    my ($node, $mac) = @_;
    my $cpath = "$PXEBOOTDIR/$PXELINUXCONFIG";

    #
    # XXX ugh. In an inner elab with an inner control network,
    # pxelinux will use the MAC address of the real control net interface
    # to construct its config file name. So we need to look that up.
    #
    if ($ELABINELAB) {
	my $qr = DBQueryWarn("select MAC from interfaces where ".
			     " node_id='$node' and role='outer_ctrl'");
	if ($qr && $qr->numrows) {
	    my %row = $qr->fetchhash();
	    if (defined($row{"MAC"})) {
		$mac = $row{"MAC"};
	    }
	}
    }

    if ($mac =~ /^(..)(..)(..)(..)(..)(..)$/) {
	$macname = "01-$1-$2-$3-$4-$5-$6";
	if ($install) {
	    if (-e "$cpath/$macname" && !unlink("$cpath/$macname")) {
		print STDERR "$node: could not remove old pxelinux config\n";
	    }
	} else {
	    print STDERR "WARNING: not changing pxelinux config for $node\n";
	}
    }
}

518 519 520 521 522
#
# Die.
#
sub fatal {
    my $msg = $_[0];
523

524 525
    TBScriptUnlock()
	if ($install);
526

527 528
    die("*** $0:\n".
	"    $msg\n");
529
}
530

531 532 533
sub RestartSubbossDhcp($$)
{
        my ($subboss, $restart) = @_;
534
        
535
        my $cmd = "ssh $subboss @prefix@/sbin/subboss_dhcpd_makeconf";
536 537 538 539 540 541 542 543

        $cmd .= " -r" if ($restart);

        print "Restarting dhcpd on subboss $subboss\n";
        if (system($cmd)) {
	    print STDERR "Failed to restart dhcpd on $subboss\n";
	}
}