Uxntal

Uxntal은 Uxn의 언어이다.

Uxntal은 Uxn CPU 위에서 돌아가는 ROM 으로 컴파일 되기 위한 Assembly 언어이다.

Note

Uxntal은 여느 프로그래밍 언어와 마찬가지로 상호의존적으로 엮여진 구조이기에, 순서대로 배우기는 어렵지만, 최대한 독립적인 개념부터 정리했다.

Read Only Memory (ROM)

ROM 은 Uxntal로부터 어셈블된다. 이름이 ROM(Read Only Memory)이지만, Uxn에 로드되는 순간, STA 등을 이용해 수정될 수 있다.

Uxntal의 opcode 를 포함한 대부분의 데이터는 그대로 byte로 변환된다.

Uxn은 기본적으로 ROM 0x0100 부터 로드되고, 0x0100 부터 작성된다. 하지만 원한다면 특정 주소부터 작성을 시작할 수 있다.

Random Access Memory (RAM)

Uxn은 2개의 256bytes의 스택으로 구성된 RAM 을 제공한다.
RAM은 기본으로 작업하는 공간인 WST (Working STack)과 추가적으로 연산에 활용할 수 있는 RST (Return STack)으로 이루어져있다.

Memory:

• WST (Working Stack)
• RST (Return Stack)

Data Structure

데이터는 0~255(2⁸-1) 범위의 정수인 byte , 0~65535(2¹⁶-1) 범위의 정수인 short 로 구분되지만, 그 차이는 스택에서 차지하는 양의 차이일 뿐이다. Byte 데이터는 두 자리 hex( 0x00 )로, short 데이터는 네 자리 hex(0x0000 )로 스택에 삽입할 수 있지만, 스택 내부에서의 구분은 없다.

#00 #ab #1234
( RESULT
WST: 00 ab 12 34
)

Caution

헷갈릴 수 있지만, #00 자체로 WST의 최상단에 00 바이트를 삽입하는 코드이다.
Literal(LIT)

Data:

• Byte

• Short = Byte × 2

Comments

(  와  )로 감싸진 문자열은 주석 처리된다. (띄어쓰기도 포함이다.)  

( This is comment. )

( 
    This is comment too )

( ( You can also nest ) )

Runes

Unxtal에는 몇 가지 char을 이용해 사용할 수 있는 기능이 있다.

Labels

라벨은 특정 ROM 주소 에 이름을 붙이는 역할을 한다.

라벨은 scope와 sublabel으로 나뉘며, scope는 @으로 시작하는 문자열로 만들 수 있다. Sublabel은 &으로 시작하는 문자열, 또는 @scope/name같이 만들 수 있다. 확인할 수 있듯이, sublabel은 scope의 하위에 위치할 수 있다.

즉, 아래 두 코드는 같은 결과를 만든다.

@banana &peel

@banana @banana/peel

Note

Uxntal에서는 라벨로 점프할 수 있는 기능을 지원한다.

• Jump Immediate(JMI)
• Jump Conditional Immediate(JCI)
• Jump Stash Return Immediate(JSI)

Warning

Uxntal은 hex를 일반 데이터로 받아들이기 때문에, 라벨이 a-f의 문자열로만 이루어 질 수 는 없다.

#00 bed INC @bed INC
( ASSEMBLY ERROR
Hexadecimal invalid: bed in @on-reset, hello.tal:2.
)

@on-reset

라벨로 다음과 같은 기능을 수행할 수 있다.

Function은 어느 위치에서 실행된 뒤, 다시 그 위치로 돌아오는, 말 그대로 함수이다.

@func ( -- )
  ( ... )
  JMP2r

Constant는 uxntal에 따로 변수의 문법이 없기 때문에, ROM 에 데이터를 쌓아두고 그 주소 를 참조하여 변수로 사용한다.

@text
    "Hello 20 "World 0a

Vector는 일종의 event listener같은 개념이다.
거의 Varvara에서만 사용되기에, 추후 Varvara를 다룰때 더 자세히 다룰 것이다.

Note

사실 Uxntal ROM 을 읽기 시작하는 지점인 0x0100 에는 기본적으로 @on-reset 이라는 vector가 할당되어있다.

Padding

|를 이용해 특정 ROM 메모리 부터 작성을 시작할 수 있다. 하지만 Uxn은 ROM 0x0100 부터 실행할 것이기에, 실행을 원한다면 0x0100 에 코드를 작성해야 한다. 또한, 지나온 메모리 에 작성할 수 없기 때문에 작은 순서로 작성해야한다. (라벨을 붙이는 것 만이라면 가능하다.)

|100 #00 INC routine INC
|200 @routine
( RESULT
WST: 01
RST: 01 06
)

|100 #00 INC r-one INC
|200 @r-one r-two
|150 @r-two INC
( ASSEMBLY ERROR
Writing rewind: INC in @r-two, test.tal:3.
)

$를 이용해 현재 ROM 주소 에서 상대적으로 움직일 수 있다.

라벨과 함께 이용해서 ROM 의 특정 위치에 구조체(struct)를 만들 수 있다.

|d0 @player &x $2 &y $2 &health $1
(
player 구조체에 x, y가 각 short를 차지하고, health가 byte를 차지한다.
코드 내에서 player/x 등으로 호출할 수 있다. 
)

Note

Padding 결과, ROM 파일은 아래와 같다.

Details

( test.tal )
|100 "A
|150 "B
$4f  "C

$ ./uxnasm test.tal test.rom
$ xxd test.rom
00000000: 4100 0000 0000 0000 0000 0000 0000 0000  A...............
00000010: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000020: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000030: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000040: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000050: 4200 0000 0000 0000 0000 0000 0000 0000  B...............
00000060: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000070: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000080: 0000 0000 0000 0000 0000 0000 0000 0000  ................
00000090: 0000 0000 0000 0000 0000 0000 0000 0000  ................
000000a0: 43                                       C

Number, Ascii Runes

스택에 데이터를 삽입하는 runes

• #로 hex값을 스택 에 삽입할 수 있다. Literal (LIT)

• "로 아스키 문자열의 각 글자를 byte로 ROM 삽입할 수 있다.

  Warning

  프로그램의 실행 중 스택 에 삽입하는 것이 아니다. 어셈블러가 "를 만나면, 뒤의 문자열을 아스키 hex로 변환해 그대로 ROM 에 삽입한다.

  ( test.rom )
  "banana
  

  $ ./uxnasm test.tal test.rom
  $ xxd hello.rom
  00000000: 6261 6e61 6e61                           banana
  

Adressing

Uxntal에는 ROM 주소 를 다루는 6가지 runes가 존재한다. 각 rune은 라벨의 주소 를 가져오는 역할을 한다.

Literal- 은 실행 당시에 그 주소 를 가져와서 스택 에 삽입한다.

• Literal Relative(,)는 현재 PC에서 라벨의 주소까지의 거리를 스택에 삽입한다.
• Literal Zero Page(.)는 zero-page 라벨의 주소(byte)를 스택에 삽입한다.
• Literal Absolute(;)는 라벨의 주소(short)를 스택에 삽입한다.

Note

( test.rom )
;label @label

Result & Analyze

$ ./uxnasm test.tal test.rom
$ xxd test.rom
00000000: a001 03                                  ...
          ^^~~~~~
    (1)---+     +--(2)

• (1) 0x0a: LIT2 의 opcode, 즉 다음에 오는 short를 stack에 삽입
• (2) 0x0103: @label의 ROM 주소

Raw- 는 어셈블러 시점에 주소 를 가져와서 ROM 에 삽입 한다.

• Raw Relative(_)는 현재 PC에서 라벨의 주소까지의 거리를 ROM에 삽입한다.
• Raw Zero Page(-)는 zero-page 라벨의 주소(byte)를 ROM에 삽입한다.
• Raw Absolute(=)는 라벨의 주소(short)를 ROM에 삽입한다.

Note

( test.rom )
=label @label

Result & Analyze

$ ./uxnasm test.tal test.rom
$ xxd test.rom
00000000: 0102                                     ..
          ^^^^
    (1)---+ 

• (1) 0x0102: @label의 ROM 주소

결과에서도 알 수 있듯, Raw Labeling은 어셈블리 단계에서 라벨 의 ROM 주소 를 삽입하기에, 라벨의 주소(0x0102) 가 Litral Labeling(0x0103 ) 보다 하나 앞으로 간 것을 볼 수 있다.

Wrappings

• ( ,  ) 괄호 는 주석이다.

• [, ] 대괄호는 그것을 포함한 내부가 무시되는 ( ,  ) 달리, 그 자체가 무시된다. 대괄호는 가독성을 위해 opcode를 묶는 표기로 쓰인다.

• {, } 중괄호 는 anonymous, 즉 이름 없는 루틴처럼 쓰인다.

Macro

%name { }으로 매크로를 만들 수 있다.

%modulo ( num denum -- res ) {
	DIVk MUL SUB }

@routine ( -- c* )
	#18 #03 modulo JMP2r

Opcodes

Uxntal은 연산자 우선순위가 없고, 그저 연산자가 프로그램된 순서대로 스택에서 실행된다.
PC는 현재 opcode의 다음 ROM 주소 가 되며, 각 opcode 실행 후, 2¹씩 증가한다.²

#0f #06 #04 ADD MUL
( RESULT
WST: 96
)

1. 0x06 + 0x04 = 0x0a (WST: 0f 0a)
2. 0x0f × 0x0a = 0x96 (WST: 96)

Notation

Uxntal은 아래와 같은 Forth 언어의 표기법을 따른다.

-- 앞의 각 아이템을 실행 전 스택 의 상태, 뒤의 각 아이템을 실행 후 스택 의 상태로 표기한다.

#12 #34 ADD
( RESULT
WST: 46
)

ADD ( a b -- c )

Shorts를 대상으로 하는 연산 이라면, 그 아이템 뒤에 *을 붙여서 표기한다.

#1234 #abcd ADD2
( RESULT
WST: be 01
)

ADD2 ( a* b* -- c* )

RST에 영향을 끼치는 연산 이라면, . 뒤에 그 RST 의 상황을 표기한다.

#12 STH
( RESULT
WST: 
RST: 12
)

STH ( a -- . a)

( BEFORE RST: 12 )
STHr
( RESULT
WST: 12
)

STHr ( . a -- a )

Note

Stash

Stash(STH)는 스택(WST) 의 최상단 byte 를 소모하여 RST 으로 삽입한다.
STHr은 RST 의 최상단 byte 를 소모하여 WST 으로 삽입한다.

Mode

Uxntal에는 3가지 모드가 존재한다.

Short mode는 byte 대신 short(두 byte)를 소모하여 연산한다.
점프와 관련된 opcode³에서는 absolute 위치를 사용한다.

#0123 #abcd ADD2
( RESULT
WST: ac f0
)

ADD2 ( a* b* -- c* )

Keep mode는 연산 이후 연산에 사용된 값들을 소모하지 않고 보존한다.

#01 #23 ADDk
( RESULT
WST: 01 23 24
)

ADD2 ( a b -- a b c )

Return mode는 WST 대신 RST에서 연산을 시행한다.

( BEFORE RST: 01 23 )
ADDr
( RESULT
RST: 24
)

ADDr ( . a b -- . c )

Note

Stash

Stash(STH)는 스택의 최상단 byte를 소모하여 RST으로 삽입한다.
STHr은 RST의 최상단 byte를 소모하여 WST으로 삽입한다.

이러한 mode들은 혼합해 사용할 수 있다. 각 opcode는 총 8가지의 variant를 갖는다.⁴

ADD    ( a b -- c )
ADD2   ( a* b* -- c* )
ADDk   ( a b -- a b c )
ADDr   ( . a b -- . c )
ADD2k  ( a* b* -- a* b* c* )
ADDkr  ( . a b -- . a b c )
ADD2r  ( . a* b* -- . c* )
ADD2kr ( . a* b* -- . a* b* c* )

따라서, Uxntal의 opcode는 각 2 bytes를 차지한다.

Immediate Opcodes

Immediate Opcode는 스택 최상단에서 데이터를 소모하여 연산하지 않고, opcode 이후에 ROM에 쓰여진 값 을 즉시 가져와 사용하는 opcode들이다.
지정된 방식으로만 작동하기 때문에 immediate opcode에는 mode가 없다.

Literal(LIT)은 #를 사용해 다음에 오는 데이터를 스택에 삽입한다.

#12 #abcd
( RESULT
WST: 12 ab cd
)

Note

Literal(LIT)

Literal(LIT)은 사실 #이외에도 쓰일 수 있는데, ROM에서 다음에 오는 데이터를 그대로 스택에 삽입하는 opcode이다.

( test.tal )
LIT "A
( RESULT
WST: 41
)

$ ./uxnasm test.tal test.rom
$ xxd test.rom
00000000: 8041                                     .A
          ^^~~
    (1)---+  +--(2)

• (1) 0x80: LIT의 opcode, 즉 ROM 의 다음 byte(0x41) 를 스택에 삽입한다.
• (2) 0x41: A의 ascii 값

LIT2는 물론 ROM 에서 두 byte를 소모한다.

Jummp Immediate(JMI)는 ! 이후 루틴의 이름을 적는 방식으로 루틴으로 점프한다.

#00 !routine INC
@routine INC INC
( RESULT
WST: 02
)

위 코드에서 점프 opcode가 없었다면 결과가 03 이었겠지만, @routine 루틴(의 주소)으로 점프하였기에, 결과는 02이다.

Jummp Conditional Immediate(JCI)는 ? 이후 루틴의 이름을 적는 방식으로 조건적으로 점프한다.
연산 시, 스택 에서 앞의 byte를 가져와 그 값에 따라 앞의 byte를 가져와 그 값에 따라 루틴으로 점프한다. 즉, 조건 점프는 byte를 소모한다.

? 이후 루틴이 올 경우, 스택 최상위 byte를 소모하고, 0x00이 아니라면 루틴으로 점프한다. 0x00이라면 그대로 진행한다. (공식 문서에서는 PC를 2 증가시킨다고도 표현한다.)

#00 ?routine INC @routine INC INC
( RESULT
WST: 03
)

#01 ?routine INC @routine INC INC
( RESULT
WST: 02
)

? 이후 {, } 으로 감싸진 부분이 나온다면 이전과 반대로 스택 최상위 byte가 00이라면 내부를 실행한다.

#10 #00 ?{ INC }
( RESULT
WST: 11
)

#10 #01 ?{ INC }
( RESULT
WST: 10
)

이는 Uxntal에서 헷갈리는 부분 중 하나인데, }을 루틴의 정의라고 생각하고, {을 루틴의 라벨이라고 생각하면 그나마 나을 듯 하다.

#10 #00 ?{ INC }

#10 #00 ?end INC @end

Jump Stash Return Immediate(JSI)는 간단히 말해 루틴을 해당 위치에서 실행한다.
JMI와의 차이점은 현재 PC+2의 값을 RST에 삽입하고, 루틴의 위치로 점프한다.

1#00
2routine 
3INC         
4@routine    
5( RESULT    
6WST: 00     
7RST: 01 05  
8     ^^^^^ Line 3의 PC
9)

Note

Jump Stash Return

Jump Stash Return(JSR)이라는 다른 opcode도 있는데, 이것은 동적으로 스택 최상위에 있는 주소로 점프함과 동시에 현재 PC+2 값을 RST에 삽입한다.
따라서 아래 코드는 JSI의 예시 코드와 정확이 동일한 결과를 만든다.

1#00
2;routine JSR
3INC         
4@routine    
5( RESULT    
6WST: 00     
7RST: 01 05  
8     ^^^^^ Line 3의 PC
9)

JSI가 존재 함에도 불구하고 JSR이 따로 존재하는 이유는, 루틴을 정해서 점프하는 JSI와 달리, 동적인 루틴/주소로 점프할 수 있기 때문이다.

Literal Absolute(;)

실행된 위치의 ROM 주소(PC) 를 저장하기에, 루틴을 실행하고 원래의 위치로 돌아올 수 있다는 점을 이용해 함수 같이 쓰인다. 그리고 돌아오게 만들 수 있기에, 내부 어느 시점에서 쓰인다고 하여 서브루틴이라고도 한다.

#07 #04 modulo BRK
( 이대로 진행하면 그대로 modulo의 opcode를 실행하기 때문에, 그전에 break한다. )

( Forth notation은 코드 내에서 루틴의 sideeffect를 표기할때 주로 쓰인다. )
@modulo ( a mod -- res ) 
  DIVk MUL SUB JMP2r
( RESULT
WST: 03
)

Note

Break

Break(BRK)는 현재 vector의 연산을 종료한다. 이 opcode에는 모드가 없다.

Further More…

본 글에서는 Uxntal의 기본적 문법과 생태계만을 설명했다. 다양한 opcode들[↗] 은 직접 읽어보길 바란다.

Related

• Uxn/Varvara Ecosystem

References

• https://wiki.xxiivv.com/site/uxntal.html[↗]
• https://learnxinyminutes.com/uxntal/[↗]