source: trunk/src/PBSQuery.py @ 329

#
# Authors: Roy Dragseth (roy.dragseth@cc.uit.no) 
#          Bas van der Vlies (basv@sara.nl)
#
# SVN INFO:
#   $Id: PBSQuery.py 289 2013-02-26 09:22:59Z bas $
#
"""
Usage: from PBSQuery import PBSQuery

This class gets the info from the pbs_server via the pbs.py module
for the several batch objects. All get..() functions return an dictionary
with id as key and batch object as value

There are four batch objects:
 - server 
 - queue
 - job
 - node

Each object can be handled as an dictionary and has several member
functions. The second parameter is an python list and can be used if you 
are only interested in certain resources, see example

There are the following functions for PBSQuery:
  job - 
    getjob(job_id, attributes=<default is all>)
    getjobs(attributes=<default is all>)
 
  node -
    getnode(node_id, attributes=<default is all>)
    getnodes(attributes=<default is all>)

  queue -
    getqueue(queue_id, attributes=<default is all>)
    getqueues(attributes=<default is all>)

  server -
    get_serverinfo(attributes=<default is all>)

Here is an example how to use the module:
    from PBSQuery import PBSQuery
    p = PBSQuery()
    nodes = p.getnodes()
    for name,node in nodes.items():
        print name
        if node.is_free():
           print node, node['state']

    l = [ 'state', 'np' ]
    nodes = p.getnodes(l)
    for name,node in nodes.items():
           print node, node['state']

The parameter 'attributes' is an python list of resources that 
you are interested in, eg: only show state of nodes
        l = list()
    l.append('state')
    nodes = p.getnodes(l)
"""
import pbs
import UserDict
import string
import sys
import re
import types

class PBSError(Exception):
    def __init__(self, msg=''):
        self.msg = msg
        Exception.__init__(self, msg)
        
    def __repr__(self):
        return self.msg

    __str__ = __repr__


class PBSQuery:

    # a[key] = value, key and value are data type string
    #
    OLD_DATA_STRUCTURE = False

    def __init__(self, server=None):
        if not server:
            self.server = pbs.pbs_default()
        else:
            self.server = server

        self._connect()
        ## this is needed for getjob a jobid is made off:
        #    sequence_number.server (is not self.server)
        #
        self.job_server_id = list(self.get_serverinfo())[0] 
        self._disconnect()


    def _connect(self):
        """Connect to the PBS/Torque server"""
        self.con = pbs.pbs_connect(self.server)
        if self.con < 0:
            str = "Could not make a connection with %s\n" %(self.server)
            raise PBSError(str)

    def _disconnect(self):
        """Close the PBS/Torque connection"""
        pbs.pbs_disconnect(self.con)
        self.attribs = 'NULL'

    def _list_2_attrib(self, list):
        """Convert a python list to an attrib list suitable for pbs"""
        self.attribs = pbs.new_attrl( len(list) )
        i = 0 
        for attrib in list:
            # So we can user Resource
            attrib = attrib.split('.')
            self.attribs[i].name = attrib[0]
            i = i + 1

    def _pbsstr_2_list(self, str, delimiter):
        """Convert a string to a python list and use delimiter as spit char"""
        l = sting.splitfields(str, delimiter)
        if len(l) > 1:
            return l

    def _list_2_dict(self, l, class_func):
        """
        Convert a pbsstat function list to a class dictionary, The 
        data structure depends on the function new_data_structure().
        
        Default data structure is:
            class[key] = value, Where key and value are of type string

        Future release, can be set by new_data_structure():
            - class[key] = value where value can be:
              1. a list of values of type string
              2. a dictionary with as list of values of type string. If
                 values contain a '=' character

          eg: 
                print node['np']
                >> [ '2' ]

                print node['status']['arch']
                >> [ 'x86_64' ]
        """
        self.d = {}
        for item in l:
            new = class_func()

            self.d[item.name] = new 
            
            new.name = item.name

            for a in item.attribs:

                if self.OLD_DATA_STRUCTURE:

                    if a.resource:
                        key = '%s.%s' %(a.name, a.resource)
                    else:
                        key = '%s' %(a.name)

                    new[key] = a.value

                else:
                    values = string.split(a.value, ',') 
                    sub_dict = string.split(a.value, '=')


                    # We must creat sub dicts, only for specified 
                    # key values
                    #
                    if a.name in ['status', 'Variable_List']:

                        for v in values:

                            tmp_l = v.split('=')

                            ## Support for multiple EVENT mesages in format [key=value:]+ 
                            #  format eg: message=EVENT:sample.time=1288864220.003,EVENT:kernel=upgrade,cputotals.user=0
                            #             message=ERROR <text>
                            #
                            if tmp_l[0] in ['message']:

                                if tmp_l[1].startswith('EVENT:'):

                                    tmp_d  = dict()
                                    new['event'] = class_func(tmp_d)

                                    message_list = v.split(':')
                                    for event_type in message_list[1:]:
                                        tmp_l = event_type.split('=')
                                        new['event'][ tmp_l[0] ] = tmp_l[1:]

                                else:

                                    ## ERROR message
                                    #
                                    new['error'] = tmp_l [1:]

                            elif tmp_l[0].startswith('EVENT:'): 

                                  message_list = v.split(':')
                                  for event_type in message_list[1:]:
                                      tmp_l = event_type.split('=')
                                      new['event'][ tmp_l[0] ] = tmp_l[1:]

                            else:
                                  ## Check if we already added the key
                                  #
                                  if new.has_key(a.name):

                                      new[a.name][ tmp_l[0] ] = tmp_l[1:] 

                                  else:

                                      tmp_d  = dict()
                                      tmp_d[ tmp_l[0] ] = tmp_l[1:]
                                      new[a.name] = class_func(tmp_d) 

                    else: 

                        ## Check if it is a resource type variable, eg:
                        #  - Resource_List.(nodes, walltime, ..)
                        #
                        if a.resource:

                            if new.has_key(a.name):
                                new[a.name][a.resource] = values

                            else:
                                tmp_d = dict()
                                tmp_d[a.resource] = values
                                new[a.name] = class_func(tmp_d) 
                        else:
                            # Simple value
                            #
                            new[a.name] = values

        self._free(l)
            
    def _free(self, memory):
        """
        freeing up used memmory

        """
        pbs.pbs_statfree(memory)

    def _statserver(self, attrib_list=None):
        """Get the server config from the pbs server"""
        if attrib_list:
            self._list_2_attrib(attrib_list)
        else:
            self.attribs = 'NULL' 
            
        self._connect()
        serverinfo = pbs.pbs_statserver(self.con, self.attribs, 'NULL')
        self._disconnect() 
        
        self._list_2_dict(serverinfo, server)

    def get_serverinfo(self, attrib_list=None):
        self._statserver(attrib_list)
        return self.d

    def _statqueue(self, queue_name='', attrib_list=None):
        """Get the queue config from the pbs server"""
        if attrib_list:
            self._list_2_attrib(attrib_list)
        else:
            self.attribs = 'NULL' 
            
        self._connect()
        queues = pbs.pbs_statque(self.con, queue_name, self.attribs, 'NULL')
        self._disconnect() 
        
        self._list_2_dict(queues, queue)

    def getqueue(self, name, attrib_list=None):
        self._statqueue(name, attrib_list)
        try:
            return self.d[name]
        except KeyError, detail:
            return self.d
        
    def getqueues(self, attrib_list=None):
        self._statqueue('', attrib_list)
        return self.d

    def _statnode(self, select='', attrib_list=None, property=None):
        """Get the node config from the pbs server"""
        if attrib_list:
            self._list_2_attrib(attrib_list)
        else:
            self.attribs = 'NULL' 
            
        if property:
            select = ':%s' %(property)

        self._connect()
        nodes = pbs.pbs_statnode(self.con, select, self.attribs, 'NULL')
        self._disconnect() 
        
        self._list_2_dict(nodes, node)

    def getnode(self, name, attrib_list=None):
        self._statnode(name, attrib_list)
        try:
            return self.d[name]
        except KeyError, detail:
            return self.d
        
    def getnodes(self, attrib_list=None):
        self._statnode('', attrib_list)
        return self.d

    def getnodes_with_property(self, property, attrib_list=None):
        self._statnode('', attrib_list, property)
        return self.d

    def _statjob(self, job_name='', attrib_list=None):
        """Get the job config from the pbs server"""
        if attrib_list:
            self._list_2_attrib(attrib_list)
        else:
            self.attribs = 'NULL' 
            
        self._connect()
        jobs = pbs.pbs_statjob(self.con, job_name, self.attribs, 'NULL')
        self._disconnect() 
        
        self._list_2_dict(jobs, job)

    def getjob(self, name, attrib_list=None):
        ## To make sure we use the full name of a job; Changes a name
        # like 1234567 into 1234567.job_server_id
        #
        if len(name.split('.')) == 1 :
            name = name.split('.')[0] + "." + self.job_server_id

        self._statjob(name, attrib_list)
        try:
            return self.d[name]
        except KeyError, detail:
            return self.d
        
    def getjobs(self, attrib_list=None):
        self._statjob('', attrib_list)
        return self.d

    def get_server_name(self):
        return self.server

    def new_data_structure(self): 
        """
        Use the new data structure. Is now the default
        """
        self.OLD_DATA_STRUCTURE = False

    def old_data_structure(self): 
        """
        Use the old data structure. This function is obselete and
        will be removed in a future release
        """
        self.OLD_DATA_STRUCTURE = True

class _PBSobject(UserDict.UserDict):
    TRUE  = 1
    FALSE = 0

    def __init__(self, dictin = None):
        UserDict.UserDict.__init__(self)
        self.name = None

        if dictin:
            if dictin.has_key('name'):
                self.name = dictin['name']
                del dictin['name']
            self.data = dictin

    def get_value(self, key):
        if self.has_key(key):
            return self[key]
        else:
            return None

    def __repr__(self):
        return repr(self.data)

    def __str__(self):
        return str(self.data)

    def __getattr__(self, name):
        """
        override the class attribute get method. Return the value
        from the Userdict
        """
        try:
            return self.data[name]
        except KeyError:
            error = 'Attribute key error: %s' %(name)
            raise PBSError(error)

    ## Disabled for this moment, BvdV 16 July 2010
    #
    #def __setattr__(self, name, value):
    #   """
    #   override the class attribute set method only when the UserDict
    #   has set its class attribute
    #   """
    #   if self.__dict__.has_key('data'):
    #       self.data[name] = value
    #   else:
    #       self.__dict__[name] = value

    def __iter__(self):
        return iter(self.data.keys())

    def __nonzero__(self):
        if self.data:
            return True
        else:
            return False

    def uniq(self, list):
        """Filter out unique items of a list"""
        uniq_items = {}
        for item in list:
            uniq_items[item] = 1
        return uniq_items.keys()

    def return_value(self, key):
        """Function that returns a value independent of new or old data structure"""
        if isinstance(self[key], types.ListType):
            return self[key][0]
        else:
            return self[key] 

class job(_PBSobject):
    """PBS job class""" 
    def is_running(self):

        value = self.return_value('job_state')
        if value == 'Q':
            return self.TRUE 
        else:
            return self.FALSE

    def get_nodes(self, unique=None):
        """
        Returns a list of the nodes which run this job
        format:
          * exec_host: gb-r10n14/5+gb-r10n14/4+gb-r10n14/3+gb-r10n14/2+gb-r10n14/1+gb-r10n14/0
          * split on '+' and if uniq is set split on '/'
        """
        nodes = self.get_value('exec_host')
        
        if isinstance(nodes, str):
            if nodes:
                nodelist = string.split(nodes,'+')
                if not unique:
                    return nodelist
                else:
                    l = list()

                    for n in nodelist:
                        t = string.split(n,'/')
                        if t[0] not in l:
                            l.append(t[0])

                    return l

            else:
                return list()
        else:
                l = list()
                for n in nodes:

                    nlist = string.split(n,'+')

                    if unique:
                        for entry in nlist:

                            t = string.split(entry,'/')
                            if t[0] not in l:
                                l.append(t[0])
                    else:
                        l += nlist

                return l
        

class node(_PBSobject):
    """PBS node class"""
    
    def is_free(self):
        """Check if node is free"""

        value = self.return_value('state')
        if value == 'free':
            return self.TRUE
        else: 
            return self.FALSE 

    def has_job(self):
        """Does the node run a job"""
        try:
            a = self['jobs']
            return self.TRUE
        except KeyError, detail:
            return self.FALSE
    
    def get_jobs(self, unique=None):
        """Returns a list of the currently running job-id('s) on the node"""

        jobs = self.get_value('jobs')
        if jobs:    
            if isinstance(jobs, str):
                jlist = re.compile('[^\\ /]\\d+[^/.]').findall( jobs )
            
                if not unique:
                    return jlist
                else:
                    return self.uniq(jlist)

            else:
                job_re = re.compile('^(?:\d+/)?(.+)')
                l = list()

                if unique:
                        for j in jobs:
                            jobstr = job_re.findall(j.strip())[0]
                            if jobstr not in l: 
                                l.append(jobstr)           

                        return l
                else:
                        return jobs

        return list()


class queue(_PBSobject):
    """PBS queue class"""
    def is_enabled(self):

        value = self.return_value('enabled')
        if value == 'True':
            return self.TRUE 
        else:
            return self.FALSE

    def is_execution(self):

        value = self.return_value('queue_type')
        if value == 'Execution':
            return self.TRUE 
        else:
            return self.FALSE

class server(_PBSobject):
    """PBS server class"""

    def get_version(self):
        return self.get_value('pbs_version')

def main():
    p = PBSQuery() 
    serverinfo = p.get_serverinfo()
    for server in serverinfo.keys():
        print server, ' version: ', serverinfo[server].get_version()
    for resource in serverinfo[server].keys():
        print '\t ', resource, ' = ', serverinfo[server][resource]

    queues = p.getqueues()
    for queue in queues.keys():
        print queue
        if queues[queue].is_execution():
            print '\t ', queues[queue]
        if queues[queue].has_key('acl_groups'):
            print '\t acl_groups: yes'
        else:
            print '\t acl_groups: no'

    jobs = p.getjobs()
    for name,job in jobs.items():
        if job.is_running():
            print job

    l = ['state']
    nodes = p.getnodes(l)
    for name,node in nodes.items():
        if node.is_free(): 
            print node

if __name__ == "__main__":
    main()