Макросы и директивы компилятора FASM

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

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

test al,0xFF

инструкцией

tst

macro tst {test al, 0xFF}

После ключевого слова

macro

идет имя макроса и его содержимое внутри фигурных скобок

{}

. Вы можете использовать инструкцию

tst

в любом месте после её определения и она будет скомпилирована как

test al,0xFF

. Определение константы

tst

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

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

macro stos0

   xor al,al

   stosb

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

stos0

будет заменен этими двумя инструкциями.

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

macro align value {rb (value-1)-($+value-1) mod value}

Когда инструкция

align 4

будут найдена после определения этого макроса, она будет заменена его содержанием, и

value

станет равно

, так что в результате мы получим

rb (4-1) - ($+4-1) mod 4

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

macro mov op1,op2

 if op1 in & op2 in

   push op2

   pop op1

 else

   mov op1,op2

 end if

Этот макрос расширил возможности инструкции

mov

, при его использовании оба аргумента могут быть сегментными регистрами. К примеру

mov ds,es

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

push es

pop ds

. В остальных случаях будет использована стандартная инструкция

mov

. Следующий макрос еще более расширяет возможности инструкции

mov

, используя предыдущий макрос:

macro mov op1,op2,op3

 if arg3 eq

   mov op1,op2

 else

   mov op1,op2

   mov op2,op3

 end if

Теперь

mov

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

mov es,ds,dx

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

push ds, pop es

mov ds,dx

Директива

purge

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

mov

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

purge mov

. Следующий

purge mov

удалит также синтаксис для сегментных регистров, но далее такие директивы ничего не сделают.

Если после директивы

macro

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

macro stoschar [char]

   mov al,char

   stosb

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

stoschar 1,2,3

будет скомпилирован как следующие инструкции:

mov al,1

stosb

mov al,2

stosb

mov al,3

stosb

Есть некоторые специальные директивы, располагаемые только в определениях макросов. Директива

local

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

macro movstr

   local move

 move:

   lodsb

   stosb

   test al,al

   jnz move

При использовании этого макроса метка

move

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

Директивы

forward

reverse

common

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

forward

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

reverse

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

common

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

local

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

common

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

Вот пример макроса, который создаст таблицу адресов к строкам, заданных этими строками:

macro strtbl name,[string]

 common

   label name dword

 forward

   local label

   dd label

 forward

   label db string,0

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

macro stdcall proc,[arg]

 reverse

push arg

 common

call proc

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

stdcall foo, 1,2,3

будет собран как:

push 3

push 2

push 1

call foo

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

forward

или

reverse

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

stdcall

macro invoke proc,[arg]

common

stdcall [proc],arg

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

Внутри макроса существует также специальный оператор

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

cond

macro jif op1,cond,op2,label

   cmp op1,op2

   j#cond label

К примеру

jif ax,ae,10h,exit

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

cmp ax,10h

jae exit

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

от того же самого выражения без знака. Так строка, которой предшествуют

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

знак. Вот пример макроса, использующий эту особенность:

macro message arg

 if arg eq +arg

   mov dx,arg

 else

   local str

   jmp @f

   str db arg,0Dh,0Ah,24h

@@:

   mov dx,str

 end if

   mov ah,9 int 21h

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

Структуры

Директива

struc

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

struc

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

Макрос, определенный с помощью директивы

struc

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

Все правила относительно стандартных макрокоманд относятся и к макросам структур.

Вот пример структуры:

struc point x,y

   .x dw x

   .y dw y

Например

my point 7,11

определит структуру, с меткой

my

, содержащую две переменные:

my.x

с величиной

my.y

с величиной

Следующий пример показывает, как расширить директиву

db

возможностью вычислить размер определенных данных:

struc db [data]

 common

   label .data byte

   db data

   .size = $-.data

С этим макросом

msg db 'Hello!',13,10

определит также константу

msg.size

, равную размеру определенных данных в байтах и также дополнительную метку

msg.data

, которая будет указывать на данные типа байт.

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

virtual

в макросе структуры (см.??).

Директивы формата

Директива

format

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

format binary

Директивы

use16

use32

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

Директива

org

устанавливает адрес, в котором как ожидается, будет работать код. Должна сопровождаться адресом.

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

Формат MZ (MZ executable)

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

format MZ

. Для этого формата по умолчанию создается 16 битный код.

Директива

segment

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

use16

, или

use32

что определит, будет ли код в сегменте 16 или 32 битным. Начало сегмента выравнивается по параграфам (16 байт). Все метки, определенные после этого будут иметь величины относительно начала сегмента.

Директива

entry

устанавливает точку входа для MZ файла, она должна сопровождаться дальним адресом (название сегмента, двоеточие и смещение в сегменте) точки входа.

Директива

stack

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

Директива

heap

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

heap 0

чтобы разместить только действительно необходимую программе память. Размер кучи по умолчанию — 65535.

Формат PE (Portable Executable)

Чтобы выбрать формат PE, используйте директиву

format PE

. Она может сопровождаться дополнительными типами формата:

console

GUI

или

native

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

at

и численное выражение, определяющее, базу PE образа и затем произвольно on оператор, сопровождаемый строкой в кавычках, содержащей имя файла содержащего MZ заглушку для PE программы (если указанный файл не формата MZ он берется как обычный двоичный файл и конвертируется в MZ). Установка кода по умолчанию для этого формата — 32 бита.

Директива

section

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

code

data

readable

writeable

executable

, shareable и

discardable

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

export

import

resource

fixups

. Когда выбрано определение данных

fixups

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

Директива

entry

устанавливает точку входа для Portable Executable, необходимо значение точки.

Директива

stack

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

Директива

heap

задает размер кучи для PE, за директивой идет значение, резервируемое под кучу, произвольная величина стека может следовать через запятую. Когда куча не определена, она создается по умолчанию 65536 байт, когда размер кучи совершенно не установлен, она устанавливается в 0.

Директива data начинает определение специальных PE данных, она должна сопровождаться одним из идентификаторов данных (

export

imort

resource

или

fixups

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

end data

. Когда выбрано определение данных

fixups

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

Формат COFF (Common Object File Format)

Чтобы выбрать формат COFF, используйте

format COFF

или

format MS COFF

, если Вы хотите создать простой или Microsoft COFF файл. В этом формате код по умолчанию 32 бит.

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

code

data

для обоих COFF вариантов,

readable

writeable

executable

shareable

discardable

только для Microsoft COFF. Начало сегмента выравнивается по страницам (4096 байт).

Директива

extrn

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

Команда