openstack-nova源码分析(二）断点调试方法

我会带着你远行 2022-02-25 04:12 408阅读 0赞

openstack源码分析, 有时候看源代码还是存在一定疑问，那么远程调试源代码就非常有必须要， 这里是使用pycham调试nova代码的一种方法

#### 一. 下载源代码 ####

openstack各个版本的源码列表网址：

https://releases.openstack.org/index.html

这里以下载O版为例：

进入–> `https://releases.openstack.org/index.html`  
—> `Release Series (版本列表)`—> `Ocata`—>`Service Projects`—> `nova`—> 选择一个版本下载（这里选择最新的15.1.5版本下载）

nova 源码其他获取地址：

https://github.com/openstack/nova/releases

https://releases.openstack.org/rocky/?_ga=2.80636691.582651414.1553938910-375997408.1539443417#nova

#### 二. 调试环境配置 ####

1.  pycharm 软件目录下 debug-eggs目录的pycharm-debug.egg拷贝到远程主机：

如：E:\\Program Files\\JetBrains\\PyCharm\\debug-eggs

1.  在远程主机centos上安装：

easy_install pycharm-debug.egg

[root@nova ~]# easy_install pycharm-debug.egg 
    Processing pycharm-debug.egg
    creating /usr/lib/python2.7/site-packages/pycharm-debug.egg
    Extracting pycharm-debug.egg to /usr/lib/python2.7/site-packages
    Adding pycharm debug to easy-install.pth file
    
    Installed /usr/lib/python2.7/site-packages/pycharm-debug.egg
    Processing dependencies for pycharm===debug
    Finished processing dependencies for pycharm===debug
    [root@nova ~]#

1.  pycharm配置远程调试  
    在pycharm中选项 Run -> Edit configurations -> + (+号) -> python remote debug -> 配置参数

NAME：novaDebug
    IP: 本地主机ip （要求虚拟机可以访问的本地主机ip， 这里是虚拟机，因此配置本地连接虚拟机的网卡ip： 192.168.137.1）
    port：56789

![在这里插入图片描述][20190331185910463.gif]  
mapping配置本地代码与远程代码的映射

如： d:/nova ---- /usr/lib/python2.7/site-packages/nova

1.  pycharm启动远程debug监听远程调试：  
    出现：

Starting debug server at port 56789
    Waiting for process connection...
    Use the following code to connect to the debugger:
    import pydevd
    pydevd.settrace('192.168.137.1', port=56789, stdoutToServer=True, stderrToServer=True)

1.  远程linux主机代码修改：

**由于nova底层使用使用的eventlet多线程（协程），对于debug调试有时候无法捕获对应线程，因此需要在单线程下进行调试。**  
解决此问题参考如下：

grep -rn 'eventlet.monkey_patch'  /usr/lib/python2.6/site-packages/nova
    vi /usr/lib/python2.7/site-packages/nova/cmd/__init__.py

更新else后的eventlet.monkey\_patch(os=False)

from nova import debugger
    
    if debugger.enabled():
        # turn off thread patching to enable the remote debugger
        eventlet.monkey_patch(os=False, thread=False)
    else:
        eventlet.monkey_patch(os=False, thread=False)

**接下来以调试flavor为例**

在本地pycharm 设置断点：

api\openstack\compute\flavor.py

找到对应list的函数， 在limited\_flavors处设置断点

class FlavorsController(wsgi.Controller):
         ····
    
        @extensions.expected_errors(404)
        def show(self, req, id):
            """Return data about the given flavor id."""
            context = req.environ['nova.context']
            try:
                flavor = flavors.get_flavor_by_flavor_id(id, ctxt=context)
                req.cache_db_flavor(flavor)
            except exception.FlavorNotFound as e:
    						...

1.  将如下代码， 添加到需要调试的远程代码的源码处

import pydevd
    pydevd.settrace('192.168.137.1', port=56789, stdoutToServer=True, stderrToServer=True)

例如：

flavor对应的文件为：

vi /usr/lib/python2.7/site-packages/nova/api/openstack/compute/flavors.py

修改后代码：

class FlavorsController(wsgi.Controller):
    		... 
    		
        @extensions.expected_errors(404)
        def show(self, req, id):
            """Return data about the given flavor id."""
            context = req.environ['nova.context']
            try:
                flavor = flavors.get_flavor_by_flavor_id(id, ctxt=context)
                import pydevd
                 pydevd.settrace('192.168.137.1', port=56789, stdoutToServer=True, stderrToServer=True)
                req.cache_db_flavor(flavor)
            except exception.FlavorNotFound as e:
                raise webob.exc.HTTPNotFound(explanation=e.format_message())

清理编译文件：

[root@nova compute]# rm -f /usr/lib/python2.7/site-packages/nova/api/openstack/compute/flavors.pyc
    [root@nova compute]# rm -f /usr/lib/python2.7/site-packages/nova/api/openstack/compute/flavors.pyo

1.  重启nova服务nova-api、nova-compute(这里可以不重启)

systemctl restart openstack-nova-api.service
    
    systemctl restart openstack-nova-compute.service

1.  调试：  
    加载环境变量：

[root@nova ~]# source ~/admin-openrc.sh

在命令行中输入， nova flavor-show 进行断点调试：

[root@nova ~]# nova flavor-show f35936d6-8e16-4f92-b8b8-1d31ace8f33b

进入断点， 配置成功

[20190331185910463.gif]: /images/20220225/aa97b4afeb0e48a5bb7523ad445e0f23.png