2 Star 2 Fork 0

laokz / klpmake

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MulanPSL-2.0

KLPMAKE

Inspired by KPATCH @ https://github.com/dynup/kpatch. Many thanks!

Klpmake 是Linux内核热补丁制作工具,它调用编译工具链,将用户的补丁文件生成为“部分链接”的目标文件,对其中的Livepatch Symbols -- non-exported global symbols and non-included local symbols进行修正,最终生成符合Livepatch module ELF format的内核模块。

Klpmake以内核samples/livepatch/livepatch-sample.c为模板,通过.patch文件自动生成补丁模块源码。再通过内核和模块DWARF信息及/proc/kallsyms/proc/modules,可靠解析定位Livepatch Symbols。制作时不编译内核,不深入hacking ELF格式,也基本架构无关。

Klpmake小、简单、快,支持对内核及已加载的模块打补丁。

当前主要针对的是openEuler操作系统。

用法

软件依赖及编译

软件依赖libdwarf(>=0.8.0)、libclang、elfutils-libelf(gelf)、bash及一些coreutils工具。运行时需要内核/模块源码、debuginfo文件(DWARF4格式)。热补丁模块制作过程与常规模块基本相同,需要内核的编译构建基础设施。一些依赖库的安装命令:

sudo dnf install clang-libs clang-devel libdwarf-devel elfutils-libelf-devel bash

不同的发行版,软件安装的目录可能不同。在编译klpmake前请检查并修改当前还很简陋的config.h和Makefile内容,然后:

make

Klpmake由klpmake(主入口)、klpsrc、fixklp三个可执行文件组成。

运行

创建工作目录,目录名将作为热补丁的模块名;将补丁文件放到工作目录下,执行:

sudo klpmake-dir/klpmake -s source-tree-root -b debuginfo-tree-root

source-tree-root是源码树根目录,debuginfo-tree-root是包含debuginfo文件的根目录,如vmlinux、*.ko.debug等。

建议分步执行klpmake,这样可以检查确认每步的结果是否正确是否符合预期,并可以根据需要增加hook功能等。用法见klpmake的Usage。

生成的文件

  • livepatch.c 补丁模块主文件
  • *.c 补丁模块其它文件
  • Makefile 补丁模块Makefile,以上文件由klpsrc生成
  • *.ko 最终生成的补丁模块
  • _klpsrc.conf 补丁基本信息,klpmake生成,klpsrc使用
  • _klpmake.syms KLPSYMs位置信息,klpsrc生成,fixklp使用
  • *.c.patched 打补丁后的源码文件
  • *.ko.patial “部分链接”的补丁,内核编译工具生成,fixklp使用

示例

example

局限

  • 查找源码所属模块时,依赖同目录下Makefile严格的代码模式匹配(klpmake)
  • 查找修改的函数时,依赖严格的.patch代码模式匹配(klpmake)
  • 只支持一个.patch文件(klpmake、klpsrc)
  • 不支持检测基于ftrace livepatch机制的函数打补丁条件(klpmake、klpsrc)
  • 定义在头文件或函数内的static变量均被视为新变量(klpsrc)
  • 不支持对可变参数的函数打补丁(klpsrc)
  • 内核/模块二进制必须有DWARF4信息,有.debug_info和,.debug_aranges或.debug_ranges节(klpsrc)
  • 不支持同一源文件中的static变量重名或与extern变量重名(klpsrc)
  • 不支持不同源文件的non-included static符号、被补丁函数重名(klpsrc、fixklp)
  • 未考虑KSYM_NAME_LEN(512)符号名长度限制(klpsrc、fixklp)
关于DWARF信息

社区有对DWARF信息可靠性的担心,这里列出klpmake用到的:

  • 定位函数符号:DW_TAG_compile_unit的DW_AT_name、DW_AT_low_pc、DW_AT_high_pc、DW_AT_ranges
  • 定位函数符号(当前仅作info用):DW_TAG_subprogram的DW_AT_name、DW_AT_low_pc、DW_AT_decl_line
  • 定位变量符号:DW_TAG_variable的DW_AT_name、DW_AT_location、DW_AT_decl_line(当前仅作info用)

用tools目录下的工具,比对vmlinux中的DWARF和kallsyms中的变量名字、地址:

架构 kallsyms数量(非t/T) DWARF数量 DWARF不匹配kallsyms数量 kallsyms去掉.xxx后
x86-64 49919 28989 5846 305
riscv64 53100 44225 5710 25
aarch64 46259 25680 5202 47

因为函数内定义的static变量名字会后缀.123,因此单纯从数量上看,不匹配率基本小于1%。具体分析,DWARF会生成一些弱符号的地址,,

工具是在riscv64平台上开发和测试的,刚刚迈出一小步...

非常期待你的试用与反馈!非常欢迎hacker来指点贡献!

木兰宽松许可证, 第2版 木兰宽松许可证, 第2版 2020年1月 http://license.coscl.org.cn/MulanPSL2 您对“软件”的复制、使用、修改及分发受木兰宽松许可证,第2版(“本许可证”)的如下条款的约束: 0. 定义 “软件”是指由“贡献”构成的许可在“本许可证”下的程序和相关文档的集合。 “贡献”是指由任一“贡献者”许可在“本许可证”下的受版权法保护的作品。 “贡献者”是指将受版权法保护的作品许可在“本许可证”下的自然人或“法人实体”。 “法人实体”是指提交贡献的机构及其“关联实体”。 “关联实体”是指,对“本许可证”下的行为方而言,控制、受控制或与其共同受控制的机构,此处的控制是指有受控方或共同受控方至少50%直接或间接的投票权、资金或其他有价证券。 1. 授予版权许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的版权许可,您可以复制、使用、修改、分发其“贡献”,不论修改与否。 2. 授予专利许可 每个“贡献者”根据“本许可证”授予您永久性的、全球性的、免费的、非独占的、不可撤销的(根据本条规定撤销除外)专利许可,供您制造、委托制造、使用、许诺销售、销售、进口其“贡献”或以其他方式转移其“贡献”。前述专利许可仅限于“贡献者”现在或将来拥有或控制的其“贡献”本身或其“贡献”与许可“贡献”时的“软件”结合而将必然会侵犯的专利权利要求,不包括对“贡献”的修改或包含“贡献”的其他结合。如果您或您的“关联实体”直接或间接地,就“软件”或其中的“贡献”对任何人发起专利侵权诉讼(包括反诉或交叉诉讼)或其他专利维权行动,指控其侵犯专利权,则“本许可证”授予您对“软件”的专利许可自您提起诉讼或发起维权行动之日终止。 3. 无商标许可 “本许可证”不提供对“贡献者”的商品名称、商标、服务标志或产品名称的商标许可,但您为满足第4条规定的声明义务而必须使用除外。 4. 分发限制 您可以在任何媒介中将“软件”以源程序形式或可执行形式重新分发,不论修改与否,但您必须向接收者提供“本许可证”的副本,并保留“软件”中的版权、商标、专利及免责声明。 5. 免责声明与责任限制 “软件”及其中的“贡献”在提供时不带任何明示或默示的担保。在任何情况下,“贡献者”或版权所有者不对任何人因使用“软件”或其中的“贡献”而引发的任何直接或间接损失承担责任,不论因何种原因导致或者基于何种法律理论,即使其曾被建议有此种损失的可能性。 6. 语言 “本许可证”以中英文双语表述,中英文版本具有同等法律效力。如果中英文版本存在任何冲突不一致,以中文版为准。 条款结束 如何将木兰宽松许可证,第2版,应用到您的软件 如果您希望将木兰宽松许可证,第2版,应用到您的新软件,为了方便接收者查阅,建议您完成如下三步: 1, 请您补充如下声明中的空白,包括软件名、软件的首次发表年份以及您作为版权人的名字; 2, 请您在软件包的一级目录下创建以“LICENSE”为名的文件,将整个许可证文本放入该文件中; 3, 请将如下声明文本放入每个源文件的头部注释中。 Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details. Mulan Permissive Software License,Version 2 Mulan Permissive Software License,Version 2 (Mulan PSL v2) January 2020 http://license.coscl.org.cn/MulanPSL2 Your reproduction, use, modification and distribution of the Software shall be subject to Mulan PSL v2 (this License) with the following terms and conditions: 0. Definition Software means the program and related documents which are licensed under this License and comprise all Contribution(s). Contribution means the copyrightable work licensed by a particular Contributor under this License. Contributor means the Individual or Legal Entity who licenses its copyrightable work under this License. Legal Entity means the entity making a Contribution and all its Affiliates. Affiliates means entities that control, are controlled by, or are under common control with the acting entity under this License, ‘control’ means direct or indirect ownership of at least fifty percent (50%) of the voting power, capital or other securities of controlled or commonly controlled entity. 1. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable copyright license to reproduce, use, modify, or distribute its Contribution, with modification or not. 2. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to you a perpetual, worldwide, royalty-free, non-exclusive, irrevocable (except for revocation under this Section) patent license to make, have made, use, offer for sale, sell, import or otherwise transfer its Contribution, where such patent license is only limited to the patent claims owned or controlled by such Contributor now or in future which will be necessarily infringed by its Contribution alone, or by combination of the Contribution with the Software to which the Contribution was contributed. The patent license shall not apply to any modification of the Contribution, and any other combination which includes the Contribution. If you or your Affiliates directly or indirectly institute patent litigation (including a cross claim or counterclaim in a litigation) or other patent enforcement activities against any individual or entity by alleging that the Software or any Contribution in it infringes patents, then any patent license granted to you under this License for the Software shall terminate as of the date such litigation or activity is filed or taken. 3. No Trademark License No trademark license is granted to use the trade names, trademarks, service marks, or product names of Contributor, except as required to fulfill notice requirements in Section 4. 4. Distribution Restriction You may distribute the Software in any medium with or without modification, whether in source or executable forms, provided that you provide recipients with a copy of this License and retain copyright, patent, trademark and disclaimer statements in the Software. 5. Disclaimer of Warranty and Limitation of Liability THE SOFTWARE AND CONTRIBUTION IN IT ARE PROVIDED WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED. IN NO EVENT SHALL ANY CONTRIBUTOR OR COPYRIGHT HOLDER BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO ANY DIRECT, OR INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING FROM YOUR USE OR INABILITY TO USE THE SOFTWARE OR THE CONTRIBUTION IN IT, NO MATTER HOW IT’S CAUSED OR BASED ON WHICH LEGAL THEORY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 6. Language THIS LICENSE IS WRITTEN IN BOTH CHINESE AND ENGLISH, AND THE CHINESE VERSION AND ENGLISH VERSION SHALL HAVE THE SAME LEGAL EFFECT. IN THE CASE OF DIVERGENCE BETWEEN THE CHINESE AND ENGLISH VERSIONS, THE CHINESE VERSION SHALL PREVAIL. END OF THE TERMS AND CONDITIONS How to Apply the Mulan Permissive Software License,Version 2 (Mulan PSL v2) to Your Software To apply the Mulan PSL v2 to your work, for easy identification by recipients, you are suggested to complete following three steps: i Fill in the blanks in following statement, including insert your software name, the year of the first publication of your software, and your name identified as the copyright owner; ii Create a file named “LICENSE” which contains the whole context of this License in the first directory of your software package; iii Attach the statement to the appropriate annotated syntax at the beginning of each source file. Copyright (c) [Year] [name of copyright holder] [Software Name] is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

简介

KLPMAKE 是个Linux内核热补丁制作工具 展开 收起
C 等 3 种语言
MulanPSL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
C
1
https://gitee.com/laokz/klpmake.git
git@gitee.com:laokz/klpmake.git
laokz
klpmake
klpmake
master

搜索帮助