DominoServer.py

   1 #!/usr/bin/env python
   2
   3 #Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
   4 #   Licensed under the Apache License, Version 2.0 (the "License");
   5 #   you may not use this file except in compliance with the License.
   6 #   You may obtain a copy of the License at
   7 #       http://www.apache.org/licenses/LICENSE-2.0
   8 #   Unless required by applicable law or agreed to in writing, software
   9 #   distributed under the License is distributed on an "AS IS" BASIS,
  10 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 #   See the License for the specific language governing permissions and
  12 #   limitations under the License.
  13
  14 import sys, os, glob, random, errno
  15 import getopt, socket
  16 import logging, json
  17 import sqlite3
  18 #sys.path.append('gen-py')
  19 #sys.path.insert(0, glob.glob('./lib/py/build/lib.*')[0])
  20 sys.path.insert(0, glob.glob('./lib')[0])
  21
  22
  23 from dominoRPC import Communication
  24 from dominoRPC.ttypes import *
  25 from dominoRPC.constants import *
  26
  27 from thrift import Thrift
  28 from thrift.transport import TSocket
  29 from thrift.transport import TTransport
  30 from thrift.protocol import TBinaryProtocol
  31 from thrift.server import TServer
  32
  33 from toscaparser.tosca_template import ToscaTemplate
  34 #from toscaparser.utils.gettextutils import _
  35 #import toscaparser.utils.urlutils
  36
  37 from mapper import *
  38 from partitioner import *
  39 from util import miscutil
  40
  41 #Load configuration parameters
  42 from domino_conf import *
  43
  44
  45 class CommunicationHandler:
  46   def __init__(self):
  47     self.log = {}
  48
  49   def __init__(self, dominoserver):
  50     self.log = {}
  51     self.dominoServer = dominoserver
  52     self.seqno = 0;
  53
  54   def openconnection(self, ipaddr, tcpport):
  55     try:
  56       # Make socket
  57       transport = TSocket.TSocket(ipaddr, tcpport)
  58       transport.setTimeout(THRIFT_RPC_TIMEOUT_MS)
  59       # Add buffering to compensate for slow raw sockets
  60       self.transport = TTransport.TBufferedTransport(transport)
  61       # Wrap in a protocol
  62       self.protocol = TBinaryProtocol.TBinaryProtocol(self.transport)
  63       # Create a client to use the protocol encoder
  64       self.sender = Communication.Client(self.protocol)
  65       self.transport.open()
  66     except Thrift.TException, tx:
  67       logging.error('%s' , tx.message)
  68
  69
  70
  71   def closeconnection(self):
  72     self.transport.close()
  73
  74   def push_template(self,template,ipaddr,tcpport):
  75     self.openconnection(ipaddr,tcpport)
  76     pushm = PushMessage()
  77     pushm.domino_udid = SERVER_UDID
  78     pushm.seq_no = self.seqno
  79     pushm.template_type = 'tosca-nfv-v1.0'
  80     pushm.template = template
  81     try:
  82       push_r = self.sender.d_push(pushm)
  83       logging.info('Push Response received from %d' , push_r.domino_udid)
  84     except (Thrift.TException, TSocket.TTransportException) as tx:
  85       logging.error('%s' , tx.message)
  86     except (socket.timeout) as tx:
  87       self.dominoServer.handle_RPC_timeout(pushm)
  88     except:
  89       logging.error('Unexpected error: %s', sys.exc_info()[0])
  90
  91     self.seqno = self.seqno + 1
  92
  93     self.closeconnection()
  94
  95   #Heartbeat from Domino Client is received
  96   #Actions:
  97   #     - Respond Back with a heartbeat
  98
  99   def d_heartbeat(self, hb_msg):
 100     global SERVER_UDID
 101     logging.info('heartbeat received from %d' , hb_msg.domino_udid)
 102
 103     hb_r = HeartBeatMessage()
 104     hb_r.domino_udid = SERVER_UDID
 105     hb_r.seq_no = self.seqno
 106
 107     self.seqno = self.seqno + 1
 108
 109     return hb_r
 110
 111   #Registration from Domino Client is received
 112   #Actions:
 113   #
 114   #       - Respond Back with Registration Response
 115   def d_register(self, reg_msg):
 116     global SERVER_UDID
 117
 118     #Prepare and send Registration Response
 119     reg_r = RegisterResponseMessage()
 120     logging.info('Registration Request received for UDID %d from IP: %s port: %d', reg_msg.domino_udid_desired, reg_msg.ipaddr, reg_msg.tcpport)
 121
 122
 123     reg_r.domino_udid_assigned = self.dominoServer.assign_udid(reg_msg.domino_udid_desired)
 124     reg_r.seq_no = self.seqno
 125     reg_r.domino_udid = SERVER_UDID
 126     #return unconditional success
 127     #To be implemented:
 128     #Define conditions for unsuccessful registration (e.g., unsupported mapping)
 129     reg_r.responseCode = SUCCESS
 130     #no need to send comments
 131     #To be implemented:
 132     #Logic for a new UDID assignment
 133
 134     self.seqno = self.seqno + 1
 135
 136     #commit to the database
 137     dbconn = sqlite3.connect(SERVER_DBFILE)
 138     c = dbconn.cursor()
 139     try:
 140       newrow = [(reg_r.domino_udid_assigned, reg_msg.ipaddr, reg_msg.tcpport, ','.join(reg_msg.supported_templates), reg_msg.seq_no),]
 141       c.executemany('INSERT INTO clients VALUES (?,?,?,?,?)',newrow)
 142     except sqlite3.OperationalError as ex:
 143       logging.error('Could not add the new registration record into %s for Domino Client %d :  %s', SERVER_DBFILE, reg_r.domino_udid_assigned, ex.message)
 144     except:
 145       logging.error('Could not add the new registration record into %s for Domino Client %d', SERVER_DBFILE, reg_r.domino_udid_assigned)
 146       logging.error('Unexpected error: %s', sys.exc_info()[0])
 147
 148     dbconn.commit()
 149     dbconn.close()
 150
 151     return reg_r
 152
 153
 154   #Subscription from Domino Client is received
 155   #Actions:
 156   #       - Save the templates  & labels
 157   #       - Respond Back with Subscription Response
 158   def d_subscribe(self, sub_msg):
 159     global SERVER_UDID, SERVER_SEQNO
 160     logging.info('Subscribe Request received from %d' , sub_msg.domino_udid)
 161
 162     if sub_msg.template_op == APPEND:
 163       if self.dominoServer.subscribed_templateformats.has_key(sub_msg.domino_udid):
 164         self.dominoServer.subscribed_templateformats[sub_msg.domino_udid].update(set(sub_msg.supported_template_types))
 165       else:
 166         self.dominoServer.subscribed_templateformats[sub_msg.domino_udid] = set(sub_msg.supported_template_types)
 167     elif sub_msg.template_op == OVERWRITE:
 168       self.dominoServer.subscribed_templateformats[sub_msg.domino_udid] = set(sub_msg.supported_template_types)
 169     elif sub_msg.template_op == DELETE:
 170       self.dominoServer.subscribed_templateformats[sub_msg.domino_udid].difference_update(set(sub_msg.supported_template_types))
 171
 172 #    if sub_msg.labels != []:
 173     if sub_msg.label_op == APPEND:
 174       logging.debug('APPENDING Labels...')
 175       if self.dominoServer.subscribed_labels.has_key(sub_msg.domino_udid):
 176         self.dominoServer.subscribed_labels[sub_msg.domino_udid].update(set(sub_msg.labels))
 177       else:
 178         self.dominoServer.subscribed_labels[sub_msg.domino_udid] = set(sub_msg.labels)
 179     elif sub_msg.label_op == OVERWRITE:
 180       logging.debug('OVERWRITING Labels...')
 181       self.dominoServer.subscribed_labels[sub_msg.domino_udid] = set(sub_msg.labels)
 182     elif sub_msg.label_op == DELETE:
 183       logging.debug('DELETING Labels...')
 184       self.dominoServer.subscribed_labels[sub_msg.domino_udid].difference_update(set(sub_msg.labels))
 185
 186     logging.debug('Supported Template: %s Supported Labels: %s' , self.dominoServer.subscribed_templateformats[sub_msg.domino_udid] , self.dominoServer.subscribed_labels[sub_msg.domino_udid])
 187
 188     #commit to the database
 189     dbconn = sqlite3.connect(SERVER_DBFILE)
 190     c = dbconn.cursor()
 191     newlabelset = self.dominoServer.subscribed_labels[sub_msg.domino_udid]
 192     try:
 193       c.execute("REPLACE INTO labels (udid, label_list) VALUES ({udid}, '{newvalue}')".\
 194                format(udid=sub_msg.domino_udid, newvalue=','.join(list(newlabelset)) ))
 195     except sqlite3.OperationalError as ex1:
 196       logging.error('Could not add the new labels to %s for Domino Client %d :  %s', SERVER_DBFILE, sub_msg.domino_udid, ex1.message)
 197     except:
 198       logging.error('Could not add the new labels to %s for Domino Client %d', SERVER_DBFILE, sub_msg.domino_udid)
 199       logging.error('Unexpected error: %s', sys.exc_info()[0])
 200
 201     newttypeset = self.dominoServer.subscribed_templateformats[sub_msg.domino_udid]
 202     try:
 203       c.execute("REPLACE INTO ttypes (udid, ttype_list) VALUES ({udid}, '{newvalue}')".\
 204                format(udid=sub_msg.domino_udid, newvalue=','.join(list(newttypeset)) ))
 205     except sqlite3.OperationalError as ex1:
 206       logging.error('Could not add the new labels to %s for Domino Client %d :  %s', SERVER_DBFILE, sub_msg.domino_udid, ex1.message)
 207     except:
 208       logging.error('Could not add the new labels to %s for Domino Client %d', SERVER_DBFILE, sub_msg.domino_udid)
 209       logging.error('Unexpected error: %s', sys.exc_info()[0])
 210
 211
 212     dbconn.commit()
 213     dbconn.close()
 214
 215
 216     #Fill in the details
 217     sub_r = SubscribeResponseMessage()
 218     sub_r.domino_udid = SERVER_UDID
 219     sub_r.seq_no = self.seqno
 220     sub_r.responseCode = SUCCESS
 221     self.seqno = self.seqno + 1
 222
 223     return sub_r
 224
 225   #Template Publication from Domino Client is received
 226   #Actions:
 227   #       - Parse the template, perform mapping, partition the template
 228   #       - Launch Push service
 229   #       - Respond Back with Publication Response
 230   def d_publish(self, pub_msg):
 231     global SERVER_UDID, SERVER_SEQNO, TOSCADIR, TOSCA_DEFAULT_FNAME
 232     logging.info('Publish Request received from %d' , pub_msg.domino_udid)
 233     logging.debug(pub_msg.template)
 234
 235     # Save as file
 236     try:
 237       os.makedirs(TOSCADIR)
 238     except OSError as exception:
 239       if exception.errno == errno.EEXIST:
 240         logging.debug('ERRNO %d; %s exists. Creating: %s', exception.errno, TOSCADIR,  TOSCADIR+TOSCA_DEFAULT_FNAME)
 241       else:
 242         logging.error('Error occurred in creating %s. Err no: %d', exception.errno)
 243
 244     #Risking a race condition if another process is attempting to write to same file
 245     f = open(TOSCADIR+TOSCA_DEFAULT_FNAME, 'w')
 246     for item in pub_msg.template:
 247       print>>f, item
 248     f.close()
 249
 250     # Load tosca object from file into memory
 251     tosca = ToscaTemplate( TOSCADIR+TOSCA_DEFAULT_FNAME )
 252
 253     # Extract Labels
 254     node_labels = label.extract_labels( tosca )
 255     logging.debug('Node Labels: %s', node_labels)
 256
 257     # Map nodes in the template to resource domains
 258     site_map = label.map_nodes( self.dominoServer.subscribed_labels , node_labels )
 259     logging.debug('Site Maps: %s' , site_map)
 260
 261     # Select a site for each VNF
 262     node_site = label.select_site( site_map )
 263     logging.debug('Selected Sites: %s', node_site)
 264
 265     # Create per-domain Tosca files
 266     file_paths = partitioner.partition_tosca('./toscafiles/template1.yaml',node_site,tosca.tpl)
 267
 268     # Create list of translated template files
 269
 270     # Create work-flow
 271
 272     # Send domain templates to each domain agent/client
 273     # FOR NOW: send untranslated but partitioned tosca files to scheduled sites
 274     # TBD: read from work-flow
 275     for site in file_paths:
 276       domino_client_ip = self.dominoServer.registration_record[site].ipaddr
 277       domino_client_port = self.dominoServer.registration_record[site].tcpport
 278       self.push_template(miscutil.read_templatefile(file_paths[site]), domino_client_ip, domino_client_port)
 279
 280     #Fill in the details
 281     pub_r = PublishResponseMessage()
 282     pub_r.domino_udid = SERVER_UDID
 283     pub_r.seq_no = self.seqno
 284     pub_r.responseCode = SUCCESS
 285     self.seqno = self.seqno + 1
 286     return pub_r
 287
 288   #Query from Domino Client is received
 289   #Actions:
 290   #
 291   #       - Respond Back with Query Response
 292   def d_query(self, qu_msg):
 293     #Fill in the details
 294     qu_r = QueryResponseMessage()
 295
 296     return qu_r
 297
 298
 299 class DominoServer:
 300    def __init__(self):
 301      self.assignedUUIDs = list()
 302      self.subscribed_labels = dict()
 303      self.subscribed_templateformats = dict()
 304      self.registration_record = dict()
 305      self.communicationHandler = CommunicationHandler(self)
 306      self.processor = Communication.Processor(self.communicationHandler)
 307      self.transport = TSocket.TServerSocket(port=DOMINO_SERVER_PORT)
 308      self.tfactory = TTransport.TBufferedTransportFactory()
 309      self.pfactory = TBinaryProtocol.TBinaryProtocolFactory()
 310      #Use TThreadedServer or TThreadPoolServer for a multithreaded server
 311      #self.communicationServer = TServer.TThreadedServer(self.processor, self.transport, self.tfactory, self.pfactory)
 312      self.communicationServer = TServer.TThreadPoolServer(self.processor, self.transport, self.tfactory, self.pfactory)
 313
 314
 315    def start_communicationService(self):
 316      self.communicationServer.serve()
 317
 318    #For now assign the desired UDID
 319    #To be implemented:
 320    #Check if ID is already assigned and in use
 321    #If not assigned, assign it
 322    #If assigned, offer a new random id
 323    def assign_udid(self, udid_desired):
 324      if udid_desired in self.assignedUUIDs:
 325        new_udid = random.getrandbits(63)
 326        while new_udid in self.assignedUUIDs:
 327          new_udid = random.getrandbits(63)
 328
 329        self.assignedUUIDs.append(new_udid)
 330        return new_udid
 331      else:
 332        self.assignedUUIDs.append(udid_desired)
 333        return udid_desired
 334
 335    def handle_RPC_timeout(self, RPCmessage):
 336      if RPCmessage.messageType == PUSH:
 337       logging.debug('RPC Timeout for message type: PUSH')
 338       # TBD: handle each RPC timeout separately
 339
 340 def main(argv):
 341   server = DominoServer()
 342   loglevel = LOGLEVEL
 343   #process input arguments
 344   try:
 345       opts, args = getopt.getopt(argv,"hc:l:",["conf=","log="])
 346   except getopt.GetoptError:
 347       print 'DominoServer.py -c/--conf <configfile> -l/--log <loglevel>'
 348       sys.exit(2)
 349   for opt, arg in opts:
 350       if opt == '-h':
 351          print 'DominoClient.py -c/--conf <configfile> -p/--port <socketport> -i/--ipaddr <IPaddr> -l/--log <loglevel>'
 352          sys.exit()
 353       elif opt in ("-c", "--conf"):
 354          configfile = arg
 355       elif opt in ("-l", "--log"):
 356          loglevel= arg
 357   #Set logging level
 358   numeric_level = getattr(logging, loglevel.upper(), None)
 359   try:
 360     if not isinstance(numeric_level, int):
 361       raise ValueError('Invalid log level: %s' % loglevel)
 362     logging.basicConfig(filename=logfile,level=numeric_level, format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
 363   except ValueError, ex:
 364     print ex.message
 365     sys.exit(2)
 366
 367   #start the database with schemas
 368   dbconn = sqlite3.connect(SERVER_DBFILE)
 369   c = dbconn.cursor()
 370   try:
 371     c.execute('''CREATE TABLE labels (udid INTEGER PRIMARY KEY, label_list TEXT)''')
 372   except sqlite3.OperationalError as ex:
 373     logging.debug('In database file %s, no table is created as %s', SERVER_DBFILE, ex.message)
 374
 375   try:
 376     c.execute('''CREATE TABLE ttypes (udid INTEGER PRIMARY KEY, ttype_list TEXT)''')
 377   except sqlite3.OperationalError as ex:
 378     logging.debug('In database file %s, no table is created as %s', SERVER_DBFILE, ex.message)
 379
 380   try:
 381     c.execute('''CREATE TABLE clients (udid INTEGER PRIMARY KEY, ipaddr TEXT, tcpport INTEGER, templatetypes TEXT, seqno INTEGER)''')
 382   except sqlite3.OperationalError as ex:
 383     logging.debug('In database file %s, no table is created as %s', SERVER_DBFILE, ex.message)
 384
 385   dbconn.commit()
 386   dbconn.close()
 387
 388   logging.debug('Domino Server Starting...')
 389   server.start_communicationService()
 390   print 'done.'
 391
 392 if __name__ == "__main__":
 393    main(sys.argv[1:])