Trabalho 1: Montador para a arquitetura do computador IAS

Avisos

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

Todos os casos de teste e script de correção disponibilizados: casos-de-teste.tar.gz
Prazos de entrega do trabalho:
- 10-04-2015, até as 23:59h - Fator de multiplicação 1.0x
- 12-04-2015, até as 23:59h - Fator de multiplicação 0.8x
- 13-04-2015, até as 20:59h - Fator de multiplicação 0.6x

Introdução

Como já visto em aula, 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 (o simulador pode ser encontrado em http://www.ic.unicamp.br/~edson/disciplinas/mc404/2015-1s/ab/anexos/ias).

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:

vetor:
vetor:   .word 10
vetor:   .word 10 @ Comentario apos diretiva

.word 10
.word 10  @ Comentario apos diretiva
@ Comentario sozinho  

vetor: ADD M[0x0000000100]
vetor: ADD M[0x0000000100] @ Comentario apos instrucao

ADD M[0x0000000100]

e as seguintes linhas são inválidas:

vetor: outro_vetor: mais_um_vetor: 

vetor: .word 10 ADD M[0x000000000100]

.word 10 .align 5

vetor: ADD M[0x000000000100] .word 10

ADD M[0x000000000100] ADD M[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 palavra "não preenchida" com zeros.
O montador deve ser case-INsensitive, isto é, insensível ao contexto, devendo aceitar letras maiúsculas e minúsculas sem fazer distinção entre elas. Os casos de teste serão bastante mistos, fazendo uso de letras maiúsculas e minúsculas alternadamente.
Não é necessário (e inclusive não-recomendável) tratar acentos no montador. No caso de comentários, até pode se usar palavras acentuadas, visto que os comentários são descartados no processo de montagem. Mas para rótulos, não é necessário aceitar o uso de acentos. Nos casos de teste, não haverá nenhum acento, nem nos comentários.
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 imprimí-lo no 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 "@" (arroba) é 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

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).
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(0: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) ou 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 M[HEX]
mnemônico M[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 um rótulo. Caso seja usado endereço em hexadecimal ou decimal, esse deve ser informado dentro de colchetes, após a letra "M" - como exemplo, "M[0x0000000200]". No caso de se utilizar rótulo, esse deve ser informado diretamente, por exemplo "ADD varX".

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
load	LOAD M(X)
load_neg	LOAD -M(X)
load_abs	LOAD \|M(X)\|
load_mq	LOAD MQ
load_mq_mx	LOAD MQ,M(X)
store	STOR M(X)
jump	JUMP M(X,0:19) se X for o endereço de uma instrução à esquerda de uma palavra.
jump	JUMP M(X,20:39) se X for o endereço de uma instrução à direita de uma palavra.
jump+	JUMP+M(X,0:19) se X for o endereço de uma instrução à esquerda de uma palavra.
jump+	JUMP+M(X,20:39) se X for o endereço de uma instrução à direita de uma palavra.
add	ADD M(X)
add_abs	ADD \|M(X)\|
sub	SUB M(X)
sub_abs	SUB \|M(X)\|
mul	MUL M(X)
div	DIV M(X)
lsh	LSH
rsh	RSH
store_addr	STOR M(X,8:19) se X for o endereço de uma instrução à esquerda de uma palavra.
store_addr	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.

Valores de retorno do montador

Se o montador executar corretamente, ele deve retornar o valor 0 (valor a ser retornado pela função main). Caso haja algum erro, ele deve retornar o valor "-1". Este valor pode ser retornado pela função main, ou pela chamada de sistema exit (-1).

Tratamento de erros

Seu montador deve tratar erros. Sempre que houver um erro, seu montador deve emitir uma mensagem de erro na saída de erros (stderr) 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 ou 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

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/mc404ab/T01.
Deverão ser entregues todos os arquivos de código (.c) e cabeçalhos (.h) do seu trabalho, além de um arquivo Makefile que gere o executável do montador como regra padrão. Todos esses arquivos devem ser comprimidos em um único arquivo .tar.gz, com o nome raXXXXXX.tar.gz, em que XXXXXX é o número de seu RA. O executável do montador, que será gerado pelo Makefile, deve ser nomeado ias-as (sem extensão mesmo!).
O arquivo de entrada (em linguagem de montagem) terá no máximo 16 mil caracteres.

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. É importante que o montador não gere um mapa de memória nesses casos. 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 levados em conta na correção e podem aumentar ou diminuir a nota.
Você pode usar como base o Makefile do exemplo: trab01-example.tar.gz

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: 8000 bytes.
Tratamento de diretivas .word ou .wfill quanto 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 jump, jump+ ou stor_addr 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.
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.