openvimd.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 ##
   5 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
   6 # This file is part of openvim
   7 # All Rights Reserved.
   8 #
   9 # Licensed under the Apache License, Version 2.0 (the "License"); you may
  10 # not use this file except in compliance with the License. You may obtain
  11 # a copy of the License at
  12 #
  13 #         http://www.apache.org/licenses/LICENSE-2.0
  14 #
  15 # Unless required by applicable law or agreed to in writing, software
  16 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  17 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  18 # License for the specific language governing permissions and limitations
  19 # under the License.
  20 #
  21 # For those usages not covered by the Apache License, Version 2.0 please
  22 # contact with: nfvlabs@tid.es
  23 ##
  24
  25 '''
  26 This is the main program of openvim, it reads the configuration
  27 and launches the rest of threads: http clients, openflow controller
  28 and host controllers
  29 '''
  30
  31 __author__="Alfonso Tierno"
  32 __date__ ="$10-jul-2014 12:07:15$"
  33 __version__="0.5.2-r519"
  34 version_date="Jan 2017"
  35 database_version="0.9"      #expected database schema version
  36
  37 import httpserver
  38 import auxiliary_functions as af
  39 import sys
  40 import getopt
  41 import time
  42 import vim_db
  43 import yaml
  44 import os
  45 from jsonschema import validate as js_v, exceptions as js_e
  46 import host_thread as ht
  47 import dhcp_thread as dt
  48 import openflow_thread as oft
  49 import threading
  50 from vim_schema import config_schema
  51 import logging
  52 import logging.handlers as log_handlers
  53 import imp
  54 import socket
  55
  56 global config_dic
  57 global logger
  58 logger = logging.getLogger('vim')
  59
  60 class LoadConfigurationException(Exception):
  61     pass
  62
  63 def load_configuration(configuration_file):
  64     default_tokens ={'http_port':9080, 'http_host':'localhost',
  65                      'of_controller_nets_with_same_vlan':True,
  66                      'image_path':'/opt/VNF/images',
  67                      'network_vlan_range_start':1000,
  68                      'network_vlan_range_end': 4096,
  69                      'log_level': "DEBUG",
  70                      'log_level_db': "ERROR",
  71                      'log_level_of': 'ERROR',
  72                      'bridge_ifaces': {},
  73                      'network_type': 'ovs',
  74             }
  75     try:
  76         #First load configuration from configuration file
  77         #Check config file exists
  78         if not os.path.isfile(configuration_file):
  79             return (False, "Configuration file '"+configuration_file+"' does not exists")
  80
  81         #Read and parse file
  82         (return_status, code) = af.read_file(configuration_file)
  83         if not return_status:
  84             return (return_status, "Error loading configuration file '"+configuration_file+"': "+code)
  85         try:
  86             config = yaml.load(code)
  87         except yaml.YAMLError, exc:
  88             error_pos = ""
  89             if hasattr(exc, 'problem_mark'):
  90                 mark = exc.problem_mark
  91                 error_pos = " at position: (%s:%s)" % (mark.line+1, mark.column+1)
  92             return (False, "Error loading configuration file '"+configuration_file+"'"+error_pos+": content format error: Failed to parse yaml format")
  93
  94
  95         try:
  96             js_v(config, config_schema)
  97         except js_e.ValidationError, exc:
  98             error_pos = ""
  99             if len(exc.path)>0: error_pos=" at '" + ":".join(map(str, exc.path))+"'"
 100             return False, "Error loading configuration file '"+configuration_file+"'"+error_pos+": "+exc.message
 101
 102
 103         #Check default values tokens
 104         for k,v in default_tokens.items():
 105             if k not in config: config[k]=v
 106         #Check vlan ranges
 107         if config["network_vlan_range_start"]+10 >= config["network_vlan_range_end"]:
 108             return False, "Error invalid network_vlan_range less than 10 elements"
 109
 110     except Exception,e:
 111         return (False, "Error loading configuration file '"+configuration_file+"': "+str(e))
 112     return (True, config)
 113
 114 def create_database_connection(config_dic):
 115     db = vim_db.vim_db( (config_dic["network_vlan_range_start"],config_dic["network_vlan_range_end"]), config_dic['log_level_db'] );
 116     if db.connect(config_dic['db_host'], config_dic['db_user'], config_dic['db_passwd'], config_dic['db_name']) == -1:
 117         logger.error("Cannot connect to database %s at %s@%s", config_dic['db_name'], config_dic['db_user'], config_dic['db_host'])
 118         exit(-1)
 119     return db
 120
 121 def usage():
 122     print "Usage: ", sys.argv[0], "[options]"
 123     print "      -v|--version: prints current version"
 124     print "      -c|--config FILE: loads the configuration file (default: openvimd.cfg)"
 125     print "      -h|--help: shows this help"
 126     print "      -p|--port PORT: changes port number and overrides the port number in the configuration file (default: 908)"
 127     print "      -P|--adminport PORT: changes admin port number and overrides the port number in the configuration file (default: not listen)"
 128     print "      --dbname NAME: changes db_name and overrides the db_name in the configuration file"
 129     #print( "      --log-socket-host HOST: send logs to this host")
 130     #print( "      --log-socket-port PORT: send logs using this port (default: 9022)")
 131     print( "      --log-file FILE: send logs to this file")
 132     return
 133
 134
 135 if __name__=="__main__":
 136     hostname = socket.gethostname()
 137     #streamformat = "%(levelname)s (%(module)s:%(lineno)d) %(message)s"
 138     log_formatter_complete = logging.Formatter(
 139         '%(asctime)s.%(msecs)03d00Z[{host}@openmanod] %(filename)s:%(lineno)s severity:%(levelname)s logger:%(name)s log:%(message)s'.format(host=hostname),
 140         datefmt='%Y-%m-%dT%H:%M:%S',
 141     )
 142     log_format_simple =  "%(asctime)s %(levelname)s  %(name)s %(filename)s:%(lineno)s %(message)s"
 143     log_formatter_simple = logging.Formatter(log_format_simple, datefmt='%Y-%m-%dT%H:%M:%S')
 144     logging.basicConfig(format=log_format_simple, level= logging.DEBUG)
 145     logger = logging.getLogger('openmano')
 146     logger.setLevel(logging.DEBUG)
 147     try:
 148         opts, args = getopt.getopt(sys.argv[1:], "hvc:p:P:", ["config=", "help", "version", "port=", "adminport=", "log-file=", "dbname="])
 149     except getopt.GetoptError, err:
 150         # print help information and exit:
 151         logger.error("%s. Type -h for help", err) # will print something like "option -a not recognized"
 152         #usage()
 153         sys.exit(-2)
 154
 155     port=None
 156     port_admin = None
 157     config_file = 'openvimd.cfg'
 158     log_file = None
 159     db_name = None
 160
 161     for o, a in opts:
 162         if o in ("-v", "--version"):
 163             print "openvimd version", __version__, version_date
 164             print "(c) Copyright Telefonica"
 165             sys.exit(0)
 166         elif o in ("-h", "--help"):
 167             usage()
 168             sys.exit(0)
 169         elif o in ("-c", "--config"):
 170             config_file = a
 171         elif o in ("-p", "--port"):
 172             port = a
 173         elif o in ("-P", "--adminport"):
 174             port_admin = a
 175         elif o in ("-P", "--dbname"):
 176             db_name = a
 177         elif o == "--log-file":
 178             log_file = a
 179         else:
 180             assert False, "Unhandled option"
 181
 182
 183     try:
 184         #Load configuration file
 185         r, config_dic = load_configuration(config_file)
 186         #print config_dic
 187         if not r:
 188             logger.error(config_dic)
 189             config_dic={}
 190             exit(-1)
 191         if log_file:
 192             try:
 193                 file_handler= logging.handlers.RotatingFileHandler(log_file, maxBytes=100e6, backupCount=9, delay=0)
 194                 file_handler.setFormatter(log_formatter_simple)
 195                 logger.addHandler(file_handler)
 196                 #logger.debug("moving logs to '%s'", global_config["log_file"])
 197                 #remove initial stream handler
 198                 logging.root.removeHandler(logging.root.handlers[0])
 199                 print ("logging on '{}'".format(log_file))
 200             except IOError as e:
 201                 raise LoadConfigurationException("Cannot open logging file '{}': {}. Check folder exist and permissions".format(log_file, str(e)) )
 202
 203         logger.setLevel(getattr(logging, config_dic['log_level']))
 204         logger.critical("Starting openvim server command: '%s'", sys.argv[0])
 205         #override parameters obtained by command line
 206         if port:
 207             config_dic['http_port'] = port
 208         if port_admin:
 209             config_dic['http_admin_port'] = port_admin
 210         if db_name:
 211             config_dic['db_name'] = db_name
 212
 213         #check mode
 214         if 'mode' not in config_dic:
 215             config_dic['mode'] = 'normal'
 216             #allow backward compatibility of test_mode option
 217             if 'test_mode' in config_dic and config_dic['test_mode']==True:
 218                 config_dic['mode'] = 'test'
 219         if config_dic['mode'] == 'development' and config_dic['network_type'] == 'bridge' and \
 220                 ( 'development_bridge' not in config_dic or config_dic['development_bridge'] not in config_dic.get("bridge_ifaces",None) ):
 221             logger.error("'%s' is not a valid 'development_bridge', not one of the 'bridge_ifaces'", config_file)
 222             exit(-1)
 223
 224         if config_dic['mode'] != 'normal':
 225             print '!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!'
 226             print "!! Warning, openvimd in TEST mode '%s'" % config_dic['mode']
 227             print '!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!'
 228         config_dic['version'] = __version__
 229
 230     #Connect to database
 231         db_http = create_database_connection(config_dic)
 232         r = db_http.get_db_version()
 233         if r[0]<0:
 234             logger.error("DATABASE is not a VIM one or it is a '0.0' version. Try to upgrade to version '%s' with './database_utils/migrate_vim_db.sh'", database_version)
 235             exit(-1)
 236         elif r[1]!=database_version:
 237             logger.error("DATABASE wrong version '%s'. Try to upgrade/downgrade to version '%s' with './database_utils/migrate_vim_db.sh'", r[1], database_version)
 238             exit(-1)
 239         db_of = create_database_connection(config_dic)
 240         db_lock= threading.Lock()
 241         config_dic['db'] = db_of
 242         config_dic['db_lock'] = db_lock
 243
 244     #precreate interfaces; [bridge:<host_bridge_name>, VLAN used at Host, uuid of network camping in this bridge, speed in Gbit/s
 245         config_dic['dhcp_nets']=[]
 246         config_dic['bridge_nets']=[]
 247         for bridge,vlan_speed in config_dic["bridge_ifaces"].items():
 248             #skip 'development_bridge'
 249             if config_dic['mode'] == 'development' and config_dic['development_bridge'] == bridge:
 250                 continue
 251             config_dic['bridge_nets'].append( [bridge, vlan_speed[0], vlan_speed[1], None] )
 252         del config_dic["bridge_ifaces"]
 253
 254         #check if this bridge is already used (present at database) for a network)
 255         used_bridge_nets=[]
 256         for brnet in config_dic['bridge_nets']:
 257             r,nets = db_of.get_table(SELECT=('uuid',), FROM='nets',WHERE={'provider': "bridge:"+brnet[0]})
 258             if r>0:
 259                 brnet[3] = nets[0]['uuid']
 260                 used_bridge_nets.append(brnet[0])
 261                 if config_dic.get("dhcp_server"):
 262                     if brnet[0] in config_dic["dhcp_server"]["bridge_ifaces"]:
 263                         config_dic['dhcp_nets'].append(nets[0]['uuid'])
 264         if len(used_bridge_nets) > 0 :
 265             logger.info("found used bridge nets: " + ",".join(used_bridge_nets))
 266         #get nets used by dhcp
 267         if config_dic.get("dhcp_server"):
 268             for net in config_dic["dhcp_server"].get("nets", () ):
 269                 r,nets = db_of.get_table(SELECT=('uuid',), FROM='nets',WHERE={'name': net})
 270                 if r>0:
 271                     config_dic['dhcp_nets'].append(nets[0]['uuid'])
 272
 273     # get host list from data base before starting threads
 274         r,hosts = db_of.get_table(SELECT=('name','ip_name','user','uuid'), FROM='hosts', WHERE={'status':'ok'})
 275         if r<0:
 276             logger.error("Cannot get hosts from database %s", hosts)
 277             exit(-1)
 278     # create connector to the openflow controller
 279         of_test_mode = False if config_dic['mode']=='normal' or config_dic['mode']=="OF only" else True
 280
 281         if of_test_mode:
 282             OF_conn = oft.of_test_connector({"of_debug": config_dic['log_level_of']} )
 283         else:
 284             #load other parameters starting by of_ from config dict in a temporal dict
 285             temp_dict={ "of_ip":  config_dic['of_controller_ip'],
 286                         "of_port": config_dic['of_controller_port'],
 287                         "of_dpid": config_dic['of_controller_dpid'],
 288                         "of_debug":   config_dic['log_level_of']
 289                 }
 290             for k,v in config_dic.iteritems():
 291                 if type(k) is str and k[0:3]=="of_" and k[0:13] != "of_controller":
 292                     temp_dict[k]=v
 293             if config_dic['of_controller']=='opendaylight':
 294                 module = "ODL"
 295             elif "of_controller_module" in config_dic:
 296                 module = config_dic["of_controller_module"]
 297             else:
 298                 module = config_dic['of_controller']
 299             module_info=None
 300             try:
 301                 module_info = imp.find_module(module)
 302
 303                 OF_conn = imp.load_module("OF_conn", *module_info)
 304                 try:
 305                     OF_conn = OF_conn.OF_conn(temp_dict)
 306                 except Exception as e:
 307                     logger.error("Cannot open the Openflow controller '%s': %s", type(e).__name__, str(e))
 308                     if module_info and module_info[0]:
 309                         file.close(module_info[0])
 310                     exit(-1)
 311             except (IOError, ImportError) as e:
 312                 if module_info and module_info[0]:
 313                     file.close(module_info[0])
 314                 logger.error("Cannot open openflow controller module '%s'; %s: %s; revise 'of_controller' field of configuration file.", module, type(e).__name__, str(e))
 315                 exit(-1)
 316
 317
 318     #create openflow thread
 319         thread = oft.openflow_thread(OF_conn, of_test=of_test_mode, db=db_of,  db_lock=db_lock,
 320                         pmp_with_same_vlan=config_dic['of_controller_nets_with_same_vlan'],
 321                         debug=config_dic['log_level_of'])
 322         r,c = thread.OF_connector.obtain_port_correspondence()
 323         if r<0:
 324             logger.error("Cannot get openflow information %s", c)
 325             exit()
 326         thread.start()
 327         config_dic['of_thread'] = thread
 328
 329     #create dhcp_server thread
 330         host_test_mode = True if config_dic['mode']=='test' or config_dic['mode']=="OF only" else False
 331         dhcp_params = config_dic.get("dhcp_server")
 332         if dhcp_params:
 333             thread = dt.dhcp_thread(dhcp_params=dhcp_params, test=host_test_mode, dhcp_nets=config_dic["dhcp_nets"], db=db_of,  db_lock=db_lock, debug=config_dic['log_level_of'])
 334             thread.start()
 335             config_dic['dhcp_thread'] = thread
 336
 337
 338     #Create one thread for each host
 339         host_test_mode = True if config_dic['mode']=='test' or config_dic['mode']=="OF only" else False
 340         host_develop_mode = True if config_dic['mode']=='development' else False
 341         host_develop_bridge_iface = config_dic.get('development_bridge', None)
 342         config_dic['host_threads'] = {}
 343         for host in hosts:
 344             host['image_path'] = '/opt/VNF/images/openvim'
 345             thread = ht.host_thread(name=host['name'], user=host['user'], host=host['ip_name'], db=db_of, db_lock=db_lock,
 346                     test=host_test_mode, image_path=config_dic['image_path'], version=config_dic['version'],
 347                     host_id=host['uuid'], develop_mode=host_develop_mode, develop_bridge_iface=host_develop_bridge_iface  )
 348             thread.start()
 349             config_dic['host_threads'][ host['uuid'] ] = thread
 350
 351
 352
 353     #Create thread to listen to web requests
 354         http_thread = httpserver.httpserver(db_http, 'http', config_dic['http_host'], config_dic['http_port'], False, config_dic)
 355         http_thread.start()
 356
 357         if 'http_admin_port' in config_dic:
 358             db_http = create_database_connection(config_dic)
 359             http_thread_admin = httpserver.httpserver(db_http, 'http-admin', config_dic['http_host'], config_dic['http_admin_port'], True)
 360             http_thread_admin.start()
 361         else:
 362             http_thread_admin = None
 363         time.sleep(1)
 364         logger.info('Waiting for http clients')
 365         print ('openvimd ready')
 366         print ('====================')
 367         sys.stdout.flush()
 368
 369         #TODO: Interactive console would be nice here instead of join or sleep
 370
 371         r="help" #force print help at the beginning
 372         while True:
 373             if r=='exit':
 374                 break
 375             elif r!='':
 376                 print "type 'exit' for terminate"
 377             r = raw_input('> ')
 378
 379     except (KeyboardInterrupt, SystemExit):
 380         pass
 381     except SystemExit:
 382         pass
 383     except getopt.GetoptError as e:
 384         logger.critical(str(e)) # will print something like "option -a not recognized"
 385         #usage()
 386         exit(-1)
 387     except LoadConfigurationException as e:
 388         logger.critical(str(e))
 389         exit(-1)
 390
 391     logger.info('Exiting openvimd')
 392     threads = config_dic.get('host_threads', {})
 393     if 'of_thread' in config_dic:
 394         threads['of'] = (config_dic['of_thread'])
 395     if 'dhcp_thread' in config_dic:
 396         threads['dhcp'] = (config_dic['dhcp_thread'])
 397
 398     for thread in threads.values():
 399         thread.insert_task("exit")
 400     for thread in threads.values():
 401         thread.join()
 402     #http_thread.join()
 403     #if http_thread_admin is not None:
 404     #http_thread_admin.join()
 405     logger.debug( "bye!")
 406     exit()
 407