SourceInsight 精确导入Linux kernel源码的方法

2022-12-23,,,

相信有很多人用 SourceInsight 查看 Linux Kernel 源码,但导入源码时会遇到一些问题。
1、如果把整个源码树都导入进去,查看符号定义的时候,会发现有大量重复定义,很难找到正确的位置
2、如果手动导入只和该硬件平台相关的源码,工作量太大
本帖提供了一个方法,可用脚本生成只和该硬件平台相关的源码的文件列表,然后通过该文件列表,将相应文件导入 SourceInsight 。
以下是步骤,共4步:
1、新建 SourceInsight 项目
     先不要导入文件,停在如下界面:
    

2、完整编译内核,将编译时输出的信息保存到一个文件中
    例如:

    make ARCH=arm > build_log.txt

build_log.txt 文件中内容大致如下:

    CC      init/main.o
    CHK     include/generated/compile.h
    CC      init/do_mounts.o
    HOSTCC  usr/gen_init_cpio
    CC      arch/arm/vfp/vfpmodule.o
    CC      arch/arm/kernel/elf.o
    AS      arch/arm/kernel/entry-armv.o
    AS      arch/arm/vfp/entry.o
    AS      arch/arm/kernel/entry-common.o
    CC      arch/arm/kernel/irq.o
    AS      arch/arm/vfp/vfphw.o
    GEN     usr/initramfs_data.cpio
    CC      arch/arm/kernel/opcodes.o

3、生成文件列表
     下载 帖子 最后面的附件,解压后是 linux shell 脚本。
    编辑脚本两个变量,ARCH 和 MACH,MACH是平台的名字。如果你用的平台对应 arch/arm/mach-at91 的话,就改成 MACH=at91,以此类推。
           
    在内核源码目录下执行:

    ./sg.sh build_log.txt file_list.txt

复制代码

这样,SourceInsight 需要的 文件列表 file_list.txt 就生成了。里面的内容大致如下:
      

4、导入文件列表
     回到 SourceInsight,点击窗口右下角 help 按钮上方的 “add from list” 按钮导入生成的 file_list.txt 文件。
       
     到此为止,文件导入完成了。重新打开工程,会提示同步、构建,之后就可以正常的查看源码了。

这样导入的文件和硬件平台是完全对应的。
下面是本帖的核心,就是这个脚本,有兴趣的可以看看:

    #!/bin/sh
    ARCH=arm
    MACH=at91
    FILE_IN=$1
    FILE_OUT=$2
    # .c
    SOURCE_LIST=""
    # generated file list
    FILE_LIST=""
    # nest depth for function get_includes()
    NEST_DTPTH=0
    # recursive function, used to get included files from files.
    # result is stored in FILE_LIST
    # $1 : file list, e.g. "fs/ext4/file.c fs/ext4/fsync.c"
    get_includes()
    {
    local includes
    local file
    for file in $1
    do
    if [ ! -e ${file} ]; then
    continue
    fi
    if echo "${FILE_LIST}" | grep -E ${file} > /dev/null; then
    continue
    fi
    FILE_LIST="${FILE_LIST} ${file}"
    NEST_DTPTH=$((NEST_DTPTH+1))
    echo "<${NEST_DTPTH} : ${file}"
    includes=$(                                                                                \
    grep -E -H '^#include' ${file} |                                \
    sed -r \
    -e 's@^.*<(acpi/.*)>@include/\1@'                 \
    -e 's@^.*<(asm-generic/.*)>@include/\1@'\
    -e 's@^.*<(config/.*)>@include/\1@'         \
    -e 's@^.*<(crypto/.*)>@include/\1@'         \
    -e 's@^.*<(drm/.*)>@include/\1@'                 \
    -e 's@^.*<(generated/.*)>@include/\1@'         \
    -e 's@^.*<(keys/.*)>@include/\1@'                 \
    -e 's@^.*<(linux/.*)>@include/\1@'                 \
    -e 's@^.*<(math-emu/.*)>@include/\1@'         \
    -e 's@^.*<(media/.*)>@include/\1@'                 \
    -e 's@^.*<(misc/.*)>@include/\1@'                 \
    -e 's@^.*<(mtd/.*)>@include/\1@'                 \
    -e 's@^.*<(net/.*)>@include/\1@'                 \
    -e 's@^.*<(pcmcia/.*)>@include/\1@'         \
    -e 's@^.*<(rdma/.*)>@include/\1@'                 \
    -e 's@^.*<(rxrpc/.*)>@include/\1@'                 \
    -e 's@^.*<(scsi/.*)>@include/\1@'                 \
    -e 's@^.*<(sound/.*)>@include/\1@'                 \
    -e 's@^.*<(target/.*)>@include/\1@'         \
    -e 's@^.*<(trace/.*)>@include/\1@'                 \
    -e 's@^.*<(uapi/.*)>@include/\1@'                 \
    -e 's@^.*<(video/.*)>@include/\1@'                 \
    -e 's@^.*<(xen/.*)>@include/\1@'                 \
    -e "s@^.*<(asm/.*)>@arch/${ARCH}/include/\1 arch/${ARCH}/include/generated/\1@"        \
    -e "s@^.*<(mach/.*)>@arch/${ARCH}/mach-${MACH}/include/\1@"        \
    -e 's@(^.*/)[^/]+\.c.*\"(.*)\"@\1\2@'         \
    -e 's@/\*.*@@'                                                         \
    -e 's@^.*\#include.*$@@'                                  \
    -e 's@^@ @' |                                                        \
    sort |                                                                                 \
    uniq |                                                                                \
    tr -d '\n' |                                                                 \
    tr -d '\r'                                                                        \
    )
    if [ -n "${includes}" ]; then
    get_includes "${includes}"
    fi
    echo ">${NEST_DTPTH}) : ${file}"
    NEST_DTPTH=$((NEST_DTPTH-1))
    done
    }
    # get *.c from kernel build log
    SOURCE_LIST=$(                                                \
    grep -E '^\s*CC' ${FILE_IN} |        \
    sed -r                                                         \
    -e 's/^\s*CC\s*/ /'                        \
    -e 's/\.o/\.c/'                        |        \
    tr -d '\n' |                                         \
    tr -d '\r'                                                \
    )
    echo ${SOURCE_LIST}
    get_includes "${SOURCE_LIST}"
    FILE_LIST=$(echo "${FILE_LIST}" | sed -r -e 's/\s/\r\n/g' )
    echo "${FILE_LIST}" > ${FILE_OUT}

SourceInsight 精确导入Linux kernel源码的方法的相关教程结束。

《SourceInsight 精确导入Linux kernel源码的方法.doc》

下载本文的Word格式文档,以方便收藏与打印。