Что такое код strnatcmp

strnatcmp()

Синтаксис:

strnatcmp ($str1 , $str2 )

Поддерживается следующими версиями PHP:

Описание функции:

Функция strnatcmp() сравнивает две строки с применением алгоритма «естественного упорядочивания». Под алгоритмом «естественного упорядочивания» понимается сравнение привычное для человека.

В стандартных компьютерных алгоритмах число 2 (представленное в виде строки) будет больше чем число 10 (также представленное в виде строки). Это связано с тем, что сравнение идет посимвольно. Функция strnatcmp() устраняет этот недостаток.

Возвращает три возможных значения:

число меньше 0 — если str1 меньше чем str2;

число больше 0 — если str1 больше чем str2.

0 — если str1 равно str2.

Обязательный аргумент. Первая сравниваемая строка.

Обязательный аргумент. Вторая сравниваемая строка.

string

При сравнении учитывается регистр.

Примеры:

Сравнение алфавитно-цифровых строк с применением алгоритма «естественного упорядочивания» и без него дает совершенно противоположные результаты.

echo «Стандартное сравнение
«;
echo strcmp(‘doc2’, ‘doc10’);
echo «
«;
echo «Алгоритм \»естественного упорядочения\»
«;
echo strnatcmp(‘doc2’, ‘doc10’);
?>

Стандартное сравнение
1
Алгоритм «естественного упорядочения»
-1

strnatcmp

strnatcmp — сравнение строк с использованием алгоритма «natural order/натурального порядка».

Описание

int strnatcmp (string str1, string str2)

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

Этот код даст на выводе:

Дополнительно см. страницу Martin’а Pool’а Natural Order String Comparison.

Как и другие функции сравнения строк, эта возвращает str1 меньше str2 ; > 0, если str1 больше str2 ; 0, если они равны.

Обратите внимание, что это сравнение с учётом регистра символов.

Указатели на структуры

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

Объявление указателя на структуру

Как и другие указатели, указатель на структуру объявляется с помощью звездочки * , которую помещают перед именем переменной структуры. Например, для ранее определенной структуры addr следующее выражение объявляет addr_pointer указателем на данные этого типа (то есть на данные типа addr ):

Использование указателей на структуры

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

У такого способа, как передача любых (кроме самых простых) структур функциям, имеется один большой недостаток: при выполнении вызова функции, чтобы поместить структуру в стек, необходимы существенные ресурсы. (Вспомните, что аргументы передаются функциям через стек.) Впрочем, для простых структур с несколькими членами эти ресурсы являются не такими уж большими. Но если в структуре имеется большое количество членов или некоторые члены сами являются массивами, то при передаче структур функциям производительность может упасть до недопустимо низкого уровня. Как же решить эту проблему? Надо передавать не саму структуру, а указатель на нее.

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

Чтобы получить адрес переменной-структуры, необходимо перед ее именем поместить оператор & . Например, в следующем фрагменте кода

адрес структуры person можно присвоить указателю p :

Чтобы с помощью указателя на структуру получить доступ к ее членам, необходимо использовать оператор стрелка -> . Вот, например, как можно сослаться на поле balance :

Оператор -> , который обычно называют оператором стрелки , состоит из знака «минус», за которым следует знак «больше». Стрелка применяется вместо оператора точки тогда, когда для доступа к члену структуры используется указатель на структуру.

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

Эту программу можно настраивать, меняя определение DELAY .

В этой программе объявлена глобальная структура my_time , но при этом не объявлены никакие другие переменные программы. Внутри же main() объявлена структура systime и она инициализируется значением 00:00:00. Это значит, что systime непосредственно видна только в функции main() .

Функциям update() (которая изменяет значения времени) и display() (которая выводит эти значения) передается адрес структуры systime . Аргументы в обеих функциях объявляются как указатель на структуру my_time .

Внутри update() и display() доступ к каждому члену systime осуществляется с помощью указателя. Так как функция update() принимает указатель на структуру systime , то она в состоянии обновлять значение этой структуры. Например, необходимо «в полночь», когда значение переменной, в которой хранится количество часов, станет равным 24, сбросить отсчет и снова сделать значение этой переменной равным 0. Для этого в update() имеется следующая строка:

Таким образом, компилятору дается указание взять адрес t (этот адрес указывает на переменную systime из main() ) и сбросить значение hours в нуль.

Помните, что оператор точка используется для доступа к элементам структуры при работе с самой структурой. А когда используется указатель на структуру, то надо применять оператор стрелка.

Что такое код strnatcmp

strnatcmp — Сравнение строк с использованием алгоритма «естественного упорядочения»

Описание int strnatcmp ( string str1, string str2 )

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

Стандартный алгоритм сравнения Array ( [0] => img1.png [1] => img10.png [2] => img12.png [3] => img2.png ) Алгоритм «естественного упорядочения» Array ( [0] => img1.png [1] => img2.png [2] => img10.png [3] => img12.png )

Подобно другим функциям сравнения строк, strnatcmp() возвращает отрицательное число, если str1 меньше, чем str2 ; положительное число если, str1 больше, чем str2 , и 0 если строки равны.

strnatcmp — Сравнение строк с использованием алгоритма «natural order»

(PHP 4, PHP 5, PHP 7)

strnatcmp — Сравнение строк с использованием алгоритма «natural order»

Описание

Эта функция реализует алгоритм сравнения, упорядочивающий алфавитно-цифровые строки подобно тому, как это сделал бы человек, такой алгоритм называется «natural ordering». Сравнение происходит с учетом регистра.

Список параметров

Возвращаемые значения

Подобно другим функциям сравнения строк, данная функция возвращает отрицательное число, если str1 меньше, чем str2 , положительное число, если str1 больше, чем str2 , и 0 если строки равны.

Примеры

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

Результат выполнения данного примера:

Смотрите также

• preg_match() — Выполняет проверку на соответствие регулярному выражению
• strcasecmp() — Бинарно-безопасное сравнение строк без учета регистра
• substr() — Возвращает подстроку
• stristr() — Регистронезависимый вариант функции strstr
• strcmp() — Бинарно-безопасное сравнение строк
• strncmp() — Бинарно-безопасное сравнение первых n символов строк
• strncasecmp() — Бинарно-безопасное сравнение первых n символов строк без учета регистра
• strnatcasecmp() — Сравнение строк без учета регистра с использованием алгоритма «natural order»
• strstr() — Находит первое вхождение подстроки
• natsort() — Сортирует массив, используя алгоритм «natural order»
• natcasesort() — Сортирует массив, используя алгоритм «natural order» без учета регистра символов

Учимся правильно оформлять код на C на примере open source проектов

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

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

Научиться правильному оформлению кода можно, например:

• из книг и журналов;
• из руководств в сети;
• из общения с коллегами;
• на собственном опыте.

Другой, не менее интересный, подход — взять проверенный временем открытый проект и разобраться в том, какие решения принимали его разработчики. Хорошим примером в этом случае будет ядро Linux.

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

Давайте посмотрим на пример реализации функции из исходного кода Linux:

Код выглядит чистым и понятным:

• Он короткий, всего несколько строк.
• Подробная сигнатура функции.
• Код хорошо документирован.
• Код правильно и последовательно структурирован.
• Понятные имена переменных.

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

Стиль написания кода очень сильно влияет на его читаемость. Поэтому время, потраченное на тренировку и периодические код-ревью, всегда окупится.

Давайте теперь посмотрим на код ядра Linux с помощью CppDepend и попробуем разобраться, какими правилами руководствовались разработчики.

Модульность

Модульность — это техника дизайна приложений, которая обеспечивает повторное использование кода и облегчает его поддержку.

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

Мы можем использовать два подхода:

• Положить все исходники в одну директорию
• Объединить файлы, относящиеся к одному модулю в одну директорию.

В случае с ядром Linux директории и поддиректории используются для обеспечения модульности кода ядра.

Инкапсуляция

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

Давайте посмотрим на статические функции с помощью следующего запроса в CQLinq:

Мы можем использовать панель Метрик (Metric view) чтобы оценить код в целом. На этой панели код представлен в виде дерева (Treemap). Древовидная структура, используемая в CppDepend показывает иерархию кода:

• Директории в проекте.
• Файлы в директориях.
• Структуры, функции и переменные в файлах.

Дерево проекта позволяет наглядно представить результаты запроса CQLinq.

Видно, что множество функций — статические.

Теперь давайте найдем статические поля:

В коде ядра Linux инкапсуляция используется каждый раз, когда доступ к функции или переменной должен быть разрешен только из того же файла.

Используйте структуры для своих данных

В C функции используют переменные для работы. Переменные могут быть:

• статическими;
• глобальными;
• локальными;
• полями структур.

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

Давайте найдем все глобальные переменные с примитивным типом:

Их всего несколько, и, возможно, мы могли бы сгруппировать их в структуры, например ( elfcorehdr_addr и elfcorehdr_size ) или ( pm_freezing и pm_nosig_freezing ).

Функции должны быть краткими и понятными

Вот совет из linux coding style по поводу длины функции:

Функции должны быть короткими и понятными, делать только одну вещь. Они должны занимать один или, максимум, два экрана текста (экран по ISO/ANSI имеет размер 80×24). Функция должна делать одну вещь, и делать ее хорошо.

Максимальная длина функции обратно пропорциональна ее сложности и количеству уровней вложенности. Так, если у вас, например, простая функция с одним, но большим case-выражением, она может быть длинной.

Давайте найдем все функции, длина которых больше 30 строк:

Всего немного методов занимает больше 30 строк.

Количество параметров функции

Функции с количеством параметров большим, чем 8 (NbParameters > , трудно вызывать. Также, их вызов плохо сказывается на производительности. Вместо этого мы можем передавать в них структуру с необходимыми значениями.

Только два метода принимают больше, чем 8 параметров.

Количество локальных переменных

Методы, в которых используются более 8 локальных переменных (значение NbVariables) тяжело понимать и поддерживать. Методы, в которых 15 и более локальных переменных очень сложны и их следует разбивать на более мелкие (кроме тех случаев, когда код сгенерирован сторонним инструментом).

Только в пяти функциях используется более 15 локальных переменных.

Избегайте сложных функций

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

Есть несколько более комплексных метрик:

• Cyclomatic complexity — популярная метрика, показывающая количество ветвлений в коде.
• Nesting Depth — is a metric defined on methods that is relative to the maximum depth of the more nested scope in a method body.
• Max Nested loop — максимальный уровень вложенности в методе.

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

Давайте посмотрим на функции, которые можно упростить:

Только небольшое количество функций можно признать сложными.

Соглашения об именовании

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

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

Имена только 4 структур начинаются с «_» вместо строчной буквы.

Отступы и выравнивание

Отступы очень важны для того, чтобы код был читаем. Вот что пишут об этом на странице linux coding style:

Обоснование: Основная идея отступов состоит в том, чтобы показать где начинается и заканчивается логический блок кода. Когда вы смотрите на один и тот же код в течение 20 часов, трудно не заметить пользу отступов.

Некоторые могут возразить, что отступ в 8 пробелов делает код слишком широким, особенно на 80-знаковой строке терминала. Ответ: Если вам понадобилось более трех уровней отступа, вы что-то делаете неправильно и вам следует переписать этот участок.

Заключение

Чтение кода open-source проектов всегда идет на пользу вашему опыту. При этом нет необходимости скачивать и собирать проект, достаточно просто просматривать код, например, на GitHub.

Структуры в Си и их передача

Структура — это удобное хранилище для разнородных данных, которые хочется объединить. К примеру, вы можете создать структуру, описывающую параметры вашего устройства — сетевые настройки, таймаут спящего режима, его идентификатор и прочее подобное, типа какой-нибудь строки приветствия и состояния светодиода. Раз все параметры будут храниться в одном месте — они всегда будут на виду, да и нормальные IDE будут вам подсказывать поля структуры при обращении к ним. Ещё мы рассмотрим хранение и восстановление структур из архива, а также их передачу по сети.

Объявление такой структуры:

Как это работает?

В си довольно удобный синтаксис, в том плане что многие вещи записываются как «тип_данных переменная», начиная с «int i» заканчивая «void main() <>». Так и здесь, кодовое слово struct начинает объявление структуры, и весь кусок кода «struct < … >» просто задаёт новый тип. Соответственно, params — это уже готовая переменная (экземпляр типа), которую можно использовать. Внутри фигурных скобок перечислены все поля структуры, которые потом будут доступны так: params.ID или params.IP[2]. Длина полей должна быть фиксированной, поэтому нельзя использовать строки вида *text, только массивы вида text[12].

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

Так появляется возможность оставить все объявления структурных типов в отдельном файле (header), а в главном файле просто использовать уже готовые структурные типы для объявления структур прямо по месту.

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

Вариант с массивом особенно удобен для сервера в клиент-серверной топологии сети — на каждом клиенте хранятся в структуре его собственные параметры, а на мастер-устройстве располагается таблица параметров всех клиентов в виде массива структур.

В принципе, ничего сложного в структурах нет, а с темой серверов и клиентов мы плавно подошли к более интересной теме:

Хранение, передача и синхронизация структур

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

Начальное смещение получим так:

мы объявили указатель char и поместили в него адрес params. Теперь Bytes указывает на первый байт структуры, и при последовательном чтении мы побайтно прочитаем всю структуру. Но сколько байт нужно прочитать? Для этого рассмотрим две интересных функции.

sizeof и offsetof

Это даже не функции, а встроенные макросы языка Си. Начнём с более простой, sizeof.

Компилятор заменяет все записи вида sizeof X на значение длины Х. В качестве X может выступать как тип, так и экзмепляр типа, т.е. в нашем случае можно подставить в sizeof и тип структуры (если мы его заводили с помощью typedef), и саму переменную структуры так: sizeof params_struct или sizeof params. Она пройдёт по всем полям структуры, сложит их длины и отдаст сумму, которая и будет длиной структуры.

offsetof — настоящий макрос, который принимает два параметра (структуру _s_ и поле _m_ в ней) и отдаёт положение этого поля в структуре, его смещение относительно начала структуры. Выглядит этот макрос очень просто:

Как он работает?

1. Берём число 0
2. Преобразуем его к типу «указатель на структуру s»: (s*)0
3. Обращаемся к полю m из этой структуры: ((s*)0)->m
4. Вычисляем его адрес: &(((s*)0)->m)
5. Преобразуем адрес к целому числу: (size_t)&(((s*)0)->m)

Магия именно в первом шаге, в котором мы берём 0. Благодаря этому на четвёртом шаге абсолютный адрес поля, вычисленный компилятором, оказывается отсчитан относительно начала структуры — структуру-то мы положили в адрес 0. Таким образом, после выполнения этого макроса мы реально имеем смещение поля относительно начала структуры. Понятно, что этот макрос правильно определит смещения даже в сложных и вложенных структурах.

Здесь нужно сделать небольшое отступление. Дело в том, что я рассматривал самый простой случай, когда поля упакованы точно вслед друг за другом. Есть и другие методы упаковки, которые называются «выравнивание». К примеру, можно выдавать каждому полю «слот», кратный 4 байтам, или 8 байтам. Тогда даже char будет занимать 8 байт, и общий размер структуры вырастет, а все смещения сдвинутся и станут кратны выравниванию. Эта штука полезна при программировании для компьютера, поскольку из-за грануляции ОЗУ процессор гораздо быстрее умеет извлекать из памяти выровненные данные, ему требуется на это меньше операций.

Работа с массивом из структуры

Окей, теперь мы умеем представлять любую структуру в виде массива байт, и обратно. Вы поняли фишку? У нас теперь одна и та же область памяти имеет роли «структура» и «массив». Изменяем что-то в структуре — меняется массив, меняем массив — меняется структура.

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

Теперь осталось лишь научиться удобно с этим всем работать.

Хранение и передача структуры

Чтобы создать архивную копию структуры, для передачи по сети или для складывания её в надёжное место — отдайте в вашу функцию передачи данных адрес этого массива. К примеру, моя функция записи массива данных в EEPROM выглядит так: I2C_burst_write (I2Cx, HW_address, addr, n_data, *data). Вам просто нужно вместо n_data передать sizeof params, а вместо *data — &params:

Функции передачи данных по сети обычно выглядят примерно так же. В качестве данных передавайте &params, а в качестве длины данных — sizeof params.

Приём и восстановление структуры

Всё точно так же. Моя функция чтения массива из EEPROM: I2C_burst_read (I2Cx, HW_address, addr, n_data, *data). n_data = sizeof params, *data = &params:

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

Реализовав эти методы, мы воплотим удобную синхронизацию двух структур, находящихся на разных компьютерах: клиент-микроконтроллер может быть хоть на другой стороне земного шара от сервера, но передать структуры будет всё так же просто.

Хранение/восстановление отдельных полей

И зачем же мы так долго рассматривали макрос offsetof? Его очень удобно использовать для чтения и записи отдельных полей структуры, например так:

Ну и вообще, было бы неплохо сделать удобные макросы-обёртки для этой цели.

Что такое код strnatcmp

We recommend upgrading to the latest Google Chrome or Firefox.

Join GitHub today

GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.

code / thirdparty / strnatcmp.h

• © 2020 GitHub , Inc.
• Terms
• Privacy
• Security
• Status
• Help

You can’t perform that action at this time.

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.

.NET и работа с неуправляемым кодом. Часть 1

.NET и работа с неуправляемым кодом. Часть 1

.NET и работа с неуправляемым кодом

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

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

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

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

struct test
<
struct innerstr
<
char str[300];
int Int;
int * in_pInt;
> in ;
char str[2][50];
int IntArr[10];
int * pInt;
innerstr* pStruct;
int * ptr;
>;

* This source code was highlighted with Source Code Highlighter .

[StructLayout(LayoutKind.Sequential)]
public struct Test
<
public Innerstr _in;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 50 * 2)]
public char [] str;;
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 10)]
public int [] IntArr;
public IntPtr pInt;
public IntPtr pStruct;
public IntPtr ptr;

[StructLayout(LayoutKind.Sequential)]
public struct Innerstr
<
[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 300)]
internal string str;
public int _Int;
public IntPtr in_pInt;
>
>

* This source code was highlighted with Source Code Highlighter .

Как можете заметить, все указатели из C были заменения на тип IntPtr из C#. Двумерные массивы — на одномерные, аналогичной длины. А сама структура подписана аттрибутом [StructLayout]. Значение LayoutKind параметра Sequential используется для принудительного последовательного размещения членов в порядке их появления.

Для массивов необходимо указать их тип как UnmanagedType.ByValArray и сразу же указать их точный размер. Даже если размер самой переменной будет отличаться — при передаче, он автоматически будет уравнен в необходимый размер.

Вызов неуправляемого кода

extern «C» __declspec(dllexport) int ExpFunc(test* s, bool message)

* This source code was highlighted with Source Code Highlighter .

[ return :MarshalAs(UnmanagedType.I4)]
[DllImport( «TestTkzDLL.dll» )]
public static extern int ExpFunc([In, Out] IntPtr c, [In] bool message);

* This source code was highlighted with Source Code Highlighter .

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

// для получения указателя на => int* pInt
int _pInt = 2010; // значение числа
IntPtr _pInt_buffer = Marshal.AllocCoTaskMem(Marshal.SizeOf(_pInt)); // выделили кусочек памяти
Marshal.StructureToPtr(_pInt, _pInt_buffer, false ); // записали содержимое
test.pInt = _pInt_buffer; // сохранили

* This source code was highlighted with Source Code Highlighter .

По аналогии, и для innerstr* pStruct, и для всех остальных указателей.

Test.Innerstr inner2 = new Test.Innerstr();
IntPtr _pStruct_buffer = Marshal.AllocCoTaskMem(Marshal.SizeOf(inner2));
Marshal.StructureToPtr(inner2, _pStruct_buffer, false );
test.pStruct = _pStruct_buffer;

* This source code was highlighted with Source Code Highlighter .

Вот и всё, всё просто. Теперь осталось из кода вызвать метод

// ГЕНЕРИРУЕМ ЗАПРОС (способ с маршилингом данных в память, затем передачей ссылки)
/////////////////////////////////////
IntPtr ptr1 = Marshal.AllocCoTaskMem(Marshal.SizeOf(test));
Marshal.StructureToPtr(test, ptr1, false );
int retInt = ExpFunc(ptr1, false ); // вызов ветода
test = (Start >typeof (Start >/// получаем наше значение обратно из неуправляемого кода

* This source code was highlighted with Source Code Highlighter .

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

Затем не забудьте почистить память. В отличие от управляемого кода, сборщик мусора не может чистить неуправляемый. Поэтому необходимо вызвать Marshal.FreeCoTaskMem(ptr); для всех ссылок IntPtr

PS: добавлено позже… аттрибут [StructLayout(LayoutKind.Sequential)], также может указывать на используемую таблицу символов, ANSI или UNICODE. Для этого необходимо написать [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)], [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)] или [StructLayout(LayoutKind.Sequential, CharSet = CharSet.Auto)]. По-умолчанию используется ANSI.

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

Обновлено
Добавлены исходники тестового проекта. Скачать

Реклама PVS-Studio — статический анализ кода на языке Си и Си++

Данная статья устарела. Обновляемый список статей о проверенных проектах находится здесь.

Этот документ рекламирует статический анализатор PVS-Studio. Описывается, как использование PVS-Studio уменьшит количество ошибок в коде проекта на языке C/C++/C++11 и сократит затраты на тестирование, отладку и сопровождение кода. Приводится большое количество примеров ошибок, найденных анализатором в различных Open-Source проектах. Документ описывает PVS-Studio на момент версии 4.38 от 12 октября 2011 и, как следствие, не отражает возможности следующих версий. Чтобы познакомиться с новыми возможностями, предлагаем посетить сайт продукта www.viva64.com или поискать обновленный вариант этой статьи.

Что такое статический анализ кода

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

Статический анализ кода отчасти схож с методикой обзоров кода (code review). Отличие в том, что роль экспертов здесь выполняет программное обеспечение. Конечно, возможности программы далеки от возможности команды людей. Но зато, программа неутомима, и её использование на несколько порядков дешевле по сравнению с обзорами кода.

Статические анализаторы могут быть как общего назначения (например, PVS-Studio, Microsoft PREFast, Gimpel PC-Lint, Parasoft C++Test), так и специализированными для поиска определенных классов ошибок (например, Chord для верификации параллельных Java программ). Статические анализаторы обычно используются в компаниях с высокой культурой разработки и зрелыми процессами разработки программного обеспечения. Это связано с тем, что инструменты статического анализа требуют понимания принципов их работы, необходимости уделить некоторое время их изучению и интеграции в процесс разработки. Взамен они позволяют выявить большое количество ошибок на самых ранних этапах разработки программного кода.

Основное преимущество использования статических анализаторов кода состоит в возможности существенного снижения стоимости устранения дефектов в программе. Чем раньше ошибка выявлена, тем меньше стоимость ее исправления. Так, согласно данным, приведенным в книге Макконнелла «Совершенный Код», исправление ошибки на этапе тестирования обойдется в десять раз дороже, чем на этапе конструирования (кодирования):

Рисунок 1. Средняя стоимость исправления дефектов в зависимости от времени их внесения и обнаружения (данные для таблицы взяты из книги С. Макконнелла «Совершенный Код»).

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

Инструмент PVS-Studio

PVS-Studio это легкий в изучении и использовании инструмент статического анализа кода. PVS-Studio представляет собой модуль расширения к среде программирования Visual Studio 2005/2008/2010. Впрочем, анализатор можно использовать и из командной строки, о чем более подробно можно узнать в документации.

Основные характеристики PVS-Studio:

Поддерживаемые языки: С / C++ / С++11 (в тех рамках, в которых эти языки поддерживает компилятор Visual C++).

Операционные системы: 32-битные и 64-битные версии Windows XP / 2003 / Vista / 2008 / 7.

Системные требования: Системные требования к анализатору совпадают с требованиями к Microsoft Visual Studio.

Режимы работы: Как расширение среды Visual Studio 2005/2008/2010. Запуск из командной строки (есть solution-файл / нет solution-файла). Примечание: работа PVS-Studio с Visual C++ Express Edition не возможна, поскольку эта система не поддерживает модули расширений.

Интеграция с системами continuous integration: Есть.

Документация: На русском и английском языке.

Возможность скачать демонстрационную версию: Есть.

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

Типы выявляемых дефектов

Диагностические сообщения PVS-Studio можно разделить на 4 группы:

1. Диагностика 64-битных ошибок

PVS-Studio имеет, на наш взгляд, самый мощный в мире набор правил статического анализа, выявляющих 64-битные ошибки. Эти диагностические правила помогают перенести 32-битный код на 64-битную систему и контролировать написание нового 64-битного кода. На тему 64-битных ошибок мы написали множество интересных статей, с которыми можно познакомиться на нашем сайте:

• Коллекция примеров 64-битных ошибок в реальных программах: http://www.viva64.com/ru/a/0065/
• 64-битный конь, который умеет считать: http://www.viva64.com/ru/a/0043/
• Что такое size_t и ptrdiff_t: http://www.viva64.com/ru/a/0050/
• Уроки разработки 64-битных приложений на языке Си/Си++: http://www.viva64.com/ru/l/

В перечисленных статьях подробно рассмотрена тематика 64-битных дефектов, и здесь мы не будем на ней останавливаться. Приведем только один пример, чтобы дать понять о каких ошибках в этих статьях идёт речь:

Этот код был обнаружен PVS-Studio в проекте Newton Game Dynamics. Обратите внимание на второй вызов функции ‘memset’. Из-за случайной опечатки эта функция заполняет нулями ‘sizeof(faceOffsetHitogram)’ байт, а не ‘sizeof(mainSegmenst)’.

Почему эту ошибку мы называем 64-битной? Дело в том, что эта ошибка проявит себя только при компиляции кода в 64-битном режиме. В 32-битной программе размер указателей и типа ‘dgInt32’ совпадает. Это значит, что в 32-битной программе размер массивов faceOffsetHitogram и mainSegmenst совпадут. В 64-битной программе эти массивы занимают разное количество байт, а следовательно функция ‘memset’ заполнит только часть массива.

2. Выявление неэффективных конструкций

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

Анализатор выдаст для этого кода предупреждение V804. Этот код можно оптимизировать, если предварительно вычислить длину строки и поместить её во временную переменную. Это не всегда нужно. Однако, если подобный код выполняется множество раз в цикле, такая оптимизация может быть весьма полезна.

3. Диагностические правила, имплементированные по заказу пользователей

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

4. Диагностические правила общего назначения

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

Лучшей рекламой для программистов являются примеры исходного кода. Поэтому не будем писать абстрактные тексты о возможностях статического анализа, а покажем эти самые примеры на практике. Если вы стремитесь поскорее посмотреть их, то перейдите к разделу «Примеры выявленных ошибок в различных open-source проектах». Или ещё немного потерпите и прочитайте всю скромную хвалебную статью по порядку.

Работа с отчетом PVS-Studio

Если вы работаете с анализатором в рамках среды Visual Studio, то в вашем распоряжении будет простой интерфейс, состоящий из 2 компонент: новое меню и интерактивное окно для работы с предупреждениями.

1. Меню PVS-Studio

Рисунок 2. Меню PVS-Studio, интегрированное в Visual Studio 2005.

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

2. Интегративное окно с предупреждениями

Рисунок 3. Окно PVS-Studio для работы с предупреждениями (кликните на картинку для просмотра полноценного снимка экрана)

• Навигация по коду. Осуществляется двойным щелчком мыши по сообщению с помощью иконок вперёд/назад или с помощью горячих клавиш ‘Alt — [‘ и ‘Alt — ]’.
• Открытие документации для соответствующей ошибки. Необходимо щелкнуть мышкой на коде ошибки.
• Включение/выключение различных наборов предупреждений. Например, можно просмотреть только предупреждения первого уровня важности, относящиеся к 64-битным диагностикам.
• Различные способы сортировки и фильтрации сообщений. Возможен поиск определенных сообщений. Есть и другие мелкие возможности, такие как «пометка звездочкой» сообщений, вызвавших интерес.
• Для отдельных сообщений также доступно контекстное меню (наведите на сообщение и нажмите правую кнопку мыши). Например, с помощью него можно осуществить такую важную функцию, как пометить диагностику как ложную (Mark selected errors as False Alarms).

Инкрементальный анализ кода

PVS-Studio позволяет дешево внедрить статический анализ в процесс разработки.

Если включен режим «Incremental Analysis after Build», то анализатор запускается сразу после компиляции и проверяет только те файлы, которые были «задеты» правками пользователя. То есть пользователь видит ошибки только в том коде, который он непосредственно пишет или затрагивает при рефакторинге.

Программисту не надо беспокоиться о большом объеме кода, с которым он в данный момент не работает. Возможно, этому коду уже более 5 лет. Он практически не модифицируется и большинство дефектов в нем уже исправлено. Этот код не надо бросаться проверять в первую очередь, и анализатор этого и не делает. Программист будет видеть предупреждения только в свежем коде. А уж если у него будет дополнительное время, он всегда сможет проверить проект целиком, заглянув в самые редко посещаемые места.

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

Рисунок 5. Всплывающее уведомление PVS-Studio.

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

Попробуйте. Мы уверены, программистам понравится этот режим работы.

Возврат инвестиций при использовании PVS-Studio (ROI)

Этот раздел на тот случай, если попробуете анализатор PVS-Studio и найдете только несколько ошибок. У вас возникнет вопрос, в чём польза от использования статического анализа, если он смог выявить только небольшое количество дефектов? Если это произошло, то вспомните про этот текст и ознакомьтесь со следующими 2 заметками:

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

Поддержка наших пользователей

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

• создание файлов-отчетов в определенном формате;
• разработка скриптов (сценариев) для особых вариантов запуска PVS-Studio;
• доработка инструмента для взаимодействия с той или иной системой непрерывной интеграции или сборки;
• введение новых настроек в инструменте;
• проверка не всех файлов проекта/решения, а только некоторых (по именам или по времени модификации – к примеру, за последний день).

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

Примеры выявленных ошибок в различных open-source проектах

Мы регулярно проверяем известные и не очень известные open-source проекты. Это делается для того, чтобы иметь возможность написать соответствующую рекламную заметку и протестировать работу анализатора PVS-Studio на новом коде. Многие читатели спрашивают, сообщаем ли мы авторам проектов о найденных ошибках. Да, в обязательном порядке. И так случается, что иногда после этого у нас появляется новый клиент.

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

Из проверенных нами проектов, конечно, взято только по несколько ошибок. Если описывать все найденные дефекты, то это уже будет справочник. Список проверенных проектов:

Рисунок 6. Логотипы проверенных проектов

Ошибки работы с массивами и строками

Ошибки в обработке массивов и строк являются самым обширным классом дефектов в программах на языке Си/Си++. Это плата за возможность эффективной низкоуровневой работы с оперативной памятью. В статье будет показа лишь малая часть подобных ошибок, найденных анализатором PVS-Studio. Но думаем, что любой Си/Си++ программист понимает, как их много и как они коварны.

Пример 1. Проект Wolfenstein 3D. Очистка только части объекта.

Ошибка найдена с помощью диагностики V568: It’s odd that the argument of sizeof() operator is the ‘&itemInfo’ expression. cgame cg_weapons.c 1467.

Оператор sizeof() вычисляет размер указателя, а не структуры ‘itemInfo_t’. На самом деле должно быть написано «sizeof(*itemInfo)».

Пример 2. Проект Wolfenstein 3D. Копирование только части матрицы.

Ошибка найдена с помощью диагностики V511: The sizeof() operator returns size of the pointer, and not of the array, in ‘sizeof(src)’ expression. Splines math_matrix.h 94

Как правило, программисты ожидают, что ‘sizeof(src)’ вернет размер массива равного «3*3*sizeof(float)». Но согласно стандарту языка, ‘src’ это просто указатель, а вовсе не массив. Таким образом, матрица будет скопирована только частично. Функция ‘memcpy’ скопирует 4 или 8 байт (размер указателя) в зависимости от того, этот код 32-битный или 64-битный.

Если хочется скопировать матрицу целиком, то можно передать в функцию ссылку на массив. Корректный вариант кода:

Пример 3. Проект FAR Manager. Очистка только части массива.

Ошибка найдена с помощью диагностики V579: The memset function receives the pointer and its size as arguments. It is possibly a mistake. Inspect the third argument. far treelist.hpp 66

Скорее всего, здесь не хватает умножения на количество очищаемых элементов, и код должен был выглядеть так: «memset(Last, 0, LastCount * sizeof(*Last));».

Пример 4. Проект ReactOS. Некорректное вычисление длины строки.

Ошибка найдена с помощью диагностики V579: The strncmp function receives the pointer and its size as arguments. It is possibly a mistake. Inspect the third argument. vga vbe.c 57

Имеющиеся в коде вызовы функции ‘strncmp’ сравнивают только несколько первых символов, а не строки целиком. Ошибка в том, что для вычисления длины строк используется совершенно неуместный здесь оператор sizeof(). Оператор sizeof() вычисляет размер указателя, а вовсе не количество байт в строке.

Самое неприятное и коварное с этой ошибкой в том, что этот код почти работает. В 99% случаев сравнение по первым нескольким символам бывает достаточно. Зато 1% может подарить массу удовольствий и долгую отладку.

Пример 5. Проект VirtualDub. Выход за рамки массива (явный индекс).

Фрагмент кода найден с помощью диагностики V557: Array overrun is possible. The ‘9’ index is pointing beyond array bound. VirtualDub f_convolute.cpp 73

Это пример не настоящей ошибки, но зато хорошей диагностики. Почему это не ошибка, поясняет автор: http://www.virtualdub.org/blog/pivot/entry.php? >

Пример 6. Проект CPU Identifying Tool. Выход за рамки массива (индекс в макросе).

Ошибка найдена с помощью диагностики V557: Array overrun is possible. The ’64’ index is pointing beyond array bound. stickies stickies.cpp 7947

Эта ошибочная ситуация является разновидностью предыдущей. Терминальный ноль записывается за границей массива. Корректным вариантом кода будет: «findWhat[FINDBUFFLEN — 1] = ‘\0’;».

Пример 7. Проект Wolfenstein 3D. Выход за рамки массива (неверное выражение).

Ошибка найдена с помощью диагностики V557: Array overrun is possible. The ‘sizeof (bs->teamleader)’ index is pointing beyond array bound. game ai_team.c 548

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

Терминальный ноль записывается за пределами массива ‘teamleader’. Корректный вариант:

Пример 8. Проект Miranda IM. Копирование только части строки.

Ошибка найдена с помощью диагностики V512: A call of the ‘memcpy’ function will lead to a buffer overflow or underflow. tabsrmm utils.cpp 1080

Если используются Unicode-строки, то один символ занимает не один байт, а 2 или 4 байта (в зависимости от используемой модели данных в компиляторе). К сожалению, про этом легко забывается, и нередко в программах можно встретить дефекты, аналогичные тому, который показан здесь.

Функция ‘CopyMemory’ скопирует только часть строки L»mailto:», так как работает с байтами, а не с символами. Код можно исправить, используя более подходящую функцию для копирования строк или, по крайней мере, умножив число 7 на sizeof(wchar_t).

Пример 9. Проект CMake. Выход за границу массива внутри цикла.

Ошибка найдена с помощью диагностики V557: Array overrun is possible. The value of ‘i’ index could reach 367. cmlibarchive archive_windows.c 1140, 1142

Обработчик ошибок сам содержит ошибку. Оператор sizeof() возвращает размер массива в байтах, а не количество элементов в нём. В результате, в цикле программа попытается перебирать намного больше элементов, чем должна. Корректный цикл должен выглядеть так:

Пример 10. Проект CPU Identifying Tool. Печать строки саму в себя.

Ошибка найдена с помощью диагностики V541: It is dangerous to print the string ‘szOperatingSystem’ into itself. stickies camel.cpp 572, 603

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

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

Пример 11. Проект FCE Ultra. Для строки выделяется памяти меньше, чем надо.

Ошибка найдена с помощью диагностики V518: The ‘realloc’ function allocates strange amount of memory calculated by ‘strlen(expr)’. Perhaps the correct variant is ‘strlen(expr) + 1’. fceux cheat.cpp 609

Причиной ошибки является опечатка. Аргументом функции strlen() должен быть указатель ‘name’, а вовсе не выражение «name+1». В результате, функция realloc выделит на 2 байта меньше памяти, чем необходимо. Один байт потеряется из-за того, что к длине строки не прибавлена единица. Другой байт потеряется из-за того, что функция ‘strlen’ считает длину строки, пропустив первый символ.

Пример 12. Проект Notepad++. Частичное обнуление массива.

Ошибка найдена с помощью диагностики V512: A call of the memset function will lead to a buffer overflow or underflow. notepadPlus DockingManager.cpp 60

Очередная путаница с количеством элементов в массиве и его размером. Забыто умножение на sizeof(int).

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

Неопределенное поведение (Undefined behavior)

В начале немного теории.

Неопределённое поведение (англ. undefined behaviour) — свойство некоторых языков программирования (наиболее заметно в Cи и Си++) в определённых ситуациях выдавать результат, зависящий от реализации компилятора. Другими словами, спецификация не определяет поведение языка в любых возможных ситуациях, а говорит: «при условии А результат операции Б не определён». Допускать такую ситуацию в программе считается ошибкой, даже если на некотором компиляторе программа успешно выполняется, она не будет кроссплатформенной и может отказать на другой машине в другой ОС и даже на других настройках компилятора.

Точка следования (англ. Sequence point) — в программировании любая точка программы, в которой гарантируется, что все побочные эффекты предыдущих вычислений уже проявились, а побочные эффекты последующих еще отсутствуют. Подробнее про точки следования и какие ситуации неопределенного поведения с ними связаны можно прочитать здесь: http://www.viva64.com/ru/t/0065/.

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

Ошибка найдена с помощью диагностики V554: Incorrect use of auto_ptr. The memory allocated with ‘new []’ will be cleaned using ‘delete’. interactive_ui_tests accessibility_win_browsertest.cc 171

Это пример демонстрирует, когда использование умного указателя может привести к неопределенному поведению. Проявить себя это может повреждением кучи, аварийным завершением программы, неполному разрушению объектов или любым другим образом. Ошибка заключается в том, что память выделяется с помощью оператора new [], а освобождается в деструкторе класса ‘auto_ptr’ с помощью оператора delete:

Чтобы исправить ситуации, необходимо использовать более подходящий класс, например boost::scoped_array.

Пример 2. Проект IPP Samples. Классический Undefined behavior.

Ошибка найдена с помощью диагностики V567: Undefined behavior. The ‘pTemp’ variable is modified while being used twice between sequence points. me umc_me_cost_func.h 168

Это классический пример неопределенного поведения программы. Именно такую конструкцию используют для демонстрации Undefined behavior во многих статьях. Неизвестно, увеличится pTemp на единицу или нет. Два действия по изменению значения pTemp находятся в одной точке следования. Это значит, что компилятор может создать следующий псевдокод:

pTemp = pTemp + 1;

А может, создать другой вариант кода:

pTemp = pTemp + 1;

Какой именно код будет создан, зависит от компилятора и ключей оптимизации.

Пример 3. Проект Fennec Media Project. Сложное выражение.

Ошибка найдена с помощью диагностики V567: Undefined behavior. The ‘m_nCurrentBitIndex’ variable is modified while being used twice at single sequence point. MACLib unbitarrayold.cpp 78

Между двумя использованиями переменной m_nCurrentBitIndex нет точек следования. Это значит, что стандартом не определено, в какой момент эта переменная увеличится. Соответственно, в зависимости от компилятора и ключей оптимизации, этот код может работать по-разному.

Пример 4. Проект Miranda IM. Сложное выражение.

Ошибка найдена с помощью диагностики V567: Undefined behavior. The ‘s’ variable is modified while being used twice between sequence points.msne zxml.c 371

Здесь используется префиксный инкремент переменной. Но это ничего не значит. Нет никакой гарантии, что переменная ‘s’ будет увеличена перед вызовом функции strspn().

Ошибки, связанные с приоритетом операций

Для легкости понимания примеров освежим в памяти таблицу приоритетов операций.

Рисунок 7 — Приоритет операций языка Си/Си++

Пример 1. Проект MySQL. Приоритет операции ! и &.

Ошибка найдена с помощью диагностики V564: The ‘&’ operator is applied to bool type value. You’ve probably forgotten to include parentheses or intended to use the ‘&&’ operator. innobase ha_innodb.cc 6789

По замыслу программиста, часть выражения должна проверить, что определенный бит в переменной ‘create_info->options’ равен нулю. Однако, приоритет операции ‘!’ выше, чем операции ‘&’. И выражение работает так:

Чтобы код работал правильно, необходимо использовать дополнительные скобки:

Или, что на наш взгляд более красиво, написать так:

Пример 2. Проект eMule Plus. Приоритет операции * и ++.

Ошибка найдена с помощью диагностики V532: Consider inspecting the statement of ‘*pointer++’ pattern. Probably meant: ‘(*pointer)++’. emule customautocomplete.cpp 277

Если указатель ‘pceltFetched’ не нулевой, функция должна увеличивать переменную типа ULONG, на которую этот указатель указывает. Ошибка в том, что в приоритет операции ‘++’ выше, чем приоритет операции ‘*’ (разыменования указателя). Строка «*pceltFetched++;» эквивалентна следующим действиям:

Фактически, здесь просто увеличивается значение указателя. Чтобы код стал корректен, необходимо добавить скобки: «(*pceltFetched)++;».

Пример 3. Проект Chromium. Приоритет операции & и !=.

Ошибка найдена с помощью диагностики V564: The ‘&’ operator is applied to bool type value. You’ve probably forgotten to include parentheses or intended to use the ‘&&’ operator. base platform_file_win.cc 216

Очень легко забыть, что приоритет операции ‘!=’ выше, чем операции ‘&’. Так произошло и здесь. В результате получается выражение:

Ещё раз упростим выражение:

Получается, что вместо пятого бита, протестировали первый бит. Чтобы исправить ситуацию, требуются вставить дополнительные скобки.

Пример 4. Проект BCmenu. Путаница с IF и ELSE.

Ошибка найдена с помощью диагностики V563: It is possible that this ‘else’ branch must apply to the previous ‘if’ statement. fire bcmenu.cpp 1853

Здесь ошибка не с приоритетом операций, но родственная ей. Не учтено, что ветка ‘else’ относится к ближайшему оператору ‘if’. Видно, что код оформлен исходя из того, как будто он работает так:

Но на самом деле он эквивалентен следующей конструкции:

Пример 5. Проект IPP Samples. Приоритет операции ?: и |.

Ошибка найдена с помощью диагностики V502: Perhaps the ‘?:’ operator works in a different way than it was expected. The ‘?:’ operator has a lower priority than the ‘|’ operator. vm vm_file_win.c 393

В зависимости от значения переменной ‘islog’, выражение должно было быть равно «FILE_ATTRIBUTE_NORMAL» или «FILE_ATTRIBUTE_NORMAL | FILE_FLAG_NO_BUFFERING». Но этого не происходит. Приоритет операции ‘?:’ ниже, чем операции ‘|’. В результате код работает так:

Так как FILE_ATTRIBUTE_NORMAL равняется 0x00000080, то условие всегда истинно. Это означает, что в mds[3] всегда будет записываться 0.

Пример 6. Проект Newton Game Dynamics. Приоритет операции ?: и *.

Ошибка найдена с помощью диагностики V502: Perhaps the ‘?:’ operator works in a different way than it was expected. The ‘?:’ operator has a lower priority than the ‘*’ operator. physics dgminkowskiconv.cpp 1061

В этом коде ошибка вновь связана с низким приоритетом операции ‘?:’. Условием для оператора ‘?:’ является бессмысленное подвыражение «dgFloat32 (1.0e-24f) * (den > dgFloat32 (0.0f))». Исправить ситуацию можно, используя круглые скобки.

Кстати, программисты часто забывают о коварстве оператора ‘?:’. Предлагаю заметку на эту тему: «Как уменьшить вероятность ошибки на этапе написания кода. Заметка N2».

Ошибки форматированного вывода

Примеры этих ошибок однообразны и скучны, поэтому рассмотрим совсем немного примеров. Их суть в том, что функции с переменным количеством аргументов принимают фактические аргументы, несовместимые со строкой, задающей формат. Любой программист, использующий такие функции, как printf(), хорошо знаком с данной разновидностью ошибок.

Пример 1. Проект ReactOS. Некорректная печать символа типа WCHAR.

Ошибка найдена с помощью диагностики V576: Incorrect format. Consider checking the third actual argument of the ‘fprintf’ function. The char type argument is expected. regedit regproc.c 293

Функция fprinf() должна распечатать символ типа char. Но третьим аргументов является символ типа WCHAR. Пользователю будет выдано некорректно сформированное сообщение. Чтобы код стал корректен, в строке, задающей формат, следует заменить ‘%c’ на ‘%C’.

Пример 2. Проект Intel AMT SDK. Пропущенный символ ‘%’.

Ошибка найдена с помощью диагностики V576: Incorrect format. A different number of actual arguments is expected while calling ‘_snprintf’ function. Expected: 18. Present: 19. mod_pvs mod_pvs.cpp 308

На взгляд найти здесь ошибку очень непросто. Однако, статический анализатор PVS-Studio неутомим и замечает, что функция принимает больше фактических аргументов, чем задано в строке форматирования. Дело в том, что в одном месте пропущен символ ‘%’. Выделим этот фрагмент:

Пример 3. Проект Intel AMT SDK. Неиспользуемый аргумент.

Ошибка найдена с помощью диагностики V576: Incorrect format. A different number of actual arguments is expected while calling ‘printf’ function. Expected: 1. Present: 2. RemoteControlSample remotecontrolsample.cpp 792

Ошибка в том, что переменная ‘tmp’ никак не используется при выводе информационного сообщения.

Пример 4. Проект G3D Content Pak. Печать бессмысленных данных.

Ошибка найдена с помощью диагностики V520: The comma operator ‘,’ in array index expression ‘[0, 0]’. graphics3D anyval.cpp 275

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

Рассмотрим, как работает выражение ‘m[0, 1]’. Вначале вычисляется выражение «0, 1». Результатом такого выражения является 1. Затем вызывается функция ‘operator[]’ в классе Matrix3. Функция принимает фактический аргумент 1 и вернет указатель на первую строку в матрице. Именно значение этого указателя и будет распечатано функцией ‘printf()’, хотя она ожидает значение типа float.

Примеры выявленных опечаток в коде

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

Количество таких ошибок можно существенно сократить, используя статический анализатор PVS-Studio. Анализатор найдет их еще до начала тестирования, что существенно сократит цену нахождения и устранения дефектов.

Пример 1. Проект Miranda IM. Присваивание внутри IF.

Ошибка найдена с помощью диагностики V560: A part of conditional expression is always true: 0x29. icqoscar8 fam_03buddy.cpp 632

Из-за опечатки, внутри условия оператора ‘if’ происходит присваивание. Корректное условие: «if (wTLVType == 0x29 && wTLVLen == sizeof(DWORD))».

Пример 2. Проект ReactOS. Ошибка присваивания.

Ошибка найдена с помощью диагностики V570: The ‘mii->cch’ variable is assigned to itself. user32 menu.c 4347

Значение переменной присваивается само себе. Очевидно, планировалось написать так: «mii->cch = miiW->cch;».

Пример 3. Проект Clang. Опечатка в названии объекта.

Ошибка найдена с помощью диагностики V501: There are identical sub-expressions ‘LBO->hasNoUnsignedWrap ()’ to the left and to the right of the ‘&&’ operator. LLVMAnalysis instructionsimplify.cpp 1891

Имеется опечатка при использовании переменных с похожими именами. В первой строке надо использовать как переменную LBO, так и RBO. Исправленный вариант кода:

Пример 4. Проект Notepad++. Неправильная проверка состояния.

Ошибка найдена с помощью диагностики V501: There are identical sub-expressions to the left and to the right of the ‘&&’ operator. _isPointXValid && _isPointXValid

Дважды используется имя ‘_isPointXValid’. На самом деле, функция должна вернуть: «_isPointXValid && _isPointYValid».

Пример 5. Проект StrongDC++. Неудачная проверка наличия \r\n.

Ошибка найдена с помощью диагностики V501: There are operator. miniupnpc miniupnpc.c 153

Из-за опечатки дважды проверяем наличие символа ‘\r’. На самом деле еще должно проверяться наличие символа ‘\n’.

Пример 6. Проект G3D Content Pak. Не там поставлена круглая закрывающаяся скобка.

Ошибка найдена с помощью диагностики V575: The ‘memcmp’ function processes ‘0’ elements. Inspect the ‘third’ argument. graphics3D matrix4.cpp 269

Одна круглая скобка закрывается не там, где необходимо. Получается, что размер сравниваемой области памяти вычисляется выражением «sizeof(Matrix4) == 0». Это выражение всегда даёт в результате значение ‘false’. Затем ‘false’ превращается в целочисленное значение, равное 0. Корректный код:

Пример 7. Проект QT. Ошибка копирования членов структуры.

Ошибка найдена с помощью диагностики V570: The ‘transition->m_hasGetterSetterProperties’ variable is assigned to itself. QtScript structure.cpp 512

Рассматривая подобный код, очень сложно заметить ошибку. Однако, она здесь есть. Поле ‘m_hasGetterSetterProperties’ копируется само в себя. Корректный код должен выглядеть так:

Пример 8. Проект Apache HTTP Server. Лишний оператор sizeof.

Ошибка найдена с помощью диагностики V568: It’s odd that the argument of sizeof() operator is the ‘sizeof (SECURITY_ATTRIBUTES)’ expression. libhttpd util_win32.c 115

В поле ‘nLength’ должен был записан размер структуры ‘SECURITY_ATTRIBUTES’. В коде допущена опечатка. Оператор ‘sizeof’ здесь используется два раза. Как результат, в поле ‘nLength’ записывается размер, которыё имеет тип ‘size_t’. Корректный код:

Пример 9. Проект FCE Ultra. Двойное объявление переменной.

Ошибка найдена с помощью диагностики V561: It’s probably better to assign value to ‘x’ variable than to declare it anew. Previous daclaration: ines.cpp, line 960. fceuxines.cpp 962

Переменная ‘x’ должна хранить информацию, удалось ли открыть файл или нет. Из-за опечатки, вместо присваивания переменной единицы создается и инициализируется новая переменная с именем ‘x’. Корректный код, должен был быть таким:

Пример 10. Проект Notepad++. Использование оператора &&, вместо &.

Ошибка найдена с помощью диагностики V560: A part of conditional expression is always true: 0xff. notepadPlus babygrid.cpp 694

Выражение «(lParam >> 16) && 0xff» не имеет никакого практического смысла и всегда равно значению 1 (true). Здесь опечатка заключается в том, что используется оператор ‘&&’, хотя должен был использоваться оператор ‘&’.

Пример 11. Проект WinDjView. Недописанное условие.

Ошибка найдена с помощью диагностики V560: A part of conditional expression is always true: 0xA. WinDjView xmlparser.cpp 45 False

Функция IsValidChar всегда возвращает значение ‘true’. Из-за опечатки, в одном месте пропущено сравнение: «. || 0xA || . «.

Пример 12. Проект Fennec Media Project. Лишняя точка с запятой.

Ошибка найдена с помощью диагностики V529: Odd semicolon ‘;’ after ‘for’ operator. settings.c 483

Про то, как опасна лишняя точка с запятой ‘;’ знают все программисты на Си и Си++. К сожалению, это знание не мешает делать подобные опечатки. После первого оператора ‘for’ стоит лишняя точка с запятой, что делает этот фрагмент программы неработоспособным.

Пример 13. Проект QT. Забытый оператор break.

Ошибка найдена с помощью диагностики: V519: The ‘ret’ variable is assigned values twice successively. Perhaps this is a mistake. Check lines: 3765, 3767. QtGui qcleanlooksstyle.cpp 3767

Классическая ошибка — пропущен ‘break’ внутри оператора ‘switch’. Думаю, комментарии здесь излишни.

Пример 14. Проект Miranda IM. Присваивание вместо сравнения.

Ошибка найдена с помощью диагностики V559: Suspicious assignment ins >

Опечатка находится внутри условия оператора ‘if’. Вместо ‘==’ написано просто ‘=’. Функция некорректно обработает ситуацию, когда некий элемент не будет найден.

Пример 15. Проект IPP Samples. Некорректный индекс.

Ошибка найдена с помощью диагностики V557: Array overrun is possible. The ’30’ index is pointing beyond array bound. avs_enc umc_avs_enc_compressor_enc_b.cpp 495

Обратите внимание вот на этот фрагмент: «m_pMbInfo->refIdx[dir][30]». Из-за опечатки вместо индекса 3 написано число 30. Кстати, этот пример хорошо показывает относительность разделения в статье ошибок по типам. Эту ошибку вполне можно отнести к разделу «Ошибки работы с массивами и строками». Деление условно и сделано, чтобы показать разнородность ошибок, которые может найти анализатор PVS-Studio.

Пример 16. Проект ReactOS. Опечатка в макросе.

Ошибка найдена с помощью диагностики V519: The ‘v2’ variable is assigned values twice successively. Perhaps this is a mistake. Check lines: 343, 343. win32k gradient.c 343

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

В этот раз до пункта под номером 13 закончить раздел не получилось. Уж очень много в программах ошибок связано именно с опечатками. Гораздо больше, чем думают программисты. Этот раздел можно продолжить и дальше. В нашей коллекции ещё много забавных примеров. Но мы нашли в себе силы всё-таки остановиться на 16 примерах.

Неверное использование базовых функций и классов

Пример 1. Проект Fennec Media Project. Отсутствие двух терминальных нулей.

Ошибка найдена с помощью диагностики V540: Member ‘lpstrFilter’ should point to string terminated by two 0 characters. base windows.c 5309

В Windows API есть структуры, в которых указатели на строки должны заканчиваться двойным нулем. Именно на такую строку и указывает член ‘lpstrFilter’ в структуре OPENFILENAME.

Описание ‘lpstrFilter’ в MSDN:

A buffer containing pairs of null-terminated filter strings. The last string in the buffer must be terminated by two NULL characters.

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

Пример 2. Проект TortoiseSVN. Неверное использование функции ‘remove’.

Ошибка найдена с помощью диагностики V530: The return value of function ‘remove’ is required to be utilized. contextmenu.cpp 442

Функция std::remove не удаляет элементы из контейнера. Она только сдвигает элементы и возвращает итератор на начало мусора. Пусть мы имеем контейнер vector , содержащий элементы 1,2,3,1,2,3,1,2,3. Если выполнить код «remove( v.begin(), v.end(), 2 )», то контейнер будет содержать элементы 1,3,1,3,X,X,X, где X — некий мусор. При этом функция вернет итератор на первый мусорный элемент, и если мы хотим удалить эти мусорные элементы, то должны написать код: «v.erase(remove(v.begin(), v.end(), 2), v.end())».

Пример 3. Проект TortoiseSVN. Использование функции ’empty’ вместо ‘clear’.

Ошибка найдена с помощью диагностики V530: The return value of function ’empty’ is required to be utilized. mailmsg.cpp 40

Ошибка заключается в том, что вместо функции vector::clear() случайно вызывается функция vector::empty() и содержимое массива остается неизменным. Это достаточно распространенная ошибка, так как слова ‘clear’ и ’empty’ достаточно близки по смыслу, и их легко спутать.

Пример 4. Проект WinMerge. Использование функции ’empty’ вместо ‘clear’.

Ошибка найдена с помощью диагностики V530: The return value of function ’empty’ is required to be utilized WinMerge DirActions.cpp 1307, 1308

Вновь ошибка связана с тем, что вместо clear() используется функция empty(). Примеры таких ошибок можно взять и из других проектов: InstantVNC, IPP Samples, Chromium, Intel AMT SDK и так далее. К сожалению, все эти примеры будут однообразны, и рассматривать их будет неинтересно. Но поверьте, эти дефекты встречаются в серьезных проектах, разработанных профессиональными разработчиками.

Пример 5. Проект Pixie. Использование функции ‘alloca’ внутри циклов.

Ошибка найдена с помощью диагностики V505: The ‘alloca’ function is used inside the loop. This can quickly overflow stack. ri polygons.cpp 1120

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

Пример 6. Проект Miranda IM. Перепутанные аргументы.

Ошибка найдена с помощью диагностики V575: Function receives an odd argument. clist_modern modern_image_array.cpp 59

Функция ‘memset’ обрабатывает 0 элементов. То есть фактически, ничего не делает. Причина в перепутанных аргументах. Корректный вызов функции memset:

Примеры бессмысленного кода

Пример 1. Проект IPP Samples. Недописанное условие.

Ошибка найдена с помощью диагностики V503: This is a nonsensical comparison: pointer Пример 2. Проект Pc Ps2 Emulator. Некорректный switch.

Ошибка найдена с помощью диагностики V560: A part of conditional expression is always true: 2. pcsx2 debugger.cpp 321

Подобный код не имеет практического смысла. Видимо, на самом деле планировалось написать так:

Пример 3. Проект CPU Identifying Tool. Слишком строгое условие.

Ошибка найдена с помощью диагностики V550: An odd precise comparison: x == 0. It’s probably better to use a comparison with defined precision: fabs(A — B) ‘ Пример 4. Проект Lugaru. Двойное присваивание.

Ошибка найдена с помощью диагностики V519: The ‘radius’ object is assigned values twice successively. Perhaps this is a mistake. Lugaru gamedraw.cpp 1505

Возможно, для эксперимента, в переменную ‘radius’ явно записали значение 110. А потом забыли удалить эту строку. В результате, имеем бессмысленный и возможно даже ошибочный код.

Пример 5. Проект QT. Дублирующаяся проверка.

Ошибка найдена с помощью диагностики V501: There are identical sub-expressions to the left and to the right of the ‘&&’ operator. Qt3Support q3richtext.cpp 6978

Ошибка найдена с помощью диагностики V516: Cons >

Проверка «sf_error != 0» всегда возвращает true, так как ‘sf_error’ это имя функции, в которой мы находимся.

Пример 7. Проект IPP Samples. Странный код внутри цикла.

Ошибка найдена с помощью диагностики V532: Consider inspecting the statement of ‘*pointer++’ pattern. Probably meant: ‘(*pointer)++’. mpeg2_dec umc_mpeg2_dec.cpp 59

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

Всегда ложные или истинные условия

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

Пример 1. Проект Shareaza. Диапазон значений типа char.

Ошибка найдена с помощью диагностики V547: Expression ‘pBytes [ 0 ] == 0xEF’ is always false. The value range of signed char type: [-128, 127]. Shareaza remote.cpp 350

В данном коде тип ‘TCHAR’ представляет собой тип ‘char’. Диапазон значений char от -128 до 127 включительно. Значение 0xEF в переменной типа char это не что иное, как число -17. При сравнении переменной типа ‘char’ с числом 0xEF, её тип расширяется до типа ‘int’. Но значение по-прежнему лежит в диапазоне [-128..127]. Условие «pBytes[0] == 0xEF» («-17 == 0xEF») всегда ложно и программа работает не так, как задумывалось.

Пример 2. Проект TortoiseSVN. Диапазон значений типа char.

Ошибка найдена с помощью диагностики V547: Expression ‘* utf8CheckBuf == 0xC0’ is always false. The value range of signed char type: [-128, 127]. tortoiseblame.cpp 310

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

Пример 3. Проект VirtualDub. Беззнаковый тип всегда >= 0.

Ошибка найдена с помощью диагностики V547: Expression ‘c Пример 4. Проект Swiss-Army Knife of Trace. Работа с сокетами.

Ошибка найдена с помощью диагностики V547: Expression ‘(m_socketHandle = socket (2, 1, 0)) Пример 5. Проект Chromium. Работа со временем.

Ошибка найдена с помощью диагностики V547: Expression ‘current_idle_time Пример 6. Проект ICU. Ошибка в условии.

Ошибка найдена с помощью диагностики V547: Expression ‘*string != 0 || *string != ‘_» is always true. Probably the ‘&&’ operator should be used here. icui18n ucol_sit.cpp 242

Условие содержит логическую ошибку. Подвыражение «(*string != 0 || *string != ‘_’)» всегда истинно. Один и тот же символ строки не может быть одновременно не равен 0 и ‘_’.

Пример 7. Проект QT. Опасный цикл.

Ошибка найдена с помощью диагностики V547: Expression ‘—size >= 0’ is always true. Unsigned type value is always >= 0. QtCLucene arrays.h 154

Условие (—size >= 0) всегда истинно, так как переменная size имеет беззнаковый тип. Это значит, что если две сравниваемые последовательности одинаковы, то мы выйдем за их пределы. Это в свою очередь приведет к Access Violation или другим сбоям в работе программы.

Пример 8. Проект MySQL. Ошибка в условии.

Ошибка найдена с помощью диагностики V547: Expression ‘str [0] != ‘a’ || str [0] != ‘A» is always true. Probably the ‘&&’ operator should be used here. clientlib my_time.c 340

Условие всегда истинно, ведь символ всегда не равен ‘a’ или не равен ‘A’. Корректная проверка:

Пример 9. Проект QT. Неправильный учёт количества ссылок.

Ошибка найдена с помощью диагностики V545: Such conditional expression of ‘if’ operator is incorrect for the HRESULT type value ‘(HRESULT) 0L’. The SUCCEEDED or FAILED macro should be used instead. phonon_ds9 qbasefilter.cpp 60

Условием проверки является константа S_OK. Так как S_OK это 0, то функция AddRef() никогда не вызывается. Здесь должна была быть проверка: if (hr == S_OK).

Пример 10. Проект TickerTape. Неправильный торнадо.

Ошибка найдена с помощью диагностики V517: The use of ‘if (A) <. >else if (A) <. >‘ pattern was detected. There is a probability of logical error presence. TickerTape wind.cpp 118

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

Пример 11. Проект Apache HTTP Server. Ошибка работы с сокетами в Windows.

Ошибка найдена с помощью диагностики V547: Expression ‘csd Пример 12. Проект QT. Опечатка в сравнениях.

Ошибка найдена с помощью диагностики V517: The use of ‘if (A) <. >else if (A) <. >‘ pattern was detected. There is a probability of logical error presence. Check lines: 2303, 2305. lrelease profileevaluator.cpp 2303

В отмеченной строке должно быть написано «ver == QSysInfo::WV_2003». Из-за этой ошибки утверждение «ret = QLatin1String(«Win2003″)» никогда не будет выполнено.

Уязвимости в коде

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

Пример 1. Проект Ultimate TCP/IP. Неправильная проверка пустой строки.

Ошибка найдена с помощью диагностики V528: It is odd that pointer to ‘char’ type is compared with the ‘\0’ value. Probably meant: *m_szPassword != ‘\0’. UTMail ut_crammd5.cpp 333

Приведенный участок кода должен проверить, что указатель на пароль не равен NULL и что строка не пустая. Но вместо этого два раза проверяет, что указатель не равен NULL. Проверка, что строка пустая не работает. Условие «if (m_szPassword != ‘\0’)» должно было проверять, что в самом начале строки располагается терминальный ноль и значит строка пустая. Но здесь забыто разыменование указателя, и с нулем сравнивается сам указатель. Корректный код:

Пример 2. Проект Chromium. Работа с нулевым указателем.

Ошибка найдена с помощью диагностики V522: Dereferencing of the null pointer ‘plugin_instance’ might take place. Check the logical condition. chrome_frame_npapi chrome_frame_npapi.cc 517

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

Пример 3. Проект SMTP Client with SSL/TLS. Неполная очистка буфера.

Ошибка найдена с помощью диагностики V512: A call of the ‘memset’ function will lead to a buffer overflow or underflow. CSmtp md5.cpp 212

Функция в целях безопасности пытается очистить буфер, содержащий деликатную (sensitive) информацию. Но получается это плохо. В буфере будут очищен только первый байт. Ошибка в том, что оператор ‘sizeof’ вычисляет размер типа ‘uint1’, а не размер буфера. Корректный код:

С неполноценной очисткой памяти вообще ошибки встречаются достаточно часто. Рассмотрим еще несколько подобных ситуаций.

Пример 4. Проект Chromium. Неполная очистка буфера.

Ошибка найдена с помощью диагностики V512: A call of the ‘memset’ function will lead to underflow of the buffer ‘(exploded)’. base time_win.cc 227

Функция ZeroMemory очищает только часть структуры Exploded. Причина, что оператор ‘sizeof’ возвращает размер указателя. Чтобы исправить ошибку, необходимо разыменовать указатель:

Пример 5. Проект Apache HTTP Server. Неполная очистка буфера.

Ошибка найдена с помощью диагностики V512: A call of the ‘memset’ function will lead to underflow of the buffer ‘(context)’. apr sha2.c 560

Ошибка полностью аналогична рассмотренной ранее. Оператор ‘sizeof’ вычисляет размер указателя. Чтобы исправить ситуацию, необходимо написать: «sizeof(*context)».

Пример 6. Проект Miranda IM. Некорректная обработка строк.

Ошибка найдена с помощью диагностики: V528 It is odd that pointer to ‘char’ type is compared with the ‘\0’ value. Probably meant: *str != ‘\0’. clist_modern modern_skinbutton.cpp 282

V528 It is odd that pointer to ‘char’ type is compared with the ‘\0’ value. Probably meant: *endstr != ‘\0’. clist_modern modern_skinbutton.cpp 283

Это весьма опасный код, так как он неправильно пытается определить конец строки. Такой код может привести к выходу за границы строк и, как следствие, к возникновению исключения Access Violation. Ошибка кроется здесь: «str!=’\0′» и здесь «endstr!=’\0′». Не хватает разыменования указателя. Корректный код:

Пример 7. Проект PNG library. Случайное обнуление указателя.

Ошибка найдена с помощью диагностики V527: It is odd that the ‘\0’ value is assigned to ‘char’ type pointer. Probably meant: *new_key [79] = ‘\0’. graphics3D pngwutil.c 1283

Этот пример демонстрирует ошибку, где случайно вместо обрезания длины строки, обнуляется указатель. Дело в том, что new_key это указатель на строку. А это значит, чтобы обрезать её до 79 символов, код должен выглядеть так:

Пример 8. Проект Intel AMT SDK. Непроверенное имя пользователя.

Ошибка найдена с помощью диагностики V501: There are identical sub-expressions ‘options->delivery_password’ to the left and to the right of the ‘||’ operator. OpenWsmanLib wsman-client.c 631

Из-за невнимательности два раза проверяется наличие пароля, но не проверяется наличие имени пользователя. Корректный код:

Пример 9. Проект Ultimate TCP/IP. Некорректная обработка пустых строк.

Ошибка найдена с помощью диагностики V547: Expression ‘(len — indx) >= 0’ is always true. Unsigned type value is always >= 0. UTDns utstrlst.cpp 58

Выражение «len — indx» имеет беззнаковый тип ‘size_t’ и всегда >= 0. Посмотрим, к чему это приведёт, если на вход будет подана пустая строка.

Если строка пустая, то: len = 0, indx = 1.

Выражение len — indx равно значению 0xFFFFFFFFu.

Так как 0xFFFFFFFFu > 0 и indx Пример 10. Проект Miranda IM. Неработающая защита от Underflow.

Ошибка найдена с помощью диагностики V547: Expression ‘nOldLength Пример 11. Проект Apache HTTP Server. Неправильная обработка отрицательных значений.

Ошибка найдена с помощью диагностики V547: Expression ‘len Пример 12. Проект Ultimate TCP/IP. Некорректное условие остановки цикла.

Ошибка найдена с помощью диагностики V547: Expression ‘loop >= 0’ is always true. Unsigned type value is always >= 0. UTDns utstrlst.cpp 430

Предположим, что вся строка состоит исключительно из пробелов. Перебирая символы, программа дойдёт до нулевого элемента строки и переменная ‘loop’ станет равна нулю. Затем выполнится очередное уменьшение переменной ‘loop’. Так как эта переменная имеет беззнаковый тип, то её значение станет равно 0xFFFFFFFFu или 0xFFFFFFFFFFFFFFFFu (в зависимости от разрядности). Естественно, что это значение >= 0 и начнется новая итерация цикла. Произойдет доступ к памяти по адресу szString[0xFFFFFFFFu], последствия чего хорошо знакомы каждому программисту на Си/Си++.

Copy-Paste

Программисты также зря недооценивают ошибки связанные с Copy-Paste, как и обыкновенные опечатки. Их очень и очень много. Программисты тратят на них много времени при отладке.

Опечатки и ошибки Copy-Paste, конечно, похожи, но есть отличие, из-за которого в этой статье они разделены. Опечатки часто приводят к тому, что вместо одной переменной используется другая. А при копировании, обычно просто забывают что-то поправить.

Пример 1. Проект Fennec Media Project. Промах при работе с элементами массива.

Ошибка найдена с помощью диагностики V525: The code containing the collection of similar blocks. Check items ’11’, ’12’, ’13’, ’13’ in lines 716, 717, 718, 719. id3 editor.c 716

Четыре схожие строчки, скорее всего, появились в коде программы с помощью копирования. Затем, при правке индексов допущена ошибка, из-за которой ноль записывается в ‘fhead[13] ‘ два раза и не записывается в ‘fhead[14] ‘.

Пример 2. Проект MySQL. Промах при работе с элементами массива.

Ошибка найдена с помощью диагностики V525: The code containing the collection of similar blocks. Check items ‘0’, ‘1’, ‘2’, ‘3’, ‘4’, ‘1’, ‘6’ in lines 680, 682, 684, 689, 691, 693, 695. sql records.cc 680

Ошибка сразу не видна, поэтому выделим её отдельно:

На самом деле, здесь должно быть написано:

Пример 3. Проект TortoiseSVN. Неисправленное имя файла.

Ошибка найдена с помощью диагностики V524: It is odd that the ‘GetDbgHelpVersion’ function is fully equivalent to the ‘GetImageHlpVersion’ function (SymbolEngine.h, line 98). symbolengine.h 105

Функция ‘GetImageHlpVersion’, скорее всего, получена копированием функции ‘GetInMemoryFileVersion’. Ошибка в том, что в скопированной функции забыли исправить имя файл. Корретный код:

Пример 4. Проект Clang. Одинаковые тела функций.

Ошибка найдена с помощью диагностики V524: It is odd that the body of ‘clearTopDownPointers’ function is fully equivalent to the body of ‘clearBottomUpPointers’ function (ObjCARC.cpp, line 1318). LLVMScalarOpts objcarc.cpp 1322

Видимо, тело функции clearBottomUpPointers некорректно, и эта функция должна была выглядеть так:

Пример 5. Проект QT. Неудачный swap.

Ошибка найдена с помощью диагностики V519: The ‘x1’ variable is assigned values twice successively. Perhaps this is a mistake. Check lines: 2218, 2219. Qt3Support q3canvas.cpp 2219

Первая строчка совершенно корректна и обменивает значения в переменных x1 и x2. Во второй строке должны быть обменены переменные y1 и y2. Эта строка видима была копией предыдущей. В ней надо было заменить все буквы ‘x’ на буквы ‘y’. К сожалению, в одном месте это забыли сделать: «. x1=y2; . «.

Пример 6. Проект Crystal Space 3D SDK. Одинаковые подвыражения.

Ошибка найдена с помощью диагностики V501: There are identical sub-expressions to the left and to the right of the ‘&&’ operator. plgcsopcode icelss.h 69

Ошибка в том, что два раза используется переменная ‘lss.mP0.’ В правой части выражения следовало использовать ‘lss.mP1’.

Пример 7. Проект Notepad++. Установка некорректного стиля.

Ошибка найдена с помощью диагностики V525: The code containing the collection of similar blocks. Check items ‘7’, ‘7’, ‘6’, ‘7’ in lines 576, 580, 584, 588

Глазами найти здесь ошибку практически нереально, поэтому сократим текст, чтобы выделить интересное:

Случайно используется IDC_KEYWORD3_BOLD_CHECK вместо IDC_KEYWORD3_ITALIC_CHECK.

Пример 8. Проект ReactOS. Выбор не того объекта.

Ошибка найдена с помощью диагностики V523: The ‘then’ statement is equivalent to the ‘else’ statement. cardlib cardbutton.cpp 83

Объект ‘hsh’ не используется, зато ‘hhi’ используется два раза. Корректный код должен выглядеть так:

Пример 9. Проект IPP Samples. Неправильная проверка.

Ошибка найдена с помощью диагностики V501: There are identical sub-expressions ‘m_pContext->m_seqLayerHeader->heightMB’ to the left and to the right of the ‘&&’ operator. vc1_dec umc_vc1_video_decoder.cpp 1347

Пример 10. Проект ReactOS. Ошибка в имени переменной.

Ошибка найдена с помощью диагностики V537: Consider reviewing the correctness of ‘x’ item’s usage. win32k bitblt.c 670

Очень хороший пример, где видно, что строку скопировали. Потом одно имя ‘x’ поправили, а второе нет. Должно быть:

Разное

Пример 1. Проект Image Processing SDK. Восьмеричное число.

Ошибка найдена с помощью диагностики V536: Be advised that the utilized constant value is represented by an octal form. Oct: 0713, Dec: 459. IFF plugins pixelservices.inl 146

Если рассмотреть вторую функцию, то станет ясно, что хотелось использовать число 713, а вовсе на 0713. Число 0713 задано в восьмеричной системе счисления. Об этом легко забыть, если редко использовать восьмеричные константы.

Пример 2. Проект IPP Samples. Одна переменная для двух циклов.

Ошибка найдена с помощью диагностики V535: The variable ‘c’ is being used for this loop and for the outer loop. jpegcodec jpegdec.cpp 4652

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

Заключение и вывод

Вывод прост: купите PVS-Studio!

Различные ссылки

• Главная страница статического анализатора PVS-Studio. http://www.viva64.com/ru/pvs-studio/
• Скачать демонстрационную версию. http://www.viva64.com/ru/pvs-studio-download/
• Купить PVS-Studio. http://www.viva64.com/ru/order/
• Документация по PVS-Studio. http://www.viva64.com/ru/d/
• Пообщаться с разработчиками PVS-Studio. http://www.viva64.com/ru/about-feedback/
• Наш Twitter. http://twitter.com/Code_Analysis

Найдите ошибки в своем C, C++, C# и Java коде

Предлагаем попробовать проверить код вашего проекта с помощью анализатора кода PVS-Studio. Одна найденная в нём ошибка скажет вам о пользе методологии статического анализа кода больше, чем десяток статей.