Trabalho 1: Montador para a arquitetura do computador IAS

Avisos

Nesta seção serão apresentados os avisos importantes referentes ao trabalho 1.

19/09/2016: Enunciado do trabalho 1 divulgado!

Introdução

Um montador (assembler) é uma ferramenta que converte código em linguagem de montagem (assembly) para código em linguagem de máquina. Neste trabalho, você irá implementar um montador para a linguagem de montagem do computador IAS, que produza como resultado um mapa de memória para ser utilizado no simulador do IAS, que pode ser encontrado em: http://www.ic.unicamp.br/~edson/disciplinas/mc404/2016-2s/abef/IAS-sim/index.html.

Especificações do montador

Nesta seção serão apresentadas as especificações gerais do montador, da linguagem de montagem aceita por ele e da linguagem de máquina que o montador deve produzir.

Especificações gerais

O arquivo de saída do montador é um mapa de memória que contém linhas no formato:

AAA DD DDD DD DDD

Na linha acima, AAA é uma sequência de 3 dígitos hexadecimais que representa o endereço de memória, totalizando 12 bits. Já DD DDD DD DDD é uma sequência de 10 dígitos hexadecimais, que totaliza 40 bits e representa um dado ou duas instruções do IAS, conforme já visto em aula. Note que existem caracteres de espaço na linha, num total de exatos 4 espaços - é importante que seu montador produza um mapa de memória EXATAMENTE nesse formato para permitir a execução dos casos de teste. Não deve haver caracteres extras ou linhas em branco, apenas linhas no formato acima.

O arquivo de entrada do montador deve ser um arquivo de texto tal que cada linha deve ser como uma das seguintes:

 [rotulo:] [instrucao] [# comentario]

 [rotulo:] [diretiva] [# comentario]

Nas linhas acima, os colchetes determinam elementos opcionais - ou seja, qualquer coisa é opcional, podendo então haver linhas em branco no arquivo de entrada, ou apenas linhas de comentário, ou linhas só com uma instrução, etc. É possível que haja múltiplos espaços em branco no início ou fim da linha ou entre os elementos. Como exemplo, as seguintes linhas são válidas num arquivo de entrada para o montador:

vetor1:
vetor2:   .word 10
vetor3:   .word 10 # Comentario apos diretiva

.word 10
.word 10  # Comentario apos diretiva
# Comentario sozinho  

vetor4: ADD "0x0000000100"
vetor5: ADD "0x0000000100" # Comentario apos instrucao

ADD "0x0000000100"

e as seguintes linhas são inválidas:

rotulo1: outro_rotulo: mais_um_rotulo: 

vetor: .word 10 ADD "0x000000000100"

.word 10 .align 5

vetor: ADD "0x000000000100" .word 10

ADD "0x000000000100" ADD "0x000000000100"

Algumas regras gerais do montador:

É possível que um programa possua palavras de memória com apenas uma instrução (veja a diretiva .align). O seu montador deve completar a parte "não preenchida" da palavra com zeros.
O montador deve ser sensível à caixa das letras (o mnemônico LD é válido enquanto que o mnemônico ld não é). O montador deve interromper a montagem e produzir uma mensagem de erro (ver abaixo) quando esta regra for violada.
Os casos de teste não possuirão palavras acentuadas, portanto, não é necessário tratar acentos no montador.
O executável do montador deve aceitar 2 argumentos, sendo que o primeiro é obrigatório e o segundo é opcional.
- O primeiro argumento deve conter o nome do arquivo de entrada, ou seja, o nome do arquivo que contém o programa em linguagem de montagem.
- O segundo argumento, facultativo, é o nome do arquivo de saída a ser gerado pelo montador. Caso o segundo argumento não seja fornecido, você deve imprimir o mapa de memória na saída padrão (stdout), em vez de imprimi-lo em arquivo.
- Dois exemplos válidos são:
```
./ias-as entrada.s saida.map
```
  que lê um arquivo denominado entrada.s e gera o mapa de memória no arquivo saida.map, e
```
./ias-as prog.s
```
  que lê um arquivo de nome prog.s e imprime o mapa de memória na saída padrão. Você não deve supor que os nomes dos arquivos tenham sufixos pré-determinados, como ".s", ".asm", ".map", etc. Dessa forma, os seguintes comandos também devem ser válidos:
```
./ias-as arq.asm arq.hex
./ias-as arq.txt arq.out
```

As próximas seções descrevem as regras referentes à linguagem de montagem.

Comentários

Comentários são cadeias de caracteres que servem para documentar ou anotar o código. Essas cadeias devem ser desprezadas durante a montagem do programa. Todo texto à direita de um caractere "#" (cerquilha) é considerado comentário.

Rótulos

Rótulos são compostos por caracteres alfanuméricos e podem conter o caractere "_" (underscore). Um rótulo é definido como uma cadeia de caracteres que deve ser terminada com o caractere ":" (dois pontos) e não pode ser iniciada com um número. Exemplos de rótulos válidos são:

varX:
var1:
_varX2:
laco_1:
__DEBUG__:

Exemplos de rótulos inválidos são:

varx::
:var1
1var:
laco
ro:tulo

Diretivas

Todas as diretivas da linguagem de montagem do IAS começam com o caractere "." (ponto). As diretivas podem ter um ou dois argumentos - tais argumentos podem ser dos seguintes tipos:

HEX	um valor na representação hexadecimal. Estes valores possuem exatamente 12 dígitos, sendo os dois primeiros '0' e 'x' e os 10 últimos dígitos hexadecimais, ou seja, 0-9, a-f ou A-F. Ex: `0x0a0Ef217D0`
DEC(min:max)	valores numéricos na representação decimal. Apenas valores no intervalo (min:max) são válidos e seu montador deve realizar esta verificação. Caso o valor não esteja no intervalo (min:max), o montador deve emitir uma mensagem de erro na saída de erro e interromper o processo de montagem sem produzir o mapa de memória na saída padrão (`stdout`) ou no arquivo de saída.
ROT	caracteres alfanuméricos e "_" (underscore). Não pode começar com número (veja a descrição de rótulos acima) e deve terminar com ':'.
SYM	caracteres alfanuméricos e "_" (underscore) - não pode começar com número.

A Tabela 1, abaixo, apresenta a sintaxe das diretivas de montagem e os tipos de seus argumentos.

Sintaxe	Argumento 1	Argumento 2
.set	SYM	HEX \| DEC(0:2³¹-1)
.org	HEX \| DEC(0:1023)
.align	DEC(1:1023)
.wfill	DEC(1:1023)	HEX \| DEC(-2³¹:2³¹-1) \| ROT \| SYM
.word	HEX \| DEC(0:2³²-1) \| ROT \| SYM

Tabela 1: Sintaxe das diretivas de montagem e os tipos dos argumentos.

O caractere "|" separa as opções. Por exemplo: a diretiva .org pode receber como argumento um valor hexadecimal (HEX) ou decimal no intervalo (0:1023). Dessa forma, as linhas do seguinte programa são válidas:

	.org 0x0000000000
	.org 0x000000000f
	.org 100

enquanto que as seguintes linhas são inválidas

	.org 0x0000000000 | 10
	.org -10
	.org 0x000 20
	.org

A descrição do comportamento de cada uma das diretivas está na apostila de programação do computador IAS (programando_o_IAS.pdf). Também podem ser encontradas nos slides das aulas.

Instruções

As instruções que requerem um endereço podem ser descritas utilizando-se qualquer um dos seguintes formatos:

mnemônico "HEX"
mnemônico "DEC(0:1023)"
mnemônico "ROT"

As instruções que nao requerem o campo endereço possuem o seguinte formato:

mnemônico

Note que no segundo campo é possível usar um endereço em hexadecimal (HEX) ou decimal (DEC), ou o identificador de um rótulo (sem o caractere ':'). O endereço, ou o rótulo, deve ser descrito entre aspas duplas. Exemplos válidos são:

	ADD "laco"
	SUB "0x00000000F4"

Algumas instruções não requerem o campo endereço (RSH, por exemplo). Se o programa especificar o campo endereço para estas instruções, seu montador deve emitir uma mensagem de erro e interromper a montagem. Para as instruções que não requerem o campo endereço seu montador deve preencher os bits referentes ao campo endereço no mapa de memória com zeros.

A Tabela 2, abaixo, apresenta os mnemônicos válidos e as instruções que devem ser emitidas para cada um dos casos.

Mnemônico	Instrução a ser emitida
LD	LOAD M(X)
LD-	LOAD -M(X)
LD\|	LOAD \|M(X)\|
LDmq	LOAD MQ
LDmq_mx	LOAD MQ,M(X)
ST	STOR M(X)
JMP	JUMP M(X,0:19) se o alvo for uma instrução à esquerda da palavra de memória (endereços do tipo HEX ou DEC sempre indicam endereços à esquerda enquanto que rótulos podem indicar endereços à esquerda ou direita).
JMP	JUMP M(X,20:39) se o alvo for uma instrução à direita de uma palavra de memória.
JUMP+	JUMP+M(X,0:19) se o alvo for uma instrução à esquerda da palavra de memória (endereços do tipo HEX ou DEC sempre indicam endereços à esquerda enquanto que rótulos podem indicar endereços à esquerda ou direita).
JUMP+	JUMP+M(X,20:39) se o alvo for uma instrução à direita de uma palavra de memória.
ADD	ADD M(X)
ADD\|	ADD \|M(X)\|
SUB	SUB M(X)
SUB\|	SUB \|M(X)\|
MUL	MUL M(X)
DIV	DIV M(X)
LSH	LSH
RSH	RSH
STaddr	STOR M(X,8:19) se X for o endereço de uma instrução à esquerda de uma palavra.
STaddr	STOR M(X,28:39) se X for o endereço de uma instrução à direita de uma palavra.

Tabela 2: Mnemônicos válidos e as instruções que devem ser emitidas para cada um dos casos.

Tratamento de erros

Seu montador deve tratar erros. Sempre que houver um erro, seu montador deve emitir uma mensagem de erro no arquivo de saída e terminar a execução sem produzir o mapa de memória, ou seja, sem escrever o mapa de memória no arquivo de saída. Caso o arquivo de saída não tenha sido fornecido, a mensagem de erro dever ser emitida na saída padrão e o mapa de memória não deve ser escrito na saída padrão.

As mensagens de erro devem seguir o seguinte padrão:

ERROR on line XX
mensagem!

onde XX é o número da linha do arquivo de entrada que causou o erro e "mensagem" é a mensagem de erro. Esta mensagem deve estar na linha subsequente à primeira. Exemplos:

ERROR on line 3
addu is not a valid mnemonic!

ERROR on line 56
0x00$02 is not a valid hex number!

Requisitos/informações da entrega

Prazos de entrega do trabalho:
- 17-10-2016, até as 23:59h - Fator de multiplicação 1.0x
- 18-10-2016, até as 23:59h - Fator de multiplicação 0.8x
- 19-10-2016, até as 13:59h - Fator de multiplicação 0.6x
A linguagem de programação a ser utilizada para desenvolver o montador deve ser obrigatoriamente a linguagem C. Não serão aceitos trabalhos que façam uso de alguma biblioteca não-padrão, ou seja, apenas podem ser utilizadas as rotinas da biblioteca padrão do compilador.
O trabalho é individual. Caso haja qualquer tentativa de fraude, como plágio, todos os envolvidos serão desonrados com atribuição de nota 0 na média da disciplina.
Utilize a plataforma SuSy para entrega. O endereço da atividade é: https://susy.ic.unicamp.br:9999/mc404abef/T1
O susy será configurado para corrigir o trabalho parcialmente, ou seja, mensagens de erro e outros critérios definidos neste enunciado serão corrigidos à parte.
Deverão ser entregues todos os arquivos de código (.c) e cabeçalhos (.h) do seu trabalho.
Os arquivos de teste (em linguagem de montagem) terão no máximo 4096 caracteres.
Caso não seja especificada por uma diretiva .org, a posição inicial de montagem é no endereço 0 à esquerda.

Dicas

Consulte a apostila de programação do IAS (programando_o_IAS.pdf) para informações sobre a semântica das diretivas e a codificação das instruções da linguagem de montagem.
Casos de teste propositalmente errados serão usados. O montador não deve gerar um mapa de memória nesses casos, nem mesmo parcial. Ele deve apontar erros e parar a montagem (veja a seção de tratamento de erros).
O código-fonte do montador, em C, deve ser bem comentado e organizado. Variáveis com nomes amigáveis, tabulações que facilitem a leitura, etc serão levadas em conta na correção e podem aumentar ou diminuir a nota.

Perguntas Frequentes e Outras Dúvidas

Tamanho máximo dos rótulos: 64 caracteres, incluindo o ":".
Tamanho máximo dos símbolos na diretiva .set: 64 caracteres.
Tamanho máximo do arquivo de entrada: 4096 bytes.
Tratamento de diretivas .word ou .wfill quando a posição de montagem estiver apontando para o lado direito de uma palavra de memória: interromper o processo de montagem com mensagem de erro.
Quando o parâmetro das instruções JMP, JUMP+ ou STaddr for um número, em vez de rótulo, a instrução gerada deve considerar que o endereço é relativo à parte esquerda da palavra de memória.
O caractere TAB (\t) deve ser tratado como espaço? Sim.
Caso seja encontrada uma palavra reservada (por exemplo um mnemônico) como argumento da diretiva .set o que deve ser feito? Você pode ignorar este caso pois não serão realizados testes em que o argumento da diretiva set seja uma palavra reservada.
A diretiva .set pode ser utilizada com uma palavra reservada, como um mnemônico? Não.
O que fazer caso o programa produza conteúdo de memória além das 1024 palavras endereçáveis? O montador deve emitir um erro.
É necessário que a diretiva .set trate outros valores além de números, como mnemônicos ou rótulos em geral? Não, os casos de teste apenas vão contemplar .set SYM HEX | DEC(0:2³¹-1), por exemplo, .set TEMP 23.