KolibriOS/kolibrios
15
21
Fork 36
Code Issues 129 Pull Requests 31 Actions 1 Projects 1 Releases Wiki Activity

system/docs: update docs and SF constants to match actual kernel #306

Merged
Burer merged 9 commits from docs-review into main 2026-02-26 17:25:20 +00:00
Conversation 10 Commits 9 Files Changed 3 +49 -36
4 changed files with 49 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 746808c462 - Show all commits

29
kernel/trunk/docs/sysfuncr.txt
View File

@@ -3695,7 +3695,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
* ecx = требуемый размер в байтах
Возвращаемое значение:
* eax = 0 - неудача
* eax = указатель на выделенное кольцо
* eax = указатель на выделенную кольцевую память
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:33:46 +00:00
Outdated
Review
Copy Link

"Кольцевой буфер/кольцевую память" maybe?

"Кольцевой буфер/кольцевую память" maybe?
Замечания:
* Запрошенный размер должен быть кратен размеру страницы (4 Кб).
* Память выделяется так, что доступ за пределами буфера приводит
@@ -3719,7 +3719,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
---------------------- Константы для регистров: ----------------------
eax - SF_SYS_MISC (68)
ebx - 30
ebx - SSF_UNLOAD_DRIVER (30)
======================================================================
======== Функция 68, подфункция 31 - получить данные драйвера. =======
@@ -4547,12 +4547,12 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
---------------------- Константы для регистров: ----------------------
eax - SF_BLITTER (73)
======================================================================
=================== Функция 74, подфункция 255 ========================
=================== Функция 74, подфункция -1 ========================
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:36:48 +00:00
Outdated
Review
Copy Link

Is this really necessary?

Is this really necessary?
=========== Получить количество активных сетевых устройств. ==========
======================================================================
Параметры:
* eax = 74 - номер функции
* bl = 255 - номер подфункции
* bl = -1 (или 255) - номер подфункции
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-24 20:02:51 +00:00
Outdated
Review
Copy Link

This should be obvious to the developer. Why explain this?

This should be obvious to the developer. Why explain this?
Возвращаемое значение:
* eax = количество активных сетевых устройств
@@ -4702,7 +4702,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
eax - SF_NETWORK_GET (74) / SF_NETWORK_DEVICE (74)
bl - SSF_LINK_STATUS (10)
======================================================================
== Функция 74.11, Получить количество пакетов переданных с ошибкой. ==
== Функция 74.11, Получить количество пакетов переданных с ошибкой. ==
======================================================================
Параметры:
* eax = 74 - номер функции
@@ -4716,7 +4716,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
eax - SF_NETWORK_GET (74) / SF_NETWORK_DEVICE (74)
bl - SSF_TX_PACKET_ERROR_COUNT (11)
======================================================================
=== Функция 74.12, Получить число пакетов отброшенных при отправке. ==
=== Функция 74.12, Получить число пакетов отброшенных при отправке. ==
======================================================================
Параметры:
* eax = 74 - номер функции
@@ -4730,7 +4730,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
eax - SF_NETWORK_GET (74) / SF_NETWORK_DEVICE (74)
bl - SSF_TX_PACKET_DROP_COUNT (12)
======================================================================
=== Функция 74.13, Получить число пакетов утерянных при отправке. ====
=== Функция 74.13, Получить число пакетов утерянных при отправке. ====
======================================================================
Параметры:
* eax = 74 - номер функции
@@ -4745,7 +4745,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
bl - SSF_TX_PACKET_MISS_COUNT (13)
======================================================================
==== Функция 74.14, Получить число пакетов полученных с ошибкой. =====
==== Функция 74.14, Получить число пакетов полученных с ошибкой. =====
======================================================================
Параметры:
* eax = 74 - номер функции
@@ -4760,7 +4760,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
bl - SSF_RX_PACKET_ERROR_COUNT (14)
======================================================================
== Функция 74.15, Получить число пакетов отброшенных при получении. ==
== Функция 74.15, Получить число пакетов отброшенных при получении. ==
======================================================================
Параметры:
* eax = 74 - номер функции
@@ -4774,7 +4774,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
eax - SF_NETWORK_GET (74) / SF_NETWORK_DEVICE (74)
bl - SSF_RX_PACKET_DROP_COUNT (15)
======================================================================
=== Функция 74.16, Получить число пакетов утерянных при получении. ===
=== Функция 74.16, Получить число пакетов утерянных при получении. ===
======================================================================
Параметры:
* eax = 74 - номер функции
@@ -5128,7 +5128,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
---------------------- Константы для регистров: ----------------------
eax - SF_FUTEX (77)
ebx - 10
ebx - SSF_PIPE_READ (10)
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-24 20:08:31 +00:00
Outdated
Review
Copy Link

It is assumed that reading will be in the future on file descriptors. It is better to remove the PIPE prefix if the constant names are not taken.

It is assumed that reading will be in the future on file descriptors. It is better to remove the `PIPE` prefix if the constant names are not taken.
======================================================================
======== Функция 77, подфункция 11, Записать из буфера в файл. =======
@@ -5146,7 +5146,7 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
---------------------- Константы для регистров: ----------------------
eax - SF_FUTEX (77)
ebx - 11
ebx - SSF_PIPE_WRITE (11)
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-24 20:09:02 +00:00
Outdated
Review
Copy Link

Same: https://git.kolibrios.org/KolibriOS/kolibrios/pulls/306/files#issuecomment-3992

Same: https://git.kolibrios.org/KolibriOS/kolibrios/pulls/306/files#issuecomment-3992
======================================================================
=========== Функция 77, подфункция 13, Создать новый pipe. ===========
@@ -5164,10 +5164,13 @@ Architecture Software Developer's Manual, Volume 3, Appendix B);
Возвращаемое значение:
* eax = 0 если успех, иначе отрицательный код ошибки:
-EFAULT, -EINVAL, -EMFILE, -ENFILE.
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:42:15 +00:00
Outdated
Review
Copy Link

I'm not sure if this is specifically stated somewhere in the documentation (error codes).

I'm not sure if this is specifically stated somewhere in the documentation (error codes).
Примечания:
* В случае успеха pipefd[0] является дескриптором чтения, а pipefd[1]
— дескриптором записи.
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:44:08 +00:00
Outdated
Review
Copy Link

Why is there no constant?

Why is there no constant?
---------------------- Константы для регистров: ----------------------
eax - SF_FUTEX (77)
ebx - 13
ebx - SSF_PIPE_CREATE (13)
======================================================================
========== Функция -1 - завершить выполнение потока/процесса =========

30
kernel/trunk/docs/sysfuncs.txt
View File

@@ -2480,7 +2480,7 @@ Remarks:
---------------------- Constants for registers: ----------------------
eax - SF_SET_WINDOW_SHAPE (50)
======================================================================
============= Function 51, subfunction 1 - create thread. ============
============= Function 51, subfunction 1 - create thread. ============
======================================================================
Parameters:
* eax = 51 - function number
@@ -3678,9 +3678,9 @@ Returned value:
Remarks:
* The driver entry is called with DRV_EXIT before unloading.
---------------------- Constants for registers: ----------------------
eax - SF_SYS_MISC (68)
ebx - 30
---------------------- Constants for registers: ----------------------
eax - SF_SYS_MISC (68)
ebx - SSF_UNLOAD_DRIVER (30)
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:45:40 +00:00
Outdated
Review
Copy Link

Why is there no constant?

Why is there no constant?
======================================================================
=========== Function 68, subfunction 31 - get driver data. ===========
@@ -3895,7 +3895,7 @@ Remarks:
eax - SF_DEBUG (69)
ebx - SSF_RESUME (5)
======================================================================
== Function 69, subfunction 6 - read from memory of debugged process. ==
= Function 69, subfunction 6 - read from memory of debugged process. =
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:46:37 +00:00
Outdated
Review
Copy Link

Seems extra =

Seems extra =
======================================================================
Parameters:
* eax = 69 - function number
@@ -5325,7 +5325,7 @@ Returned value:
======================================================================
Remarks:
* Subfunctions 4-7 are reserved and currently return -1.
* Subfunctions 8, 9 and 12 are not implemented and return -EBADF.
* Subfunctions 8-9 and 12 are not implemented and return -EBADF.
======================================================================
=========== Function 77, Subfunction 10, Read from pipe. ============
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:51:50 +00:00
Outdated
Review
Copy Link

Maybe - instead of ,?

Maybe `-` instead of `,`?
======================================================================
@@ -5340,9 +5340,9 @@ Returned value:
Remarks:
* Only pipe descriptors are supported.
---------------------- Constants for registers: ----------------------
eax - SF_FUTEX (77)
ebx - 10
---------------------- Constants for registers: ----------------------
eax - SF_FUTEX (77)
ebx - SSF_PIPE_READ (10)
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:52:40 +00:00
Outdated
Review
Copy Link

Const?

Const?
======================================================================
=========== Function 77, Subfunction 11, Write to pipe. =============
======================================================================
@@ -5357,9 +5357,9 @@ Returned value:
Remarks:
* Only pipe descriptors are supported.
---------------------- Constants for registers: ----------------------
eax - SF_FUTEX (77)
ebx - 11
---------------------- Constants for registers: ----------------------
eax - SF_FUTEX (77)
ebx - SSF_PIPE_WRITE (11)
======================================================================
========== Function 77, Subfunction 13, Create pipe. ================
======================================================================
@@ -5375,9 +5375,9 @@ Remarks:
* On success, pipefd[0] is a read descriptor and pipefd[1] is a
write descriptor.
---------------------- Constants for registers: ----------------------
eax - SF_FUTEX (77)
ebx - 13
---------------------- Constants for registers: ----------------------
eax - SF_FUTEX (77)
ebx - SSF_PIPE_CREATE (13)
mxlgv marked this conversation as resolved Outdated
mxlgv commented 2026-01-02 20:52:49 +00:00
Outdated
Review
Copy Link

Const?

Const?
======================================================================
=== Function 80 - file system interface with parameter of encoding ===
======================================================================

5
programs/KOSfuncs.inc
View File

@@ -204,6 +204,8 @@ SF_SYS_MISC=68
SSF_MEM_FREE_EXT=26
SSF_LOAD_FILE=27
SSF_MEM_ALLOC_RING=29
SSF_UNLOAD_DRIVER=30
SSF_GET_DRIVER_DATA=31
SF_DEBUG=69
SSF_SET_MESSAGE_AREA=0
SSF_GET_REGISTERS=1
@@ -293,6 +295,9 @@ SF_FUTEX=77
SSF_DESTROY=1
SSF_WAIT=2
SSF_WAKE=3
SSF_PIPE_READ=10
SSF_PIPE_WRITE=11
SSF_PIPE_CREATE=13
; File system errors:
FSERR_SUCCESS=0

21
programs/develop/koldbg/kosfuncs.inc
View File

@@ -201,9 +201,11 @@ SF_SYS_MISC=68
SSF_MEM_CLOSE=23
SSF_SET_EXCEPTION_HANDLER=24
SSF_SET_EXCEPTION_STATE=25
SSF_MEM_FREE_EXT=26
SSF_LOAD_FILE=27
SSF_MEM_ALLOC_RING=29
SSF_MEM_FREE_EXT=26
SSF_LOAD_FILE=27
SSF_MEM_ALLOC_RING=29
SSF_UNLOAD_DRIVER=30
SSF_GET_DRIVER_DATA=31
SF_DEBUG=69
SSF_SET_MESSAGE_AREA=0
SSF_GET_REGISTERS=1
@@ -288,11 +290,14 @@ SF_NETWORK_PROTOCOL=76
SSF_ARP_DEL_ENTRY=50005h
SSF_ARP_SEND_ANNOUNCE=50006h
SSF_ARP_CONFLICTS_COUNT=50007h
SF_FUTEX=77
SSF_CREATE=0
SSF_DESTROY=1
SSF_WAIT=2
SSF_WAKE=3
SF_FUTEX=77
SSF_CREATE=0
SSF_DESTROY=1
SSF_WAIT=2
SSF_WAKE=3
SSF_PIPE_READ=10
SSF_PIPE_WRITE=11
SSF_PIPE_CREATE=13
; File system errors:
FSERR_SUCCESS=0