Введение в Roslyn. Использование для разработки инструментов статического анализа

в 11:15, , рубрики: .net, api, C#, open source, pvs-studio, roslyn, static code analysis, Visual Studio, Блог компании PVS-Studio, статический анализ кода
Введение в Roslyn. Использование для разработки инструментов статического анализа - 1

Roslyn является платформой, предоставляющей разработчику различные мощные средства для разбора и анализа кода. Но наличия таких средств недостаточно, нужно понимать, что и для чего необходимо использовать. Данная статья несёт цель ответить на подобные вопросы. Помимо этого, будет рассказано об особенностях разработки статических анализаторов, использующих Roslyn API.

Введение

Знания, приведённые в данной статье, получены при разработке статического анализатора кода PVS-Studio, часть которого, отвечающая за проверку C#-проектов, написана с использованием Roslyn API.

Статью можно разделить на 2 больших логических раздела:

  • Общая информация про Roslyn. Обзор инструментов, предоставляемых им для разбора и анализа кода. Приводится как общее описание сущностей и интерфейсов, так и взгляд на них с точки зрения разработчика статического анализатора.
  • Особенности, которые следует учитывать при разработке статических анализаторов. О том, как использовать Roslyn для разработки продуктов этого класса, что нужно учитывать при разработке диагностических правил, как их писать, пример диагностики и т.п.

Если же разбить статью на разделы более детально, можно выделить следующие части:

  • Roslyn. Что это и зачем нам нужно?
  • Подготовка к разбору проектов и анализу файлов.
  • Синтаксическое дерево и семантическая модель как 2 основные компоненты, необходимые для статического анализа.
  • Syntax Visualizer – расширение среды разработки Visual Studio, а также наш помощник в разборе кода.
  • Особенности, которые необходимо принимать во внимание при разработке статического анализатора кода.
  • Пример диагностического правила.

Примечание. Дополнительно предлагаю вашему вниманию родственную статью "Руководство по разработке модулей расширений на C# для Visual Studio 2005-2012 и Atmel Studio".

Roslyn

Roslyn – платформа с открытым исходным кодом, разрабатываемая корпорацией Microsoft, и содержащая в себе компиляторы и средства для разбора и анализа кода, написанного на языках программирования C# и Visual Basic.

Roslyn используется в среде разработки Microsoft Visual Studio 2015. Различные нововведения наподобие code fixes реализуются как раз за счёт использования Roslyn.

С помощью средств анализа, предоставляемыми платформой Roslyn, можно производить полный разбор кода, анализируя все поддерживаемые конструкции языка.

Среда Visual Studio позволяет создавать на основе Roslyn как встраиваемые в саму IDE инструменты (расширения Visual Studio), так и независимые приложения (standalone инструменты).

Введение в Roslyn. Использование для разработки инструментов статического анализа - 2

Исходный код Roslyn доступен в соответствующем репозитории на GitHub. Это позволяет посмотреть, что и как работает, а в случае обнаружения какой-либо ошибки – сообщить о ней разработчикам.

Рассматриваемый ниже вариант создания статического анализатора и диагностических правил является не единственным. Возможно создание диагностик, основанное на использовании стандартного класса DiagnosticAnalyzer. Встроенные диагностики Roslyn используют именно это решение. Это позволит, например, произвести интеграцию со стандартным списком ошибок Visual Studio, предоставляет возможность подсветки ошибок в текстовом редакторе и т.д. Но стоит помнить, что если эти диагностики будут существовать внутри процесса devenv.exe, являющегося 32-битным, накладываются серьёзные ограничения на объём используемой памяти. В некоторых случаях это критично и не позволит провести глубокий анализ больших проектов (того же Roslyn). К тому же в этом случае Roslyn оставляет разработчику меньше контроля по обходу дерева и самостоятельно занимается распараллеливанием этого процесса.

C# анализатор PVS-Studio является standalone-приложением, что решает проблему с ограничением на использование памяти. Помимо этого, мы получаем больший контроль над обходом дерева, реализуем распараллеливание необходимым нам образом, тем самым больше контролируя процесс разбора и анализа кода. Так как опыт в создании анализатора, работающего по такому принципу (PVS-Studio С++), уже есть, его было бы целесообразно использовать и при написании C# анализатора. Интеграция со средой разработки Visual Studio осуществляется аналогично C++ анализатору – посредством плагина, вызывающего это standalone-приложение. Таким образом, используя уже имеющиеся наработки, удалось создать анализатор для нового языка и связать его с уже имеющимися решениями, встроив в полноценный продукт – PVS-Studio.

Подготовка к анализу файлов

Перед тем, как приступать к самому анализу, необходимо получить список файлов, исходный код которых будет проверяться, а также получить сущности, необходимые для корректного анализа. Можно выделить несколько пунктов, которые нужно выполнить для получения необходимых для анализа данных:

  1. Создание workspace;
  2. Получение solution (опционально);
  3. Получение проектов;
  4. Разбор проекта: получение компиляции, списка файлов;
  5. Разбор файла: получение синтаксического дерева и семантической модели;

Введение в Roslyn. Использование для разработки инструментов статического анализа - 3

На каждом пункте стоит остановиться чуть подробнее.

Создание рабочего пространства

Создание рабочего пространства (workspace) необходимо для получения решения или проектов. Для получения workspace'a необходимо вызвать статический метод Create класса MSBuildWorkspace, возвращающий объект типа MSBuildWorkspace.

Получение решения

Получение solution'a актуально, когда необходимо проанализировать, например, несколько входящих в данное решение проектов, или их все. Тогда, получив solution, легко можно получить список всех входящих в него проектов.

Для получения solution'a используется метод OpenSolutionAsync объекта MSBuildWorkspace. В итоге получаем коллекцию, содержащая в себе список проектов (т.е. объект IEnumerable<Project>).

Получение проектов

Если отсутствует необходимость в анализе всех проектов, можно получить конкретный, интересующий нас проект, используя асинхронный метод OpenProjectAsync объекта MSBuildWorkspace. Используя этот метод, получаем объект типа Project.

Разбор проекта: получение компиляции и списка файлов для анализа

После того, как получен список проектов для анализа, можно приступать к их разбору. Результатом разбора проекта должен стать список файлов для анализа и компиляция.

Список файлов получить просто – для этого используется свойство Documents экземпляра класса Project.

Для получения компиляции используется метод TryGetCompilation или GetCompilationAsync.

Получение компиляции – один из ключевых моментов, так как именно она используется для получения семантической модели (подробнее о которой будет рассказано позже), необходимой для проведения глубокого и сложного анализа исходного кода.

Для того, чтобы получить корректную компиляцию, проект должен быть скомпилированным – в нём не должно быть ошибок компиляции, а все зависимости должны лежать на месте.

Пример использования. Получение проектов

Ниже приведён код, демонстрирующий различные варианты получения проектных файлов с использованием класса MSBuildWorkspace:

void GetProjects(String solutionPath, String projectPath)
{
  MSBuildWorkspace workspace = MSBuildWorkspace.Create();
  Solution currSolution = workspace.OpenSolutionAsync(solutionPath)
                                   .Result;
  IEnumerable<Project> projects = currSolution.Projects;
  Project currProject = workspace.OpenProjectAsync(projectPath)
                                 .Result;             
}

Данные действия не должны вызывать никаких вопросов, так как всё, что здесь происходит, было описано выше.

Разбор файла: получение синтаксического дерева и семантической модели

Следующий этап – разбор файла. Сейчас необходимо получить 2 сущности, на которых и базируется полноценный анализ – синтаксическое дерево и семантическую модель. Синтаксическое дерево строится на основании исходного кода программы и используется для анализа различных конструкций языка. Семантическая модель предоставляет информацию об объектах и их типах.

Для получения синтаксического дерева (объект типа SyntaxTree) используется метод TryGetSyntaxTree или GetSyntaxTreeAsync экземпляра класса Document.

Семантическая модель (объект типа SemanticModel) получается из компиляции с использованием синтаксического дерева, полученного ранее. Для этого используется метод GetSemanticModel экземпляра класса Compilation, принимающего в качестве обязательного параметра объект типа SyntaxTree.

Класс, который будет обходить синтаксическое дерево и проводить анализ, должен быть унаследован от класса CSharpSyntaxWalker, что позволит переопределить методы обхода различных узлов. Вызывая метод Visit, принимающий в качестве параметра корень дерева (для его получения используется метод GetRoot объекта типа SyntaxTree), мы тем самым запускаем рекурсивный обход узлов синтаксического дерева.

Ниже приведён код, в котором демонстрируется реализация описанных выше действий:

void ProjectAnalysis(Project project)
{
  Compilation compilation = project.GetCompilationAsync().Result;
  foreach (var file in project.Documents)
  {
    SyntaxTree tree = file.GetSyntaxTreeAsync().Result;
    SemanticModel model = compilation.GetSemanticModel(tree);
    Visit(tree.GetRoot());
  }
}

Переопределённые методы обхода узлов

Для каждой конструкции языка определены узлы своего типа. А для каждого типа узла определён метод, выполняющих обход узлов подобного типа. Таким образом, добавляя обработчики (диагностические правила) в методы обхода тех или иных узлов, мы можем анализировать только интересующие нас конструкции языка.

Пример переопределённого метода обхода узлов, соответствующих оператору if:

public override void VisitIfStatement(IfStatementSyntax node)
{
  base.VisitIfStatement(node);
}

Добавляя в тело метода соответствующие правила, мы тем самым будем анализировать все операторы if, которые встретятся в коде программы.

Синтаксическое дерево

Синтаксическое дерево является базовым элементом, необходимым для анализа кода. Именно по нему происходит перемещение в ходе анализа. Дерево строится на основе кода, приведённого в файле, из чего следует вывод, что каждый файл имеет своё синтаксическое дерево. Помимо этого стоит учитывать тот факт, что синтаксическое дерево является неизменяемым. Нет, изменить его, конечно, можно, вызвав соответствующий метод, но результатом его работы будет новое синтаксическое дерево, а не изменённое старое.

Например, для следующего кода:

class C
{
  void M()
  { }
}

Синтаксическое дерево будет иметь следующий вид:

Введение в Roslyn. Использование для разработки инструментов статического анализа - 4

Здесь синим цветом обозначены узлы дерева (Syntax nodes ), а зелёным – лексемы (Syntax tokens ).

В синтаксическом дереве, которое строит Roslyn на основе программного кода, можно выделить 3 элемента:

  • Syntax nodes;
  • Syntax tokens;
  • Syntax trivia.

Каждый из этих элементов дерева стоит рассмотреть подробнее, так как все они так или иначе используются в ходе статического анализа. Другое дело, что одни из них используются регулярно, а другие – на порядок реже.

Syntax nodes

Syntax nodes (далее – узлы) представляют синтаксические конструкции, такие как объявления, операторы, выражения и т.д. Основная работа, происходящая при анализе кода, приходится на обработку узлов. Именно по ним происходит перемещение, на обходе тех или иных видов узлов базируются диагностические правила.

Рассмотрим пример дерева, соответствующего выражению

a *= (b + 4);

В отличие от предыдущего рисунка, здесь приведены только узлы и комментарии к ним, которые позволят легче сориентироваться в том, какой узел какой конструкции соответствует.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 5

Базовый тип

Базовым типом узлов является абстрактный класс SyntaxNode. Этот класс предоставляет в распоряжение разработчика методы, общие для всех узлов. Перечислим некоторые наиболее часто используемые из них (если какие-то вещи, вроде того, что такое SyntaxKind или т.п. будут вам сейчас непонятны – не волнуйтесь, об этом будет рассказано ниже):

  • ChildNodes – получает список узлов, являющихся дочерними для текущего. Возвращает объект типа IEnumerable<SyntaxNode>;
  • DescendantNodes — получает список всех узлов, находящихся в дереве ниже текущего. Также возвращает объект типа IEnumerable<SyntaxNode>;
  • Contains – проверяет, включает ли в себя текущий узел другой, переданный в качестве аргумента;
  • GetLeadingTrivia – позволяет получить элементы syntax trivia, предшествующие данному узлу, если они есть;
  • GetTrailingTrivia –позволяет получить элементы syntax trivia, следующие за данным узлом, если они есть;
  • Kind – возвращает элемент перечисления SyntaxKind, конкретизирующий данный узел;
  • IsKind – принимает в качестве параметра элемент перечисления SyntaxKind, и возвращает булево значение, определяющее, соответствует ли конкретный тип узла типу, переданному в качестве аргумента.

Помимо этого в классе определен ряд свойств. Некоторые из них:

  • Parent – возвращает ссылку на родительский узел. Крайне необходимое свойство, так как именно оно позволяет перемещаться вверх по дереву;
  • HasLeadingTrivia – возвращает булево значение, означающее наличие или отсутствие элементов syntax trivia, предшествующих данному узлу;
  • HasTrailingTrivia – возвращает булево значение, означающее наличие или отсутствие элементов syntax trivia, следующее за данным узлом.

Производные типы

Но вернёмся к типам узлов. Каждый узел, представляющий ту или иную конструкцию языка, имеет свой тип, определяющий ряд свойств, упрощающих навигацию по дереву и получение необходимых данных. Этих типов – множество. Приведём некоторые из них и то, каким конструкциям языка они соответствуют:

  • IfStatementSyntax – оператор if;
  • InvocationExpressionSyntax – вызов метода;
  • BinaryExpressionSyntax – инфиксная операция;
  • ReturnStatementSyntax – выражение с оператором return;
  • MemberAccessExpressionSyntax – доступ к члену класса;
  • И множество прочих типов.

Пример. Разбор оператора if

Рассмотрим пример того, как использовать эти знания на практике на примере оператора if.

Пусть в анализируемом коде есть фрагмент следующего вида:

if (a == b)
  c *= d;
else
  c /= d;

В синтаксическом дереве этот фрагмент будет представлен узлом типа IfStatementSyntax. Тогда можно легко получить интересующую нас информацию, обращаясь к различным свойствам этого класса:

  • Condition – возвращает условие, проверяемое в операторе. Возвращаемое значение – ссылка типа ExpressionSyntax;
  • Else – возвращает ветвь else оператора if, если она есть. Возвращаемое значение – ссылка типа ElseClauseSyntax;
  • Statement – возвращает тело оператора if. Возвращаемое значение – ссылка типа StatementSyntax.

На практике это выглядит так же, как и в теории:

void Foo(IfStatementSyntax node)
{
  ExpressionSyntax condition  = node.Condition; // a == b
  StatementSyntax statement   = node.Statement; // c *= d
  ElseClauseSyntax elseClause = node.Else;      /* else
                                                     c /= d;
                                                */
}

Таким образом, зная тип узла, легко получать другие узлы, входящие в его состав. Подобный набор свойств определён и для других типов узлов, характеризующих определённые конструкции – объявления методов, циклы for, лямбды и т.д.

Конкретизация типа узла. Перечисление SyntaxKind

Порой бывает недостаточно знать тип узла. Один из случаев – префиксные операции. Например, нам нужно выделить префиксные операции инкремента и декремента. Можно было бы проверить тип узла.

if (node is PrefixUnaryExpressionSyntax)

Но такой проверки будет недостаточно, так как под это условие подойдут операторы '!', '+', '-', '~', ведь они тоже являются префиксными унарными операциями. Как же быть?

На помощь приходит перечисление SyntaxKind. В этом перечислении определены все возможные конструкции языка, а также его ключевые слова, модификаторы и пр. С помощью элементов этого перечисления можно установить конкретный тип узла. Для конкретизации типа узла в классе SyntaxNode определены следующие свойства и методы:

  • RawKind – свойство типа Int32, хранящее целочисленное значение, конкретизирующее данный узел. На практике чаще применяются методы Kind и IsKind;
  • Kind – метод, не принимающий аргументов и возвращающий элемент перечисления SyntaxKind;
  • IsKind – метод, принимающий в качестве аргумента элемент перечисления SyntaxKind и возвращающий значение true или false, в зависимости от того, соответствует ли точный тип узла типу переданного аргумента.

Используя методы Kind или IsKind, можно легко определить, является ли узел префиксной операцией инкремента или декремента:

if (node.Kind() == SyntaxKind.PreDecrementExpression ||
    node.IsKind(SyntaxKind.PreIncrementExpression))

Лично мне больше нравится использование метода IsKind, так как код выглядит лаконичнее и более читаемо.

Syntax tokens

Syntax tokens (далее – лексемы) являются терминалами грамматики языка. Лексемы представляют собой элементы, которые не подлежат дальнейшему разбору – идентификаторы, ключевые слова, специальные символы. В ходе анализа кода напрямую с ними приходится работать куда реже, чем с узлами дерева. Однако если всё же приходится работать с лексемами, как правило, это ограничивается получением текстового представления лексемы или же проверки её типа.

Рассмотрим упоминавшееся ранее выражение.

a *= (b + 4);

На рисунке ниже представлено синтаксическое дерево, получаемое из этого выражения. Но здесь, в отличие от предыдущего рисунка, также изображены лексемы. Наглядно видна связь между узлами и лексемами, входящими в их состав.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 6

Использование при анализе

Все лексемы представлены значимым типом SyntaxToken. Поэтому для того, чтобы узнать, чем же именно является лексема, используются упоминавшиеся ранее методы Kind и IsKind и элементы перечисления SyntaxKind.

Если же необходимо получить текстовое представление лексемы, достаточно обратиться к свойству ValueText.

Можно получить и значение лексемы (например, число, если лексема представлена числовым литералом), для чего достаточно обратиться к свойству Value, возвращающему ссылку типа Object. Однако для получения константных значений обычно применяется семантическая модель и более удобный метод GetConstantValue, который будет рассмотрен в соответствующем разделе.

Кроме того, к лексемам (фактически – к ним, а не к узлам) привязаны syntax trivia (о том, что это, написано в следующем разделе).

Для работы с syntax trivia определены следующие свойства:

  • HasLeadingTrivia – булево значение, соответствующие наличию или отсутствию элементов syntax trivia перед лексемой;
  • HasTrailingTrivia — булево значение, соответствующие наличию или отсутствию элементов syntax trivia после лексемы;
  • LeadingTrivia – элементы syntax trivia, предшествующие лексеме;
  • TrailingTrivia – элементы syntax trivia, следующие за лексемой.

Пример использования

Рассмотрим простой оператор if:

if (a == b) ;

Данный оператор будет разбит на несколько лексем:

  • Ключевые слова: 'if';
  • Идентификаторы: 'a', 'b';
  • Специальные символы: '(', ')', '==', ';'.

Пример получения значений лексемы:

a = 3;

Пусть в качестве анализируемого узла нам приходит литерал '3'. Тогда получить его текстовое и численное представление можно следующим образом:

void GetTokenValues(LiteralExpressionSyntax node)
{
  String tokenText = node.Token.ValueText;
  Int32 tokenValue = (Int32)node.Token.Value;
}

Syntax trivia

Syntax trivia (дополнительная синтаксическая информация) – это те элементы дерева, которые не будут скомпилированы в IL-код. К таким элементам относятся элементы форматирования (пробелы, символы перевода строки), комментарии, директивы препроцессора.

Рассмотрим простое выражение следующего вида:

a = b; // Comment

Здесь можно выделить следующую дополнительную синтаксическую информацию: пробелы, однострочный комментарии, символ конца строки. Связи между дополнительной синтаксической информацией и лексемами наглядно отражены на рисунке, представленном ниже.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 7

Использование при анализе

Дополнительная синтаксическая информация, как упоминалось ранее, связана с лексемами. Разделяют Leading trivia и Trailing trivia. Leading trivia – предшествующая лексеме дополнительная синтаксическая информация, trailing trivia – дополнительная синтаксическая информация, следующая за лексемой.

Все элементы дополнительной синтаксической информации имеют тип SyntaxTrivia. Для определения того, чем конкретно является элемент (пробел, однострочный комментарий, многострочный комментарий и пр.) используется перечисление SyntaxKind и уже известные вам методы Kind и IsKind.

Как правило, при статическом анализе вся работа с дополнительной синтаксической информацией сводится к определению того, чем является её элементы, иногда – к анализу текста элемента.

Пример использования

Пусть у нас имеется следующий анализируемый код:

// It's a leading trivia for 'a' token
a = b; /* It's a trailing trivia for 
          ';' token */

Здесь однострочный комментарий будет привязан к лексеме 'a', а многострочный комментарий – к лексеме ';'.

Если в качестве узла нам приходит выражение a = b;, легко получить текст однострочного и многострочного комментариев следующим образом:

void GetComments(ExpressionSyntax node)
{
  String singleLineComment = 
    node.GetLeadingTrivia()
        .SingleOrDefault(p => p.IsKind(
                                SyntaxKind.SingleLineCommentTrivia))
        .ToString();

  String multiLineComment = 
    node.GetTrailingTrivia()
        .SingleOrDefault(p => p.IsKind(
                                SyntaxKind.MultiLineCommentTrivia))
        .ToString();
}

Краткое обобщение

Кратко обобщив информацию данного раздела, можно выделить следующие пункты, касаемо синтаксического дерева:

  • Синтаксическое дерево – базовый элемент, необходимый для статического анализа;
  • Синтаксическое дерево неизменяемо;
  • Выполняя обход синтаксического дерева, мы обходим различные конструкции языка, для каждой из которой определён свой тип;
  • Для каждого типа, соответствующего какой-либо синтаксической конструкции языка, есть метод обхода, переопределив который, можно задавать логику обработки узла;
  • Три основных элемента дерева – syntax nodes, syntax tokens, syntax trivia ;
  • Syntax nodes – синтаксические конструкции языка. К этой категории относятся объявления, определения, операторы и т.п.;
  • Syntax tokens – лексемы, конечные символы грамматики языка. К этой категории относятся идентификаторы, ключевые слова, спец. символы и т.п.;
  • Syntax trivia – дополнительная синтаксическая информация. К этой категории относятся комментарии, директивы препроцессора, пробелы и т.п.

Семантическая модель

Семантическая модель предоставляет информацию об объектах и о типах объектов. Это очень мощный инструмент, позволяющий проводить глубокий и сложный анализ. Именно поэтому важно иметь корректную компиляцию и корректную семантическую модель. Напомню, что для этого проект должен быть скомпилированным.

Следует помнить, что при анализе мы работаем с узлами, а не с объектами. Поэтому для получения информации, например, о типе объекта не сработают ни оператор is, ни метод GetType, так как они предоставляют информацию об узле, а не об объекте. Пусть, например, мы анализируем следующий код:

a = 3;

О том, что такое a, из этого кода можно лишь строить предположения. Нельзя сказать, локальная ли это переменная, или свойство, или поле, можно сделать только приблизительные предположения о типе. Но догадки никого не интересуют, нужна точная информация.

Можно было бы попробовать пройтись вверх по дереву до объявления переменной, но это было бы слишком расточительно с точки зрения производительности и объема кода. К тому же, объявление запросто может находиться где-нибудь в другом файле, или даже в сторонней библиотеке, исходного кода которой у нас нет

Тут на помощь и приходит семантическая модель.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 8

Можно выделить 3 наиболее часто используемые функции, предоставляемые семантической моделью:

  • Получение информации об объекте;
  • Получение информации о типе объекта;
  • Получение константных значений.

На каждом из этих пунктов следует остановиться подробнее, так как все они важны и повсеместно применяются при статическом анализе кода.

Получение информации об объекте. Symbol

Информацию об объекте предоставляют так называемые символы (symbols).

Базовый интерфейс символа – ISymbol, предоставляет методы и свойства, общие для всех объектов, независимо от того, чем они являются – полем, свойством или чем-то ещё.

Существует ряд производных типов, выполняя приведение к которым можно получать более специфическую информацию об объекте. К таким интерфейсам относятся IFieldSymbol, IPropertySymbol, IMethodSymbol и прочие.

Например, используя приведение к интерфейсу IFieldSymbol и обратившись к полю IsConst можно узнать, является ли узел константным полем. А если использовать интерфейс IMethodSymbol, можно узнать, возвращает-ли метод какое-либо значение.

Для символов определено свойство Kind, возвращающее элементы перечисления SymbolKind. По своему предназначению это перечисление аналогично перечислению SyntaxKind. То есть с помощью свойства Kind можно узнать, с чем мы сейчас работаем – локальным объектом, полем, свойством, сборкой и пр.

Пример использования. Узнаём, является ли узел константным полем.

Предположим, что имеется определение поля следующего вида:

private const Int32 a = 10;

А где-то ниже – следующий код:

var b = a;

Предположим, что нам требуется узнать, является ли a константным полем. Из вышеприведённого выражения можно получить необходимую информацию об узле а, используя семантическую модель. Код получения необходимой информации выглядит следующий образом:

Boolean? IsConstField(SemanticModel model,        
                      IdentifierNameSyntax identifier)
{
  ISymbol smb = model.GetSymbolInfo(identifier).Symbol;
  if (smb == null)
    return null;
  return smb.Kind == SymbolKind.Field && 
         (smb as IFieldSymbol).IsConst;
}

Сначала получаем символ для идентификатора, используя метод GetSymbolInfo объекта типа SemanticModel, после чего сразу обращаемся к полю Symbol (именно оно содержит интересующую нас информацию, поэтому в данном случае нет смысла хранить где-то структуру SymbolInfo, возвращаемую методом GetSymbolInfo).

После проверки на null, используя свойство Kind, конкретизирующее символ, убеждаемся, что идентификатор на самом деле является полем. Если это действительно так – выполняем приведение к производному интерфейсу IFieldSymbol, который позволит обратиться к свойству IsConst, получив тем самым информацию о константности поля.

Получение информации о типе объекта. Интерфейс ITypeSymbol

Часто необходимо узнать тип объекта, представляемого узлом. Как я писал выше, оператор is и метод GetType не подходят, так как они оперируют с типом узла, а не анализируемого объекта.

К счастью, выход есть, причём весьма элегантный. Нужную информацию можно получить, используя интерфейс ITypeSymbol. Для его получения используется метод GetTypeInfo объекта типа SemanticModel. Вообще этот метод возвращает структуру TypeInfo, содержащую 2 важных свойства:

  • ConvertedType – возвращает информацию о типе выражения после выполнения неявного приведения. Если приведения не было, возвращаемое значение аналогично тому, что возвращает свойство Type;
  • Type – возвращает тип выражения, представленного в узле. Если получить тип выражения невозможно, возвращается значение null. Если тип не может быть определён из-за какой-то ошибки, возвращается интерфейс IErrorTypeSymbol.

Используя интерфейс ITypeSymbol, возвращаемый этими свойствами, можно получить всю интересующую информацию о типе. Эта информация извлекается за счёт обращения к свойствам, некоторые из которых приведены ниже:

  • AllInterfaces – список всех реализуемых типом интерфейсов. Учитываются также и интерфейсы, реализуемые базовыми типами;
  • BaseType – базовый тип;
  • Interfaces – список интерфейсов, реализуемых конкретно данным типом;
  • IsAnonymousType – информация о том, является ли тип анонимным;
  • IsReferenceType – информация о том, является ли тип ссылочным;
  • IsValueType – информация о том, является ли тип значимым;
  • TypeKind – конкретизирует тип (аналогично свойству Kind для интерфейса ISymbol). Содержит информацию о том, что из себя представляет тип – класс, структуру, перечисление и т.д.

Стоит отметить, что можно узнавать не только тип объекта, но и тип всего выражения целиком. Например, вы можете получить тип выражения a + b, и по отдельности типы переменных a и b. Так как эти типы могут отличаться, возможность получения типов для всего выражения целиком является достаточно полезной при разработке некоторых диагностических правил.

Кроме того, как и для интерфейса ISymbol, существует ряд производных интерфейсов, позволяющих получить более специфическую информацию.

Пример использования. Получение названий всех реализуемых типом интерфейсов

Для того, чтобы получить названия всех интерфейсов, реализуемых типом, а также базовыми типами, можно использовать следующий код:

List<String> GetInterfacesNames(SemanticModel model, 
                                IdentifierNameSyntax identifier)
{
  ITypeSymbol nodeType = model.GetTypeInfo(identifier).Type;
  if (nodeType == null)
    return null;
  return nodeType.AllInterfaces
                 .Select(p => p.Name)
                 .ToList();
}

Всё достаточно просто, используемые здесь методы и свойства были описаны выше, поэтому никаких трудностей с пониманием данного кода, думаю, возникнуть не должно.

Получение константных значений

Семантическую модель можно использовать также для получения константных значений. Эти значения можно получить для константных полей, символьных, строковых и числовых литералов. Выше было описано, как можно получить константные значения, используя лексемы. Семантическая модель предоставляет более удобный интерфейс для этого. В этом случае нам не нужны лексемы, достаточно иметь узел, из которого можно получить константное значение – остальное модель сделает самостоятельно. Это очень удобно, так как, напоминаю, при анализе основная работа ведётся именно с узлами.

Для получения константных значений используется метод GetConstantValue, возвращающий структуру Optional<Object>, используя которую, легко проверить успешность операции и получить интересующее нас значение.

Пример использования. Получение константного значения поля

Предположим, что имеется анализируемый код:

private const String str = "Some string";

Если где-то в коде программы встретится объект str, используя семантическую модель можно будет легко получить строку, на которую ссылается это поле:

String GetConstStrField(SemanticModel model, 
                        IdentifierNameSyntax identifier)
{
  Optional<Object> optObj = model.GetConstantValue(identifier);
  if (!optObj.HasValue)
    return null;
  return optObj.Value as String;
}

Краткое обобщение

Кратко обобщив информацию данного раздела, можно выделить следующие пункты, касаемо семантической модели:

  • Семантическая модель предоставляет семантическую информацию (об объектах, их типах и пр.);
  • Необходима для проведения глубокого и сложного анализа;
  • Для получения корректной семантической модели проект должен быть скомпилированным;
  • Семантическую информацию об объекте предоставляет интерфейс ISymbol;
  • Семантическую информацию о типе объекта предоставляет интерфейс ITypeSymbol;
  • С помощью семантической модели возможно получение значений константных полей и литералов.

Syntax visualizer

Syntax visualizer (далее – визуализатор) – расширение для среды разработки Visual Studio, входящее в комплект Roslyn SDK (который можно загрузить в галерее Visual Studio). Данный инструмент, как следует из названия, выполняет функции отображения синтаксического дерева.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 9

Как видно из рисунка, синими элементами отображаются узлы, зелёными – лексемы, красными – дополнительная синтаксическая информация. Кроме этого для каждого узла можно узнать его тип, значение Kind, значения свойств. Кроме того есть возможность получения интерфейсов ISymbol и ITypeSymbol для узлов дерева.

Данный инструмент удобен при использовании методологии TDD, когда перед реализацией диагностического правила вы пишете набор юнит-тестов, а лишь затем приступаете к программированию логики правила. Визуализатор позволяет легче ориентироваться по написанному коду, узнать, на обход какого узла нужно подписаться и куда двигаться по дереву, для каких узлов необходимо (и можно) получить тип и символ, упрощая тем самым процесс разработки диагностического правила.

Помимо представления дерева в формате, приведённом на рисунке выше, можно отобразить его в более наглядной форме. Для этого достаточно вызвать контекстное меню для интересующего вас элемента и выбрать пункт View Directed Syntax Graph. При помощи этого механизма я получал деревья различных синтаксических конструкций, используемых и приводимых ранее в статье.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 10

История из жизни.

В ходе разработки PVS-Studio был случай, когда возникало исключение переполнения стека. Как оказалось, дело в том, что в одном из проверяемых проектов — ILSpy — есть автосгенерированный файл Parser.cs, в котором присутствует просто какое-то нереальное количество вложенных операторов if. В итоге, при попытке обхода дерева просто заканчивалась стековая память. В анализаторе мы эту проблему победили, просто увеличив максимальный размер стека для потоков, в которых происходит обход, но синтаксический визуализатор, заодно с Visual Studio, до сих пор «отваливается» на этом файле.

Можете проверить сами. Откройте заветный файл, найдите эту «бездну» операторов if и попробуйте посмотреть синтаксическое дерево (например, строка 3218).

Особенности, которые необходимо учитывать при разработке статического анализатора

Существует ряд правил, которых необходимо придерживаться, разрабатывая статические анализаторы. Соблюдение этих правил позволит сделать более качественный продукт и реализовывать функциональные диагностические правила.

  1. Для глубокого и качественного анализа нужна полная информация о всех типах, встретившихся в коде. В большинстве диагностических правил недостаточно простого обхода узлов дерева, часто приходится обрабатывать типы выражений и получать информацию об анализируемых объектах. Для этого и нужна семантическая модель, которая должна быть корректной. Напомню, что для этого проект должен быть скомпилированным, все зависимости должны быть на месте. Тем не менее, даже если это так, не стоит пренебрегать различными проверками результатов, получаемых с использованием семантической модели;
  2. Важно правильно выбирать тип узла для начала анализа. Это позволит уменьшить количество перемещений по дереву и различных приведений. Естественно, это также уменьшит объем кода, упростив его поддержку. Для того, чтобы лучше определиться со стартовым узлом анализа, используйте синтаксический визуализатор;
  3. Если нет уверенности в том, что код является ошибочным, лучше не ругаться. Но в пределах разумного, конечно. Дело в том, что если анализатор будет ругаться по делу и без дела, появится слишком большое количество шума в виде ложных срабатываний, на фоне которых реальные ошибки найти будет трудно. С другой стороны, если совсем ни на что не ругаться, толку от анализатора тоже не будет. Поэтому иногда приходится выбирать компромисс, но конечная цель – свести количество ложных срабатываний к минимуму, в идеале – к 0;
  4. При разработке диагностических правил важно предусмотреть все возможные, невозможные, а также ряд невероятных случаев, с которыми вы можете столкнуться в ходе анализа. Для этого необходимо разрабатывать большое количество юнит-тестов, как позитивных – фрагментов кода, где должна срабатывать ваша диагностика, так и негативных – тех фрагментов, на которые не стоит выдавать предупреждения;
  5. В процесс разработки диагностических правил отлично вписывается методология TDD. Изначально разрабатываются наборы позитивных и негативных юнит-тестов, и лишь после этого начинается реализация диагностического правила. Это позволит легче ориентироваться с синтаксическим деревом по мере реализации, так как перед глазами уже будут примеры различных деревьев. К тому же на этом этапе пригодится синтаксический визуализатор;
  6. Важно тестировать анализатор на реальных проектах. Как бы вы ни старались, скорее всего не удастся покрыть юнит-тестами все случаи, с которыми придётся столкнуться диагностическим правилам анализатора. Проверка же анализатора на реальных проектах позволит выявить места, где правила отрабатывают некорректно, следить за изменениями работы анализатора, увеличивать базу юнит-тестов.

Алгоритм написания диагностических правил

Поиск ошибок, осуществляемый статическим анализатором, реализуется за счёт различных диагностических правил. Для реализации всех правил существует набор общих действий, выделив которые, можно получить общий алгоритм написания диагностики.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 11

  1. Первым шагом необходимо сформулировать суть правила. Перед разработкой необходимо обдумать, на какие же фрагменты кода стоит выдавать предупреждения, а на какие – нет;
  2. Когда диагностическое правило уже обрело некоторую форму и стало понятно, на какие ситуации стоит выдавать предупреждение, необходимо заняться разработкой юнит-тестов, а именно – реализовать наборы позитивных и негативных тестов. На позитивных тестах должна срабатывать ваша диагностика. На начальных этапах разработки важно сделать базу позитивных юнит тестов как можно больше, так как это позволит отлавливать больше подозрительных ситуаций. Не меньшее внимание стоит уделить и негативным юнит тестам. По мере разработки и тестирования диагностики, база негативных юнит-тестов будет постоянно пополняться. Именно за счёт этого будет снижаться количество ложных срабатываний, выводя соотношение хороших срабатываний к плохим в нужную сторону;
  3. После того, как разработан базовый набор юнит-тестов, можно приступать к реализации диагностики. Не забывайте пользоваться синтаксическим визуализатором – этот инструмент может сильно помочь в процессе программирования;
  4. После того, как диагностика будет готова, а все юнит-тесты будут успешно проходить, необходимо приступать к следующему этапу – тестированию на реальных проектах. Это позволит обнаружить ложные срабатывания (а может и падения) вышей диагностики, расширить базу юнит-тестов. Чем больше открытых проектов используется для тестирования, тем больше возможных вариантов анализируемого кода вы рассматриваете, тем лучше и мощнее становится ваша диагностика;
  5. После тестирования на реальных проектах скорее всего придётся дорабатывать диагностику, так как сходу редко можно попасть прямо в яблочко. Что ж, ничего страшного, это нормальный процесс! Вносите необходимые изменения и снова тестируйте правило;
  6. Повторяйте предыдущий пункт до тех пор, пока диагностика не покажет желаемый результат. После этого можно гордиться проделанной работой.

Пример диагностического правила. Поиск пропущенного оператора throw

Введение в Roslyn. Использование для разработки инструментов статического анализа - 12

В статическом анализаторе кода PVS-Studio есть диагностика V3006, которая ищет пропущенный оператор throw. Логика следующая – создаётся объект исключения, но при этом он никак не используется (ссылка на него никуда не передаётся, не возвращается из метода и т.п.). Тогда, скорее всего, можно сказать, что программист пропустил оператор throw. В итоге исключение не будет сгенерировано, а созданный объект просто будет уничтожен при следующей сборке мусора.

Так как с правилом мы уже определились, можно начинать писать юнит-тесты.

Пример позитивного теста:

if (cond)
  new ArgumentOutOfRangeException();

Пример негативного теста:

if (cond)
  throw new FieldAccessException();

Можно выделить следующие пункты в алгоритме работы диагностики:

  1. Подписываемся на обход узлов типа ObjectCreationExpressionSyntax. Этот тип узлов соответствует созданию объекта с использованием оператора new – как раз то, что нам нужно;
  2. Убеждаемся, что тип создаваемого объекта является совместимым с System.Exception (т.е. либо этим типом, либо производным). Если это так, будем считать, что тип является типом исключения. Для получения типа будем использовать семантическую модель (напоминаю, что модель предоставляет возможность получать тип выражения);
  3. Проверяем, что объект не используется (ссылка на объект никуда не записывается и не передаётся);
  4. Если предыдущие пункты соблюдены – выдаём предупреждение.

Ниже будет приведена возможная реализация данного диагностического правила. Я специально несколько переписал и упростил код, чтобы сделать его короче и легче для понимания. Но даже такое небольшое правило справляется со своей задачей и находит реальные ошибки.

Общий код поиска пропущенного оператора throw:

readonly String ExceptionTypeName = typeof(Exception).FullName;
Boolean IsMissingThrowOperator(SemanticModelAdapter model,        
                               ObjectCreationExpressionSyntax node)
{           
  if (!IsExceptionType(model, node))
    return false;

  if (IsReferenceUsed(model, node.Parent))
    return false;

  return true; 
}

Как видно из кода, здесь выполняются действия, описанные в алгоритме, приведённом выше. В первом условии выполняется проверка того, что тип создаваемого объекта – тип исключения. Вторая проверка используется для определения, используется ли созданный объект.

Кого-то может смутить тип SemanticModelAdapter. Ничего хитрого здесь нет, это обёртка над семантической моделью. В данном примере она используется для тех же целей, что и обыкновенная семантическая модель (объект типа SemanticModel).

Метод проверки, является ли тип исключением:

Boolean IsExceptionType(SemanticModelAdapter model,
                        SyntaxNode node)
{
  ITypeSymbol nodeType = model.GetTypeInfo(node).Type;

  while (nodeType != null && !(Equals(nodeType.FullName(),
                                      ExceptionTypeName)))
    nodeType = nodeType.BaseType;

  return Equals(nodeType?.FullName(),
                ExceptionTypeName);

}

Логика проста – получаем информацию о типе, проверяем всю иерархию наследования. Если в итоге обнаруживается, что один из базовых типов – System.Exception, считаем, что тип создаваемого объекта – тип исключения.

Метод проверки, что ссылка никуда не передаётся и не сохраняется:

Boolean IsReferenceUsed(SemanticModelAdapter model, 
                     SyntaxNode parentNode)
{
  if (parentNode.IsKind(SyntaxKind.ExpressionStatement))
    return false;

  if (parentNode is LambdaExpressionSyntax)
    return (model.GetSymbol(parentNode) as IMethodSymbol)
             ?.ReturnsVoid == false;

  return true;
} 

Можно было бы проверить, используется ли ссылка, но пришлось бы рассматривать слишком много случаев: возвращение из метода, передачу в метод, запись в переменную и т.п. Гораздо проще рассмотреть случаи, когда ссылка никуда не передаётся и не записывается. Это покрывается описанными выше проверками.

С первой, думаю, всё понятно – мы проверяем, что родительский узел – простое выражение. Вторая проверка тоже не таит в себе секретов. Если родительский узел – лямбда-выражение, проверим, что ссылка не возвращается из лямбды.

Roslyn. Достоинства и недостатки

Roslyn – не панацея. Несмотря на то, что это мощная платформа для разбора и анализа кода, как и у любого проекта, у него есть свои недостатки. В то же время достоинств у платформы тоже масса. Что ж, давайте выделим некоторые пункты из обеих категорий.

Достоинства

  • Множество типов узлов. Это может напугать на начальных стадиях работы с платформой, но на деле оказывается её большим достоинством. Можно подписаться на обход определённых узлов, соответствующих тем или иным конструкциям языка, тем самым анализируя интересующие нас участки. Кроме того, каждый тип узла предлагает характерный для него набор свойств, облегчая задачу получения необходимых данных;
  • Удобная навигация по дереву. Для перемещения по дереву или получения необходимых данных достаточно просто обращаться к свойствам узлов. Как сказано выше, каждый тип узла содержит свой набор свойств, что ещё больше упрощает задачу;
  • Семантическая модель. Сущность, позволяющая получать информацию об объектах и типах, предоставляя к тому же удобный интерфейс для этого, является очень сильной стороной платформы;
  • Открытый исходный код. Можно следить за процессом развития платформы, при желании посмотреть, что и как устроено. К тому же можно приобщиться к процессу разработки, сообщая разработчикам о найденных ошибках – это пойдёт на пользу всем.

Недостатки

  • Открытие проектов может порождать различные проблемы. Порой Roslyn не может корректно открыть проект (не подцепляет какую-нибудь зависимость, файл и т.п.), из-за чего не удаётся получить корректную компиляцию и, как итог – семантическую модель. Это рубит на корню глубокий анализ, так как без семантической модели глубокий анализ невозможен. Приходится использовать дополнительные средства (например, MSBuild) для корректного разбора решений/проектов;
  • Приходится изобретать собственные механизмы для, казалось бы, простых вещей. Например – сравнение узлов. Метод Equals для узлов просто сравнивает ссылки, чего явно недостаточно. Приходится изобретать свои механизмы сравнения.
  • Программа, построенная на базе Roslyn, может потреблять много памяти (гигабайты). Для современных 64-битных компьютеров с большим объемом памяти это не является критичным, но учитывать эту особенность стоит. Вполне возможно, что разработанный вами продукт будет бесполезен на слабых устаревших компьютерах.

PVS-Studio – статический анализатор кода, использующий Roslyn API

PVS-Studio – это статический анализатор кода, предназначенный для выявления ошибок в исходном коде программ, написанных на C, C++, C#.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 13

Та часть анализатора, которая отвечает за проверку C# кода, написана с использованием Roslyn API. Знания и правила, изложенные выше, не взяты с потолка – они получены и сформулированы в ходе работы над анализатором.

PVS-Studio является примером того, какой продукт можно создать, используя Roslyn. В данный момент в анализаторе реализовано свыше 80 диагностических правил. PVS-Studio уже нашёл ошибки во множестве проектов. Некоторые из них:

  • Roslyn;
  • MSBuild;
  • CoreFX;
  • SharpDevelop;
  • MonoDevelop;
  • Microsoft Code Contracts;
  • NHibernate;
  • Space engineers;
  • И многие другие.

Но лучше один раз увидеть, чем сто раз услышать, в нашем случае – лучше собственными глазами взглянуть на анализатор. Его можно загрузить по соответствующей ссылке – посмотрите, что удастся обнаружить в ваших проектах.

У некоторых может возникнуть вопрос: «А что же интересного удалось найти в ходе проверки проектов?». Много чего интересного! Если кто-то думает, что профессионалы не допускают ошибок, рекомендую ознакомиться с базой ошибок, найденных в open source проектах. Помимо этого в блоге можно почитать статьи о проверке тех или иных проектов.

Итоги

Общее

  • Roslyn позволяет разбирать и анализировать код до мельчайших подробностей. Это открывает простор для создания различных приложений на его основе, в том числе статических анализаторов;
  • Для серьёзного анализа проект должен быть скомпилированным, так как это обязательное условие для получения корректной семантической модели;
  • 2 сущности, на которых базируется статический анализ– синтаксическое дерево и семантическая информация. Только используя их в совокупности, можно проводить действительно серьёзный анализ;
  • Открытый исходный код – загружайте и пользуйтесь;
  • Syntax visualizer – полезное расширение, которое поможет вам при работе с платформой.

Синтаксическое дерево

  • Строится для каждого файла и является неизменяемым.
  • Состоит из 3-ёх основных элементов – syntax nodes, syntax tokens, syntax trivia;
  • Узлы – основной элемент дерева, с которым приходится работать в ходе анализа кода;
  • Для каждой конструкции узла определён узел своего типа, что позволяет легко получить необходимые данные, обращаясь к свойствам объекта узла;
  • Лексемы – терминалы грамматики языка, представляющие идентификаторы, ключевые слова, разделители и пр.;
  • Дополнительная синтаксическая информация – комментарии, пробельные символы, директивы препроцессора и пр.;
  • Используйте метод IsKind и перечисление SyntaxKind для конкретизации типа элемента дерева.

Семантическая модель

  • Для качественного анализа должна быть корректной;
  • Позволяет получать информацию об объектах и их типах;
  • Используйте метод GetSymbolInfo, интерфейс ISymbol и производные от него для получения информации о самом объекте;
  • Используйте метод GetTypeInfo, интерфейс ITypeSymbol и производные от него для получения информации о типе объекта или выражения;
  • Используйте метод GetConstantValue для получения константных значений.

Статический анализ

  • Если нет уверенности в том, что код ошибочен, лучше не ругаться. Не стоит засорять результат работы анализатора ложными срабатываниями;
  • При написании диагностик можно выделить общий алгоритм, соблюдение которого позволит реализовывать мощные и функциональные диагностические правила;
  • Используйте синтаксический визуализатор;
  • Чем больше юнит-тестов, тем лучше;
  • При разработке диагностических правил важно проверять их на различных реальных проектах.

Заключение

Введение в Roslyn. Использование для разработки инструментов статического анализа - 14

Подводя итог, хотелось бы сказать, что Roslyn — это действительно мощная платформа, на основе которой можно создавать различные многофункциональные инструменты – анализаторы, инструменты рефакторинга и много чего ещё. Низкий поклон Microsoft за Roslyn, а также за возможность его свободного использования.

Однако наличия платформы мало – нужно знать, как с ней работать. Основные понятия и принципы работы и были описанные в данной статье. Полученные знания помогут вам легче и быстрее вникнуть в процесс разработки с использованием Roslyn API, было бы желание.

Введение в Roslyn. Использование для разработки инструментов статического анализа - 15

Если хотите поделиться этой статьей с англоязычной аудиторией, то прошу использовать ссылку на перевод: Sergey Vasiliev. Introduction to Roslyn and its use in program development.

Прочитали статью и есть вопрос?
Часто к нашим статьям задают одни и те же вопросы. Ответы на них мы собрали здесь: Ответы на вопросы читателей статей про PVS-Studio, версия 2015. Пожалуйста, ознакомьтесь со списком.

Автор: PVS-Studio

Источник

Поделиться новостью

* - обязательные к заполнению поля