草庐IT

c++ - SAL(源注释语言)的目的是什么？SAL 1 和 2 之间有什么区别？

coder 2024-02-01 原文

如题中所问:

What is the purpose of SAL (Source Annotation Language) and what is the difference between SAL 1 and SAL 2?

我了解用法的基础知识，这有助于突出传递给函数的每个变量的目的以及用于静态代码分析的各种其他内容，但它实际上有多大区别(忽略越来越清晰的对项目中其他程序员的参数要求)？

如果我有以下原型(prototype):

_Success_(return == 1) 
int TestFunction( _In_ int* pTest, _Inopt_ char* pOptional );

这应该“告诉”静态分析器该函数在成功运行后将返回 1，pTest 是一个指针，不能为 nullptr 并且pOptional 是一个指针，它可以是也可以不是 nullptr。但是，静态分析器不能从函数定义本身获取这些信息吗？此外，它如何处理获得的信息(例如成功标准)？

此外，为什么 SAL 1 和 SAL 2 之间存在差异，为什么微软决定改变他们命名宏的方式(即从 __out 到 _Out_ 和__success 到 _Success_?)

如果在 MSDN 的某个地方对此进行了详细描述，我很抱歉，但我无法在 StackOverflow 上找到它或任何其他问题的详细答案，所以我想我会问一下，希望能满足我的好奇心。

提前感谢您的宝贵时间!

最佳答案

我阅读了您问题中的多个问题，希望我能全部回答:

为什么要使用 SAL 而不仅仅是从源代码中推导？

关于使用 SAL 明确告诉分析器有关参数行为等详细信息的观点有多个答案。

  1. 虽然分析器可以从实现中推断出参数行为，但它通常无法区分实现的意图和意外。作为开发人员，如果您明确说明不同参数的预期用途，分析器既可以验证您编写的实现是否满足您的意图，也可以验证调用方是否正确使用了它。

  2. 当源代码不可用于分析时，这会为静态分析器提供有关函数行为的信息，例如在作为 Visual Studio、驱动程序套件等的一部分提供的各种头文件中声明的函数。

  3. SAL 允许表达难以甚至不可能仅从源代码推断的概念，例如驱动程序中的锁使用和 IRQL 要求。

  4. 这也有助于与回调函数保持一致。 Windows header 描述的一些框架可能会声明一组回调函数，因此 Windows 框架将调用那些在别处(应用程序、驱动程序等)定义的回调函数。因此 Windows 永远看不到被调用函数的源代码，回调函数定义也永远看不到调用者。

分析器从成功中得到什么信息？

这与您编写的案例无关。但是在有输出参数的情况下(例如 Out 和 family)，这意味着如果函数不成功，调用者不能依赖输出注释。例如:

_Success_(return) bool GetASmallInt(_Out_range_(0, 10) int& an_int);

如果 GetASmallInt 返回 true，则 an_int 将介于 0 和 10 之间，包括 0 和 10。如果它返回 false，则不存在这样的保证，并且该变量甚至可能还没有被函数初始化。

SAL 1 和 SAL 2 之间有什么区别，为什么注释从 __in 重命名为 _In_？

SAL 的原始定义中的一些特殊情况(例如 __in)与 C++ 不能很好地融合。新语法从一些较新的实现开始，确保它符合 C 和 C++ 语法的要求。

SAL 1 和 SAL 2 之间的主要区别在于 SAL 2 能够表达很多 SAL 1 不能表达的概念，并且 SAL 2 定义得更好，尤其是在 C++ 方面，如上所述。

关于c++ - SAL(源注释语言)的目的是什么？SAL 1 和 2 之间有什么区别？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/16265188/

ampSALcode分析器c++visual-studiomicrosoft-sal

有关c++ - SAL(源注释语言)的目的是什么？SAL 1 和 2 之间有什么区别？的更多相关文章

  1. ruby - 为什么我可以在 Ruby 中使用 Object#send 访问私有(private)/ protected 方法？ - 2

    类classAprivatedeffooputs:fooendpublicdefbarputs:barendprivatedefzimputs:zimendprotecteddefdibputs:dibendendA的实例a=A.new测试a.foorescueputs:faila.barrescueputs:faila.zimrescueputs:faila.dibrescueputs:faila.gazrescueputs:fail测试输出failbarfailfailfail.发送测试[:foo,:bar,:zim,:dib,:gaz].each{|m|a.send(m)resc

  2. ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2

    我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？ 最佳答案 通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co

  3. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  4. ruby - 什么是填充的 Base64 编码字符串以及如何在 ruby​​ 中生成它们？ - 2

    我正在使用的第三方API的文档状态:"[O]urAPIonlyacceptspaddedBase64encodedstrings."什么是“填充的Base64编码字符串”以及如何在Ruby中生成它们。下面的代码是我第一次尝试创建转换为Base64的JSON格式数据。xa=Base64.encode64(a.to_json) 最佳答案 他们说的padding其实就是Base64本身的一部分。它是末尾的“=”和“==”。Base64将3个字节的数据包编码为4个编码字符。所以如果你的输入数据有长度n和n%3=1=>"=="末尾用于填充n%

  5. ruby - 解析 RDFa、微数据等的最佳方式是什么，使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作，但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式，例如使用这个yaml文件，它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  6. ruby - 为什么 4.1%2 使用 Ruby 返回 0.0999999999999996？但是 4.2%2==0.2 - 2

    为什么4.1%2返回0.0999999999999996？但是4.2%2==0.2。 最佳答案 参见此处:WhatEveryProgrammerShouldKnowAboutFloating-PointArithmetic实数是无限的。计算机使用的位数有限(今天是32位、64位)。因此计算机进行的浮点运算不能代表所有的实数。0.1是这些数字之一。请注意，这不是与Ruby相关的问题，而是与所有编程语言相关的问题，因为它来自计算机表示实数的方式。 关于ruby-为什么4.1%2使用Ruby返

  7. ruby-on-rails - Rails 应用程序之间的通信 - 2

    我构建了两个需要相互通信和发送文件的Rails应用程序。例如，一个Rails应用程序会发送请求以查看其他应用程序数据库中的表。然后另一个应用程序将呈现该表的json并将其发回。我还希望一个应用程序将存储在其公共(public)目录中的文本文件发送到另一个应用程序的公共(public)目录。我从来没有做过这样的事情，所以我什至不知道从哪里开始。任何帮助，将不胜感激。谢谢! 最佳答案 无论Rails是什么，几乎所有Web应用程序都有您的要求，大多数现代Web应用程序都需要相互通信。但是有一个小小的理解需要你坚持下去，网站不应直接访问彼此

  8. ruby-on-rails - 如何优雅地重启 thin + nginx？ - 2

    我的瘦服务器配置了nginx，我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例，但找不到好的解决方案。有没有人能做到这一点？ 最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器，例如server{listen80;server

  9. ruby - ruby 中的 TOPLEVEL_BINDING 是什么？ - 2

    它不等于主线程的binding，这个toplevel作用域是什么？此作用域与主线程中的binding有何不同？>ruby-e'putsTOPLEVEL_BINDING===binding'false 最佳答案 事实是，TOPLEVEL_BINDING始终引用Binding的预定义全局实例，而Kernel#binding创建的新实例>Binding每次封装当前执行上下文。在顶层，它们都包含相同的绑定(bind)，但它们不是同一个对象，您无法使用==或===测试它们的绑定(bind)相等性。putsTOPLEVEL_BINDINGput

  10. ruby - Infinity 和 NaN 的类型是什么？ - 2

    我可以得到Infinity和NaNn=9.0/0#=>Infinityn.class#=>Floatm=0/0.0#=>NaNm.class#=>Float但是当我想直接访问Infinity或NaN时:Infinity#=>uninitializedconstantInfinity(NameError)NaN#=>uninitializedconstantNaN(NameError)什么是Infinity和NaN？它们是对象、关键字还是其他东西？ 最佳答案 您看到打印为Infinity和NaN的只是Float类的两个特殊实例的字符串

随机推荐