First Add
This commit is contained in:
root
+471
@@ -0,0 +1,471 @@
|
||||
#############################################################################
|
||||
# $Id: Genders.pm.in,v 1.9 2010-02-02 00:04:34 chu11 Exp $
|
||||
#############################################################################
|
||||
# Copyright (C) 2007-2019 Lawrence Livermore National Security, LLC.
|
||||
# Copyright (C) 2001-2007 The Regents of the University of California.
|
||||
# Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
|
||||
# Written by Jim Garlick <garlick@llnl.gov> and Albert Chu <chu11@llnl.gov>.
|
||||
# UCRL-CODE-2003-004.
|
||||
#
|
||||
# This file is part of Genders, a cluster configuration database.
|
||||
# For details, see <http://www.llnl.gov/linux/genders/>.
|
||||
#
|
||||
# Genders is free software; you can redistribute it and/or modify it under
|
||||
# the terms of the GNU General Public License as published by the Free
|
||||
# Software Foundation; either version 2 of the License, or (at your option)
|
||||
# any later version.
|
||||
#
|
||||
# Genders is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
# details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License along
|
||||
# with Genders. If not, see <http://www.gnu.org/licenses/>.
|
||||
#############################################################################
|
||||
|
||||
package Genders;
|
||||
|
||||
use strict;
|
||||
use Libgenders;
|
||||
|
||||
our $VERSION = "0.03";
|
||||
|
||||
require Exporter;
|
||||
our @ISA = qw(Exporter);
|
||||
our @EXPORT_OK = qw(&_errormsg $GENDERS_DEFAULT_FILE $debugkey $handlekey);
|
||||
our %EXPORT_TAGS = ( 'all' => [ qw(&_errormsg
|
||||
$GENDERS_DEFAULT_FILE
|
||||
$debugkey
|
||||
$handlekey) ] );
|
||||
|
||||
our $GENDERS_DEFAULT_FILE = Libgenders->GENDERS_DEFAULT_FILE;
|
||||
our $debugkey = "_DEBUG";
|
||||
our $handlekey = "_HANDLE";
|
||||
|
||||
sub _errormsg {
|
||||
my $self = shift;
|
||||
my $msg = shift;
|
||||
my $str;
|
||||
|
||||
if ($self->{$debugkey}) {
|
||||
$str = $self->{$handlekey}->genders_errormsg();
|
||||
print STDERR "Error: $msg, $str\n";
|
||||
}
|
||||
}
|
||||
|
||||
sub new {
|
||||
my $proto = shift;
|
||||
my $class = ref($proto) || $proto;
|
||||
my $filename = shift;
|
||||
my $self = {};
|
||||
my $handle;
|
||||
my $rv;
|
||||
|
||||
$self->{$debugkey} = 0;
|
||||
|
||||
$handle = Libgenders->genders_handle_create();
|
||||
if (!defined($handle)) {
|
||||
_errormsg($self, "genders_handle_create()");
|
||||
return undef;
|
||||
}
|
||||
|
||||
$self->{$handlekey} = $handle;
|
||||
|
||||
$rv = $self->{$handlekey}->genders_load_data($filename);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_load_data()");
|
||||
return undef;
|
||||
}
|
||||
|
||||
bless ($self, $class);
|
||||
return $self;
|
||||
}
|
||||
|
||||
sub debug {
|
||||
my $self = shift;
|
||||
my $num = shift;
|
||||
|
||||
if (ref($self)) {
|
||||
if (defined $num) {
|
||||
$self->{$debugkey} = $num;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
sub getnodename {
|
||||
my $self = shift;
|
||||
my $node;
|
||||
|
||||
if (ref($self)) {
|
||||
$node = $self->{$handlekey}->genders_getnodename();
|
||||
if (!defined($node)) {
|
||||
_errormsg($self, "genders_getnodename()");
|
||||
return "";
|
||||
}
|
||||
return $node;
|
||||
}
|
||||
else {
|
||||
return "";
|
||||
}
|
||||
}
|
||||
|
||||
sub getnodes {
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
my $val = shift;
|
||||
my $nodes;
|
||||
|
||||
if (ref($self)) {
|
||||
$nodes = $self->{$handlekey}->genders_getnodes($attr, $val);
|
||||
if (!defined($nodes)) {
|
||||
_errormsg($self, "genders_getnodes()");
|
||||
return ();
|
||||
}
|
||||
return @$nodes;
|
||||
}
|
||||
else {
|
||||
return ();
|
||||
}
|
||||
}
|
||||
|
||||
sub getattr {
|
||||
my $self = shift;
|
||||
my $node = shift;
|
||||
my $attrsvals;
|
||||
my $attrs;
|
||||
|
||||
if (ref($self)) {
|
||||
$attrsvals = $self->{$handlekey}->genders_getattr($node);
|
||||
if (!defined($attrsvals)) {
|
||||
_errormsg($self, "genders_getattr()");
|
||||
return ();
|
||||
}
|
||||
($attrs) = @$attrsvals;
|
||||
return @$attrs;
|
||||
}
|
||||
else {
|
||||
return ();
|
||||
}
|
||||
}
|
||||
|
||||
sub getattrval {
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
my $node = shift;
|
||||
my $val;
|
||||
|
||||
if (ref($self)) {
|
||||
$val = $self->{$handlekey}->genders_getattrval($attr, $node);
|
||||
if (!defined($val)) {
|
||||
_errormsg($self, "genders_getattrval()");
|
||||
return "";
|
||||
}
|
||||
return $val;
|
||||
}
|
||||
else {
|
||||
return "";
|
||||
}
|
||||
}
|
||||
|
||||
sub getattr_all {
|
||||
my $self = shift;
|
||||
my $attrs;
|
||||
|
||||
if (ref($self)) {
|
||||
$attrs = $self->{$handlekey}->genders_getattr_all();
|
||||
if (!defined($attrs)) {
|
||||
_errormsg($self, "genders_getattr_all()");
|
||||
return ();
|
||||
}
|
||||
return @$attrs;
|
||||
}
|
||||
else {
|
||||
return ();
|
||||
}
|
||||
}
|
||||
|
||||
sub testattr {
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
my $node = shift;
|
||||
my $rv;
|
||||
|
||||
if (ref($self)) {
|
||||
$rv = $self->{$handlekey}->genders_testattr($attr, $node);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_testattr()");
|
||||
return 0;
|
||||
}
|
||||
return $rv;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
sub testattrval {
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
my $val = shift;
|
||||
my $node = shift;
|
||||
my $rv;
|
||||
|
||||
if (ref($self)) {
|
||||
$rv = $self->{$handlekey}->genders_testattrval($attr, $val, $node);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_testattrval()");
|
||||
return 0;
|
||||
}
|
||||
return $rv;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
sub isnode {
|
||||
my $self = shift;
|
||||
my $node = shift;
|
||||
my $rv;
|
||||
|
||||
if (ref($self)) {
|
||||
$rv = $self->{$handlekey}->genders_isnode($node);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_isnode()");
|
||||
return 0;
|
||||
}
|
||||
return $rv;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
sub isattr{
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
my $rv;
|
||||
|
||||
if (ref($self)) {
|
||||
$rv = $self->{$handlekey}->genders_isattr($attr);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_isattr()");
|
||||
return 0;
|
||||
}
|
||||
return $rv;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
sub isattrval {
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
my $val = shift;
|
||||
my $rv;
|
||||
|
||||
if (ref($self)) {
|
||||
$rv = $self->{$handlekey}->genders_isattrval($attr, $val);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_isattrval()");
|
||||
return 0;
|
||||
}
|
||||
return $rv;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
sub index_attrvals {
|
||||
my $self = shift;
|
||||
my $attr = shift;
|
||||
|
||||
if (ref($self)) {
|
||||
$self->{$handlekey}->genders_index_attrvals($attr);
|
||||
}
|
||||
}
|
||||
|
||||
sub query {
|
||||
my $self = shift;
|
||||
my $query = shift;
|
||||
my $nodes;
|
||||
|
||||
if (ref($self)) {
|
||||
$nodes = $self->{$handlekey}->genders_query($query);
|
||||
if (!defined($nodes)) {
|
||||
_errormsg($self, "genders_query()");
|
||||
return ();
|
||||
}
|
||||
return @$nodes;
|
||||
}
|
||||
else {
|
||||
return ();
|
||||
}
|
||||
}
|
||||
|
||||
sub testquery {
|
||||
my $self = shift;
|
||||
my $query = shift;
|
||||
my $node = shift;
|
||||
my $rv;
|
||||
|
||||
if (ref($self)) {
|
||||
$rv = $self->{$handlekey}->genders_testquery($query, $node);
|
||||
if ($rv < 0) {
|
||||
_errormsg($self, "genders_testquery()");
|
||||
return 0;
|
||||
}
|
||||
return $rv;
|
||||
}
|
||||
else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Genders - Perl library for querying a genders file
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
use Genders;
|
||||
|
||||
$Genders::GENDERS_DEFAULT_FILE;
|
||||
|
||||
$obj = Genders->new([$filename])
|
||||
|
||||
$obj->debug($num)
|
||||
|
||||
$obj->getnodename()
|
||||
$obj->getnodes([$attr, [$val]])
|
||||
$obj->getattr([$node])
|
||||
$obj->getattr_all()
|
||||
$obj->getattrval($attr, [$node])
|
||||
|
||||
$obj->testattr($attr, [$node])
|
||||
$obj->testattrval($attr, $val, [$node])
|
||||
|
||||
$obj->isnode([$node])
|
||||
$obj->isattr($attr)
|
||||
$obj->isattrval($attr, $val)
|
||||
|
||||
$obj->index_attrvals($attr)
|
||||
|
||||
$obj->query($query)
|
||||
$obj->testquery($query, [$node])
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This package provides a perl interface for querying a genders file.
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<Genders-E<gt>new([$filename])>
|
||||
|
||||
Creates a Genders object and load genders data from the specified
|
||||
file. If the genders file is not specified, the default genders file
|
||||
will be used. Returns undef if file cannot be read.
|
||||
|
||||
=item B<$obj-E<gt>debug($num)>
|
||||
|
||||
Set the debug level in the genders object. By default, the debug
|
||||
level is 0 and all debugging is turned off. To turn it on, set the
|
||||
level to 1.
|
||||
|
||||
=item B<$obj-E<gt>getnodename()>
|
||||
|
||||
Returns the name of the current node.
|
||||
|
||||
=item B<$obj-E<gt>getnodes([$attr, [$val]])>
|
||||
|
||||
Returns a list of nodes with the specified attribute and value. If a
|
||||
value is not specified only the attribute is considered. If the
|
||||
attribute is not specified, all nodes listed in the genders file are
|
||||
returned.
|
||||
|
||||
=item B<$obj-E<gt>getattr([$node])>
|
||||
|
||||
Returns a list of attributes for the specified node. If the node
|
||||
is not specified, the local node's attributes returned.
|
||||
|
||||
=item B<$obj-E<gt>getattr_all()>
|
||||
|
||||
Returns a list of all attributes listed in the genders file.
|
||||
|
||||
=item B<$obj-E<gt>getattrval($attr, [$node])>
|
||||
|
||||
Returns the value of the specified attribute for the specified node.
|
||||
If the attribute does not exist or the attribute has no value, an
|
||||
empty string is returned. If the node is not specified, the local
|
||||
node's attribute value is returned.
|
||||
|
||||
=item B<$obj-E<gt>testattr($attr, [$node])>
|
||||
|
||||
Returns 1 if the specified node has the specified attribute, 0 if it
|
||||
does not. If the node is not specified, the local node is checked.
|
||||
|
||||
=item B<$obj-E<gt>testattrval($attr, $val, [$node])>
|
||||
|
||||
Returns 1 if the specified node has the specified attribute and value,
|
||||
0 if it does not. If the node is not specified, the local node is
|
||||
checked.
|
||||
|
||||
=item B<$obj-E<gt>isnode([$node])>
|
||||
|
||||
Returns 1 if the specified node is listed in the genders file, 0 if it
|
||||
is not. If the node is not specified, the local node is checked.
|
||||
|
||||
=item B<$obj-E<gt>isattr($attr)>
|
||||
|
||||
Returns 1 if the specified attribute is listed in the genders file, 0
|
||||
if it is not.
|
||||
|
||||
=item B<$obj-E<gt>isattrval($attr, $val)>
|
||||
|
||||
Returns 1 if the specified attribute is equal to the specified value
|
||||
for some node in the genders file, 0 if it is not.
|
||||
|
||||
=item B<$obj-E<gt>index_attrvals($attr)>
|
||||
|
||||
Internally indexes genders attribute values for faster search times.
|
||||
Subsequent calls with a different attribute will overwrite earlier
|
||||
indexes.
|
||||
|
||||
=item B<$obj-E<gt>query($query)>
|
||||
|
||||
Returns a list of nodes specified by a genders query. A genders query
|
||||
is based on the union, intersection, set difference, or complement
|
||||
between genders attributes and values. Union is represented by two
|
||||
pipe symbols ('||'), intersection by two ampersand symbols ('&&'),
|
||||
difference by two minus symbols ('--'), and complement by a tilde
|
||||
('~') Operations are performed from left to right. Parentheses may be
|
||||
used to change the order of operations. For example, the following
|
||||
query would retrieve all nodes other than management or login nodes:
|
||||
"~(mgmt||login)". If the query is not specified, all nodes listed
|
||||
in the genders file are returned.
|
||||
|
||||
=item B<$obj-E<gt>testquery($query, [$node])>
|
||||
|
||||
Returns 1 if the specified node meets the conditions of the specified
|
||||
query, 0 if it does not. If the node is not specified, the local node
|
||||
is checked.
|
||||
|
||||
=back
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Albert Chu E<lt>chu11@llnl.govE<gt>
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<Libgenders>.
|
||||
|
||||
L<libgenders>.
|
||||
+307
@@ -0,0 +1,307 @@
|
||||
#############################################################################
|
||||
# $Id: Libgenders.pm.in,v 1.7 2010-02-02 00:04:34 chu11 Exp $
|
||||
#############################################################################
|
||||
# Copyright (C) 2007-2019 Lawrence Livermore National Security, LLC.
|
||||
# Copyright (C) 2001-2007 The Regents of the University of California.
|
||||
# Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
|
||||
# Written by Jim Garlick <garlick@llnl.gov> and Albert Chu <chu11@llnl.gov>.
|
||||
# UCRL-CODE-2003-004.
|
||||
#
|
||||
# This file is part of Genders, a cluster configuration database.
|
||||
# For details, see <http://www.llnl.gov/linux/genders/>.
|
||||
#
|
||||
# Genders is free software; you can redistribute it and/or modify it under
|
||||
# the terms of the GNU General Public License as published by the Free
|
||||
# Software Foundation; either version 2 of the License, or (at your option)
|
||||
# any later version.
|
||||
#
|
||||
# Genders is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
# details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License along
|
||||
# with Genders. If not, see <http://www.gnu.org/licenses/>.
|
||||
#############################################################################
|
||||
|
||||
package Libgenders;
|
||||
|
||||
use 5.006;
|
||||
use strict;
|
||||
use warnings;
|
||||
use Carp;
|
||||
|
||||
require Exporter;
|
||||
require DynaLoader;
|
||||
|
||||
our @ISA = qw(Exporter DynaLoader);
|
||||
|
||||
our $VERSION = '0.03';
|
||||
|
||||
bootstrap Libgenders $VERSION;
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
Libgenders - Perl extension for libgenders
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
use Libgenders;
|
||||
|
||||
Libgenders::GENDERS_ERR_SUCCESS
|
||||
Libgenders::GENDERS_ERR_NULLHANDLE
|
||||
Libgenders::GENDERS_ERR_OPEN
|
||||
Libgenders::GENDERS_ERR_READ
|
||||
Libgenders::GENDERS_ERR_PARSE
|
||||
Libgenders::GENDERS_ERR_NOTLOADED
|
||||
Libgenders::GENDERS_ERR_ISLOADED
|
||||
Libgenders::GENDERS_ERR_OVERFLOW
|
||||
Libgenders::GENDERS_ERR_PARAMETERS
|
||||
Libgenders::GENDERS_ERR_NULLPTR
|
||||
Libgenders::GENDERS_ERR_NOTFOUND
|
||||
Libgenders::GENDERS_ERR_SYNTAX
|
||||
Libgenders::GENDERS_ERR_QUERYINPUT
|
||||
Libgenders::GENDERS_ERR_OUTMEM
|
||||
Libgenders::GENDERS_ERR_MAGIC
|
||||
Libgenders::GENDERS_ERR_INTERNAL
|
||||
Libgenders::GENDERS_ERR_ERRNUMRANGE
|
||||
Libgenders::GENDERS_DEFAULT_FILE
|
||||
|
||||
$handle = Libgenders->genders_handle_create();
|
||||
$handle->genders_load_data([$filename]);
|
||||
|
||||
$handle->genders_errnum()
|
||||
$handle->genders_strerror($errnum)
|
||||
$handle->genders_errormsg()
|
||||
$handle->genders_perror($msg)
|
||||
|
||||
$handle->genders_getnumnodes()
|
||||
$handle->genders_getnumattrs()
|
||||
$handle->genders_getnodename()
|
||||
|
||||
$handle->genders_getnodes([$attr, [$val]])
|
||||
$handle->genders_getattr([$node])
|
||||
$handle->genders_getattr_all()
|
||||
$handle->genders_getattrval($attr, [$node])
|
||||
$handle->genders_testattr($attr, [$node])
|
||||
$handle->genders_testattrval($attr, $val, [$node])
|
||||
|
||||
$handle->genders_isnode([$node])
|
||||
$handle->genders_isattr($attr)
|
||||
$handle->genders_isattrval($attr, $val)
|
||||
|
||||
$handle->genders_index_attrvals($attr)
|
||||
|
||||
$handle->genders_query([$query])
|
||||
$handle->genders_testquery($query, [$node])
|
||||
|
||||
$handle->genders_parse([$filename]);
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This package provides a perl interface to the genders C API (see
|
||||
libgenders(3)). The perl interface is simliar to the genders C API,
|
||||
with some necessary changes due to the inherent differences between C
|
||||
and perl. Some of the functions from the C API cannot be accessed via
|
||||
this perl interface, some new functions were created, the behavior of
|
||||
some functions was modified, and the parameters passed into some
|
||||
functions have been changed. Please read the instructions below so to
|
||||
understand how to use the Libgenders package.
|
||||
|
||||
=head2 Initialization
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<Libgenders-E<gt>genders_handle_create>
|
||||
|
||||
Returns a genders object on success, undef on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_load_data([$filename])>
|
||||
|
||||
Opens, reads, and parses the genders file specified by $filename. If
|
||||
$filename is not specified, the default genders file is parsed.
|
||||
Returns 0 on success, -1 on error.
|
||||
|
||||
=back
|
||||
|
||||
=head2 Error Messages
|
||||
|
||||
Similarly to the C API, an error code is stored in the genders object
|
||||
after an error has occurred. The following can be used to retrieve
|
||||
the error code and output information about the error.
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<$handle-E<gt>genders_errnum()>
|
||||
|
||||
Returns the error code most recently set.
|
||||
|
||||
=item B<$handle-E<gt>genders_strerror($errnum)>
|
||||
|
||||
Returns a string describing the error code $errnum.
|
||||
|
||||
=item B<$handle-E<gt>genders_errormsg()>
|
||||
|
||||
Returns a string describing the most recent error.
|
||||
|
||||
=item B<$handle-E<gt>genders_perror([$msg])>
|
||||
|
||||
Outputs $msg and a string describing the most recent error to standard
|
||||
error. If $msg is not specified, only a description of the most
|
||||
recent error will be output to standard error.
|
||||
|
||||
=back
|
||||
|
||||
=head2 Utility Functions
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<$handle-E<gt>genders_getnumnodes()>
|
||||
|
||||
Returns the number of nodes listed in the genders file. Returns -1 on
|
||||
error.
|
||||
|
||||
=item B<$handle-E<gt>genders_getnumattrs()>
|
||||
|
||||
Returns the number of attributes listed in the genders file. Returns
|
||||
-1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_getnodename()>
|
||||
|
||||
Returns the shortened hostname of the current node. Returns undef on
|
||||
error.
|
||||
|
||||
=back
|
||||
|
||||
=head2 Parsing Functions
|
||||
|
||||
=over 4
|
||||
|
||||
=item B<$handle-E<gt>genders_getnodes([$attr, [$val]])>
|
||||
|
||||
Returns a reference to a list of nodes that have the specified
|
||||
attribute and value. If $val is not specified, only $attr is
|
||||
considered. If both $attr and $val are not specified, all nodes
|
||||
listed in the genders file are returned. Returns undef on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_getattr([$node])>
|
||||
|
||||
Returns a reference to an array that holds references to two lists.
|
||||
The first list is a reference to an array of attributes for the
|
||||
specified node. The second list is a reference to an array of values
|
||||
for the specified node. If $node is not specified, the local node is
|
||||
used. Returns undef on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_getattr_all()>
|
||||
|
||||
Returns a reference to a list of all the attributes listed in the
|
||||
genders file. Returns undef on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_getattrval($attr, [$node])>
|
||||
|
||||
Returns the value of an attribute listed in a node. Returns the empty
|
||||
string if the attribute has no value. If $node is not specified,
|
||||
local node is used. Returns undef on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_testattr($attr, [$node])>
|
||||
|
||||
Tests if a node has a specified attribute. If $node is not specified,
|
||||
local node is used. Returns 1 if the node contains the attribute, 0
|
||||
if not, -1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_testattrval($attr, $val, [$node])>
|
||||
|
||||
Tests if a node has a specified attribute=value pair. If $node is not
|
||||
specified, local node is used. Returns 1 if the node contains the
|
||||
attribute=value pair, 0 if not, -1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_isnode([$node])>
|
||||
|
||||
Tests if a node is listed in the genders file. If $node is not
|
||||
specified, local node is used. Returns 1 if the node is listed, 0 if
|
||||
it is not, -1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_isattr($attr)>
|
||||
|
||||
Tests if the attribute $attr is listed in the genders file. Returns 1
|
||||
if the attribute is listed, 0 if it is not, -1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_isattrval($attr, $val)>
|
||||
|
||||
Tests if the attribute=value pair is listed in the genders file.
|
||||
Returns 1 if the pair is listed, 0 if it is not, -1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_index_attrvals($attr)>
|
||||
|
||||
Internally adds indexing to decrease search times for genders
|
||||
attribute value combinations. Will specifically aid performance of
|
||||
the genders_getnodes and genders_isattrval functions. Only one
|
||||
attribute can be indexed at a time. Subsequent calls to this function
|
||||
with a different attribute will overwrite earlier indexes.
|
||||
|
||||
=item B<$handle-E<gt>genders_query([$query])>
|
||||
|
||||
Returns a reference to a list of nodes specified by a genders query.
|
||||
A genders query is based on the union, intersection, set difference,
|
||||
or complement between genders attributes and values. Union is
|
||||
represented by two pipe symbols ('||'), intersection by two ampersand
|
||||
symbols ('&&'), difference by two minus symbols ('--'), and complement
|
||||
by a tilde ('~') Operations are performed from left to right.
|
||||
Parentheses may be used to change the order of operations. For
|
||||
example, the following query would retrieve all nodes other than
|
||||
management or login nodes: "~(mgmt||login)". If $query is not
|
||||
specified, all nodes listed in the genders file are returned. Returns
|
||||
undef on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_testquery($query, [$node])>
|
||||
|
||||
Tests if a node meets the conditions specified in the query. If $node
|
||||
is not specified, local node is used. Returns 1 if the node is
|
||||
contained within the query, 0 if not, -1 on error.
|
||||
|
||||
=item B<$handle-E<gt>genders_parse([$filename])>
|
||||
|
||||
Parse a genders file and output parse errors to standard error. If
|
||||
$filename is not specified, the default genders file is parsed.
|
||||
Returns the number of errors (0 if no parse errors were found) on
|
||||
success, -1 on error.
|
||||
|
||||
=back
|
||||
|
||||
=head2 Error Codes/Constants
|
||||
|
||||
The same error codes and constants listed in /usr/include/genders.h
|
||||
can be accessed through the following functions:
|
||||
|
||||
Libgenders::GENDERS_ERR_SUCCESS
|
||||
Libgenders::GENDERS_ERR_NULLHANDLE
|
||||
Libgenders::GENDERS_ERR_OPEN
|
||||
Libgenders::GENDERS_ERR_READ
|
||||
Libgenders::GENDERS_ERR_PARSE
|
||||
Libgenders::GENDERS_ERR_NOTLOADED
|
||||
Libgenders::GENDERS_ERR_ISLOADED
|
||||
Libgenders::GENDERS_ERR_OVERFLOW
|
||||
Libgenders::GENDERS_ERR_PARAMETERS
|
||||
Libgenders::GENDERS_ERR_NULLPTR
|
||||
Libgenders::GENDERS_ERR_NOTFOUND
|
||||
Libgenders::GENDERS_ERR_OUTMEM
|
||||
Libgenders::GENDERS_ERR_SYNTAX
|
||||
Libgenders::GENDERS_ERR_QUERYINPUT
|
||||
Libgenders::GENDERS_ERR_MAGIC
|
||||
Libgenders::GENDERS_ERR_INTERNAL
|
||||
Libgenders::GENDERS_ERR_ERRNUMRANGE
|
||||
Libgenders::GENDERS_DEFAULT_FILE
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Albert Chu E<lt>chu11@llnl.govE<gt>
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<libgenders>
|
||||
|
||||
=cut
|
||||
Binary file not shown.
Reference in New Issue
Block a user