华为代码review准则概要

HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.Page1检视方法触发式检视分类专项检视交叉检视每日新合入检视版本差异检视其他检视方法HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.分类专项检视1内存使用类1.内存申请后，是否有是否申请成功?2.函数退出，特别是异常分支退出时，是否释放了内存?3.内存是否被重复释放？4.操作内存时是否存在溢出使用。5.申请与释放的接口是否一致？6.跨函数释放尤其要关注，写代码时尽量不要设计成跨函数释放。7.释放后要对指针置空。Page2HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.分类专项检视2指针使用类1.是否对函数的指针参数做了合法性检查？2.是否使用了空指针、已经释放的指针？3.对指针的偏移计算是否正确？4.指针合法性检查后是否有正确的处理？5.判断到指针为空，应清理已申请的全部资源，并退出正常流程6.多个指针变量同时指向同一块内存地址，用其中一个指针释放该内存后，其它指针是否置空或重新赋值；(如果对其它指针进行置空，则需要在使用这些指针的地方进行判断是否为空的保护)Page3HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.越界访问类1.字符串拷贝时，是否保证字符串的长度合法？2.字符串初始化、拷贝、连接的入参是否正确？3.必须有一个地方保证内存不溢出，这个保证要么是编写代码时的静态保证（定义的内存足够大），要么是运行时的动态检查，由函数提供者或调用者进行检查。建议由函数提供者进行检查，或用strncpy等方式避免拷贝过多的内存提示：使用strncpy后注意在结尾处增加'\0'。4.典型错误是字符串越界1字节；Page4分类专项检视3HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.分类专项检视4数组溢出类1.使用数组时，数组下标是否在数组范围之内？2.尤其是当循环语句和数组一起使用时，一定要注意边界值不能溢出。重点检查：边界值处理不正确，最大、最小值处理不正确，重点关注(for/while)循环变量的上下限检测；错误案例说明：1、(ULONG型变量=0)恒真循环；(恒真的原因：ULONG型变量为零时减1产生数值翻转，变为0xFFFFFFFFUL)；2、循环上下限是由外部函数传入，没有对传入值进行合法性检查导致死循环等问题；Page5HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.3、多层循环时，禁止使用同一个循环变量，否则很容易导致死循环；4、循环变量做为数组下标时，要防止数组下标越界；5、在循环体内修改循环变量时要慎重；如：对循环变量同时有加减操作时，很可能会出现死循环，要特别关注；Page6分类专项检视4HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.资源泄漏类1.在过程/函数退出之前是否释放了所有需要释放的资源(内存/文件句柄等)？2.信号量、waitlist等申请后，是否有进行释放？3.跨函数的释放，如果不是产品中早已明确的通用资源管理机制，则要在申请内存的地方写作注释4.调用可能会返回失败的函数，一定要判断返回值并做资源回收。异常处理类1.异常分支是否进行了处理？是否处理正确？2.如switch语句一定要包含default分支；3.如有if分支就应该包含else分支（对于else分支中不需要特殊处理的情况，使用注释说明）Page7分类专项检视5HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.资源保护类1.可重入函数使用全局变量时，应通过关中断、信号量（即P、V操作）等手段对其加以保护2.只对简单全局变量（如整型）进行读操作的函数可以不申请互斥保护，但操作复杂全局变量（如链表，树）时，即使仅仅读取，也必须申请互斥保护，因为存在中途被其它任务破坏数据结构的可能性3.任务切换需重点关注数据溢出类1.强制的数据类型转换，是否导致了数据的丢失？2.是否数据精度不足，导致可能发生数据溢出或翻转？3.如对计数变量，一般是进行定时读取，要保证在定时器超时前数据不能溢出。Page8分类专项检视6HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.差1错误1.此类错误一般是由于把“=”误写成“”或“=”误写成“”等造成的2.如：VlanID有效值为1~4095，通常会定义宏，比如MAX_VLAN_NUMBER为4096，这时需要注意在参数合法性判断时，需要用“=MAX_VLAN_NUMBER”，不要误用“MAX_VLAN_NUMBER”。返回值类1.函数返回值的类型需要和函数声明的类型一致2.在异常情况下，需要返回不同的错误码，而不是返回OK3.函数返回值returnok、error、true、false是否用混？Page9分类专项检视7HUAWEITECHNOLOGIESCO.,LTD.HuaweiConfidential英文标题:32-35pt颜色:R153G0B0内部使用字体:FrutigerNextLTMedium外部使用字体:Arial中文标题:30-32pt颜色:R153G0B0字体:黑体英文正文:20-22pt子目录(2-5级):18pt颜色:黑色内部使用字体:FrutigerNextLTRegular外部使用字体:Arial中文正文:18-20pt子目录(2-5级):18pt颜色:黑色字体:细黑体配色参考方案：建议同一页面内不超过四种颜色，以下是９组配色方案，同一页面内只选择一组使用。（仅供参考）客户或者合作伙伴的标志放在右上角.代码审查九字真言看见了If，就想Else。看见malloc，就去找Free。函数调用要小心，需要看看返回值。看到for循环，就找边界值。看见return要注意，要去前面找资源。看见数组把神提，问题往往在下标。不要小看字符串，长度是个大问题。得到函数不要急，看看变量初始化，各种路径要小心。赋值函数最危险，变量没有初始化