libgenders - a library of functions to parse and retrieve genders data

NAME

       libgenders - a library of functions to parse and retrieve genders data

SYNOPSIS

       #include <genders.h>

       genders_t genders_handle_create(void);

       int genders_handle_destroy(genders_t handle);

       int genders_load_data(genders_t handle, const char *filename);

       int genders_errnum(genders_t handle);

       char *genders_strerror(int errnum);

       char *genders_errormsg(genders_t handle);

       void genders_perror(genders_t handle, const char *msg);

       int genders_getnumnodes(genders_t handle);

       int genders_getnumattrs(genders_t handle);

       int genders_getmaxattrs(genders_t handle);

       int genders_getmaxnodelen(genders_t handle);

       int genders_getmaxattrlen(genders_t handle);

       int genders_getmaxvallen(genders_t handle);

       int genders_nodelist_create(genders_t handle, char ***nodelist);

       int genders_nodelist_clear(genders_t handle, char **nodelist);

       int genders_nodelist_destroy(genders_t handle, char **nodelist);

       int genders_attrlist_create(genders_t handle, char ***attrlist);

       int genders_attrlist_clear(genders_t handle, char **attrlist);

       int genders_attrlist_destroy(genders_t handle, char **attrlist);

       int genders_vallist_create(genders_t handle, char ***vallist);

       int genders_vallist_clear(genders_t handle, char **vallist);

       int genders_vallist_destroy(genders_t handle, char **vallist);

       int genders_getnodename(genders_t handle, char *node, int len);

       int  genders_getnodes(genders_t  handle,  char *nodes[], int len, const
       char *attr, const char *val);

       int genders_getattr(genders_t handle, char *attrs[], char *vals[],  int
       len, const char *node);

       int genders_getattr_all(genders_t handle, char *attrs[], int len);

       int  genders_testattr(genders_t  handle,  const  char *node, const char
       *attr, char *val, int len);

       int genders_testattrval(genders_t handle, const char *node, const  char
       *attr, const char *val);

       int genders_isnode(genders_t handle, const char *node);

       int genders_isattr(genders_t handle, const char *attr);

       int  genders_isattrval(genders_t  handle,  const char *attr, const char
       *val);

       int genders_index_attrvals(genders_t handle, const char *attr);

       int genders_query(genders_t handle, char *nodes[], int len, const  char
       *query);

       int  genders_testquery(genders_t  handle,  const char *node, const char
       *query);

       int  genders_parse(genders_t  handle,  const   char   *filename,   FILE
       *stream);

DESCRIPTION

       The  genders library functions are a set of functions used to parse and
       retrieve data from a genders file.  For API  details,  please  see  the
       individual  manpages  for  each  of  the  functions  above, or read the
       comments written in /usr/include/genders.h.

GENDERS FILE FORMAT

       Each line of the genders file has one of the  following  formats.   See
       the section HOST RANGES below for information on host range formatting.

            nodename                attr[=value],attr[=value],...
            nodename1,nodename2,... attr[=value],attr[=value],...
            nodenames[A-B]          attr[=value],attr[=value],...

       The nodename(s) are  the  shortened  hostnames  of  a  node.   This  is
       followed  by any number of spaces or tabs, and then the comma-separated
       list of attributes, each of which can optionally  have  a  value.   The
       substitution string "%n" can be used in an attribute value to represent
       the nodename.  Nodenames can be listed on multiple lines, so  a  node’s
       attributes can be specified on multiple lines.  However, no single node
       may have duplicate attributes.

       There must be no spaces embedded in the attribute list and there is  no
       provision  for  continuation  lines.   Commas  and equal characters are
       special and cannot appear in attribute names or their values.  Comments
       are  prefixed with the hash chracter (#) and can appear anywhere in the
       file.  The active genders file is typically found  at  /etc/genders  or
       /admin/etc/genders.

       Here is an example genders file from a small 16-node linux cluster:

            # slc cluster genders file
            slci,slcj,slc[0-15]  eth2=e%n,cluster=slc,all
            slci                 passwdhost
            slci,slcj            management
            slc[1-15]            compute

HOST RANGES

       As  noted  in  sections  above,  the genders database accepts ranges of
       nodenames in the general form: prefix[n-m,l-k,...], where n < m and l <
       k, etc., as an alternative to explicit lists of nodenames.

       This  range  syntax  is  meant only as a convenience on clusters with a
       prefixNN naming convention and specification of ranges  should  not  be
       considered  necessary -- the list foo1,foo9 could be specified as such,
       or by the range foo[1,9].

       Some examples of range usage follow:

       foo01,foo02,foo03,foo04,foo05:    foo[01-05]

       foo3,foo7,foo9,foo11:             foo[3,7,9-11]

       fooi,fooj,foo0,foo1,foo2:         fooi,fooj,foo[0-2]

FILES

       /usr/include/genders.h

       /etc/genders

NAME

SYNOPSIS

DESCRIPTION

GENDERS FILE FORMAT

HOST RANGES

FILES

SEE ALSO