From 03d50cc83c7c2bebb2b019667b80c1c51f4a8def Mon Sep 17 00:00:00 2001 From: Kartik Agaram Date: Fri, 5 Oct 2018 19:49:47 -0700 Subject: 4667 Standardize on hyphens in all names. And we'll use colons for namespacing labels in functions. --- subx/examples/ex10.subx | 23 ++++---- subx/examples/ex11 | Bin 1125 -> 1125 bytes subx/examples/ex11.subx | 147 ++++++++++++++++++++++++------------------------ subx/examples/ex12.subx | 4 +- subx/examples/ex8.subx | 14 ++--- subx/examples/ex9.subx | 6 +- 6 files changed, 98 insertions(+), 96 deletions(-) (limited to 'subx/examples') diff --git a/subx/examples/ex10.subx b/subx/examples/ex10.subx index f2eadc5d..43b0e1d1 100644 --- a/subx/examples/ex10.subx +++ b/subx/examples/ex10.subx @@ -12,7 +12,7 @@ # op subop mod rm32 base index scale r32 # 1-3 bytes 3 bits 2 bits 3 bits 3 bits 3 bits 2 bits 2 bits 0/1/2/4 bytes 0/1/2/4 bytes -# main: return argv_equal(argv[1], argv[2]) +# main: return argv-equal(argv[1], argv[2]) # At the start of a SubX program: # argc: *ESP # argv[0]: *(ESP+4) @@ -20,13 +20,13 @@ # ... # prolog 89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP - # call argv_equal(argv[1], argv[2]) + # call argv-equal(argv[1], argv[2]) # push argv[2] ff 6/subop/push 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . . 0xc/disp8 . # push *(EBP+12) # push argv[1] ff 6/subop/push 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . . 0x8/disp8 . # push *(EBP+8) # call - e8/call argv_equal/disp32 + e8/call argv-equal/disp32 # exit(EAX) $exit: 89/copy 3/mod/direct 3/rm32/EBX . . . 0/r32/EAX . . # copy EAX to EBX @@ -35,12 +35,12 @@ $exit: # compare two null-terminated ascii strings # reason for the name: the only place we should have null-terminated ascii strings is from commandline args -argv_equal: # (s1, s2) : null-terminated ascii strings -> EAX : boolean +argv-equal: # (s1, s2) : null-terminated ascii strings -> EAX : boolean # initialize s1 (ECX) and s2 (EDX) 8b/copy 1/mod/*+disp8 4/rm32/sib 4/base/ESP 4/index/none . 1/r32/ECX 4/disp8 . # copy *(ESP+4) to ECX 8b/copy 1/mod/*+disp8 4/rm32/sib 4/base/ESP 4/index/none . 2/r32/EDX 8/disp8 . # copy *(ESP+8) to EDX # while (true) -$argv_loop: +$argv-equal:loop: # c1/EAX, c2/EBX = *s1, *s2 b8/copy 0/imm32 # clear EAX 8a/copy 0/mod/indirect 1/rm32/ECX . . . 0/r32/EAX . . # copy byte at *ECX to lower byte of EAX @@ -48,23 +48,24 @@ $argv_loop: 8a/copy 0/mod/indirect 2/rm32/EDX . . . 3/r32/EBX . . # copy byte at *EDX to lower byte of EBX # if (c1 == 0) break 3d/compare-EAX 0/imm32 - 74/jump-if-equal $argv_break/disp8 + 74/jump-if-equal $argv-equal:break/disp8 # if (c1 != c2) return false 39/compare 3/mod/direct 0/rm32/EAX . . . 3/r32/EBX . . # compare EAX with EBX - 75/jump-if-not-equal $argv_fail/disp8 + 75/jump-if-not-equal $argv-equal:false/disp8 # ++s1, ++s2 41/inc-ECX 42/inc-EDX # end while - eb/jump $argv_loop/disp8 -$argv_break: + eb/jump $argv-equal:loop/disp8 +$argv-equal:break: # if (c2 == 0) return true 81 7/subop/compare 3/mod/direct 3/rm32/EBX . . . . . 0/imm32 # compare EBX - 75/jump-if-not-equal $argv_fail/disp8 + 75/jump-if-not-equal $argv-equal:false/disp8 +$argv-equal:success: b8/copy . . . . . . . 1/imm32 # copy to EAX c3/return # return false -$argv_fail: +$argv-equal:false: b8/copy . . . . . . . 0/imm32 # copy to EAX c3/return diff --git a/subx/examples/ex11 b/subx/examples/ex11 index cf0d0c85..f4329e00 100755 Binary files a/subx/examples/ex11 and b/subx/examples/ex11 differ diff --git a/subx/examples/ex11.subx b/subx/examples/ex11.subx index defab46b..2ffdaad3 100644 --- a/subx/examples/ex11.subx +++ b/subx/examples/ex11.subx @@ -21,7 +21,7 @@ # 1-3 bytes 3 bits 2 bits 3 bits 3 bits 3 bits 2 bits 2 bits 0/1/2/4 bytes 0/1/2/4 bytes # main: - e8/call run_tests/disp32 # 'run_tests' is a function created automatically by SubX. It calls all functions that start with 'test_'. + e8/call run-tests/disp32 # 'run-tests' is a function created automatically by SubX. It calls all functions that start with 'test-'. # exit(EAX) 89/copy 3/mod/direct 3/rm32/EBX . . . 0/r32/EAX . . # copy EAX to EBX b8/copy . . . . . . . 1/imm32 # copy to EAX @@ -29,7 +29,7 @@ # compare a null-terminated ascii string with a more idiomatic length-prefixed byte array # reason for the name: the only place we should have null-terminated ascii strings is from commandline args -kernel_string_equal: # s : null-terminated ascii string, benchmark : length-prefixed ascii string -> EAX : boolean +kernel-string-equal: # s : null-terminated ascii string, benchmark : length-prefixed ascii string -> EAX : boolean # prolog 55/push-EBP 89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP @@ -64,9 +64,9 @@ kernel_string_equal: # s : null-terminated ascii string, benchmark : length-pre # initialize loop counter i into ECX b9/copy . . . . . . . 0/imm32/exit # copy to ECX # while (i/ECX < n/EDX) -$kernel_string_loop: +$kernel-string-equal:loop: 39/compare 3/mod/direct 1/rm32/ECX . . . 2/r32/EDX . . # compare ECX with EDX - 74/jump-if-equal $kernel_string_break/disp8 + 74/jump-if-equal $kernel-string-equal:break/disp8 # c1/EAX, c2/EBX = *s, *benchmark b8/copy 0/imm32 # clear EAX 8a/copy 0/mod/indirect 7/rm32/EDI . . . 0/r32/EAX . . # copy byte at *EDI to lower byte of EAX @@ -74,29 +74,30 @@ $kernel_string_loop: 8a/copy 0/mod/indirect 6/rm32/ESI . . . 3/r32/EBX . . # copy byte at *ESI to lower byte of EBX # if (c1 == 0) return false 3d/compare-EAX 0/imm32 - 74/jump-if-equal $kernel_string_fail/disp8 + 74/jump-if-equal $kernel-string-equal:false/disp8 # if (c1 != c2) return false 39/compare 3/mod/direct 0/rm32/EAX . . . 3/r32/EBX . . # compare EAX with EBX - 75/jump-if-not-equal $kernel_string_fail/disp8 + 75/jump-if-not-equal $kernel-string-equal:false/disp8 # ++s1, ++s2, ++i 41/inc-ECX 46/inc-ESI 47/inc-EDI # end while - eb/jump $kernel_string_loop/disp8 -$kernel_string_break: + eb/jump $kernel-string-equal:loop/disp8 +$kernel-string-equal:break: # if (*s/EDI == 0) return true b8/copy 0/imm32 # clear EAX 8a/copy 0/mod/indirect 7/rm32/EDI . . . 0/r32/EAX . . # copy byte at *EDI to lower byte of EAX 81 7/subop/compare 3/mod/direct 0/rm32/EAX . . . . . 0/imm32 # compare EAX - 75/jump-if-not-equal $kernel_string_fail/disp8 + 75/jump-if-not-equal $kernel-string-equal:false/disp8 b8/copy . . . . . . . 1/imm32 # copy to EAX - eb/jump $kernel_string_end/disp8 +$kernel-string-equal:true: + eb/jump $kernel-string-equal:end/disp8 # return false -$kernel_string_fail: +$kernel-string-equal:false: b8/copy . . . . . . . 0/imm32 # copy to EAX -$kernel_string_end: +$kernel-string-equal:end: # restore registers 5f/pop-to-EDI 5e/pop-to-ESI @@ -110,142 +111,142 @@ $kernel_string_end: ## tests -test_compare_null_kernel_string_with_empty_array: - # EAX = kernel_string_equal(Null_kernel_string, "") +test-compare-null-kernel-string-with-empty-array: + # EAX = kernel-string-equal(Null-kernel-string, "") # push args 68/push ""/imm32 - 68/push Null_kernel_string/imm32 + 68/push Null-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 1, msg) + # call check-ints-equal(EAX, 1, msg) # push args - 68/push "F - test_compare_null_kernel_string_with_empty_array"/imm32 + 68/push "F - test-compare-null-kernel-string-with-empty-array"/imm32 68/push 1/imm32/true 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return -test_compare_null_kernel_string_with_non_empty_array: - # EAX = kernel_string_equal(Null_kernel_string, "Abc") +test-compare-null-kernel-string-with-non-empty-array: + # EAX = kernel-string-equal(Null-kernel-string, "Abc") # push args 68/push "Abc"/imm32 - 68/push Null_kernel_string/imm32 + 68/push Null-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 0, msg) + # call check-ints-equal(EAX, 0, msg) # push args - 68/push "F - test_compare_null_kernel_string_with_non_empty_array"/imm32 + 68/push "F - test-compare-null-kernel-string-with-non-empty-array"/imm32 68/push 0/imm32/false 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return -test_compare_kernel_string_with_equal_array: - # EAX = kernel_string_equal(Abc_kernel_string, "Abc") +test-compare-kernel-string-with-equal-array: + # EAX = kernel-string-equal(Abc-kernel-string, "Abc") # push args 68/push "Abc"/imm32 - 68/push Abc_kernel_string/imm32 + 68/push Abc-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 1, msg) + # call check-ints-equal(EAX, 1, msg) # push args - 68/push "F - test_compare_kernel_string_with_equal_array"/imm32 + 68/push "F - test-compare-kernel-string-with-equal-array"/imm32 68/push 1/imm32/true 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return -test_compare_kernel_string_with_inequal_array: - # EAX = kernel_string_equal(Abc_kernel_string, "Adc") +test-compare-kernel-string-with-inequal-array: + # EAX = kernel-string-equal(Abc-kernel-string, "Adc") # push args 68/push "Adc"/imm32 - 68/push Abc_kernel_string/imm32 + 68/push Abc-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 0, msg) + # call check-ints-equal(EAX, 0, msg) # push args - 68/push "F - test_compare_kernel_string_with_equal_array"/imm32 + 68/push "F - test-compare-kernel-string-with-equal-array"/imm32 68/push 0/imm32/false 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return -test_compare_kernel_string_with_empty_array: - # EAX = kernel_string_equal(Abc_kernel_string, "") +test-compare-kernel-string-with-empty-array: + # EAX = kernel-string-equal(Abc-kernel-string, "") # push args 68/push ""/imm32 - 68/push Abc_kernel_string/imm32 + 68/push Abc-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 0) + # call check-ints-equal(EAX, 0) # push args - 68/push "F - test_compare_kernel_string_with_equal_array"/imm32 + 68/push "F - test-compare-kernel-string-with-equal-array"/imm32 68/push 0/imm32/false 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return -test_compare_kernel_string_with_shorter_array: - # EAX = kernel_string_equal(Abc_kernel_string, "Ab") +test-compare-kernel-string-with-shorter-array: + # EAX = kernel-string-equal(Abc-kernel-string, "Ab") # push args 68/push "Ab"/imm32 - 68/push Abc_kernel_string/imm32 + 68/push Abc-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 0) + # call check-ints-equal(EAX, 0) # push args - 68/push "F - test_compare_kernel_string_with_shorter_array"/imm32 + 68/push "F - test-compare-kernel-string-with-shorter-array"/imm32 68/push 0/imm32/false 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return -test_compare_kernel_string_with_longer_array: - # EAX = kernel_string_equal(Abc_kernel_string, "Abcd") +test-compare-kernel-string-with-longer-array: + # EAX = kernel-string-equal(Abc-kernel-string, "Abcd") # push args 68/push "Abcd"/imm32 - 68/push Abc_kernel_string/imm32 + 68/push Abc-kernel-string/imm32 # call - e8/call kernel_string_equal/disp32 + e8/call kernel-string-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP - # call check_ints_equal(EAX, 0) + # call check-ints-equal(EAX, 0) # push args - 68/push "F - test_compare_kernel_string_with_longer_array"/imm32 + 68/push "F - test-compare-kernel-string-with-longer-array"/imm32 68/push 0/imm32/false 50/push-EAX # call - e8/call check_ints_equal/disp32 + e8/call check-ints-equal/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 0xc/imm32 # add to ESP c3/return @@ -253,7 +254,7 @@ test_compare_kernel_string_with_longer_array: ## helpers # print msg to stderr if a != b, otherwise print "." -check_ints_equal: # (a : int, b : int, msg : (address array byte)) -> boolean +check-ints-equal: # (a : int, b : int, msg : (address array byte)) -> boolean # prolog 55/push-EBP 89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP @@ -265,35 +266,35 @@ check_ints_equal: # (a : int, b : int, msg : (address array byte)) -> boolean 8b/copy 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . 3/r32/EBX 0xc/disp8 . # copy *(EBP+12) to EBX # if EAX == b/EBX 39/compare 3/mod/direct 0/rm32/EAX . . . 3/r32/EBX . . # compare EAX and EBX - 75/jump-if-unequal $check_ints_equal:else/disp8 + 75/jump-if-unequal $check-ints-equal:else/disp8 # print('.') # push args 68/push "."/imm32 # call - e8/call write_stderr/disp32 + e8/call write-stderr/disp32 # discard arg 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP # return - eb/jump $check_ints_equal:end/disp8 + eb/jump $check-ints-equal:end/disp8 # else: -$check_ints_equal:else: +$check-ints-equal:else: # copy msg into ECX 8b/copy 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . 1/r32/ECX 0x10/disp8 . # copy *(EBP+16) to ECX # print(ECX) # push args 51/push-ECX # call - e8/call write_stderr/disp32 + e8/call write-stderr/disp32 # discard arg 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP # print newline # push args 68/push Newline/imm32 # call - e8/call write_stderr/disp32 + e8/call write-stderr/disp32 # discard arg 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP -$check_ints_equal:end: +$check-ints-equal:end: # restore registers 5b/pop-to-EBX 59/pop-to-ECX @@ -302,7 +303,7 @@ $check_ints_equal:end: 5d/pop-to-EBP c3/return -write_stderr: # s : (address array byte) -> +write-stderr: # s : (address array byte) -> # prolog 55/push-EBP 89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP @@ -340,10 +341,10 @@ Newline: # data 0a/newline -# for kernel_string_equal tests -Null_kernel_string: +# for kernel-string-equal tests +Null-kernel-string: 00/null -Abc_kernel_string: +Abc-kernel-string: 41/A 62/b 63/c 00/null # vim:nowrap:textwidth=0 diff --git a/subx/examples/ex12.subx b/subx/examples/ex12.subx index d7c2e868..1db660ed 100644 --- a/subx/examples/ex12.subx +++ b/subx/examples/ex12.subx @@ -12,7 +12,7 @@ # 1-3 bytes 3 bits 2 bits 3 bits 3 bits 3 bits 2 bits 2 bits 0/1/2/4 bytes 0/1/2/4 bytes # mmap(0x1000) - bb/copy . . . . . . . mmap_new_segment/imm32 # copy to EBX + bb/copy . . . . . . . mmap-new-segment/imm32 # copy to EBX b8/copy . . . . . . . 0x5a/imm32/mmap # copy to EAX cd/syscall 0x80/imm8 @@ -26,7 +26,7 @@ == data # various constants used here were found in the Linux sources (search for file mman-common.h) -mmap_new_segment: # type mmap_arg_struct +mmap-new-segment: # type mmap_arg_struct # addr 00 00 00 00 # null # len diff --git a/subx/examples/ex8.subx b/subx/examples/ex8.subx index ccc6dcb9..2726eea9 100644 --- a/subx/examples/ex8.subx +++ b/subx/examples/ex8.subx @@ -20,11 +20,11 @@ # 1-3 bytes 3 bits 2 bits 3 bits 3 bits 3 bits 2 bits 2 bits 0/1/2/4 bytes 0/1/2/4 bytes # prolog 89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP - # call ascii_length(argv[1]) + # call ascii-length(argv[1]) # push args ff 6/subop/push 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . . 0x8/disp8 . # push *(EBP+8) # call - e8/call ascii_length/disp32 + e8/call ascii-length/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 4/imm32 # add to ESP @@ -33,24 +33,24 @@ b8/copy . . . . . . . 1/imm32/exit # copy to EAX cd/syscall 0x80/imm8 -ascii_length: # (s) +ascii-length: # (s) # initialize s (EDX) 8b/copy 1/mod/*+disp8 4/rm32/sib 4/base/ESP 4/index/none 2/r32/EDX 4/disp8 # copy *(ESP+4) to EDX # var result = 0 (EAX) b8/copy . . . . . . . 0/imm32 # copy to EAX -$ascii_length_loop: +$ascii-length-loop: # var c = *s (ECX) 8a/copy 0/mod/* 2/rm32/EDX . . . 1/r32/ECX . . # copy byte at *EDX to lower byte of ECX # if c == '\0' break 81 7/subop/compare 3/mod/direct 1/rm32/ECX . . . . . 0/imm32 # compare ECX - 74/jump-if-equal $ascii_length_ret/disp8 + 74/jump-if-equal $ascii-length-ret/disp8 # ++s 81 0/subop/add 3/mod/direct 2/rm32/EDX . . . . . 1/imm32 # add to EDX # ++result 40/inc-EAX # loop - eb/jump $ascii_length_loop/disp8 -$ascii_length_ret: + eb/jump $ascii-length-loop/disp8 +$ascii-length-ret: # return (result in EAX) c3/return diff --git a/subx/examples/ex9.subx b/subx/examples/ex9.subx index c5711ef1..7e4132b2 100644 --- a/subx/examples/ex9.subx +++ b/subx/examples/ex9.subx @@ -22,13 +22,13 @@ # 1-3 bytes 3 bits 2 bits 3 bits 3 bits 3 bits 2 bits 2 bits 0/1/2/4 bytes 0/1/2/4 bytes # prolog 89/copy 3/mod/direct 5/rm32/EBP . . . 4/r32/ESP . . # copy ESP to EBP - # call ascii_difference(argv[1], argv[2]) + # call ascii-difference(argv[1], argv[2]) # push argv[2] ff 6/subop/push 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . . 0xc/disp8 . # push *(EBP+12) # push argv[1] ff 6/subop/push 1/mod/*+disp8 4/rm32/sib 5/base/EBP 4/index/none . . 0x8/disp8 . # push *(EBP+8) # call - e8/call ascii_difference/disp32 + e8/call ascii-difference/disp32 # discard args 81 0/subop/add 3/mod/direct 4/rm32/ESP . . . . . 8/imm32 # add to ESP # exit(EAX) @@ -36,7 +36,7 @@ b8/copy . . . . . . . 1/imm32/exit # copy to EAX cd/syscall 0x80/imm8 -ascii_difference: # (s1, s2) : null-terminated ascii strings +ascii-difference: # (s1, s2) : null-terminated ascii strings # a = first letter of s1 (ECX) 8b/copy 1/mod/*+disp8 4/rm32/sib 4/base/ESP 4/index/none 0/r32/EAX 4/disp8 . # copy *(ESP+4) to EAX 8b/copy 0/mod/indirect 0/rm32/EAX . . . 0/r32/EAX . . # copy *EAX to EAX -- cgit 1.4.1-2-gfad0