syscall.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. /* Syscall interface (int 0x80), shared by the kernel and ring-3 commands. */
  2. #ifndef SYSCALL_H
  3. #define SYSCALL_H
  4. #define SYS_PUTSTR 1
  5. #define SYS_GET_TICKS_MS 2
  6. #define SYS_SLEEP_MS 3
  7. #define SYS_EXIT 4
  8. /* File service (see sys_fs.c). Paths are absolute VFS paths; buffers live in
  9. * the calling process's address space (the kernel runs on its CR3, so no copy
  10. * in/out is needed). */
  11. #define SYS_READ_FILE 5 /* (const char *path, void *buf, unsigned int max)
  12. -> bytes read, or <0 (SYS_E*) */
  13. #define SYS_WRITE_FILE 6 /* (const char *path, const void *buf, unsigned int len)
  14. -> 0, or <0 */
  15. #define SYS_LIST_DIR 7 /* (const char *path, unsigned int index,
  16. struct sys_dirent *out) -> 1 entry, 0 end, <0 */
  17. #define SYS_UNLINK 8 /* (const char *path) -> 0, or <0 */
  18. #define SYS_MKDIR 9 /* (const char *path) -> 0, or <0 */
  19. #define SYS_RMDIR 10 /* (const char *path) -> 0, or <0 */
  20. #define SYS_LIST_MOUNTS 11 /* (unsigned int index, struct sys_mount *out)
  21. -> 1 mount, 0 end */
  22. /* Kernel-state info for the info commands (see sys_info.c). */
  23. #define SYS_MEMINFO 12 /* (struct sys_meminfo *out) -> 0 */
  24. #define SYS_E820 13 /* (unsigned int index, struct sys_e820 *out)-> 1, 0 */
  25. #define SYS_MOUSEINFO 14 /* (struct sys_mouseinfo *out) -> 1 when present */
  26. #define SYS_STORAGE_INFO 15 /* (struct sys_storage_info *out) -> 0;
  27. refreshes the mount cache like `storage` did */
  28. #define SYS_BLKDEV 16 /* (unsigned int index, struct sys_blkdev *out) */
  29. /* Network service (see sys_net.c): the stack and NIC drivers stay in the
  30. * kernel; user commands get the configuration, the DNS/DHCP clients and the
  31. * raw frame paths (so the packet-level commands port unchanged). */
  32. #define SYS_NET_INFO 17 /* (struct sys_netinfo *out) -> 1 = NIC present */
  33. #define SYS_NET_PRINT_INFO 18 /* the driver's status lines */
  34. #define SYS_NET_ACQUIRE 19 /* take the receiver for this process (0/-1) */
  35. #define SYS_NET_RELEASE 20
  36. #define SYS_NET_MAC 21 /* (unsigned char mac[6]) -> 0/-1 */
  37. #define SYS_NET_GET_IP 22 /* (unsigned char ip[4]) */
  38. #define SYS_NET_SET_IP 23 /* (const unsigned char ip[4]) */
  39. #define SYS_NET_GET_MASK 24
  40. #define SYS_NET_GET_GW 25
  41. #define SYS_NET_GET_DNS 26
  42. #define SYS_NET_SET_DNS 27
  43. #define SYS_NET_TX 28 /* (const void *buf, unsigned len) -> 0/-1 */
  44. #define SYS_NET_RX 29 /* (void *buf, unsigned max) -> len/-1 */
  45. #define SYS_NET_DECODE 30 /* (const void *buf, unsigned len): one line */
  46. #define SYS_NET_REPLY 31 /* (in, len, out, max) -> reply length / 0 */
  47. #define SYS_NET_LOOPBACK 32 /* (int on) -> 0/-1 */
  48. #define SYS_NET_REGS 33 /* the driver's register dump */
  49. #define SYS_NET_RESET 34 /* driver re-init */
  50. #define SYS_DHCP_RUN 35 /* (timeout_ms) -> dhcp_run() result */
  51. #define SYS_DHCP_INFO 36 /* (unsigned char ip[4], unsigned *lease) -> 1 */
  52. #define SYS_DNS_RESOLVE 37 /* (name, unsigned char ip[4]) -> 0; caller owns */
  53. #define SYS_NETLOG 38 /* (const char *text) -> 0/-1 */
  54. #define SYS_NETLOG_CONF 39 /* (int enabled_or_-1, const ip[4] or NULL) */
  55. /* TCP client (see sys_net.c/tcp.c): one connection at a time; the caller
  56. * must own the NIC (SYS_NET_ACQUIRE). */
  57. #define SYS_TCP_CONNECT 40 /* (mac[6], ip[4], port) -> 0/-1/-2/-3 */
  58. #define SYS_TCP_PEER_MSS 41 /* () -> the peer's MSS of the current conn */
  59. #define SYS_TCP_SEND 42 /* (buf, len) -> 0/-1/-2/-3 */
  60. #define SYS_TCP_RECV 43 /* (buf, max, timeout_ms) -> >0/0/-1/-2 */
  61. #define SYS_TCP_CLOSE 44 /* () */
  62. #define SYS_NET_NEXT_HOP 45 /* (dst[4], hop[4]) */
  63. #define SYS_NET_ARP 46 /* (ip[4], mac[6]) -> 0/-1/-2 (net_arp_resolve) */
  64. #define SYS_NET_CONFIGURED 47 /* () -> 1 when an IP address is set */
  65. #define SYS_GETCWD 48 /* (char *buf, unsigned max) -> 0; the caller's cwd */
  66. /* Process snapshot for the `top` command (see process.c). */
  67. #define SYS_PROCINFO 49 /* (unsigned int index, struct sys_procinfo *out)
  68. -> 1 when found, 0 at the end of the table */
  69. #define SYS_KEY_POLL 55 /* () -> 0 none, ASCII, or IO_KEY_* for the caller's window */
  70. #define SYS_RTC_HMS 56 /* (struct sys_time *out) -> 0/-1 */
  71. #define SYS_RTC_GET 104 /* (struct sys_datetime *out) -> 0/-1 */
  72. #define SYS_RTC_SET 105 /* (const struct sys_datetime *in) -> 0/-1 */
  73. /* Window-manager service (see wm_abi.h). Only the kernel-spawned WM process
  74. * may call the WM_* entries; ordinary commands get -1. */
  75. #define SYS_WM_ATTACH 57 /* (struct wm_screen_info *out) -> 0/-1 */
  76. #define SYS_WM_INFO 58 /* (index, struct wm_window_info *out) -> 1/0/-1 */
  77. #define SYS_WM_MAP 59 /* (index, struct wm_map_info *out) -> 0/-1 */
  78. #define SYS_WM_ACK 60 /* (index, dirty_seq) -> 0/-1 */
  79. #define SYS_WM_FOCUS 61 /* (index) -> 0/-1 */
  80. #define SYS_WM_SET_GEOM 62 /* (index, struct wm_geom *in) -> 0/-1 */
  81. #define SYS_WM_CREATE_TERM 63 /* () -> index / -1 */
  82. #define SYS_WM_CLOSE 64 /* (index) -> 0/-1 */
  83. #define SYS_WM_POLL 65 /* (struct wm_status *out) -> 0/-1 */
  84. #define SYS_WM_BEGIN 66 /* () -> 0/-1; erase cursor, frame active */
  85. #define SYS_WM_PRESENT 67 /* (struct wm_present_info *in) -> 0/-1 */
  86. #define SYS_WM_SYNC 68 /* () -> 0/-1; run deferred gfx cleanup */
  87. #define SYS_RTC_DATETIME 69 /* (char *buf, unsigned max) -> 0/-1 */
  88. #define SYS_WIN_CREATE 70 /* (struct win_create *in, struct win_info *out) */
  89. #define SYS_WIN_PRESENT 71 /* (const struct wm_win_present *in) -> 0/-1;
  90. NULL or w/h 0 publishes the whole canvas */
  91. #define SYS_WIN_CLOSE 72 /* () -> 0/-1; close the caller's window */
  92. #define SYS_WM_RESIZE 83 /* (index, struct wm_size *content) -> 0/-1 */
  93. #define SYS_WIN_INFO 84 /* (struct win_info *out) -> 0/-1 */
  94. #define SYS_WIN_ACK_RESIZE 85 /* () -> 0/-1; swap in the pending canvas */
  95. #define SYS_WIN_POINTER 86 /* (struct win_pointer *out) -> 0/-1 */
  96. #define SYS_WIN_EVENT 87 /* (struct win_event *out) -> 1 event, 0 none */
  97. /* Per-process anonymous heap (see sys_mem.c). One growable arena at
  98. * USER_HEAP_BASE (0x60000000), at most USER_HEAP_MAX (32 MB), freed when the
  99. * process exits. SYS_MEM_ALLOC returns the base address, or <0. Ring-3
  100. * commands use malloc/free (libc/malloc.c); these syscalls are the libc
  101. * backend (libc/ucmd_mem.c) and are not called by application code. */
  102. #define SYS_MEM_ALLOC 88 /* (unsigned bytes) -> VA or <0 */
  103. #define SYS_MEM_GROW 89 /* (unsigned total_bytes) -> 0/-1; new pages not zeroed */
  104. #define SYS_MEM_FREE 90 /* () -> 0/-1 */
  105. /* CPU temperature (see thermal.c): the hottest core's DTS reading. */
  106. #define SYS_CPU_TEMP 91 /* (struct sys_cputemp *out) -> 0/-1 */
  107. /* IT87xx Super I/O hardware monitor (see it87.c); read-only. */
  108. #define SYS_SENSORS 92 /* (struct sys_sensors *out) -> 0/-1 */
  109. /* TCP server (WebDAV listener). The caller must own the NIC (SYS_NET_ACQUIRE).
  110. * SYS_TCP_ACCEPT polls a few frames and returns 1 once a connection is ready,
  111. * 0 when nothing arrived, or -3 when a netkexec header was captured (the
  112. * command should exit and let the kworker take over). */
  113. #define SYS_TCP_LISTEN 93 /* (port) -> 0/-1 */
  114. #define SYS_TCP_ACCEPT 94 /* () -> 1/0/-2/-3 */
  115. #define SYS_TCP_SRV_RECV 95 /* (buf, max, timeout_ms) -> >0/0/-1/-2 */
  116. #define SYS_TCP_SRV_SEND 96 /* (buf, len) -> 0/-1/-2/-3 */
  117. #define SYS_TCP_SRV_CLOSE 97
  118. #define SYS_TCP_PEER 99 /* (ip[4], unsigned *port) -> 0/-1 (debug log) */
  119. #define SYS_NET_SPEED 100 /* (mbps) -> 0; 0 = auto, 100 = force 100M */
  120. #define SYS_NET_MAC_SET 101 /* (const mac[6]) -> 0/-1/-2 */
  121. /* ThinkPad embedded-controller sensors (see tpec.c); read-only. */
  122. #define SYS_TPEC_SENSORS 102 /* (struct sys_tpec_sensors *out) -> 0/-1 */
  123. /* ThinkPad AC/battery snapshot (see tpec.c). SYS_POWER_F_DETAIL also reads
  124. * design capacity, the capacity unit and the manufacturer/model strings. */
  125. #define SYS_POWER_INFO 103 /* (struct sys_powerinfo *out, flags) -> 0/-1 */
  126. #define SYS_POWER_F_DETAIL 0x1
  127. /* Stat one path (the file service has no open handle). */
  128. #define SYS_FS_STAT 98 /* (path, struct sys_stat *out) -> 0/<0 */
  129. /* Terminal / process services used by the ring-3 shell. */
  130. #define SYS_TTY_CREATE 73 /* () -> tty id 1..TTY_MAX / -1 */
  131. #define SYS_TTY_READ 74 /* (id, buf, max) -> bytes / 0 / -1 */
  132. #define SYS_SPAWN 75 /* (path, arg, tty, cwd) -> pid / <0 */
  133. #define SYS_SPAWN_KCMD 76 /* (name, arg, tty) -> pid / <0 */
  134. #define SYS_ALIVE 77 /* (pid) -> 1/0 */
  135. #define SYS_KILL 78 /* (pid) -> 0/-1 */
  136. #define SYS_CHDIR 79 /* (path) -> 0/-1 */
  137. #define SYS_WIN_KEY_WAIT 80 /* (timeout_ms) -> key / 0 timeout / -1 */
  138. #define SYS_SCHEDINFO 81 /* (struct sys_schedinfo *out) -> 0/-1 */
  139. struct sys_spawn {
  140. const char *path;
  141. const char *arg;
  142. const char *cwd;
  143. unsigned int tty;
  144. };
  145. struct sys_netinfo {
  146. unsigned int present;
  147. unsigned char mac[6];
  148. unsigned char ip[4];
  149. unsigned char mask[4];
  150. unsigned char gw[4];
  151. unsigned char dns[4];
  152. unsigned int mirror_on;
  153. unsigned char mirror_host[4];
  154. char name[8];
  155. char chip[16];
  156. };
  157. /* Error codes returned by the file syscalls. */
  158. #define SYS_EIO (-1) /* disk I/O error */
  159. #define SYS_ENODEV (-2) /* no such device / unusable path prefix */
  160. #define SYS_ENOFS (-3) /* device exists but has no mounted filesystem */
  161. #define SYS_ENOENT (-4) /* file/directory not found */
  162. #define SYS_EINVAL (-5) /* path is not valid for this operation */
  163. #define SYS_EWRITE (-6) /* write refused (full, or FAT rejected it) */
  164. #define SYS_EROFS (-7) /* read-only filesystem (ramfs) */
  165. #define SYS_ENOSPC (-8) /* no space left on the filesystem */
  166. /* One directory entry. `name` is a display name: raw 8.3 for FAT mounts
  167. * (space padded, `raw_83` set) or the plain name for name-string filesystems
  168. * such as ramfs and /share. */
  169. struct sys_dirent {
  170. char name[64];
  171. unsigned int size;
  172. unsigned int is_dir;
  173. unsigned int raw_83;
  174. };
  175. /* One mounted filesystem (for `ls /`). */
  176. struct sys_mount {
  177. char name[16];
  178. char type[8]; /* "FAT12", "FAT16", "FAT32", "ramfs", "share" */
  179. unsigned int total_sectors;
  180. char label[12];
  181. unsigned int ro;
  182. };
  183. /* Result of SYS_FS_STAT. */
  184. struct sys_stat {
  185. unsigned int size;
  186. unsigned int is_dir;
  187. unsigned int ro;
  188. };
  189. struct sys_meminfo {
  190. unsigned int total_kb;
  191. unsigned int free_pages;
  192. unsigned int page_size;
  193. unsigned int e820_count;
  194. };
  195. /* One live process, for `top` (PROC_NAME_LEN = 12). cpu_ticks/life_ticks
  196. * are PIT ticks (1 kHz), so lifecycle percentages can be derived. */
  197. struct sys_procinfo {
  198. unsigned int pid;
  199. unsigned int state; /* PROC_*: 1 ready, 2 running, 4 sleep, 5 block */
  200. unsigned int cpu_ticks; /* ticks spent as the running process */
  201. unsigned int life_ticks; /* ticks since creation, >= 1 */
  202. unsigned int pages; /* resident 4 KB pages (stack + dir + user) */
  203. unsigned int weight; /* CFS weight, 1..SCHED_WEIGHT_MAX */
  204. unsigned int cpu; /* CPU id, or 0xFFFFFFFF when not running */
  205. char name[12];
  206. };
  207. /* Scheduler counters for `top` and the `sched` command. */
  208. struct sys_schedinfo {
  209. unsigned int ncpus;
  210. unsigned int runnable;
  211. unsigned int sleeping;
  212. unsigned int blocked;
  213. unsigned int zombies;
  214. unsigned int switches;
  215. unsigned int wakeups;
  216. unsigned int idle_ticks;
  217. unsigned int slice_ticks;
  218. };
  219. /* CPU temperature snapshot (see thermal.c). temp_c is the hottest core's
  220. * last DTS sample; a negative value means no Intel DTS is available. delta_c
  221. * and status are from the CPU that serviced the syscall (for diagnostics).
  222. * cpu_temp_c[] holds the per-logical-CPU cached samples. */
  223. #define SYS_CPU_MAX 8
  224. struct sys_cputemp {
  225. int temp_c;
  226. int tjmax_c;
  227. int delta_c;
  228. unsigned int status;
  229. int cpu_temp_c[SYS_CPU_MAX];
  230. unsigned int ncpus;
  231. };
  232. /* IT87xx hardware monitor snapshot (temps are signed; -128 = unconnected). */
  233. struct sys_sensors {
  234. unsigned int present;
  235. unsigned int chip_id;
  236. unsigned int base;
  237. unsigned int temp_enable;
  238. unsigned int temp_extra;
  239. int temp_c[3];
  240. unsigned int fan_rpm[3];
  241. };
  242. /* ThinkPad embedded-controller snapshot (see tpec.c). temp_c[] follows
  243. * thinkpad_acpi's temp1..temp16 (EC 0x78..0x7F, then 0xC0..0xC7); -128 means
  244. * the sensor is not present. fan_level is the raw EC 0x2F value. */
  245. #define SYS_TPEC_TEMP_MAX 16
  246. struct sys_tpec_sensors {
  247. unsigned int present;
  248. char vendor[16];
  249. char product[32];
  250. char version[32];
  251. int temp_c[SYS_TPEC_TEMP_MAX];
  252. unsigned int fan_rpm;
  253. unsigned int fan_level;
  254. };
  255. /* ThinkPad AC/battery snapshot. rate is the signed present rate in the same
  256. * unit as the capacities; unit_mwh (when unit_known) selects mWh/mW vs
  257. * mAh/mA. percent is valid only when percent_valid is set. */
  258. #define SYS_POWER_BATT_MAX 2
  259. struct sys_battery {
  260. unsigned int present;
  261. unsigned int error;
  262. unsigned int status; /* raw EC 0x38/0x39 byte */
  263. unsigned int charging;
  264. unsigned int discharging;
  265. unsigned int percent;
  266. unsigned int percent_valid;
  267. unsigned int remaining;
  268. unsigned int full;
  269. unsigned int design;
  270. unsigned int voltage_mv;
  271. int rate;
  272. unsigned int unit_known;
  273. unsigned int unit_mwh;
  274. char manufacturer[16];
  275. char model[16];
  276. };
  277. struct sys_powerinfo {
  278. unsigned int present; /* ThinkPad EC found */
  279. int ac_online; /* -1 unknown, 0 offline, 1 online */
  280. unsigned int ec_rev;
  281. char vendor[16];
  282. char product[32];
  283. char version[32];
  284. unsigned int battery_count;
  285. struct sys_battery battery[SYS_POWER_BATT_MAX];
  286. };
  287. /* Wall clock for the ring-3 clock (see rtc.c). */
  288. struct sys_time {
  289. unsigned int hour; /* 0-23 */
  290. unsigned int minute; /* 0-59 */
  291. unsigned int second; /* 0-59 */
  292. };
  293. /* Full RTC wall clock for `date` and the Date & Time app. The CMOS RTC
  294. * stores a two-digit year; the kernel expands it with a 1970-2069 window
  295. * (70-99 -> 1900s, 00-69 -> 2000s), so a dead-battery default such as 1980
  296. * or 1990 reads correctly. SYS_RTC_SET accepts the same range. */
  297. struct sys_datetime {
  298. unsigned int year; /* 1970-2069 */
  299. unsigned int month; /* 1-12 */
  300. unsigned int day; /* 1-31 */
  301. unsigned int hour; /* 0-23 */
  302. unsigned int minute; /* 0-59 */
  303. unsigned int second; /* 0-59 */
  304. unsigned int wday; /* 0 = Sunday */
  305. };
  306. struct sys_e820 {
  307. unsigned int base; /* low 32 bits, as meminfo always printed */
  308. unsigned int length;
  309. unsigned int type;
  310. };
  311. struct sys_mouseinfo {
  312. unsigned int present;
  313. unsigned int ps2;
  314. unsigned int ps2_id;
  315. unsigned int ps2_packet_size;
  316. unsigned int ps2_streaming;
  317. unsigned int usb;
  318. unsigned int usb_ctrl;
  319. unsigned int usb_addr;
  320. unsigned int usb_ep;
  321. unsigned int usb_mps;
  322. unsigned int usb_low;
  323. unsigned int usb_keyboard;
  324. unsigned int cursor_visible;
  325. char hcd[8];
  326. char backend[16];
  327. unsigned int touchpad;
  328. unsigned int tp_vendor;
  329. unsigned int tp_product;
  330. };
  331. struct sys_storage_info {
  332. unsigned int ahci_present;
  333. unsigned int blkdev_count;
  334. };
  335. struct sys_blkdev {
  336. char name[8];
  337. char model[41];
  338. unsigned int kind; /* 0 = floppy, 1 = IDE, 2 = SATA */
  339. unsigned int present;
  340. unsigned int total_sectors;
  341. };
  342. int syscall_dispatch(int num, int a1, int a2, int a3);
  343. #endif