KolibriOS/kolibrios
13
14
Fork 12
Code Issues 113 Pull Requests 16 Actions Projects 1 Releases Wiki Activity

Apps/dbgboard: add display modes and more highlighting
All checks were successful
Build system / Check kernel codestyle (pull_request) Successful in 34s
Details
Build system / Build (pull_request) Successful in 5m17s
Details

Browse Source
This commit is contained in:
rgimad
2025-03-13 17:24:09 +03:00
parent 36ce6f0b74
commit 1974f45c50
2 changed files with 274 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
programs/system/dbgboard/README.md
View File

@@ -2,6 +2,16 @@
Main advantages over the old board:
* Bigger font
* Scrolling (like in other console apps)
* K : and L: messages highligting
* Messages highligting
* K : - kernel messages (K: also supported because some code in kernel prints such)
* L: - launcher messages
* I: - information
* W: - warning
* E: - error
* S: - success
* Three display modes (You can switch modes using `Tab` key)
* User messages
* Kernel messages
* Both kernel and user messages
Also, like the old board it writes log to /tmp0/1/boardlog.txt (or you can pass another path in args like `/sys/develop/dbgboard /tmp0/1/hgfdhgfh.txt`), you can view log file in cedit by hitting `F2` key

299
programs/system/dbgboard/dbgboard.asm
View File

@@ -2,6 +2,7 @@
; DBGBOARD - a console-based debug board
; Copyright (C) 2025 KolibriOS team
format binary as ""
use32
org 0
@@ -25,18 +26,37 @@ purge mov,add,sub
include '../../KOSfuncs.inc'
; include '../../debug-fdo.inc'
include '../../proc32.inc'
include '../../struct.inc'
include '../../dll.inc'
include '../../if.inc'
include '../../string.inc'
CON_WINDOW_CLOSED = 0x200
TEXT_COLOR_YELLOW = 14
TEXT_COLOR_WHITE = 15
TEXT_COLOR_LIGHTGRAY = 7
; TEXT_COLOR_LIGHTGREEN = 10
TEXT_COLOR_LIGHTGRAY = 7
TEXT_COLOR_LIGHTBLUE = 9
TEXT_COLOR_LIGHTGREEN = 10
TEXT_COLOR_LIGHTCYAN = 11
TEXT_COLOR_LIGHTRED = 12
TEXT_COLOR_LIGHTMAGENTA = 13
TEXT_COLOR_YELLOW = 14
TEXT_COLOR_WHITE = 15
proc set_text_color stdcall uses eax, _color
RB_CAPACITY = 4096*6
MODES_COUNT = 3
MODE_USER = 0
MODE_KERNEL = 1
MODE_BOTH = 2
struct RING_BUFFER
buffer dd ?
capacity dd ?
pos dd ?
bytes_filled dd ?
ends
proc set_text_color stdcall uses eax ecx edx, _color
and [_color], 0x0F
invoke con_get_flags
and eax, 0x3F0
@@ -95,6 +115,158 @@ proc write_file stdcall uses ebx, _path, _buf, _count, _pos_lo, _pos_hi, _out_by
ret
endp
proc ring_buffer_push_byte stdcall uses eax edx esi edi, _rb, _byte
mov esi, [_rb]
mov eax, [esi + RING_BUFFER.bytes_filled]
.if eax < [esi + RING_BUFFER.capacity]
inc [esi + RING_BUFFER.bytes_filled]
.endif
mov edi, [esi + RING_BUFFER.buffer]
add edi, [esi + RING_BUFFER.pos]
mov eax, [_byte]
mov byte [edi], al
mov eax, [esi + RING_BUFFER.pos]
inc eax
xor edx, edx
div [esi + RING_BUFFER.capacity]
mov [esi + RING_BUFFER.pos], edx ; put remainder
ret
endp
proc print_ring_buffer stdcall uses eax ebx ecx edx esi, _rb
mov esi, [_rb]
mov eax, [esi + RING_BUFFER.capacity]
xor ebx, ebx
.if eax = [esi + RING_BUFFER.bytes_filled]
mov ebx, [esi + RING_BUFFER.pos]
.endif
xor ecx, ecx
.while ecx < [esi + RING_BUFFER.bytes_filled]
mov eax, ebx
add eax, ecx
xor edx, edx
div [esi + RING_BUFFER.capacity]
mov eax, [esi + RING_BUFFER.buffer]
add eax, edx
mov eax, [eax]
mov byte [chr], al
stdcall print_next_char, chr
inc ecx
.endw
ret
endp
; in - __chr
proc push_to_buffers_next_char uses ebx
.if [__is_start_line] = 1
mov eax, __prefix
add eax, [__prefix_index]
mov bl, byte [__chr]
mov [eax], bl
.if [__prefix_index] = 2
.if dword [__prefix] = 'K :'
mov [current_rb], rb_kernel
.elseif dword [__prefix] = 'K: '
mov [current_rb], rb_kernel
.else
mov [current_rb], rb_user
.endif
mov [__is_start_line], 0
mov [__prefix_index], 0
movzx eax, byte [__prefix]
stdcall ring_buffer_push_byte, [current_rb], eax
movzx eax, byte [__prefix + 1]
stdcall ring_buffer_push_byte, [current_rb], eax
movzx eax, byte [__prefix + 2]
stdcall ring_buffer_push_byte, [current_rb], eax
mov dword [__prefix], 0
.else
inc [__prefix_index]
.endif
.else
movzx eax, byte [__chr]
stdcall ring_buffer_push_byte, [current_rb], eax
.if byte [__chr] = 10
mov [__is_start_line], 1
mov [current_rb], rb_user
.endif
.endif
ret
endp
; in - chr
proc print_next_char uses ebx
.if [is_start_line] = 1
mov eax, prefix
add eax, [prefix_index]
mov bl, byte [chr]
mov [eax], bl
.if [prefix_index] = 2
.if dword [prefix] = 'K :'
stdcall set_text_color, TEXT_COLOR_YELLOW
mov [is_kernel_printing], 1
.elseif dword [prefix] = 'K: '
stdcall set_text_color, TEXT_COLOR_YELLOW
mov [is_kernel_printing], 1
.elseif dword [prefix] = 'L: '
stdcall set_text_color, TEXT_COLOR_WHITE
mov [is_kernel_printing], 0
.elseif dword [prefix] = 'I: '
stdcall set_text_color, TEXT_COLOR_LIGHTCYAN
mov [is_kernel_printing], 0
.elseif dword [prefix] = 'W: '
stdcall set_text_color, TEXT_COLOR_LIGHTMAGENTA
mov [is_kernel_printing], 0
.elseif dword [prefix] = 'E: '
stdcall set_text_color, TEXT_COLOR_LIGHTRED
mov [is_kernel_printing], 0
.elseif dword [prefix] = 'S: '
stdcall set_text_color, TEXT_COLOR_LIGHTGREEN
mov [is_kernel_printing], 0
.else
stdcall set_text_color, TEXT_COLOR_LIGHTGRAY
mov [is_kernel_printing], 0
.endif
.if [is_kernel_printing]
.if [current_mode] = MODE_KERNEL | [current_mode] = MODE_BOTH
invoke con_write_asciiz, prefix
.endif
.else
.if [current_mode] = MODE_USER | [current_mode] = MODE_BOTH
invoke con_write_asciiz, prefix
.endif
.endif
; invoke con_write_asciiz, prefix
mov [is_start_line], 0
mov [prefix_index], 0
mov dword [prefix], 0
.else
inc [prefix_index]
.endif
.else
.if [is_kernel_printing]
.if [current_mode] = MODE_KERNEL | [current_mode] = MODE_BOTH
invoke con_write_asciiz, chr
.endif
.else
.if [current_mode] = MODE_USER | [current_mode] = MODE_BOTH
invoke con_write_asciiz, chr
.endif
.endif
; invoke con_write_asciiz, chr
.if byte [chr] = 10
mov [is_start_line], 1
stdcall set_text_color, TEXT_COLOR_LIGHTGRAY
.endif
.endif
ret
endp
start:
;; if there is a second instance of conboard is running then exit
mcall SF_THREAD_INFO, thread_info, -1
@@ -122,7 +294,10 @@ start:
jnz .exit
invoke con_start, 1
invoke con_init, 80, 32, -1, -1, title
mov eax, [current_mode]
shl eax, 2 ; *4
add eax, title_base
invoke con_init, 80, 32, -1, -1, [eax]
.if byte [_cmdline] <> 0
mov [log_file_path], _cmdline
@@ -137,6 +312,34 @@ start:
mov [struct_open_in_notepad.filename], eax
mcall SF_FILE, struct_open_in_notepad
.endif
.if ah = 0x0F ; Tab
; invoke con_set_title, [title_base + 4]
; invoke con_exit, 1
; jmp .raw_exit
mov eax, [current_mode]
inc eax
.if eax >= MODES_COUNT
xor eax, eax
.endif
mov [current_mode], eax
shl eax, BSF sizeof.RING_BUFFER ; assert on sizeof, must be power of two
add eax, rb_base
mov [current_rb], eax
mov eax, [current_mode]
shl eax, 2 ; *4
add eax, title_base
invoke con_set_title, [eax]
invoke con_cls
; clear the printer context before printing the ring buffer
mov dword [chr], 0
mov dword [prefix], 0
mov [prefix_index], 0
mov [is_start_line], 1
mov [is_kernel_printing], 0 ;;
stdcall print_ring_buffer, [current_rb]
.endif
.endif
mcall SF_BOARD, SSF_DEBUG_READ
@@ -145,35 +348,14 @@ start:
jz .main_loop_cond
.endif
mov [chr], al
mov [__chr], al
.if [is_start_line] = 1
mov eax, prefix
add eax, [prefix_index]
mov bl, byte [chr]
mov [eax], bl
.if [prefix_index] = 2
.if dword [prefix] = 'K :'
stdcall set_text_color, TEXT_COLOR_YELLOW
.elseif dword [prefix] = 'L: '
stdcall set_text_color, TEXT_COLOR_WHITE
.else
stdcall set_text_color, TEXT_COLOR_LIGHTGRAY
.endif
mov [is_start_line], 0
mov [prefix_index], 0
invoke con_write_asciiz, prefix
mov dword [prefix], 0
.else
inc [prefix_index]
.endif
.else
invoke con_write_asciiz, chr
.if byte [chr] = 10
mov [is_start_line], 1
stdcall set_text_color, TEXT_COLOR_LIGHTGRAY
.endif
.endif
stdcall ring_buffer_push_byte, rb_both, eax ; we always push to "both" buffer
stdcall push_to_buffers_next_char ; push byte to user or kernel messages ring buffer depending on current state
stdcall print_next_char
; append char to logfile, if no logfile then create it
stdcall get_file_attrib, [log_file_path], file_info_buf
.if eax = 5 ; file not found
stdcall create_file, [log_file_path]
@@ -193,14 +375,36 @@ start:
; data:
title db 'Debug & message board',0
title_base:
dd title_mode_user
dd title_mode_kernel
dd title_mode_both
title_mode_user db 'Debug board - [Tab] switches mode: USER_kernel_both [F2] opens log file',0
title_mode_kernel db 'Debug board - [Tab] switches mode: user_KERNEL_both [F2] opens log file',0
title_mode_both db 'Debug board - [Tab] switches mode: user_kernel_BOTH [F2] opens log file',0
; [Tab] changes mode: user_kernel_BOTH   [F2] opens log-file
log_file_path dd default_log_file_path
default_log_file_path db '/tmp0/1/BOARDLOG.TXT',0
; to use only in print_next_char
chr db 0, 0, 0, 0
prefix db 0,0,0,0
prefix_index dd 0
is_start_line dd 1
is_kernel_printing dd 0 ; 1 if kernel is now printing (after K:), else 0
; to use only in push_to_buffers_next_char
__chr db 0, 0, 0, 0
__prefix db 0,0,0,0
__prefix_index dd 0
__is_start_line dd 1
current_mode dd MODE_BOTH
current_rb dd 0
bytes_written dd 0
chr db 0, 0
struct_open_in_notepad:
dd SSF_START_APP
@@ -210,6 +414,23 @@ struct_open_in_notepad:
dd 0
db '/sys/develop/cedit', 0
rb_base:
rb_user:
dd rb_user_buf
dd RB_CAPACITY
dd 0
dd 0
rb_kernel:
dd rb_kernel_buf
dd RB_CAPACITY
dd 0
dd 0
rb_both:
dd rb_both_buf
dd RB_CAPACITY
dd 0
dd 0
; include_debug_strings
@@ -224,7 +445,9 @@ import console, \
con_kbhit, 'con_kbhit', \
con_getch2, 'con_getch2', \
con_set_flags, 'con_set_flags', \
con_get_flags, 'con_get_flags'
con_get_flags, 'con_get_flags', \
con_set_title, 'con_set_title',\
con_cls, 'con_cls'
align 16
_image_end:
@@ -237,6 +460,10 @@ _cmdline rb 256
thread_info process_information
thread_name rb 16
rb_user_buf rb RB_CAPACITY
rb_kernel_buf rb RB_CAPACITY
rb_both_buf rb RB_CAPACITY
; reserve for stack:
rb 4096
align 16