
Данный SDK представляет собой минимальный набор, необходимый для компилирования и запуска программ для процессора MultiClet S1.
Содержание:
 - Документация:
   * Руководство S1.pdf: краткое описание языка ассемблера, команд и регистров процессора S1,
   * Соглашение о вызове S1.pdf: соглашение о вызове функций языка С,
   * Руководство по ассемблеру S1.pdf: подробное описание языка ассемблера, команд и регистров процессора S1, и принципы программирования на нем,
   * Руководство по линкеру.pdf: описание процесса и особенностей компоновки образа памяти исполняемой программы;
 - Бинарные файлы:
   * clang: компилятор языка С стандарта С99 на базе LLVM,
   * mc-as-s1: ассемблер текстовых программ процессора S1,
   * mc-ld-s1: линкер объектных файлов, полученных от ассемблера, в бинарный файл,
   * mc-dbg-s1: отладочная модель для запуска бинарных файлов;
 - Исходный код программ:
   * crt0.s: программа загрузочной части, подготавливающая стек и память для работы с кодом на языке С (подробнее написано в doc/CallingConvetion.pdf),
   * mc-sprintf.c, __mc-vprintf.c: базовая реализация функции sprintf, позволяющая печатать форматированные строки в память,
   * Заголовочные файлы;
 - Библиотеки:
   * libm.a: математическая библиотека fdlibm,
   * librt.a: библиотека, содержащая функции конвертации типов данных, используемые в LLVM.
Важно: для работы компилятора необходимо добавить путь к mc-as-s1 и mc-ld-s1 в переменную окружения PATH.


Как собрать программу на языке С: clang crt0.s main.c file.c -o program.bin
Компилятор автоматически использует ассемблер и линкер, на выходе получается готовый для запуска бинарный файл program.bin.
Важно: crt0.s всегда должен стоять первым в списке. Таким образом, линкер разместит его по адресу 0 и запуск программы начнется именно с него.
Компилятор имеет множество опций, например:
 -S - генерация файла с ассемблерным кодом по файлу на языке С (clang -S main.c)
 -I'path/to/sdk/include' - добавление пути для поиска заголовочных файлов
 -Xlinker - передача следующей опции линкеру
 -Xassembler - передача следующей опции ассемблеру
Полный список можно посмотреть, указав опцию --help.


Для сборки программ, написанных на ассемблере, необходимо:
 - ассемблировать каждый файл (mc-as-s1 file.s) для получения объектных файлов (file.o)
 - передать полученные файлы линкеру, начиная с файла, предназначенного для старта программы (mc-ld-s1 start.o file.o -o program.bin)
Линкеру также можно передать опцию -M, чтобы посмотреть список адресов всех меток в программе, которые можно использовать при отладке.
Если линкер автоматически не может правильно разместить все секции, необходимо передать ему линкер скрипт, в котором указано по каким
адресам размещать секции: mc-ld-s1 start.o file.o -T mc-s1-sdk/src/lscript.x -o program.bin


Утилита mc-dbg-s1 позволяет пошагово отлаживать программы и просматривать содержимое коммутатора, памяти и регистров после каждого шага.
Шагом является выполнение одного параграфа.
Пример того, как выполнить, отладить программу и посмотреть её результаты:
 - Подключить к программе файлы stdarg.h и stdio.h, затем добавить к списку файлов для компиляции файлы mc-sprintf.c, __mc-vprintf.c и memset.c;
 - С помощью функции mc_sprintf напечатать в память (создать глобальный массив char[], например) нужную строку;
 - Скомпилировать программу, передав линкеру параметр -M (clang -Xlinker -M), и посмотреть адрес созданного в памяти массива;
 - mc-dbg-s1 program.bin
 - Запустить моделирование, введя команду run
 - Напечатать содержимое массива, введя команду ps <address>@<amount of bytes>

Отладчик имеет множество команд, например:
 - m a sw : будет выводить содержимое коммутатора и исполняемые команды в процессе моделирования
 - n : выполнить 1 шаг (параграф)
 - b *<address> : установить точку остановки по указанному адресу (адрес нужной функции/метки можно посмотреть в результате работы линкера с опцией -M)
 - p *(<data type>*) <address>@<amount> : напечатать содержимое памяти начиная с address, приводя каждые, в зависимости от data type, несколько байт к
   числу, напечатав в итоге amount чисел
 - ps <address>@<amount of bytes> : печатать память как строку ASCII символов
Полный набор команд можно получить введя help, а также help <команда> для более подробного описания команды.


Обо всех ошибках сообщайте на почту support@multiclet.com
