Fixed an error of returning data to register x0 in the library for arm64, added possibility of clearing several registers with clr, and other minor changes of push/pop for registers inside macros

Author: lina-torovoltas

MACRO_USAGE.md

@@ -16,128 +16,149 @@ Also:
 
 
 
-## clr
-Clears the specified register by setting it to zero.
+## Auxiliary Macros
+
+### clr
+Clears the specified registers by setting them to zero.
 
 ```asm
-clr reg
+clr reg1, reg2
 ```
 
 
 **Arguments:**</br>
-`reg` — the name of the register to be cleared (e.g., `eax`, `rax`, etc.)
+`regN` — actual registers to be cleared (set to zero), depending on the target architecture.
 
 
 **Usage example:**
 
 ```asm
-clr eax    ; sets eax to 0  
-clr rax    ; sets rax to 0  
-clr r0     ; sets r0 to 0
-clr x0     ; sets x0 to 0
+clr eax, ebx    ; sets eax and ebx to 0
+clr rax, rdi    ; sets rax and rdi to 0
+clr r7, r0      ; sets r7 and r0 to 0
+clr x8, x0      ; sets x8 and x0 to 0
 ```
 
 
 
-## exit
-Terminates the program with a specified exit code.
+### push / pop  
+Pushes or pops multiple registers on/from the stack (equivalent to multiple `push`/`pop` instructions).</br>
+Register order in `pop` must match the reverse of `push`.
 
 ```asm
-exit code
+push reg1, reg2, reg3
+...
+pop reg3, reg2, reg1
 ```
 
 
 **Arguments:**</br>
-`code` — the exit code to return to the operating system (e.g., `0` for success, `1` for error)
+`regN` — actual registers to push or pop depending on the target architecture.
 
 
 **Usage example:**
 
-```asm
-exit 0    ; exit with code 0 
-exit 1    ; exit with code 1
+For x86_64:
+```
+push rax, rdi, rsi
+...
+pop rsi, rdi, rax
 ```
 
+For x86:
+```
+push eax, edi, esi
+...
+pop esi, edi, eax
+```
 
+For ARM:
+```
+push r0, r1, r2
+...
+pop r2, r1, r0
+```
 
-## time
-Stores the current UNIX time (seconds since January 1, 1970) in the architecture-specific register.
-
-```asm
-time
+For ARM64:
+```
+push x0, x1, x2
+...
+pop x2, x1, x0
 ```
 
 
 
-## mkdir
-Creates a directory with the given name and permissions (in octal format).</br>
-Returns an error code in the architecture-specific register.
+### exit
+Terminates the program with a specified exit code.
 
 ```asm
-mkdir dir_name, permissions
+exit code
 ```
 
 
 **Arguments:**</br>
-`dir_name` — name of the directory to create, given as a string literal or a pointer to a string</br>
-`permissions` — access mode in octal format, given as a number or a pointer to a variable containing the value
+`code` — the exit code to return to the operating system (e.g., `0` for success, `1` for error).
 
 
 **Usage example:**
 
 ```asm
-mkdir "dir", 700o
-mkdir name, permissions
+exit 0    ; exit with code 0 
+exit 1    ; exit with code 1
 ```
 
 
 
-## rmdir
-Removes the specified directory.</br>
+## Directory Management Macros
+
+### mkdir
+Creates a directory with the given name and permissions (in octal format).</br>
 Returns an error code in the architecture-specific register.
 
 ```asm
-rmdir dir_name
+mkdir dir_name, permissions
 ```
 
 
 **Arguments:**</br>
-`dir_name` — name of the directory to remove, given as a string literal or a pointer to a string
+`dir_name` — name of the directory to create, given as a string literal or a pointer to a string.</br>
+`permissions` — access mode in octal format, given as a number or a pointer to a variable containing the value.
 
 
 **Usage example:**
 
 ```asm
-rmdir "dir"
-rmdir name
+mkdir "dir", 700o
+mkdir name, permissions
 ```
 
 
 
-## printnum  
-Prints the given number in decimal.</br>
-Supports values according to the target architecture.</br>
-Returns the number of bytes printed in the architecture-specific register.
+### rmdir
+Removes the specified directory.</br>
+Returns an error code in the architecture-specific register.
 
 ```asm
-printnum number
+rmdir dir_name
 ```
 
 
 **Arguments:**</br>
-`number` — the unsigned integer value to print
+`dir_name` — name of the directory to remove, given as a string literal or a pointer to a string.
 
 
 **Usage example:**
 
 ```asm
-printnum 18446744073709551615
-printnum 4294967295
+rmdir "dir"
+rmdir name
 ```
 
 
 
-## print
+## Console Output Macros
+
+### print
 Prints the string at the given address with the specified length.</br>
 Returns the number of bytes printed in the architecture-specific register.
 
@@ -147,8 +168,8 @@ print str, str_len
 
 
 **Arguments:**  
-`str` — pointer to the string or string literal to print</br>
-`str_len` — length of the string in bytes, given as a number or pointer
+`str` — pointer to the string or string literal to print.</br>
+`str_len` — length of the string in bytes, given as a number or pointer.
 
 
 **Usage example:**
@@ -160,7 +181,7 @@ print "test", 4
 
 
 
-## printtim  
+### printtim  
 Prints the given string a specified number of times.</br>
 Returns the number of bytes printed in the architecture-specific register.
 
@@ -170,9 +191,9 @@ printtim times, str, str_len
 
 
 **Arguments:**</br>
-`times` — number of times to print the string, given as a number or pointer  
-`str` — pointer to the string or string literal to print  
-`str_len` — length of the string in bytes, given as a number or pointer
+`times` — number of times to print the string, given as a number or pointer.</br>
+`str` — pointer to the string or string literal to print.</br>
+`str_len` — length of the string in bytes, given as a number or pointer.
 
 
 **Usage example:**
@@ -184,69 +205,69 @@ printtim 3, "test", 4
 
 
 
-## run
-Executes the specified shell command.</br>
-Returns an error code in the architecture-specific register.
+### printnum  
+Prints the given number in decimal.</br>
+Supports values according to the target architecture.</br>
+Returns the number of bytes printed in the architecture-specific register.
 
 ```asm
-run command
+printnum number
 ```
 
+**Note:**
+
+Not available in the library for arm and arm64.
+
 
 **Arguments:**</br>
-`command` — pointer to the command string or a string literal to execute
+`number` — the unsigned integer value to print.
 
 
 **Usage example:**
 
-```
-run "echo test"
-run cmd_str
+```asm
+printnum 18446744073709551615
+printnum 4294967295
 ```
 
 
 
-## push / pop  
-Pushes or pops multiple registers on/from the stack (equivalent to multiple `push`/`pop` instructions).  
-Register order in `pop` must match the reverse of `push`.
+## Misc Macros
+
+### time
+Stores the current UNIX time (seconds since January 1, 1970) in the architecture-specific register.
 
 ```asm
-push reg1, reg2, reg3
-...
-pop reg3, reg2, reg1
+time
 ```
 
+**Note:**
 
-**Arguments:**</br>
-`regN` — actual registers to push or pop depending on the target architecture
+Not available in the library for arm and arm64.
 
 
-**Usage example:**
 
-For x86_64:
-```
-push rax, rdi, rsi
-...
-pop rsi, rdi, rax
-```
+### run
+Executes the specified shell command.</br>
+Returns an error code in the architecture-specific register.
 
-For x86:
-```
-push eax, edi, esi
-...
-pop esi, edi, eax
+```asm
+run command
 ```
 
-For ARM:
-```
-push r0, r1, r2
-...
-pop r2, r1, r0
-```
 
-For ARM64:
+**Note:**
+
+Not available in the library for arm and arm64.
+
+
+**Arguments:**</br>
+`command` — pointer to the command string or a string literal to execute.
+
+
+**Usage example:**
+
 ```
-push x0, x1, x2
-...
-pop x2, x1, x0
+run "echo test"
+run cmd_str
 ```

examples/examples_arm64/clear.asm

@@ -11,6 +11,6 @@ segment readable executable
 align 4
 
 start:
+    clr x8, x0
     mov x8, #93
-    clr x0
     svc 0

examples/examples_x64/clear.asm

@@ -9,6 +9,6 @@ entry start
 segment readable executable
 
 start:
+    clr rax, rdi
     mov rax, 60
-    clr rdi
     syscall

examples/examples_x86/clear.asm

@@ -9,6 +9,6 @@ entry start
 segment readable executable
 
 start:
+    clr eax, ebx
     mov eax, 1
-    clr ebx
     int 0x80