# IBM(c) 2007 EPL license http://www.eclipse.org/legal/epl-v10.html package xCAT_plugin::hosts; use strict; use warnings; use xCAT::Table; use xCAT::TableUtils; use xCAT::Utils; use xCAT::NetworkUtils; require xCAT::MsgUtils; use Data::Dumper; use File::Copy; use Getopt::Long; use Fcntl ':flock'; my @hosts; #Hold /etc/hosts data to be written back my $LONGNAME; my $OTHERNAMESFIRST; my $ADDNAMES; my $MACTOLINKLOCAL; ############# TODO - add return code checking !!!!! sub handled_commands { return {makehosts => "hosts",}; } sub delnode { my $node = shift; my $ip = shift; unless ($node and $ip) { return; } #bail if requested to do something that could zap /etc/hosts badly my $othernames = shift; my $domain = shift; my $idx = 0; while ($idx <= $#hosts) { if (($ip and $hosts[$idx] =~ /^${ip}\s/) or $hosts[$idx] =~ /^\d+\.\d+\.\d+\.\d+\s+${node}[\s\.r]/) { $hosts[$idx] = ""; } $idx++; } } sub addnode { my $callback = shift; my $node = shift; my $ip = shift; unless ($node and $ip) { return; } #bail if requested to do something that could zap /etc/hosts badly my $othernames = shift; my $domain = shift; my $nics = shift; my $idx = 0; my $foundone = 0; # if this ip was already added then just update the entry while ($idx <= $#hosts) { if ( $hosts[$idx] =~ /^${ip}\s/ or $hosts[$idx] =~ /^\d+\.\d+\.\d+\.\d+\s+${node}[\s\.r]/) { if ($foundone) { $hosts[$idx] = ""; } else { # we found a matching entry in the hosts list if ($nics) { # we're processing the nics table and we found an # existing entry for this ip so just add this # ode name as an alias for the existing entry my ($hip, $hnode, $hdom, $hother)= split(/ /, $hosts[$idx]); # at this point "othernames", if any is just a space # elimited list - so just add the node name to the list $othernames .= " $node"; $hosts[$idx] = build_line($callback, $ip, $hnode, $domain, $othernames); } else { # otherwise just try to completely update the existing # entry $hosts[$idx] = build_line($callback, $ip, $node, $domain, $othernames); } } $foundone = 1; } $idx++; } if ($foundone) { return; } my $line = build_line($callback, $ip, $node, $domain, $othernames); if ($line) { push @hosts, $line; } } sub build_line { my $callback = shift; my $ip = shift; my $node = shift; my $domain = shift; my $othernames = shift; my @o_names = (); my @n_names = (); if (defined $othernames) { # Trim spaces from the beginning and end from $othernames $othernames =~ s/^\s+|\s+$//g; # the "hostnames" attribute can be a list delimited by # either a comma or a space @o_names = split(/,| /, $othernames); } my $longname; foreach (@o_names) { if (($_ eq $node) || ($domain && ($_ eq "$node.$domain"))) { $longname = "$node.$domain"; $_ = ""; } elsif ($_ =~ /\./) { if (!$longname) { $longname = $_; $_ = ""; } } elsif ($ADDNAMES) { unshift(@n_names, "$_.$domain"); } } unshift(@o_names, @n_names); my $shortname=$node; if ($node =~ m/\.$domain$/i) { $longname = $node; ($shortname = $node) =~ s/\.$domain$//; } elsif ($domain && !$longname) { $shortname = $node; $longname = "$node.$domain"; } # if shortname contains a dot then we have a bad syntax for name if ($shortname =~ /\./) { my $rsp; push @{$rsp->{data}}, "Invalid short node name \'$shortname\'. The short node name may not contain a dot. The short node name is considered to be anything preceeding the network domain name in the fully qualified node name \'$longname\'.\n"; xCAT::MsgUtils->message("E", $rsp, $callback); return undef; } $othernames = join(' ', @o_names); if ($LONGNAME) { return "$ip $longname $shortname $othernames\n"; } elsif ($OTHERNAMESFIRST) { return "$ip $othernames $longname $shortname\n"; } else { return "$ip $shortname $longname $othernames\n"; } } sub addotherinterfaces { my $callback = shift; my $node = shift; my $otherinterfaces = shift; my $domain = shift; my @itf_pairs = split(/,/, $otherinterfaces); foreach (@itf_pairs) { my ($itf, $ip); if ($_ =~ /!/) { ($itf, $ip) = split(/!/, $_); } else { ($itf, $ip) = split(/:/, $_); } if ($ip && xCAT::NetworkUtils->isIpaddr($ip)) { if ($itf =~ /^-/) { $itf = $node . $itf; } addnode $callback, $itf, $ip, '', $domain; } } } sub delotherinterfaces { my $node = shift; my $otherinterfaces = shift; my $domain = shift; my @itf_pairs = split(/,/, $otherinterfaces); foreach (@itf_pairs) { my ($itf, $ip); if ($_ =~ /!/) { ($itf, $ip) = split(/!/, $_); } else { ($itf, $ip) = split(/:/, $_); } if ($ip && xCAT::NetworkUtils->isIpaddr($ip)) { if ($itf =~ /^-/) { $itf = $node . $itf; } delnode $itf, $ip, '', $domain; } } } ##!!!!!!!!!!!!!!!!!!! # NOTE FOR CHANGING # # This subroutine is called in ddns.pm, please take care the calling in ddns.pm # for your changes, especially the change upon the subroutine interface ##!!!!!!!!!!!!!!!!!!! sub add_hosts_content { my %args = @_; my $nodelist = $args{nodelist}; my $callback = $args{callback}; my $DELNODE = $args{delnode}; my $domain = $args{domain}; my $hoststab = xCAT::Table->new('hosts',-create=>0); my $hostscache; if ($hoststab) { $hostscache = $hoststab->getNodesAttribs($nodelist, [qw(ip node hostnames otherinterfaces)]); } foreach (@{$nodelist}) { my $ref = $hostscache->{$_}->[0]; my $nodename = $_; my $ip = $ref->{ip}; if (not $ip) { $ip = xCAT::NetworkUtils->getipaddr($nodename); #attempt lookup } my $netn; ($domain, $netn) = &getIPdomain($ip, $callback); if (!$domain) { if ($::sitedomain) { $domain=$::sitedomain; } elsif ($::XCATSITEVALS{domain}) { $domain=$::XCATSITEVALS{domain}; } else { my $rsp; push @{$rsp->{data}}, "No domain can be determined for node \'$nodename\'. The domain of the xCAT node must be provided in an xCAT network definition or the xCAT site definition.\n"; xCAT::MsgUtils->message("W", $rsp, $callback); next; } } if ($DELNODE) { delnode $nodename, $ip, $ref->{hostnames}, $domain; if (defined($ref->{otherinterfaces})) { delotherinterfaces $nodename, $ref->{otherinterfaces}, $domain; } } else { if (xCAT::NetworkUtils->isIpaddr($ip)) { addnode $callback, $nodename, $ip, $ref->{hostnames}, $domain; } else { my $rsp; if (!$ip) { push @{$rsp->{data}}, "Ignoring node \'$nodename\', it can not be resolved."; } else { push @{$rsp->{data}}, "Ignoring node \'$nodename\', its ip address \'$ip\' is not valid."; } xCAT::MsgUtils->message("W", $rsp, $callback); } if (defined($ref->{otherinterfaces})) { addotherinterfaces $callback, $nodename, $ref->{otherinterfaces}, $domain; } } } #end foreach if ($args{hostsref}) { @{$args{hostsref}} = @hosts; } } sub process_request { Getopt::Long::Configure("bundling"); $Getopt::Long::ignorecase = 0; Getopt::Long::Configure("no_pass_through"); my $req = shift; my $callback = shift; my $dr = shift; my %extraargs = @_; my $HELP; my $VERSION; my $REMOVE; my $DELNODE; my $usagemsg = "Usage: makehosts [-d] [-n] [-l] [-a] [-o] [-m]\n makehosts -h\n makehosts -v"; # parse the options if ($req && $req->{arg}) { @ARGV = @{$req->{arg}}; } else { @ARGV = (); } # print "argv=@ARGV\n"; if ( !GetOptions( 'h|help' => \$HELP, 'n' => \$REMOVE, 'd' => \$DELNODE, 'o|othernamesfirst' => \$OTHERNAMESFIRST, 'a|adddomaintohostnames' => \$ADDNAMES, 'm|mactolinklocal' => \$MACTOLINKLOCAL, 'l|longnamefirst' => \$LONGNAME, 'v|version' => \$VERSION, ) ) { if ($callback) { my $rsp = {}; $rsp->{data}->[0] = $usagemsg; xCAT::MsgUtils->message("I", $rsp, $callback); } else { xCAT::MsgUtils->message("I", $usagemsg . "\n"); } return; } # display the usage if -h if ($HELP) { if ($callback) { my $rsp = {}; $rsp->{data}->[0] = $usagemsg; xCAT::MsgUtils->message("I", $rsp, $callback); } else { xCAT::MsgUtils->message("I", $usagemsg . "\n"); } return; } if ($VERSION) { my $version = xCAT::Utils->Version(); if ($callback) { my $rsp = {}; $rsp->{data}->[0] = $version; xCAT::MsgUtils->message("I", $rsp, $callback); } else { xCAT::MsgUtils->message("I", $version . "\n"); } return; } # get site domain for backward compatibility my $sitetab = xCAT::Table->new('site'); if ($sitetab) { my $dom = $sitetab->getAttribs({key=>'domain'},'value'); if ($dom and $dom->{value}) { $::sitedomain=$dom->{value}; } } my $hoststab = xCAT::Table->new('hosts'); my $domain; my $lockh; @hosts = (); if ($REMOVE) { if (-e "/etc/hosts") { my $bakname = "/etc/hosts.xcatbak"; rename("/etc/hosts", $bakname); # add the localhost entry if trying to create the /etc/hosts from scratch if ($^O =~ /^aix/i) { push @hosts, "127.0.0.1 loopback localhost\n"; } else { push @hosts, "127.0.0.1 localhost\n"; } } } else { if (-e "/etc/hosts") { my $bakname = "/etc/hosts.xcatbak"; copy("/etc/hosts", $bakname); } # the contents of the /etc/hosts file is saved in the @hosts array # the @hosts elements are updated and used to re-create the # /etc/hosts file at the end by the writeout subroutine. open($lockh, ">", "/tmp/xcat/hostsfile.lock"); flock($lockh, LOCK_EX); my $rconf; open($rconf, "/etc/hosts"); # Read file into memory if ($rconf) { while (<$rconf>) { push @hosts, $_; } close($rconf); } } if ($req->{node}) { if ($MACTOLINKLOCAL) { my $mactab = xCAT::Table->new("mac"); my $machash = $mactab->getNodesAttribs($req->{node}, ['mac']); foreach my $node (keys %{$machash}) { my $mac = $machash->{$node}->[0]->{mac}; if (!$mac) { next; } my $linklocal = xCAT::NetworkUtils->linklocaladdr($mac); my $netn; ($domain, $netn) = &getIPdomain($linklocal, $callback); if (!$domain) { if ($::sitedomain) { $domain=$::sitedomain; } elsif ($::XCATSITEVALS{domain}) { $domain=$::XCATSITEVALS{domain}; } else { my $rsp; push @{$rsp->{data}}, "No domain can be determined for node \'$node\'. The domain of the xCAT node must be provided in an xCAT network definition or the xCAT site definition.\n"; xCAT::MsgUtils->message("W", $rsp, $callback); next; } } if ($DELNODE) { delnode $node, $linklocal, $node, $domain; } else { addnode $callback, $node, $linklocal, $node, $domain; } } } else { add_hosts_content(nodelist=>$req->{node},callback=>$callback,delnode=>$DELNODE,domain=>$domain); } # end else # do the other node nics - if any &donics(nodes=>$req->{node}, callback=>$callback, delnode=>$DELNODE); } else { if ($DELNODE) { return; } my @hostents = $hoststab->getAllNodeAttribs( ['ip', 'node', 'hostnames', 'otherinterfaces']); my @allnodes; foreach (@hostents) { push @allnodes, $_->{node}; my $netn; ($domain, $netn) = &getIPdomain($_->{ip}); if (!$domain) { $domain=$::sitedomain; } if (!$domain) { $domain=$::XCATSITEVALS{domain}; } if (xCAT::NetworkUtils->isIpaddr($_->{ip})) { addnode $callback, $_->{node}, $_->{ip}, $_->{hostnames}, $domain; } else { my $rsp; push @{$rsp->{data}}, "Invalid IP Addr \'$_->{ip}\' for node \'$_->{node}\'."; xCAT::MsgUtils->message("E", $rsp, $callback); } if (defined($_->{otherinterfaces})) { addotherinterfaces $callback, $_->{node}, $_->{otherinterfaces}, $domain; } } # also do nics table &donics(nodes=>\@allnodes, callback=>$callback, delnode=>$DELNODE); } writeout(); if ($lockh) { flock($lockh, LOCK_UN); } } sub writeout { my $targ; open($targ, '>', "/etc/hosts"); foreach (@hosts) { print $targ $_; } close($targ); } #------------------------------------------------------------------------------- =head3 donics Add the additional network interfaces for a list of nodes as indicated in the nics table Arguments: node name Returns: 0 - ok 1 - error Globals: Example: my $rc = &donics(nodes=>\@allnodes, callback=>$callback, delnode=>$DELNODE); Comments: none =cut #------------------------------------------------------------------------------- ##!!!!!!!!!!!!!!!!!!! # NOTE FOR CHANGING # # This subroutine is called in ddns.pm, please take care the calling in ddns.pm # for your changes, especially the change upon the subroutine interface ##!!!!!!!!!!!!!!!!!!! sub donics { my %args = @_; my $nodes = $args{nodes}; my $callback = $args{callback}; my $delnode = $args{delnode}; my @nodelist = @{$nodes}; my $nicstab = xCAT::Table->new('nics'); my $nettab = xCAT::Table->new('networks'); foreach my $node (@nodelist) { my $nich; my %nicindex; # get the nic info my $et = $nicstab->getNodeAttribs( $node, [ 'nicips', 'nichostnamesuffixes', 'nichostnameprefixes', 'nicnetworks', 'nicaliases' ] ); # only require IP for nic if ( !($et->{nicips}) ) { next; } # gather nics info # delimiter could be ":" or "!" # new $et->{nicips} looks like # "eth0!11.10.1.1,eth1!60.0.0.5|60.0.0.250..." my @nicandiplist = split(',', $et->{'nicips'}); foreach (@nicandiplist) { my ($nicname, $nicip); # if it contains a "!" then split on "!" if ($_ =~ /!/) { ($nicname, $nicip) = split('!', $_); } else { ($nicname, $nicip) = split(':', $_); } $nicindex{$nicname}=0; if (!$nicip) { next; } if ( $nicip =~ /\|/) { my @ips = split( /\|/, $nicip); foreach my $ip (@ips) { $nich->{$nicname}->{nicip}->[$nicindex{$nicname}] = $ip; $nicindex{$nicname}++; } } else { $nich->{$nicname}->{nicip}->[$nicindex{$nicname}] = $nicip; $nicindex{$nicname}++; } } my @nicandsufx = split(',', $et->{'nichostnamesuffixes'}); my @nicandprfx = split(',', $et->{'nichostnameprefixes'}); foreach (@nicandsufx) { my ($nicname, $nicsufx); if ($_ =~ /!/) { ($nicname, $nicsufx) = split('!', $_); } else { ($nicname, $nicsufx) = split(':', $_); } if ( $nicsufx =~ /\|/) { my @sufs = split( /\|/, $nicsufx); my $index=0; foreach my $suf (@sufs) { $nich->{$nicname}->{nicsufx}->[$index] = $suf; $index++; } } else { $nich->{$nicname}->{nicsufx}->[0] = $nicsufx; } } foreach (@nicandprfx) { my ($nicname, $nicprfx); if ($_ =~ /!/) { ($nicname, $nicprfx) = split('!', $_); } else { ($nicname, $nicprfx) = split(':', $_); } if ( defined($nicprfx) && $nicprfx =~ /\|/) { my @prfs = split( /\|/, $nicprfx); my $index=0; foreach my $prf (@prfs) { $nich->{$nicname}->{nicprfx}->[$index] = $prf; $index++; } } else { $nich->{$nicname}->{nicprfx}->[0] = $nicprfx; } } # see if we need to fill in a default suffix # nich has all the valid nics - ie. that have IPs provided! foreach my $nic (keys %{$nich}) { unless (defined ($nicindex{$nic})) { $nicindex{$nic} = 0; } for (my $i = 0; $i < $nicindex{$nic}; $i++ ){ if (!$nich->{$nic}->{nicsufx}->[$i] && !$nich->{$nic}->{nicprfx}->[$i]) { # then we have no suffix at all for this # so set a default $nich->{$nic}->{nicsufx}->[$i] = "-$nic"; } } } my @nicandnetwrk = split(',', $et->{'nicnetworks'}); foreach (@nicandnetwrk) { my ($nicname, $netwrk); if ($_ =~ /!/) { ($nicname, $netwrk) = split('!', $_); } else { ($nicname, $netwrk) = split(':', $_); } if (!$netwrk) { next; } if ( $netwrk =~ /\|/) { my @nets = split( /\|/, $netwrk); my $index=0; foreach my $net (@nets) { $nich->{$nicname}->{netwrk}->[$index] = $net; $index++; } } else { $nich->{$nicname}->{netwrk}->[0] = $netwrk; } } my @nicandnicalias; if (defined($et->{'nicaliases'})) { @nicandnicalias = split(',', $et->{'nicaliases'}); } foreach (@nicandnicalias) { my ($nicname, $aliases); if ($_ =~ /!/) { ($nicname, $aliases) = split('!', $_); } else { ($nicname, $aliases) = split(':', $_); } if (!$aliases) { next; } if ( $aliases =~ /\|/) { my @names = split( /\|/, $aliases); my $index=0; foreach my $alias (@names) { $nich->{$nicname}->{nicaliases}->[$index] = $alias; $index++; } } else { $nich->{$nicname}->{nicaliases}->[0] = $aliases; } } # end gather nics info # add or delete nic entries in the hosts file foreach my $nic (keys %{$nich}) { # make sure we have the short hostname my $shorthost; ($shorthost = $node) =~ s/\..*$//; for (my $i = 0; $i < $nicindex{$nic}; $i++ ){ my $nicip = ""; my $nicsuffix = ""; my $nicprefix = ""; my $nicnetworks = ""; my $nicaliases = ""; $nicip = $nich->{$nic}->{nicip}->[$i] if (defined ($nich->{$nic}->{nicip}->[$i])); $nicsuffix = $nich->{$nic}->{nicsufx}->[$i] if (defined($nich->{$nic}->{nicsufx}->[$i])); $nicprefix = $nich->{$nic}->{nicprfx}->[$i] if (defined($nich->{$nic}->{nicprfx}->[$i])); $nicnetworks = $nich->{$nic}->{netwrk}->[$i] if (defined($nich->{$nic}->{netwrk}->[$i])); $nicaliases = $nich->{$nic}->{nicaliases}->[$i] if (defined($nich->{$nic}->{nicaliases}->[$i])); if (!$nicip) { next; } # construct hostname for nic my $nichostname = "$nicprefix$shorthost$nicsuffix"; # get domain from network def provided by nic attr my $nt = $nettab->getAttribs({ netname => "$nicnetworks"}, 'domain'); # look up the domain as a check or if it's not provided my ($ndomain, $netn) = &getIPdomain($nicip, $callback); if ( $nt->{domain} && $ndomain ) { # if they don't match we may have a problem. if($nicnetworks ne $netn) { my $rsp; push @{$rsp->{data}}, "The xCAT network name listed for \'$nichostname\' is \'$nicnetworks\' however the nic IP address \'$nicip\' seems to be in the \'$netn\' network.\nIf there is an error then makes corrections to the database definitions and re-run this command.\n"; xCAT::MsgUtils->message("W", $rsp, $callback); } } # choose a domain my $nicdomain; if ( $ndomain ) { # use the one based on the ip address $nicdomain=$ndomain; } elsif ( $nt->{domain} ) { # then try the one provided in the nics entry $nicdomain=$nt->{domain}; } elsif ( $::sitedomain) { # try the site domain for backward compatibility $nicdomain=$::sitedomain; } elsif ($::XCATSITEVALS{domain}) { $nicdomain=$::XCATSITEVALS{domain}; } else { my $rsp; push @{$rsp->{data}}, "No domain can be determined for the NIC IP value of \'$nicip\'. The network domains must be provided in an xCAT network definition or the xCAT site definition.\n"; xCAT::MsgUtils->message("W", $rsp, $callback); next; } if ($delnode) { delnode $nichostname, $nicip, '', $nicdomain; } else { addnode $callback, $nichostname, $nicip, $nicaliases, $nicdomain, 1; } } # end for each index } # end for each nic } # end for each node if ($args{hostsref}) { @{$args{hostsref}} = @hosts; } $nettab->close; $nicstab->close; return 0; } #------------------------------------------------------------------------------- =head3 getIPdomain Find the xCAT network definition match the IP and then return the domain value from that network def. Arguments: node IP callback Returns: domain and netname - ok undef - error Globals: Example: my $rc = &getIPdomain($nodeIP, $callback); Comments: none =cut #------------------------------------------------------------------------------- sub getIPdomain { my $nodeIP = shift; my $callback = shift; # get the network defs my $nettab = xCAT::Table->new('networks'); my @nets = $nettab->getAllAttribs('netname', 'net', 'mask', 'domain'); # foreach network def foreach my $enet (@nets) { my $NM = $enet->{'mask'}; my $net = $enet->{'net'}; if (xCAT::NetworkUtils->ishostinsubnet($nodeIP, $NM, $net)) { return ($enet->{'domain'}, $enet->{'netname'}); last; } } # could not find the network domain for this IP address return undef; } 1;