openstack中rpc远程调用代码方法示例

本篇文章小编给大家分享一下openstack中rpc远程调用代码方法示例，文章代码介绍的很详细，小编觉得挺不错的，现在分享给大家供大家参考，有需要的小伙伴们可以来看看。

众所周知，OpenStack的通信方式有两种，一种是基于HTTP协议的RESTFul API方式，另一种则是RPC调用。两种通信方式的应用场景有所不同，在OpenStack中，前者主要用于各组件之间的通信（如nova与glance的通信），而后者则用于同一组件中各个不同模块之间的通信（如nova组件中nova-compute与nova-scheduler的通信）。

nova中rpc调用非常多，用pycharm点点点跟函数的时候遇到rpc就会点不下去了，不解决直接就看不下去了那种多法

什么是 RPC

看不明白这个图对于看nova代码，其实不是很重要，直接忽略以后再看也可以，当务之急是解决一下看openstack代码遇到rpc就跟丢了的问题

RPC、消息队列、RESTful

这三个其实不是一个层面的东西，本质上不应该放在一起比，但是因为都用来通信，比较容易混淆就还是解释一下

RESTful：主要用于各组件之间的通信（比如nova与glance的通信），或者说用于组件对外提供调用接口

RPC：则用于同一组件中各个不同模块之间的通信（比如nova组件中nova-compute与-nova-scheduler的通信）

消息队列：用于解耦组件，也是组件间通信用的，而且会有一个队列用来暂存消息

在nova中的典型rpc

nova/nova/nova/conductor/tasks/live_migrate.py

class LiveMigrationTask(base.TaskBase):
    def __init__(self, context, instance, destination,
                 block_migration, disk_over_commit, migration, compute_rpcapi,
                 servicegroup_api, scheduler_client):
        super(LiveMigrationTask, self).__init__(context, instance)
    ... 

    def _execute(self):
        self._check_instance_is_active()
        self._check_host_is_up(self.source)

        if not self.destination:
            self.destination = self._find_destination()
            self.migration.dest_compute = self.destination
            self.migration.save()
        else:
            self._check_requested_destination()

        # TODO(johngarbutt) need to move complexity out of compute manager
        # TODO(johngarbutt) disk_over_commit?

        #调用 ComputeAPI 类中的 live_migration() RPC接口
        return self.compute_rpcapi.live_migration(self.context,
                host=self.source,
                instance=self.instance,
                dest=self.destination,
                block_migration=self.block_migration,
                migration=self.migration,
                migrate_data=self.migrate_data)

conductor以compute_rpcapi.live_migration的方式远程调用compute的live_migration,过程就是,conductor以RPC的方式发出一个请求到Queue再被nova-compute接收

nova/nova/nova/compute/rpcapi.py

class ComputeAPI(object):

    # 这是一个RPC远程调用的方法
    def live_migration(self, ctxt, instance, dest, block_migration, host,
                       migration, migrate_data=None):
        args = {'migration': migration}
        version = '4.2'
        if not self.client.can_send_version(version):
            version = '4.0'

        # 获取目标 compute 主机(DEST HOST)的RPC client，即被调用的服务进程的HostIP
        cctxt = self.client.prepare(server=host, version=version)

        # 通过目标主机对象的 RPC cliient 来调用远程过程方法 cast() ，以此来实现远程调用
        cctxt.cast(ctxt, 'live_migration', instance=instance,
                   dest=dest, block_migration=block_migration,
                   migrate_data=migrate_data, **args)
        # cast()异步远程调用，不会阻塞别的进程，适合于需要长时间进行的执行过程
        # cast()的第二个参数是RPC client调用的函数名，case()后面的参数会继续作为参数传入该调用函数
        # cast()函数内的live_migration()函数是 manager.live_migration() 视具体实现迁移功能的函数，在manager.py内实现。

调用的时候是从nova/nova/conductor/tasks/live_migrate.py到nova/nova/compute/rpcapi.py，但是实际上是compute服务首先得在rpcapi.py提供出接口函数，然后使用者通过

- 1.import导入的方式去使用rpc调用

- 2.类实例化传参的方式去引入

热迁移这里用的就是类实例化传参

tip: call()表示同步调用 和 cast()表示异步调用

根据在rpc.py或者rpcapi.py中的cast()的第二个参数,去该服务下的manager.py中找和这个参数同名的函数（这个就是rpc最终想要调用的函数），我们这里是compute_rpcapi，所以要去找compute下的mannager.py

为什么要去找mannager，是因为nova.compute.manager 会一直监听 Queue ，当Queue中存在相关的 RPC 请求时，就去完成这个请求

nova/nova/nova/compute/manager.py

@wrap_exception()
    @wrap_instance_event(prefix='compute')
    @wrap_instance_fault
    def live_migration(self, context, dest, instance, block_migration,
                       migration, migrate_data):
        """执行实时迁移。

        :param context: security context
        :param dest: destination host
        :param instance: a nova.objects.instance.Instance object
        :param block_migration: if true, prepare for block migration
        :param migration: an nova.objects.Migration object
        :param migrate_data: implementation specific params

        """
        self._set_migration_status(migration, 'queued')

        def dispatch_live_migration(*args, **kwargs):
            with self._live_migration_semaphore:
                # 调用_do_live_migration执行迁移
                self._do_live_migration(*args, **kwargs)

        # NOTE(danms): We spawn here to return the RPC worker thread back to
        # the pool. Since what follows could take a really long time, we don't
        # want to tie up RPC workers.
        utils.spawn_n(dispatch_live_migration,
                      context, dest, instance,
                      block_migration, migration,
                      migrate_data)

当然实际干活的还不是manager.py的def live_migration，而是live_migration函数去调用_do_live_migration，但是之后的就是热迁移的流程，在之前的文档里写了就不展开了，反正rpc的体现就只到这里

冷迁移中还有很多例子，不一一列举了，有兴趣可以去看冷迁移源码分析这篇博客

看完例子会发现，既然原生的代码既然已经写了rpc调用，那么对应的服务肯定已经提供了rpc接口，所以实际上看到compute_rpcapi，可以不去compute下的rpc文件中找了，直接去compute下的manager看具体实现(不止compute，其他服务也一样)，当然，如果需要雪确定是同步还是异步调用那还是不要偷这一步的懒。