From c60f7450ebc321fc03bc960c3ebafea91a077559 Mon Sep 17 00:00:00 2001 From: Mathieu Maret Date: Sun, 29 Jan 2017 14:33:48 +0100 Subject: [PATCH] Initial import --- INSTALL | 131 +++++ LICENSE | 340 +++++++++++++ Makefile | 83 ++++ README | 90 ++++ VERSION | 11 + bootstrap/multiboot.S | 85 ++++ bootstrap/multiboot.h | 133 +++++ drivers/bochs.c | 123 +++++ drivers/bochs.h | 55 +++ drivers/x86_videomem.c | 127 +++++ drivers/x86_videomem.h | 97 ++++ extra/Makefile | 40 ++ extra/README | 73 +++ extra/bootsect.S | 406 +++++++++++++++ extra/dot.mkvars | 30 ++ extra/grub.img.gz | Bin 0 -> 67535 bytes extra/mtoolsrc | 2 + extra/qemu-port-e9.diff | 73 +++ extra/sos_bsect.lds | 61 +++ hwcore/cpu_context.c | 959 ++++++++++++++++++++++++++++++++++++ hwcore/cpu_context.h | 401 +++++++++++++++ hwcore/cpu_context_switch.S | 159 ++++++ hwcore/exception.c | 181 +++++++ hwcore/exception.h | 83 ++++ hwcore/exception_wrappers.S | 271 ++++++++++ hwcore/gdt.c | 186 +++++++ hwcore/gdt.h | 52 ++ hwcore/i8254.c | 79 +++ hwcore/i8254.h | 35 ++ hwcore/i8259.c | 79 +++ hwcore/i8259.h | 40 ++ hwcore/idt.c | 159 ++++++ hwcore/idt.h | 84 ++++ hwcore/ioports.h | 46 ++ hwcore/irq.c | 100 ++++ hwcore/irq.h | 97 ++++ hwcore/irq_wrappers.S | 305 ++++++++++++ hwcore/mm_context.c | 297 +++++++++++ hwcore/mm_context.h | 101 ++++ hwcore/paging.c | 789 +++++++++++++++++++++++++++++ hwcore/paging.h | 194 ++++++++ hwcore/segment.h | 73 +++ hwcore/swintr.c | 50 ++ hwcore/swintr.h | 44 ++ hwcore/swintr_wrappers.S | 116 +++++ sos/assert.c | 47 ++ sos/assert.h | 45 ++ sos/calcload.c | 396 +++++++++++++++ sos/calcload.h | 117 +++++ sos/errno.h | 43 ++ sos/klibc.c | 398 +++++++++++++++ sos/klibc.h | 103 ++++ sos/kmalloc.c | 113 +++++ sos/kmalloc.h | 63 +++ sos/kmem_slab.c | 812 ++++++++++++++++++++++++++++++ sos/kmem_slab.h | 206 ++++++++ sos/kmem_vmm.c | 606 +++++++++++++++++++++++ sos/kmem_vmm.h | 113 +++++ sos/ksynch.c | 235 +++++++++ sos/ksynch.h | 172 +++++++ sos/kwaitq.c | 321 ++++++++++++ sos/kwaitq.h | 216 ++++++++ sos/list.h | 194 ++++++++ sos/macros.h | 47 ++ sos/main.c | 514 +++++++++++++++++++ sos/mouse_sim.c | 804 ++++++++++++++++++++++++++++++ sos/physmem.c | 385 +++++++++++++++ sos/physmem.h | 202 ++++++++ sos/process.c | 280 +++++++++++ sos/process.h | 138 ++++++ sos/sched.c | 338 +++++++++++++ sos/sched.h | 158 ++++++ sos/syscall.c | 142 ++++++ sos/syscall.h | 53 ++ sos/test-art7.c | 427 ++++++++++++++++ sos/thread.c | 821 ++++++++++++++++++++++++++++++ sos/thread.h | 389 +++++++++++++++ sos/time.c | 355 +++++++++++++ sos/time.h | 222 +++++++++ sos/types.h | 67 +++ sos/uaccess.c | 200 ++++++++ sos/uaccess.h | 96 ++++ support/build_image.sh | 215 ++++++++ support/sos.lds | 125 +++++ userland/Makefile | 89 ++++ userland/crt.c | 183 +++++++ userland/crt.h | 107 ++++ userland/debug.c | 39 ++ userland/debug.h | 34 ++ userland/ldscript.lds | 67 +++ userland/libc.c | 17 + userland/libc.h | 35 ++ userland/myprog1.c | 37 ++ userland/myprog2.c | 35 ++ userland/myprog3.c | 46 ++ userland/myprog4.c | 46 ++ userland/myprog5.c | 36 ++ userland/myprog6.c | 39 ++ userland/stdarg.c | 244 +++++++++ userland/stdarg.h | 50 ++ userland/string.c | 142 ++++++ userland/string.h | 61 +++ userland/types.h | 29 ++ 103 files changed, 18454 insertions(+) create mode 100644 INSTALL create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README create mode 100644 VERSION create mode 100644 bootstrap/multiboot.S create mode 100644 bootstrap/multiboot.h create mode 100644 drivers/bochs.c create mode 100644 drivers/bochs.h create mode 100644 drivers/x86_videomem.c create mode 100644 drivers/x86_videomem.h create mode 100644 extra/Makefile create mode 100644 extra/README create mode 100644 extra/bootsect.S create mode 100644 extra/dot.mkvars create mode 100644 extra/grub.img.gz create mode 100644 extra/mtoolsrc create mode 100644 extra/qemu-port-e9.diff create mode 100644 extra/sos_bsect.lds create mode 100644 hwcore/cpu_context.c create mode 100644 hwcore/cpu_context.h create mode 100644 hwcore/cpu_context_switch.S create mode 100644 hwcore/exception.c create mode 100644 hwcore/exception.h create mode 100644 hwcore/exception_wrappers.S create mode 100644 hwcore/gdt.c create mode 100644 hwcore/gdt.h create mode 100644 hwcore/i8254.c create mode 100644 hwcore/i8254.h create mode 100644 hwcore/i8259.c create mode 100644 hwcore/i8259.h create mode 100644 hwcore/idt.c create mode 100644 hwcore/idt.h create mode 100644 hwcore/ioports.h create mode 100644 hwcore/irq.c create mode 100644 hwcore/irq.h create mode 100644 hwcore/irq_wrappers.S create mode 100644 hwcore/mm_context.c create mode 100644 hwcore/mm_context.h create mode 100644 hwcore/paging.c create mode 100644 hwcore/paging.h create mode 100644 hwcore/segment.h create mode 100644 hwcore/swintr.c create mode 100644 hwcore/swintr.h create mode 100644 hwcore/swintr_wrappers.S create mode 100644 sos/assert.c create mode 100644 sos/assert.h create mode 100644 sos/calcload.c create mode 100644 sos/calcload.h create mode 100644 sos/errno.h create mode 100644 sos/klibc.c create mode 100644 sos/klibc.h create mode 100644 sos/kmalloc.c create mode 100644 sos/kmalloc.h create mode 100644 sos/kmem_slab.c create mode 100644 sos/kmem_slab.h create mode 100644 sos/kmem_vmm.c create mode 100644 sos/kmem_vmm.h create mode 100644 sos/ksynch.c create mode 100644 sos/ksynch.h create mode 100644 sos/kwaitq.c create mode 100644 sos/kwaitq.h create mode 100644 sos/list.h create mode 100644 sos/macros.h create mode 100644 sos/main.c create mode 100644 sos/mouse_sim.c create mode 100644 sos/physmem.c create mode 100644 sos/physmem.h create mode 100644 sos/process.c create mode 100644 sos/process.h create mode 100644 sos/sched.c create mode 100644 sos/sched.h create mode 100644 sos/syscall.c create mode 100644 sos/syscall.h create mode 100644 sos/test-art7.c create mode 100644 sos/thread.c create mode 100644 sos/thread.h create mode 100644 sos/time.c create mode 100644 sos/time.h create mode 100644 sos/types.h create mode 100644 sos/uaccess.c create mode 100644 sos/uaccess.h create mode 100755 support/build_image.sh create mode 100644 support/sos.lds create mode 100644 userland/Makefile create mode 100644 userland/crt.c create mode 100644 userland/crt.h create mode 100644 userland/debug.c create mode 100644 userland/debug.h create mode 100644 userland/ldscript.lds create mode 100644 userland/libc.c create mode 100644 userland/libc.h create mode 100644 userland/myprog1.c create mode 100644 userland/myprog2.c create mode 100644 userland/myprog3.c create mode 100644 userland/myprog4.c create mode 100644 userland/myprog5.c create mode 100644 userland/myprog6.c create mode 100644 userland/stdarg.c create mode 100644 userland/stdarg.h create mode 100644 userland/string.c create mode 100644 userland/string.h create mode 100644 userland/types.h diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..54bc952 --- /dev/null +++ b/INSTALL @@ -0,0 +1,131 @@ + + SOS: A Simple Operating System + + Compilation/Installation/Test instructions + + +Compilation +=========== + +IMPORTANT +--------- + +Don't forget to run 'make clean' before 'make' after you have modified +any source or header file(s). + + +On a x86 host where grub is correctly installed +----------------------------------------------- + +Simply run 'make' + + +On a non-x86 host (without grub of course !) +-------------------------------------------- + +See extra/README + + +On an x86 host without Grub, or with a buggy Grub +------------------------------------------------- + +See extra/README + +How do I know I have a buggy grub installation ? Answer: in the qemu +PC emulator, Grub hangs while loading the kernel + + +Installation +============ + +Nothing special to do besides compiling + + +Test the SOS Kernel +=================== + +On a x86 real machine with Grub installed +----------------------------------------- + + 1st method + => Boot the sos.elf file (append 'kernel=sos.elf' in the + menu.lst or type it on Grub's command line) from a hard disk, a + floppy, or from the network + + 2nd method + => Copy the file 'fd.img' to a floppy and boot from it + + +On a x86 real machine without Grub installed +-------------------------------------------- + + 1st method + => see extra/README to compile with the grub floppy image we provide, + copy the file 'fd.img' to a floppy, and boot from it + + 2nd method + => see extra/README to compile with the boot sector we provide (up to + article 2 only), copy the file 'extra/sos_bsect.img' to a floppy, + and boot from it + + +Inside a PC emulator (x86 and non-x86 hosts) +-------------------------------------------- + +Tested on both the bochs emulator (x86/linux, sparc/solaris and +ppc/linux hosts, 'apt-get install bochs-x vgabios' on debian +testing/unstable), and the qemu system emulator (with libsdl +installed: 'apt-get install libsdl1.2-dev' on debian +testing/unstable). + + 1/ Grub is installed on the host (x86 hosts only) + - - - - - - - - - - - - - - - - - - - - - - - - - + + bochs: boot from the file 'fd.img'. Example of a ~/.bochsrc: + floppya: 1_44=/home/d2/sos/fd.img, status=inserted + romimage: file=/usr/share/bochs/BIOS-bochs-latest, address=0xf0000 + vgaromimage: /usr/share/vgabios/vgabios.bin + megs:63 # 63 Mo de RAM + + qemu: run 'qemu -fda fd.img' + If grub hangs while loading the kernel, please go to method 2/ + + 2/ Grub is not installed (all hosts) + - - - - - - - - - - - - - - - - - - + + See extra/README to generate a floppy image with the Grub floppy + image we provide, and: + + bochs: boot from the file 'fd.img' + + qemu: run 'qemu -fda fd.img' + + 3/ Bonus: boot with the bootsector we provide (all hosts, up to art. 2 ONLY !) + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + See extra/README to generate a floppy image with the boot sector we + provide, and: + + bochs: boot from the file 'extra/sos_bsect.img' + + qemu: run 'qemu -fda extra/sos_qemu.img' + + NOTE: After article 2, this way of booting is not supported: please + use the method 2/ above. + + +NOTE : recommended versions of the tools +---------------------------------------- + - OS : Linux 2.6.11.7-d2-1 i686 + - gcc : gcc (GCC) 3.3.5 (Debian 1:3.3.5-8) + - GNU binutils : GNU ld version 2.15 + - GNU make : GNU Make 3.80 + +Also tested with (on ppc/debian host): + - OS : Linux 2.6.10-powerpc ppc + - gcc : gcc (GCC) 3.2.2 + - GNU binutils : GNU ld version 2.13.2 + - GNU make : GNU Make 3.80 + +-- +David Decotigny diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..60549be --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..60b86e1 --- /dev/null +++ b/Makefile @@ -0,0 +1,83 @@ +## Copyright (C) 2004,2005 The SOS Team +## +## This program is free software; you can redistribute it and/or +## modify it under the terms of the GNU General Public License +## as published by the Free Software Foundation; either version 2 +## of the License, or (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, +## USA. + +CC=gcc +LD=ld +CFLAGS = -Wall -nostdinc -ffreestanding -DKERNEL_SOS +LIBGCC := $(shell $(CC) -print-libgcc-file-name) # To benefit from FP/64bits artihm. +LDFLAGS = --warn-common -nostdlib +OBJECTS = bootstrap/multiboot.o \ + hwcore/idt.o hwcore/gdt.o \ + hwcore/swintr.o hwcore/swintr_wrappers.o \ + hwcore/exception.o hwcore/exception_wrappers.o \ + hwcore/irq.o hwcore/irq_wrappers.o hwcore/i8259.o \ + hwcore/paging.o \ + hwcore/i8254.o drivers/x86_videomem.o drivers/bochs.o \ + hwcore/cpu_context.o hwcore/cpu_context_switch.o \ + hwcore/mm_context.o \ + sos/kmem_vmm.o sos/kmem_slab.o sos/kmalloc.o \ + sos/physmem.o sos/klibc.o \ + sos/thread.o sos/kwaitq.o \ + sos/time.o sos/sched.o sos/ksynch.o \ + sos/process.o sos/syscall.o \ + sos/assert.o sos/main.o sos/mouse_sim.o \ + sos/uaccess.o sos/calcload.o \ + userland/userprogs.kimg sos/test-art7.o + +KERNEL_OBJ = sos.elf +MULTIBOOT_IMAGE = fd.img +PWD := $(shell pwd) + +# Main target +all: $(MULTIBOOT_IMAGE) + +$(MULTIBOOT_IMAGE): $(KERNEL_OBJ) + ./support/build_image.sh $@ $< + +$(KERNEL_OBJ): $(OBJECTS) ./support/sos.lds + $(LD) $(LDFLAGS) -T ./support/sos.lds -o $@ $(OBJECTS) $(LIBGCC) + -nm -C $@ | cut -d ' ' -f 1,3 > sos.map + size $@ + +-include .mkvars + +# Create the userland programs to include in the kernel image +userland/userprogs.kimg: FORCE + $(MAKE) -C userland + +# Create objects from C source code +%.o: %.c + $(CC) -I$(PWD) -c $< $(CFLAGS) -o $@ + +# Create objects from assembler (.S) source code +%.o: %.S + $(CC) -I$(PWD) -c $< $(CFLAGS) -DASM_SOURCE=1 -o $@ + +FORCE: + @ + +# Clean directory +clean: + $(RM) *.img *.o mtoolsrc *~ menu.txt *.img *.elf *.bin *.map + $(RM) *.log *.out bochs* + $(RM) bootstrap/*.o bootstrap/*~ + $(RM) drivers/*.o drivers/*~ + $(RM) hwcore/*.o hwcore/*~ + $(RM) sos/*.o sos/*~ + $(RM) support/*~ + $(RM) extra/*~ + $(MAKE) -C userland clean diff --git a/README b/README new file mode 100644 index 0000000..efbbc89 --- /dev/null +++ b/README @@ -0,0 +1,90 @@ + + SOS: A Simple Operating System + + +This is SOS, a Simple Operating System for i386-family +processors. This is as simple as possible to show a way to program a +basic Operating System on real common hardware (PC). The code should +be easily readable and understandable thanks to frequent comments, and +references to external documentation. We chose to implement the basic +features of an OS, thus making design decisions targetting towards +simplicity of understanding, covering most of the OS classical +concepts, but not aiming at proposing yet another full-fledged +competitive OS (Linux is quite good at it). However, for those who +would like to propose some enhancements, we are open to any code +suggestions (patches only, please). And yes, there might be bugs in +the code, so please send us any bug report, and/or patches ! + +The OS comes as a set of articles (in french) to be published in the +journal "Linux Magazine France". Each month, the part of the code +related to the current article's theme is released (see VERSION file), +and the resulting OS can be successfully compiled and run, by booting +it from a floppy on a real machine (tested AMD k7, Cyrix and Intel P4 +pentiums), or through an x86 emulator (bochs or qemu). The resulting +OS is available as a multiboot compliant ELF kernel (sos.elf) and as a +floppy image (fd.img). It provides a very very very basic demo whose +aim is to understand how everything works, not to animate sprites on +the screen with 5:1 dolby sound. + +The initial technical features and lack-of-features of the OS are: + - monolithic kernel, fully interruptible, non-preemptible (big kernel + lock), target machines = i386 PC or better + - compiles on any host where the gcc/binutils toolchain (target + i586-gnu) is available. Can be tested on real i486/pentium + hardware, or on any host that can run an i486/pentium PC emulator + (bochs or qemu) + - kernel loaded by grub, or by a sample bootsector (up to article 2 + ONLY) + - clear separation of physical memory and virtual memory concepts, + even inside the kernel: no identity-mapping of the physical memory + inside the kernel (allows to move virtual mappings of kernel pages + at run-time, eg to free ISA DMA pages, and to avercome the 4G RAM + barrier) + - slab-type kernel memory allocation + - no swap, no reverse mapping + - VERY simple drivers: keyboard, x86 video memory, IDE disks + - logical devices: partitions, FAT filesystem, "hard-coded" + mountpoints only (~ MSDOS) + - no network stack + - user-level features: ELF loader (no shared libraries), processes, + user threads (kernel-level scheduling only), mmap API, basic VFS + +To understand where to look at for what, here is a brief description: + - Makefile: the (ONLY) makefile of the OS. Targets are basically + 'all' and 'clean' + - bootstrap/ directory: code to load the kernel. Both the stuff + needed for a multiboot-compliant loader (eg grub) AND a bootsector + are provided. The bootsector may only be used up to article 2. + - sos/ directory: the entry routine for the kernel (main.c), various + systemwide header files, a set of common useful C routines + ("nano-klibc"), and kernel subsystems (kernel memory management, + etc...) + - hwcore/ directory: Low-level CPU- and kernel-related routines + (interrupt/exception management, translation tables and segment + registers, ...) + - drivers/ directory: basic kernel drivers for various (non CPU) + devices (keyboard, x86 video memory, bochs 0xe9 port, ...). Used + mainly for debugging + - support/ directory: scripts and configuration files to build the + floppy images + - extra/ directory: a set of configuration files to be customized for + non-x86 host installations (yes, we primarily develop SOS on a ppc, for + the x86 target of course), or for grub-less installations. See + README file in this directory. + +The code is licensed under the terms of the GNU GPL version 2 (see +LICENSE file). + +Enjoy ! + + David Decotigny, Thomas Petazzoni, the Kos team + http://sos.enix.org/ + http://david.decotigny.free.fr/ + http://kos.enix.org/~thomas/ + http://kos.enix.org/ + + +-- +David Decotigny + +PS: Made with a Mac. diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..d019719 --- /dev/null +++ b/VERSION @@ -0,0 +1,11 @@ +SOS -- Simple OS +Copyright (C) 2003,2004,2005 The SOS Team (David Decotigny & Thomas Petazzoni) + +Version "Article 7 (1st part)" -- Basic user programs support + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + See the LICENSE file included in the distribution. diff --git a/bootstrap/multiboot.S b/bootstrap/multiboot.S new file mode 100644 index 0000000..546d947 --- /dev/null +++ b/bootstrap/multiboot.S @@ -0,0 +1,85 @@ +/* Copyright (C) 1999 Free Software Foundation, Inc. + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + + +/* The operating system is booted by Grub, so we almost have nothing + to do to boot it. We only have to conform to the Multiboot + standard, as defined by the Grub documentation */ + +#define ASM 1 +/* The multiboot.h header contains a lot of multiboot standard + definitions */ +#include "multiboot.h" + + /* The multiboot header itself. It must come first. */ +.section ".multiboot" + /* Multiboot header must be aligned on a 4-byte boundary */ + .align 4 +multiboot_header: + /* magic= */ .long MULTIBOOT_HEADER_MAGIC + /* flags= */ .long MULTIBOOT_HEADER_FLAGS + /* checksum= */ .long -(MULTIBOOT_HEADER_MAGIC \ + +MULTIBOOT_HEADER_FLAGS) + /* header_addr= */ .long multiboot_header + /* load_addr= */ .long __b_load + /* load_end_addr=*/ .long __e_load + /* bss_end_addr= */ .long __e_kernel + /* entry_addr= */ .long multiboot_entry + +/* Here is the beginning of the code of our operating system */ +.text + +.globl start, _start +start: +_start: +multiboot_entry: + /* Set up a stack */ + movl $(stack + MULTIBOOT_STACK_SIZE), %ebp + movl %ebp, %esp + + /* Set EFLAGS to 0 */ + pushl $0 + /* pop stack into the EFLAGS register */ + popf + + /* Push the magic and the address on the stack, so that they + will be the parameters of the cmain function */ + pushl %ebx + pushl %eax + + /* Call the cmain function (os.c) */ + call EXT_C(sos_main) + + /* Should never get there */ +loop: + hlt + jmp loop + +/* Here is the stack */ +.section ".init_stack", "aw", @nobits +.size stack, MULTIBOOT_STACK_SIZE +stack: + .space MULTIBOOT_STACK_SIZE + +/* Some data characterizing the stack addresses */ +.data + .globl bootstrap_stack_bottom +bootstrap_stack_bottom: .long stack + + .globl bootstrap_stack_size +bootstrap_stack_size: .long MULTIBOOT_STACK_SIZE diff --git a/bootstrap/multiboot.h b/bootstrap/multiboot.h new file mode 100644 index 0000000..ee9cdbd --- /dev/null +++ b/bootstrap/multiboot.h @@ -0,0 +1,133 @@ +#ifndef __MULTIBOOT_H__ +#define __MULTIBOOT_H__ + +/* multiboot.h - the header for Multiboot */ +/* Copyright (C) 1999 Free Software Foundation, Inc. + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ + +/* Macros. */ + +/* The magic number for the Multiboot header. */ +#define MULTIBOOT_HEADER_MAGIC 0x1BADB002 + +/* The flags for the Multiboot header. */ +#define MULTIBOOT_HEADER_FLAGS 0x00010003 + +/* The magic number passed by a Multiboot-compliant boot loader. */ +#define MULTIBOOT_BOOTLOADER_MAGIC 0x2BADB002 + +/* The size of our stack (16KB). */ +#define MULTIBOOT_STACK_SIZE 0x4000 + +#define MULTIBOOT_CMDLINE 4 +#define MULTIBOOT_MODS 8 + +/* C symbol format. HAVE_ASM_USCORE is defined by configure. */ +#ifdef HAVE_ASM_USCORE +# define EXT_C(sym) _ ## sym +#else +# define EXT_C(sym) sym +#endif + +#ifndef ASM +/* Do not include here in the assembler sources. */ + +#include + +/* The address of the stack of the bootstrap thread */ +extern sos_vaddr_t bootstrap_stack_bottom; +extern sos_size_t bootstrap_stack_size; + +/* Types. */ + +/* The Multiboot header. */ +typedef struct multiboot_header +{ + unsigned long magic; + unsigned long flags; + unsigned long checksum; + unsigned long header_addr; + unsigned long load_addr; + unsigned long load_end_addr; + unsigned long bss_end_addr; + unsigned long entry_addr; +} multiboot_header_t; + +/* The symbol table for a.out. */ +typedef struct aout_symbol_table +{ + unsigned long tabsize; + unsigned long strsize; + unsigned long addr; + unsigned long reserved; +} aout_symbol_table_t; + +/* The section header table for ELF. */ +typedef struct elf_section_header_table +{ + unsigned long num; + unsigned long size; + unsigned long addr; + unsigned long shndx; +} elf_section_header_table_t; + +/* The Multiboot information. */ +typedef struct multiboot_info +{ + unsigned long flags; + unsigned long mem_lower; + unsigned long mem_upper; + unsigned long boot_device; + unsigned long cmdline; + unsigned long mods_count; + unsigned long mods_addr; + union + { + aout_symbol_table_t aout_sym; + elf_section_header_table_t elf_sec; + } u; + unsigned long mmap_length; + unsigned long mmap_addr; + unsigned long drives_length; + unsigned long drives_addr; +} multiboot_info_t; + +/* The module structure. */ +typedef struct module +{ + unsigned long mod_start; + unsigned long mod_end; + unsigned long string; + unsigned long reserved; +} module_t; + +/* The memory map. Be careful that the offset 0 is base_addr_low + but no size. */ +typedef struct memory_map +{ + unsigned long size; + unsigned long base_addr_low; + unsigned long base_addr_high; + unsigned long length_low; + unsigned long length_high; + unsigned long type; +} memory_map_t; + +void dump_multiboot_info(multiboot_info_t *mbi); + +#endif /* ! ASM */ + +#endif /* __MULTIBOOT_H__ */ diff --git a/drivers/bochs.c b/drivers/bochs.c new file mode 100644 index 0000000..f5b0bfb --- /dev/null +++ b/drivers/bochs.c @@ -0,0 +1,123 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include + +#include "bochs.h" + +/* This is a special hack that is only useful when running the + operating system under the Bochs emulator. */ +#define SOS_BOCHS_IOPORT 0xe9 + +sos_ret_t sos_bochs_setup(void) +{ + return SOS_OK; +} + +#define _putchar(chr) \ + outb((chr), SOS_BOCHS_IOPORT) + +sos_ret_t sos_bochs_putchar(char c) +{ + _putchar(c); + + return SOS_OK; +} + +sos_ret_t sos_bochs_putstring(const char* str) +{ + for ( ; str && (*str != '\0') ; str++) + _putchar(*str); + + return SOS_OK; +} + +sos_ret_t sos_bochs_puthex(unsigned val, int nbytes) +{ + unsigned c; + +#define BOCHS_PRTHEX(q) \ + ({ unsigned char r; if ((q) >= 10) r='a'+(q)-10; \ + else r='0'+(q); _putchar(r); }) + + switch (nbytes) + { + case 4: + c = (val >> 24) & 0xff; + BOCHS_PRTHEX((c >> 4)&0xf); + BOCHS_PRTHEX(c&0xf); + case 3: + c = (val >> 16) & 0xff; + BOCHS_PRTHEX((c >> 4)&0xf); + BOCHS_PRTHEX(c&0xf); + case 2: + c = (val >> 8) & 0xff; + BOCHS_PRTHEX((c >> 4)&0xf); + BOCHS_PRTHEX(c&0xf); + case 1: + c = val & 0xff; + BOCHS_PRTHEX((c >> 4)&0xf); + BOCHS_PRTHEX(c&0xf); + } + + return SOS_OK; +} + + +sos_ret_t sos_bochs_hexdump(const void* addr, int nbytes) +{ + int offs; + for (offs = 0 ; offs < nbytes ; offs++) + { + const unsigned char *c; + + if ((offs % 16) == 0) + { + sos_bochs_putstring("0x"); + sos_bochs_puthex(offs, 4); + } + + if ((offs % 8) == 0) + sos_bochs_putstring(" "); + + c = (const unsigned char*)(addr + offs); + sos_bochs_puthex(*c, 1); + sos_bochs_putstring(" "); + + if (((offs + 1) % 16) == 0) + sos_bochs_putstring("\n"); + } + + if (offs % 16) + sos_bochs_putstring("\n"); + + return SOS_OK; +} + + +sos_ret_t sos_bochs_printf(const char *format, /* args */...) +{ + char buff[256]; + va_list ap; + + va_start(ap, format); + vsnprintf(buff, sizeof(buff), format, ap); + va_end(ap); + + return sos_bochs_putstring(buff); +} diff --git a/drivers/bochs.h b/drivers/bochs.h new file mode 100644 index 0000000..348506b --- /dev/null +++ b/drivers/bochs.h @@ -0,0 +1,55 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_BOCHS_H_ +#define _SOS_BOCHS_H_ + +/** + * @file bochs.h + * + * If you compiled Bochs with the --enable-e9-hack, then any character + * printed to the 0xE9 I/O port is printed to the xterm that is + * running Bochs. This may appear to be a detail, but in fact, this + * functionnality is *VERY* precious for debugging purposes. This + * """driver""" handles this feature. + */ + +#include +#include + +sos_ret_t sos_bochs_setup(void); + +sos_ret_t sos_bochs_putchar(char c); + +sos_ret_t sos_bochs_putstring(const char* str); + +/** Print the least signficant 32 (nbytes == 4), 24 (nbytes == 3), 16 + (nbytes == 2) or 8 (nbytes == 1) bits of val in hexadecimal. */ +sos_ret_t sos_bochs_puthex(unsigned val, int nbytes); + +/** hexdump-style pretty printing */ +sos_ret_t sos_bochs_hexdump(const void* addr, int nbytes); + +/** + * Print the formatted string. Very restricted version of printf(3): + * 1/ can print max 255 chars, 2/ supports only %d/%i, %c, %s, %x + * without any support for flag charachters (eg %08x). + */ +sos_ret_t sos_bochs_printf(const char *format, /* args */...) + __attribute__ ((format (printf, 1, 2))); + +#endif diff --git a/drivers/x86_videomem.c b/drivers/x86_videomem.c new file mode 100644 index 0000000..9b9aafc --- /dev/null +++ b/drivers/x86_videomem.c @@ -0,0 +1,127 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include + +#include "x86_videomem.h" + +/* The text video memory starts at address 0xB8000. Odd bytes are the + ASCII value of the character, even bytes are attribute for the + preceding character. */ +#define VIDEO 0xb8000 + + +/* Console screen size */ +#define LINES 25 +#define COLUMNS 80 + + +/** The structure of a character element in the video memory. @see + http://webster.cs.ucr.edu/AoA DOS edition chapter 23 */ +typedef struct { + unsigned char character; + unsigned char attribute; +} __attribute__ ((packed)) x86_video_mem[LINES*COLUMNS]; + + + +/** The base pointer for the video memory */ +static volatile x86_video_mem *video = (volatile x86_video_mem*)VIDEO; + +sos_ret_t sos_x86_videomem_setup(void) +{ + /* + * Hide cursor. @see Ralf Brown's interrupt (and port) list + * http://www-2.cs.cmu.edu/~ralf/files.html + */ +#define CRT_REG_INDEX 0x3d4 +#define CRT_REG_DATA 0x3d5 + + /* CRT index port => ask for access to register 0xa ("cursor + start") */ + outb(0x0a, CRT_REG_INDEX); + + /* (RBIL Tables 708 & 654) CRT Register 0xa => bit 5 = cursor OFF */ + outb(1 << 5, CRT_REG_DATA); + + return SOS_OK; +} + + +sos_ret_t sos_x86_videomem_cls(unsigned char attribute) +{ + /* Clears the screen */ + int i; + for(i = 0 ; i < LINES*COLUMNS ; i++) + { + (*video)[i].character = 0; + (*video)[i].attribute = attribute; + } + + return SOS_OK; +} + + +sos_ret_t sos_x86_videomem_putstring(unsigned char row, unsigned char col, + unsigned char attribute, + const char *str) +{ + unsigned video_offs = row*COLUMNS + col; + + if (video_offs >= LINES*COLUMNS) + return -SOS_EINVAL; + + for ( ; str && *str && (video_offs < LINES*COLUMNS) ; str++, video_offs++) + { + (*video)[video_offs].character = (unsigned char)*str; + (*video)[video_offs].attribute = attribute; + } + + return SOS_OK; +} + + +sos_ret_t sos_x86_videomem_putchar(unsigned char row, unsigned char col, + unsigned char attribute, + unsigned char c) +{ + unsigned video_offs = row*COLUMNS + col; + + if (video_offs >= LINES*COLUMNS) + return -SOS_EINVAL; + + (*video)[video_offs].character = c; + (*video)[video_offs].attribute = attribute; + + return SOS_OK; +} + + +sos_ret_t sos_x86_videomem_printf(unsigned char row, unsigned char col, + unsigned char attribute, + const char *format, /* args */...) +{ + char buff[256]; + va_list ap; + + va_start(ap, format); + vsnprintf(buff, sizeof(buff), format, ap); + va_end(ap); + + return sos_x86_videomem_putstring(row, col, attribute, buff); +} diff --git a/drivers/x86_videomem.h b/drivers/x86_videomem.h new file mode 100644 index 0000000..e4b2f91 --- /dev/null +++ b/drivers/x86_videomem.h @@ -0,0 +1,97 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_X86_VIDEOMEM_H_ +#define _SOS_X86_VIDEOMEM_H_ + +/** + * @file x86_videomem.h + * + * On x86 PC platforms, the text mode screen memory (and CGA/EGA/VGA + * too) is mapped into physical memory. This file handles access to + * this screen, supposed to be set in text-mode, through this memory + * area. All the functions below print the characters directly to the + * memory, without interpreting the escaped characters (such as \n, + * \r...) + */ + +#include + +/** + * x86 video attributes + * See http://webster.cs.ucr.edu/AoA/DOS/ch23/CH23-1.html + */ +/* Normal and Dark/Light foreground */ +#define SOS_X86_VIDEO_FG_BLACK 0 +#define SOS_X86_VIDEO_FG_DKGRAY 8 +#define SOS_X86_VIDEO_FG_BLUE 1 +#define SOS_X86_VIDEO_FG_LTBLUE 9 +#define SOS_X86_VIDEO_FG_GREEN 2 +#define SOS_X86_VIDEO_FG_LTGREEN 10 +#define SOS_X86_VIDEO_FG_CYAN 3 +#define SOS_X86_VIDEO_FG_LTCYAN 11 +#define SOS_X86_VIDEO_FG_RED 4 +#define SOS_X86_VIDEO_FG_LTRED 12 +#define SOS_X86_VIDEO_FG_MAGENTA 5 +#define SOS_X86_VIDEO_FG_LTMAGENTA 13 +#define SOS_X86_VIDEO_FG_BROWN 6 +#define SOS_X86_VIDEO_FG_YELLOW 14 +#define SOS_X86_VIDEO_FG_LTGRAY 7 +#define SOS_X86_VIDEO_FG_WHITE 15 +/* Background */ +#define SOS_X86_VIDEO_BG_BLACK (0 << 4) +#define SOS_X86_VIDEO_BG_BLUE (1 << 4) +#define SOS_X86_VIDEO_BG_GREEN (2 << 4) +#define SOS_X86_VIDEO_BG_CYAN (3 << 4) +#define SOS_X86_VIDEO_BG_RED (4 << 4) +#define SOS_X86_VIDEO_BG_MAGENTA (5 << 4) +#define SOS_X86_VIDEO_BG_BROWN (6 << 4) +#define SOS_X86_VIDEO_BG_LTGRAY (7 << 4) +/* Blinking */ +#define SOS_X86_VIDEO_FG_BLINKING (1 << 7) + + +/** Setup the video RAM mapping and clear the screen */ +sos_ret_t sos_x86_videomem_setup(void); + +/** Clears the screen and set the background color as given by + attribute */ +sos_ret_t sos_x86_videomem_cls(unsigned char attribute); + +/** Print the string on the scren with the given attribute. Does not + handle scrolling */ +sos_ret_t sos_x86_videomem_putstring(unsigned char row, unsigned char col, + unsigned char attribute, + const char *str); + +/** Print the character on the scren with the given attribute. Does not + handle scrolling */ +sos_ret_t sos_x86_videomem_putchar(unsigned char row, unsigned char col, + unsigned char attribute, + unsigned char c); + +/** + * Print the formatted string. Very restricted version of printf(3): + * 1/ can print max 255 chars, 2/ supports only %d/%i, %c, %s, %x + * without any support for flag charachters (eg %08x). + */ +sos_ret_t sos_x86_videomem_printf(unsigned char row, unsigned char col, + unsigned char attribute, + const char *format, /* args */...) + __attribute__ ((format (printf, 4, 5))); + +#endif /* _SOS_X86_VIDEOMEM_H_ */ diff --git a/extra/Makefile b/extra/Makefile new file mode 100644 index 0000000..f858aa6 --- /dev/null +++ b/extra/Makefile @@ -0,0 +1,40 @@ +OBJCOPY=objcopy + +all: sos_qemu.img + +-include ../.mkvars + +# The image is the simple concatenation of the boot sector and the kernel +# It may be use in bochs or on a real floppy, but NOT in qemu (see below) +sos_bsect.img: bsect.bin sos.bin + cat $^ > $@ + @echo "You can use the $@ image in bochs or on a real floppy (NOT qemu)" + +# For qemu, the trick is to tell it we have *more* than 1440 sectors (720kB). +# Rtherwise the qemu disk geometry will be configured to be that of a 720kB +# floppy, while our boot sector assumes it to be 1.44MB +sos_qemu.img: sos_bsect.img + # Padding with 0s after the bsect/kernel image + cat $< /dev/zero | dd of=$@ bs=1k count=1440 + @echo "You can use the $@ image in qemu, bochs, or on a real floppy" + +# we extract the boot sector from the main ELF binary +bsect.bin: sos_bsect.elf + $(OBJCOPY) -v -O binary -j .bootsect $< $@ + +# we extract the kernel code from the main ELF binary +sos.bin: sos_bsect.elf + $(OBJCOPY) -v -O binary -R .bootsect $< $@ + +# The main ELF binary contains the boot sector and the kernel code +# linked together (hence we deal with a SINGLE image that we split +# above) because they share some symbol definitions +sos_bsect.elf: bootsect.o compile_kernel + $(LD) --warn-common -T ./sos_bsect.lds -o $@ \ + bootsect.o $(wildcard ../hwcore/*.o ../drivers/*.o ../sos/*.o) + +compile_kernel: + $(MAKE) -C .. + +clean: + $(RM) *.img *.elf *.bin *~ *.o *.out diff --git a/extra/README b/extra/README new file mode 100644 index 0000000..0272f1f --- /dev/null +++ b/extra/README @@ -0,0 +1,73 @@ + +Contents of the extra/ directory +================================ + +Data and configuration files to support generation of sos on non-x86 +and/or grub-less hosts: + - dot.mkvars: file to copy as .mkvars in the root directory to + compile on a non-x86 host, and to generate the grub floppy image on + a grub-less host + - grub.img.gz: compressed image of a Grub floppy (without any + kernel). Used by dot.mkvars. + - mtoolsrc: file needed by .mkvars to compile a the floppy image + +Support of a sos-specific boot sector: + - Makefile: rules to compile sos_bsect.img, the floppy image with the + boot sector and the Sos + - bootsect.S: x86 Sos boot sector (GNU as). Depends on sos_bsect.lds + - sos_bsect.lds: ld script to bind the boot sector with the remaining + of the kernel + +Misc: + - qemu-port-e9.diff: patch over qemu to support the bochs "port 0xe9 hack" + + +What you can do with these files +================================ + + +*** Compile SOS from another architecture: +------------------------------------------ + - compile a cross-compiler for the i586-gnu target. This involves + compiling the binutils and gcc. Here are example configuration + options for them: + binutils (replace sparc-cun-solaris with your arch): + ../binutils-2.13/configure --prefix=/udd/ddecotig/temp_dd/xgcc/host-sparc-solaris7/stow/binutils-2.11 --host=sparc-sun-solaris2.7 i586-gnu + make && make install + gcc (ditto): + CFLAGS="-O2 -Dinhibit_libc" ../gcc-3.2/configure --target=i586-gnu --prefix=/udd/ddecotig/temp_dd/xgcc/host-sparc-solaris7/stow/gcc-3.2 --with-as=/udd/ddecotig/temp_dd/xgcc/host-sparc-solaris7/bin/as --with-ld=/udd/ddecotig/temp_dd/xgcc/host-sparc-solaris7/bin/ld --with-gnu-as --with-gnu-ld --enable-languages=c --disable-shared --disable-multilib --disable-nls --enable-threads=single + make && make install + - compile the mtools + - copy dot.mkvars to the root directory of SOS, as ".mkvars" + - customize the CC/LD/... variables to suit your cross-compiler + installatioon + - now you may run make from the SOS root directory, it should + generate the Grub boot floppy image. The following warning is + normal: + .mkvars:16: attention : écrasement des commandes pour la cible « grub-sos.img » + Makefile:92: attention : anciennes commandes ignorées pour la cible « grub-sos.img » + + +*** To compile SOS from an x86 where grub is not or incorrectly installed: +-------------------------------------------------------------------------- + - copy dot.mkvars to the root directory of SOS, as ".mkvars" + - customize the CC/LD/... variables to suit your cross-compiler + installatioon + - now you may run make from the SOS root directory, it should + generate the Grub boot floppy image. The following warning is + normal: + .mkvars:16: attention : écrasement des commandes pour la cible « grub-sos.img » + Makefile:92: attention : anciennes commandes ignorées pour la cible « grub-sos.img » + + +*** To compile SOS with its own bootloader: +------------------------------------------- + - for cross-architecture compilation: see above + - cd to this extra/ directory + - run 'make' + - the floppy image is: sos_bsect.img + NOTE : SOS will not boot correctly this way after article 2 ! + + +-- +David Decotigny diff --git a/extra/bootsect.S b/extra/bootsect.S new file mode 100644 index 0000000..8d6ef8f --- /dev/null +++ b/extra/bootsect.S @@ -0,0 +1,406 @@ + +/* + * @(#) $Id: bootsect.S,v 1.8 2004/11/20 16:00:11 d2 Exp $ + * Description : Bootsecteur en syntaxe AT&T + * Auteurs : Thomas Petazzoni & Fabrice Gautier & Emmanuel Marty + * Jerome Petazzoni & Bernard Cassagne & coffeeman + * David Decotigny + * Bug reports to kos-misc@enix.org + */ + +/* + * But global de ce bootsecteur : + * + * - Initialiser la becane + * - Charger le kernel + * - Passer en mode protege + * - Executer le kernel + * + * Taille restante : Je vous rappelle qu'un bootsecteur ne peut faire + * qu'au maximum 512 octets dont 2 octets obligatoires 0xAA55. Sur + * les 510 octets reellement utilisables, il reste 3 octets dispo (60 + * si on decide d'enlever le BPB un jour) !!! + * + * thomas_petazzoni : - detection des codes d'erreurs de chargement + * David_Decotigny : - Passage en GNU as + * David_Decotigny : - Chargement du noyau au-dela du 1er Mega (taille + * max = 0x9e000 octets = 632ko), pour avoir le + * meme noyau sous grub et avec le bootsecteur + */ + + /* + * Sequence d'operations : + * - Le BIOS charge le bootsect en 0x7c00 (BOOT_ADRESS). On choisit + * la representation 0x7c0:0000 pour que le .org 0 reste valide + * - Le bootsect se deplace de lui-meme en 0x9f000 (COPY_ADRESS). On + * choisit la representation 0x9f00:0000 pour que le .org 0 reste + * valide + * - Le bootsect verifie que le processeur est du type 386+ + * - Il charge le noyau depuis la disquette en memoire a partir de + * 0x1000 (LOAD_ADRESS). Le noyau peut au max tenir sur + * SECTORS_TO_LOAD secteurs + * - Il passe en pmode flat (apres ouverture a20) + * - Il recopie le noyau (situe en LOAD_ADRESS) vers son adresse + * finale (FINAL_ADDRESS = 2Mo). La recopie se fait sur tout l'espace + * LOAD_ADRESS ---> COPY_ADRESS, c'est a dire sur 0x9e000 octets = + * 632ko. Le noyau peut donc au max faire 632ko. Le nombre max de + * secteurs de disquette qu'on peut charger est donc 1264 + */ + + +/* La taille de la pile */ +#define BOOT_STACK_SIZE 0x4000 + + .file "bootsect.S" + + /* Tout est place dans une seule section */ + .section ".bootsect" + + /* L'essentiel du bootsector (sauf les 1eres instructions) + sont a un offset 0. On fait en sorte que le compilo soit + d'accord la-dessus. Quand on a des adresse realm exotiques + (0x7c00, 0x9f000, ...), on s'arrange toujours pour avoir un + offset de 0 => on choisira le segment adapte (0x7c0, + 0x9f00, ...). Il ne faut pas oublier le ld -Ttext 0 */ + .org 0 + + /* Pour que gas genere du 16bits, afin que ca marche en realm */ + .code16 + +#define SECTORS_TO_LOAD 128 /* 64 ko */ /* MAX=1264 */ + +/* + * Parametres de la disquette. Comme c'est chiant de faire une + * procedure de detection auto, et que ca prend de la place, on fait + * ca "a la main". Par exemple, une DD 720 Ko a 9 secteurs/piste, une + * 1.44 Mo a 18 secteurs/pistes + */ +#define CYLS 80 +#define HEADS 1 +#define SECTS 18 + +#define BOOT_ADRESS 0x07C00 /* Adresse de demarrage (lineaire) */ +#define BOOT_SEG (BOOT_ADRESS>>4) /* Segment de Boot */ +#define BOOT_SIZE 512 /* Taille bu bootsecteur */ +#define COPY_ADRESS 0x9F000 /* La ou on va copier le + bootsecteur (lineaire) */ +#define COPY_SEG (COPY_ADRESS>>4) /* Segment de la ou on va + copier le bootsecteur */ +#define LOAD_ADRESS 0x01000 /* 1er chargement du systeme */ +#define LOAD_SEG (LOAD_ADRESS>>4) /* Segment du 1er chargement du */ +#define MAX_KERN_LEN COPY_ADRESS-LOAD_ADRESS /* Taille noyau maxi */ + +/* IMPORTANT : Cette valeur DOIT etre identique a l'adresse presente + dans sos.lds ! */ +#define FINAL_ADDRESS 0x200000 /* Adresse finale (physique de 0 a 4G) + ou est charge le noyau */ + +#define OP16 .byte 0x66 ; +#define OP32 .byte 0x66 ; + +/* + * Procedure qui vide le buffer clavier. + */ +#define WAITKB \ + 1: ;\ + .word 0xeb ;\ + .word 0xeb ;\ + inb $0x64, %al ;\ + andb $0x2, %al ;\ + jnz 1b + + /* Le point d'entree dans le bootsect */ +.globl _bsect +_bsect: + + /* + * La portion qui suit est situee a un offset 0x7c00 en + * memoire. Attention donc aux references memoire dans cette + * partie. On choisit de rester en offset 0 (.org 0), mais on + * charge correctement les segments a 0x7c0. + */ + + movw $BOOT_SEG, %ax /* le bootsecteur est a 0x7C00 en lineaire */ + movw %ax, %ds /* on le copie a l'adresse COPY_ADRESS */ + xorw %si, %si /* comme cette adresse est la plus haute de la mem */ + xorw %di, %di /* on pourra charger un kernel + gros */ + movw $(BOOT_SIZE>>1), %cx + movw $COPY_SEG, %ax + movw %ax, %es + cld + rep ; movsw + + /* on continue a executer le bootsecteur, mais maintenant a + partir de 0x9F000, qu'on represente sous la forme + 0x9f00:offset */ + ljmp $COPY_SEG, $here + + /* + * A partir de maintenant, on est a un offset 0 en memoire + * (segment 0x9f00), conformement a ce que veut le compilo. + */ +here: + movw %ax, %ds + + /* Petite pile temporaire (1k - 3.84k en RAM ; les adresses 0-1k + correspondent au vecteur d'interruptions). */ + movw %ax, %ss + movw $(LOAD_ADRESS - 0x10), %sp + + /* Efface l'ecran */ + movb $0x0, %ah + movb $0x3, %al + int $0x10 + + /* Affiche les messages d'attente */ + movw $loadkern, %si + call message + movw $check, %si + call message + +check386: + /* + * la attention, plus complexe : on teste si le proc est un + * 386+ pour cela, on va essayer de modifier les bits 12 ? 14 + * du registre E-flag si la modification reste, alors le proc + * est un 386+, sinon, c'est =< 286 + * + * Merci a Emmanuel Marty pour la compatibilite avec les 386 + * "pre-jurassique" + */ + + pushf /* on sauvegarde le E-Flag */ + movb $0x70, %ah + pushw %ax + popf + pushf + popw %ax + orb %ah, %ah + je no386 /* si la modif n'est pas valable, alors on saute a + no386 */ + popf /* on les restaure ? la fin ... */ + + /* Message de confirmation de 386+ et d'attente */ + movw $found386, %si + call message + movw $loading, %si + call message + +/* Copie du noyau disquette => RAM a partir de 0x1000 + L'adresse de destination est définie par es:0, où es vaut + initialement 0x100 (ie correspond alors à l'adresse 256*16, soit 4 + ko). Chaque itération incrémente ce registre es de 32, ce qui + correspond à un bond de 32*16 en mémoire, soit la taille d'un + secteur. De cette façon, puisqu'on joue sur les segments plutôt que + sur les offsets, la taille du noyau n'est pas limitée à 64 ko. Elle + est limitée par contre à la taille de la mémoire disponible sous + les 1Mo, \ie 640 ko (0x9f000 - 0x1000). */ +copyKernel: + /* Chargement du noyau en LOAD_SEG:0 */ + /* 3 iterateurs : + - load_size : le nbre de secteurs a charger + - cl : le secteur ou on en est pour le + cylindre en cours (<= SECTS) + - dh : la tete en cours (0/1) + */ + movb $0, %dl + movw $LOAD_SEG, %ax + movw %ax, %es + + xorw %bx, %bx + xorw %dx, %dx + movw $1, %cx /* premier secteur */ + +.nextsector: /* prochain secteur */ + incb %cl /* en incrementant CL */ + cmpb $SECTS, %cl /* si CL =< SECTS (=nbre de secteurs/pistes) + alors on charge */ + jbe .sector + movb $1, %cl /* sinon on revient au secteur 1 */ + incb %dh /* mais sur l'autre tete */ + cmpb $1, %dh /* on recompare, si DH =< 1 */ + je .sector /* on charge */ + movb $0, %dh /* sinon on repasse a la tete 0 */ + incb %ch /* mais on change de cylindre */ + +.sector: + pushw %es + movw $0x0201, %ax /* service 0x2, chargement 0x1 seecteur */ + int $0x13 /* Go ! */ + jc halt /* erreur */ + popw %ax + addw $32, %ax /* on a charge un secteur, donc on doit + charger 512 bytes plus loin */ + movw %ax, %es /* on avance donc le segment du buffer de + 32bytes, ie 1 secteur en RAM (car 32*16=512) */ + + movw $(0x0E*256+'.'), %ax /* affiche un point */ + int $0x10 + + decw (load_size) /* et on repart pour le prochain secteur + tant qu'on n'a pas fini ! */ + jnz .nextsector + +after: + movw $0x03f2, %dx + inb %dx, %al /* stoppe le moteur */ + andb $0x0f, %al + outb %al, %dx + + cli /* on interdit les interruptions */ + +fincopie: + pushw %cs + popw %ds + + /* on ouvre la porte A20 */ + WAITKB /* on vide le buffer */ + movb $0xd1, %al /* on met a jour le port */ + outb %al, $0x64 + WAITKB + movb $0xdf, %al /* bit 2 = ouverture/fermeture */ + outb %al, $0x60 + + /* + * init gdt + */ +InitGDT: + /* Préparation du flat mode */ + lgdt gdtr + +GoPMode: + /* Passage en mode protégé */ + movl %cr0, %eax + orb $1, %al /* set PE bit to 1 */ + movl %eax, %cr0 + + /* we are not yet in Pmode jump 'in' pmode clearing prefetch + * queue and loading a new selector */ + movw $0x10, %ax + movw %ax, %ds + movw %ax, %es + movw %ax, %fs + movw %ax, %gs + +/* + * Code 32 bits ============================================================ + */ + .code32 + +JumpToHere32: /* Se deplace a l'endroit actuel, en passant en 32bits + et en utilisant la gdt, et vide la prefetch queue */ + .byte 0x66 /* Prefixe 32bits : en realite, jusqu'au jmp, on est + encore en 16 bits */ + ljmp $0x8, $(COPY_ADRESS+(Here32)) +Here32: + /* Et voila : On est en 32 bits vrai */ + +MoveKernelToFinalAddr: /* Deplace le noyau (en LOAD_ADDRESS) vers sa + destination finale (FINAL_ADDRESS) */ + movl $0x10, %eax + movl %eax, %ds /* Seg Src = DSeg */ + movl %eax, %es /* Sed Dest = DSeg */ + cld + movl $LOAD_ADRESS, %esi /* On commence la copie au debut du noyau */ + movl $FINAL_ADDRESS, %edi /* On copie vers cette adresse */ + movl $MAX_KERN_LEN, %ecx /* Taille recopie */ + shrl $2, %ecx + rep + movsl + +LaunchKernel: + /* Met en place une pile au niveau du symbole "stack" */ + movl %eax, %ss + movl $(stack + BOOT_STACK_SIZE), %ebp + movl %ebp, %esp + + /* Saut vers le noyau. La GDT est en place (flat mode), les + * selecteurs aussi, a20 est ouverte, et les interruptions sont + * cli + pas de idt. Le PIC n'est pas programme */ + ljmp $0x8, $sos_main + +/* + * Utilities ============================================================ + */ + .code16 + +message: + lodsb /* charge ds:si dans al et incremente si */ + orb %al, %al /* si al = 0 */ + jz 1f + movb $0x0e, %ah /* service 0Eh (affichage d'un caractere) */ + movw $0x0007, %bx /* Parametres : blanc sur fond noir */ + int $0x10 /* Appel de l'interruption 10h */ + jmp message /* On repart au début ... */ + 1: ret /* si la chaine est finie alors on retourne + dans la fonction appelante */ + +halt: + pushw %cs + popw %es + movw $haltmsg, %si + call message + cli + 1: jmp 1b + ret + +no386: + movw $need386, %si + call message + call halt + + /* + * GDT + */ + +gdt: +gdtr: +NULL_Desc: + .word (EndGDT)-(gdt)-1 /* Taille GDT */ + .long (gdt)+COPY_ADRESS +unused: + .word 0 + +CS_Desc: /* 0x8 */ + .word 0xFFFF, 0 + .byte 0, 0x9B, 0xCF, 0 + +DS_Desc: /* 0x10 */ + .word 0xFFFF, 0 + .byte 0, 0x93, 0xCF, 0 + +EndGDT: + + /* quelques messages */ + +loadkern: .string "-= S O S =- : The Simple Operating System \r\n" +check: .string "Checking for a 386+ processor... " +found386: .string " [OK]\r\n" +need386: .string " [FAILED]\r\n" +diskerror: .string "Disk Error\r\n" +loading: .string "Loading... " +haltmsg: .string "System Halted\r\n" + +/*** Les code/données du boot secteur se terminent ICI. le marqueur de + * fin (aa55) est ajouté automatiquement par le script ld + * sos_bsect.lds ***/ + +/* La pile de 16k qu'on utilise au niveau de LaunchKernel se trouve + declaree avec le noyau, dans sa section ".init_stack", cad HORS du boot + secteur ! (sinon ca depasserait 512B, forcément). On aurait pu la + définir directement dans le sos_bsect.lds, ou dans un fichier .c + auxiliaire pour plus de clarté */ +/* Here is the stack */ +.section ".init_stack", "aw", @nobits +.p2align 4 +.size stack, BOOT_STACK_SIZE +stack: + .space BOOT_STACK_SIZE + +/* Some data characterizing the stack addresses */ +.data + .globl bootstrap_stack_bottom +bootstrap_stack_bottom: .long stack + + .globl bootstrap_stack_size +bootstrap_stack_size: .long BOOT_STACK_SIZE diff --git a/extra/dot.mkvars b/extra/dot.mkvars new file mode 100644 index 0000000..2f960b7 --- /dev/null +++ b/extra/dot.mkvars @@ -0,0 +1,30 @@ +# For cross-compilation and/or installations without grub available, +# copy this file as .mkvars to the root directory of the SOS sources, +# and customize the CC/LD/... variables. You still need the mtools +# installed and running + +CC := i586-gnu-gcc +LD := i586-gnu-ld +OBJCOPY := i586-gnu-objcopy +CFLAGS += -g +LIBGCC := $(shell $(CC) -print-libgcc-file-name) # To benefit from FP/64bits artihm. + +# Configuration of mtools +MTOOLSRC = extra/mtoolsrc +export MTOOLSRC + +$(MULTIBOOT_IMAGE): $(KERNEL_OBJ) menu.txt + gzip -dc < extra/grub.img.gz > $@ + mcopy menu.txt v:/boot/grub/ + mmd v:/system + mcopy sos.elf v:/system/sos.elf + +menu.txt: + echo timeout 0 > $@ + echo default 0 >> $@ + echo title SOS >> $@ + echo "root (fd0)" >> $@ + echo kernel /system/sos.elf >> $@ + +runbochs: all + echo c | bochs -q diff --git a/extra/grub.img.gz b/extra/grub.img.gz new file mode 100644 index 0000000000000000000000000000000000000000..4f98e7417112c99be2dec77daeb2b3434f878237 GIT binary patch literal 67535 zcmV)OK(@ahiwFSNcv(OI1MFOXbQ5*9|ITEROxv^*ZBf<*iO;Iw4`>jS9*PEN3Lb&R zrY)t|k|Lc}L4LFo6}F)XNifqPDZ2W6>%!We>REO5z+_kO?k`<)CVzHs~E;=;m359ZE7 zBtalDhD>RLDd=WIqAQq^^}$_tEGaZBnY-9*02ItEHcp366)7R)%*G=0CFc=z+S-7S zF%;+v^nQp8!!4$UJc%QH-9^ET4six?zT3$ax6j@GZb>w=yr}Lm*KoHRdMG{W$tMZK@=ww|`5LsIHHP?niskcl?en6Ub?W_S zecaJbM>FeF!93#`L<4@5Fo8hUH)sM`%6QawBz%nYiN13tKA#4DZ%8Cro?=_`8(8B} z_QDKbajHykl&?4q%+JoJ9eGW~>7iqqrbVeEVfwSCHM;U9E)9ANM2!6%1PT4$yDbvX zENrmd-ie4nzwx|Lx_tJnNmbI_^BRJU4$*|-89|RjoQ2|=V89{fpx|#E;=L$7vY@DB zo&hbWUiU0oSXH;mkpFc3YE)ERwF()`b#?3N(0&57XGHby?s_Gjg0D-ygMk#SckMu zl+uFILMT0k7)0D;ATmwFI2&=RllWB&@#_#VF-A;6QAEu(Q1eZc*+wmJQjfJzkB6wmF{%)$pD?Jc zCUuETz0|2*)}me>Qdh*(E0Ctjpn1xqskUiqoSLUwG^<0JXJZ=hZi7KvZ_?Ur+UK3x zjV;>WgtU&Bwh_@T1MN1^UK{IQbTdkM$&m6}Q_8Ehl-HaoziUbPeJEvT zEaeT9+GF0&S!7hg~RlZ5`W(EBQ6M{7XeUJa&3EhO~|^Gg<)t=G|y z{$w#zpg@5F1qu`>P@q780tE^bC{Un4fdT~z6ev)j;OB~|hB4^Tb>8nyoqD78g#O$b zREO+nCBp9yoB#3sq5Lxk*L{De`soI(U<^0Te8sInKY`yLSEIEs1E+%iCJwzIzskPq{jqsT z3DzwxD>jV3Mn98y{3nb0&j;~^+kb?1;`d(&Oe(+s@{9cam!i_3$|X)FDh~{~Sm6P; zgF=kw2y!+^hKjLv z6R3OhQ?E7r55X>iXj_uuZpYCsfM}aFW#O2bFl%hLhhr2UHcH0xf&R;9-<%Y@*(Fw@ zDtQdvJjwkXJup=YX1T=2Q2A-J1)<=rE^!Xd!~~Z(69w;ZiPInxi`G@GdU|b*p`NR% zsh$pnBt12em+NGspoxNfe1D^S{Bm#?{5^;a^y&2w7rc(8(f`<#Gc|Vxn#``snKEtV zx^>*NnmYT+Y0p-#wNK?<;C^(!mlD+>5UOGM2i7+u#C8o%f-8S!xW+eb4KSjatk@5m z!-47PBdk72v1)4gL)z}{$$8716Iw+a!Ad;LvNgWwLb`k`>+bMNut&s9g6^f1< zXqHO&lh&mN7J>hQwyoL?oq#nYJ>0PgXkOb?LW^s${n+z?5H^Bx&hOY!mW~L^PFQ@e zEw-*OB_^tbWZ-~?6cH1w+Q(Pkh z9!|v*l-ZxJF)S>x#0Ajbav=a`Q=)kNOVWHV+sOj>W zlar=BuCJOW155KniP-yi9lSCoMt&;tO;_fyO;V+cVrl{E5UF9M2XO198kQl(wFAW%Lah4`!Td{z zJ^d1li-w7(M^GU{fmlEc^a@mV8?KM7wIIxY#DCn1?|3TP7>XoK@Ub@BI4ap83xFis zVYtfB>F>b$_(XrP5xGCYhuvo7f}E5ZW^q|670h~;KL{;h5w`VkQ;Dw0PK(>1jQY+6 zzKCY}j$tKMoPjyLm2xe!F2!oTkDJWnLot#Ki=;2yWX}R!R;VyERntx82`t|u7Jv@k z&x0z&55cKT?>ml9FH77bh@*1)#ZO!DRfiW$t3Dcqga@4#NBu;WRLgt((Zs!F<-9#kwzMu?^|0>mtJI zzfr};HEgFmjm1A+mUsLtp5~Kt2gW7-4Y(a4FjGfELaA-tad;Lm!en{jGWNU|Dg}|8 zGE1$3nI3a0BJQ}1XKDv3jLL&q0JqG($nq6q!n!NM!eUxnlaMEp^0!_iZxt$N*Kz3r zRDyi$5}B0xpW%cQ2nog6w0IA0MA_b>9AUZ`9am4b6TV}tcm%{MJV)(B#3J4U!`=Pa zsZ}RdWs~+xyT5WaWYdTvb>u0Vn1#S$bY2!oh`^QLs1vsM`N+0Iql>+U?NN`G zu5)bs^3|p6vXGv#4Iy_}6&@gi2~_J_y>W3-)zBiC|p`cmMpAENDn{y-#fJP?<+I&uDa9Dv>L-v@c8rQ&Q#yc;+$ ze99(FT&N+Dc*ig?t#2?Zi>a)u8QiNmkJxwJJR7ezB@Il$DHM5 z?J02Tit0zY;Wg0X(o4!r-kG)LR;%$FvAN zfxqssmIjY+!<$12A9+9bOZz##yK;G?G&sY5)ec_y%Rl`8Xq1SJ7bPir3*QYj73wuB zPPr&ACz!^@qvA@qX(yt$uv{8QygefBAHfUt&$tw@;>eIB$&ywv7X))8oIzIn7TCVe zeS`AKZ7R;zHF4Q`@z#U{i6uS;iA1F#a0g_LWIP(xcNkLkYf)#f7N&wM_J@QRB)P=O zw)O|0ICw+$@!}`IZ&&3=SZ31@b~jya>_i4!;=KKwmK9`{*g7N+00f@^irK6F61cvJ z_=+76UAUc$-p1CGdtpTPW7h|9LoHCi7H`92JQR-U<(T-NLxYW)E8%ng^XSTtVy}Oi z_0#!LWTbPd_5u9vjoQk`)q#Dc=SR&?XM&7CpBAD zm)-%(7x}BtEw5a0II>i-k1s8{ zPmIaU6H3Ng4w_HsdHWfbFFAG4d=iP#3s_SJ%cE78Pcgex%&z&g`ziehKVK*JV+CCa zP7j5U`+-ex8THyG*mX_^jd}|3nGZ3101q7`X>i6Uc|+y)nf?OW;xC{qrI=qXJE@0U zj`M<1cxntO*ZOiiMy`pzW>5#_x}oAGrKg*t^yj)iE(dY zM6NRn4e|i|UFW`*q#keV>%=p4kN3ZUB4ny>jQ9B%)jLLgGDaO5qdpp=LSxj2Ns904 z07?uuB2;cX3ZA9PG2nY43bhD(vqu*2xj;5j>FqD$)b8O)jT6L+@Z9R2V^Tw9w5Rr{ zF_8`ijYs2M#!&9g&*cG}NOt3x{tm8=_S^U`ri9%W(>CAa`fxHHBh>I;GoD{T{sdXr zl-tM4M8jX)UDyWU--G2CPbZXJXQMWS@$3SsHr7HQ{{q?~&Z?&Z{ik3N-5qj^G;dF5?-5wR*NPBQ{TFbN~gdArl92=jejs;10jM3GKFk1IrCb;Y2XIk)wx;U8l`n*S7 zmZaJi$qi4AHQ2_eRby0bk`hCO;KxTgcb7cL5_98w=!Wr}0SRFzj-Kl{jvtqrXgv$9 z(jGj+63$99P3a`6{Q=lwT_GB6leyy3Mr?lkY2UfA}L;Kx%{iP$)&_q!zqe*-lrNo|iLiM7>+ z?YTwDQak5LToS8I{Ex*re)&umNGp?PXpKF?&PAINUbyIm}l zh%z5;2#xvvI(Xvlk`3FLE8`s40{p}zX7&~2$SDS5s+>F{=1osVxeYI6E=x}F-^DuN zB(twiGw>#vSP+JR z(=dS(lXdIk=>J@1u7q>Iga;;f?5A=pwJez8XJQT6Wibb=E}K0Eo4peG<&3)qGPK%{ z8I#=&89D?{>kS!Mu$3e?jM=g$i2&FA*T5{C(EJR8AWv1I`$C_@W$5qd=H+`a*nrS# zS$4AUq$X=L62;5pNO(hx=X;pkqwJSA!LkhJeo+RC>dTSja#}5~iphNbEjr?m?EAn5 zd@QY}L|X&SK3?6h%mnNIvi2_UQ54DJ_-uAJ*@T1%kVsU}ML~%mvI-tCiRQru6oV@< z55NEc5|_y9l35-~Ud%3JGA?o_-07VtF?gq^=i^Quf?yIb3Cd}BsNtbTh&t;=jDipn z%>JvYXLdKJ_x=9|7uiTLrzs&CLvUIl-6 zPA-jEsgigYGDEiD@lM=NOW2O(R)k9Q>o(k-K$t8wQjOBNF}@9yQe zoLnDKt5TIm3>dpqP1A%jD(|l5xI`C*VaaqYg_J}};n!IqoF%(orP<^*B-oTQ1R~Ni z21hOy*_=Ghl<+>kcCHVbG%%r&7au}?)D!={v>BP9$BO8GJkoP5{MM}d0f;Cmg1B9wZR6iTq zBN7@{s8etlQfhuT;tQduAQ`XPwGNQ%Fz#9pKQ?7%4fpy3C%%Z}^=aSszB)JN^j}Zpu-`mkk30DStuOk(4rXHoxI3K%Cpv zg*?qo@NCNA87e^M+ZT};V`7oCt_Kiqe@<=BjT&g@W&i+9vTq!MGetqP(O;V)0i0Uw z_)LJtJ3}#J_l>;stPaNj^Q*Ji$U-t9-H7|{$tWK3>m|qu%|ao~<|DOU$st5U21cBB zJ^;CP-2(vPaTIOtDLVKm=JZA^U{hAJ642^mPWco*q{doIaX-y%#FYg8%uLunr}VnY zyEx(MnviNeC8twLTEhNPBP2M!@ppZ6Hg}b7UJZkLl(x{}7d0gj?WK&%3@k535SO8VL)i zyafTfZ6VTdw2gTF2pKz%zYlU<{~(Cw*vk=B3RHWS5bZZXtx}T1rr*}`5+L-fMr19X^9d& z@4@Gu2;_15BjEquMzMQ|aL&6YKw_R3eny1>>G)^h4W4-aXCHoE$WtBDMq#HaN#`3tQM_{>inwZKcE2~^Es5IysuR5{fSmH*F+x< z9k$(|wVkyWRXEQyTrg;PcfS*l7?7t7lXIg94f2%8_}2J_2bq$puHcsiprVQxZjNIh zEdxvhm8Qfnp+~mGFd;)a9RGv3Dvo2V59q@Vy=04HBA+}rPHKw>;S75wKM*NTiB4!J z84Rnzz=WeE5%CR))UXvnVrW$#q9zy#?#MbC}p_@WfKhXc8v1 z%K4WM?l0E#nVHLxThDZz%yWb*AC-_<)-G0sXeNxCn9h%Rm^4Umlt-YR-PkYB5}#%ygT~6qOs{MY3qcbe zryN@Xbo@QCJ6Iwe*IE2J$);a^BI3_gok2WRy{j$%!t~v^D7X#RCA5}ANJq6CISh1_7Y8v*xgM0@oGklRM9&Q% zD@f1B0RU;|F!-y~{GNm>&vaV(-bMZ%60+j&@}I{-$h%D`{ymPEFJK&8E|*2h`O%gO z%2l8HeCaiMXT4xZGCO{9)=MV@zVfbHdFRc5k2I7Veh|w{24T_#BPsvFnA(Slvn-^) zq&C+Zd=qh{@J+;p*;dTu=J-e?w$yvSYPN18{pmyaQwcJ~w5ncQU{@F`6K`|;2!D9z zn@DfgmxxEr#YzrW(-mqEa2e)p6+N-U{X#tb0r_{!i;LvP6HWkGiYnx88whK4cE~GpidgH^v zT_W@BHt0+-=eY&hw6%k^Ou--T8FxAqe~EZ>O-NEY(@c^IcqcYCX}+*BX@T%)(n4W= z(qthg=@H?+B)f2T(h}kJq!J-MsZ=m0tq@|;YC@c#glq=R3FzPHc>)4}DHBxCA$}O* zJt=-@_8vjp={Ro_{KC5B-3`A`iT5?asoDF2_+g6o8TbGi^SZ?kOI2C+nbQ4rzfek z1AW@0%r5!C%dR6bOwh7O>4WkDIkj8Yn$X2NL(qnhem)sRQr?M|6y3*f_!E+coPJrK z4g%Lp(B$~msrZe5y5n1I;^SSMuw>Wa7f?4jiq(CQNHfNl-qoB=dvh*d`CW2$wA*l( zEqBaBgpos~u2V~OV5yg(6choeP~!l*&?@L{mrA<<4)z%EA*G-9e!&v{fDIU9L~yJT zaVoej1UHKs5$#z4$YlAy_LW|~qC}Khq8I*p53y`NxO}|p0+Pz=^MnYO2e;4DbW-YN zZ4&@y`7n3(F3>KdL2~(kZqRw%4GcF_^0dLler?BU0(-%*>D$Xk7$yWT0t!Hp(>D!zrv7)Z=?Ag zjW&A(<|~4Hd9wmJeJEGLA7Kc;qe-kUu-OM%uVM>tg8Cc*D{EPV&cMtGm zG5IB&UBVd4!6JE6IDRl;VMk-45!sY5AyvE-R({%!NyS~Kxsz_guP z0}a5O#ataZyL6qxU9+Y-jPtfAFP{JnXBK2vUVuW%4)|kFp|+6q)%zt8gbjCDek!7c zijA&8YK1jS=eB~bd%({0Vc`~jAAZl7Oy7=}8mmuK%t>=rL=@knOtzw3_7G+9{-6wg zlosz@=+uHc@LBdrIC#r4Ao>C*&7jivLPc3hIaNE`aaDl*5c1rG-LvQ5W=aUhx~U}D zks#m`nle&(v)FG250rEq2#8hQU9Jm`VMSHRePy_pAPiEr!sFvR%Dlg=#Y>uW&@2F!DrH z1C*};{|Q|)XA5DLgDvOoGr_4egmN8 z-$@)eJ>lG%kG%h67|F_#%S^!hRjyPM2I5Gcz$e`%49KVnB^l*5$4`}abB+OGi%;Xh zO`%+_-GhX80mdR@Hgu=Fz;ZIzH(^W4W#k`eDrrwi7kl~gZ=k5y8!go5C_km6h%q-u z%Nefa90EDR)SM>aPqMYs`vvyKttOBbBx|=i zDBTh;+Ad{;Pu;?mte00UPzTo{TQ5tXc<>s&j2$i;q!`C?@PP>jYvMC?U@^Z&EbFppVRKWYW^nXD;^UN=?eZTtB0p>G-%Rxt+9S-0gY}sbTF* z97RTlPd;j#2di3~ym1q(!N6c68Ka9t@PEm1ySgr+feuv1xwC{0c?*8(ha+ocB0yV? zDjtC(%4+c`@7*8VC*C<4B6I8q0Ts$m7EqkVQ28wT&ma!i>v5U={q4lZd@!RFYmUEl zyz@JV(IgycKHBnK=YPfxGwd%a1HOrvsEnIR=0ShC?R}_wmHh~dkZLX`Wxc5nEk2eb zm1|;mfa)zzj@>;qp{rzis@NDUUecF;1K=+acmsjgso+1F(jR6v zleCpbt?&k{FuPyIUd*^t%eaSNx!!^--a|klFvIL9*V~lm618atvuvg&h*x!@L61Za z$%R(S+Gi=)3PH5Javr!-hQ@jr%z7qVT;L^MG)b;9fi1M{W!&##Qya zjAVC{*kcq%h&{Y8tg6R_F)=d1s>9YR?L-3_Ch?zVo=^2TAUO-zRW0VMLlh|gB*%(5 zLMwy8?>HqjHJpuB@T6u{FY2bkaCdrvEyq2j(q`vh1VUVV8%d!w2HvMx!gZLCMG2AK zuclP_)^oud3jDf5WNk*&QzKj_WkNnRLWl@B<*+imCRcgC`K^YZf0$Ma-kFb-|6lTvv9kwBvNUE$tN|5eK+Nm8~5ErW)F~xvc%q-%I`*XMi^(Q z$6sidWbG824dOkV<8?}5+}l!*+&e;f5gIhx+X*(bRWZm` zMFcsNBfpX`o`OzMN7(##;Z4N=hM=KN4pYjrgvz6~# z5SqRw!NR6VPMPOr(9Az@+$fesf(%ww7R{0G6N7X;LMnYn)sk}TeTb5g*nm7DUXYlt z1msWwJ-&+o4GI8Kp~%)~IqNMceHXtoM4xs!p-Y$`erpmR>*l1aw}h($yG3&PTSY#u zD*aUilX3o7@X)vBe@oqaxM*WO(q zcEq<u z5PHa`ZRXssg{;)D;sIH9{okPOBNMgNFbmARZdzsQ)-&a zJ5xY9%7MtW3AmF83mclu6afoZoo?$^8(JTgwG%XF0av#XEj-R<>sD-n;D?V+3s@2RP_2P06YXjN(@U2uri)<|w-}iB&tI#k~jxri@ZM8;0WF z$|gz?z5$^jn)3@L%IY*)VIbu{m)&K@_Pqln`Zh`-=UyyMwCf?S9E)6$mIJ#Ug{jTU z0kY)68Kk`PI}rP~ENALU)tO3?6~03UgsSAbA+tV2lWb6TChs6rymir_csss!o^(WQ z-3K2@mBMjQ)jn3v&%*s;LTPzU5H@({SzOhqDbi+K$*Doia_264i`spe8ZPb?NLFwy z#Aa^B75UtYyz5Q_Zrj?a>6oF0{=Sd`jjY*>1797RieVRZroHloOism<+q%i;*j7hY zq{F$YsbTgU-t{zX5Yrf#08eFaDF4d!TOxSZYHYFf4d`#E2{9qL9tP07tCOU~Xj3#z zS|U>%ez9yT=ZF#a64~;u$Mi_AThVAMTer&D+oa^l(4wNcG*r>8TVY~}yUBc5R5ul( z+-vbeNKREynF>MpP+e$rKe6a%Pz5+o(e{ zO{<`GT+FR6DQ$UZPIFtU?ObFu$57Ff<6p_}Buao#_Y8)v)#%ef5xk_Kb`T^ExC8%%7!nOhks^PeNxyHm>sKh0NBh zO89j|EMzrQ{&XJ+nND;dguyJ=Pgnw;WN-5~2Iqr0WO)*ShJ`~rG4+Z(}qTu!}sT4G(q)`M|C?Q^^ z>b)`}0+l+XSQ8AV;~GE8{{ywmWGr}&=W(FgVuRaSY0GN1R#L~lyPb*EAL7h21H-EF z4|M|dhIbyofidre)#IZZIc~1!E%+|Zu}cZ@785 zW1Kd|t^*h!YEL8>VOh#wwWN2E-#P~38d-Wf_Hq9l?>>N#Mi2ylHrhfy4hi>B!t8$K zg?bQ^vne6XpMWDP{2c`C8I%z3Pe8ACVMB4aeKsXT`xBVT`+NW5`YSfjV%}azrB2+c zt^46(W|z*BNQ}ib9>>9*qD$uHaX}kgv&tg_5{~y3TNXJ5DGlSv8k*~yh#9jK=_5L@ z;i|7gF^@@aqMj1n8M-?BwH)y*^^ux%h}pm#*NDlqT_z0L6%YmiI(KkCj9m|klQ$(3 zMpP(tctw?fGPH5M*UAUDI-*UL!<~D@8H~s^nXBaWjru;+I zOxuEdh!!*94s{}1@kl%h(vqco0vU_-_Buu@@S)faq1}VTCaF;vCbf#~_taF@zo+A> zC&zz~+VE{CG_1nlI^yUkHUkvLOF2!DFjA3kBWdQA;_GwlTfc{?nRE*_!pv&QQIvlJ zp6q`|k?$HalWNJ1#%!AoQ;s5yLxGP8=-s-R!kzH9#4L8}S6-W=gtP|<pceJs76C9@Jq#{S=1oGI(%rE9~!pgR8DbwT9Tqt{Wi2 z`%Q6(9n-Uv`dhS_0ZqrE)UUT;oG@dSvh~Vz{O5fphW(*LPLq(J=G_*jN)LnH*|-D??-Qr zIDW@r+$oKgtufMgXarF=4I#5RA=}(d*7(^Bonus+-0C4DEK2(uywPH>ex;!(MTq+a zmr%!)ZLn;+6$KxYW@Zl6|mFsZ~!P6OApAvfGB+8JY%;;qQ;(+FFzXGFRXWjd+R!xlmK`82BgpE>x9qGTa1h#6L+~N= zb`7BqLc41SIE41p5MT(s0~54{Dua)`IWpA&3f1IW_OXt#y5YOAsM&fU`yW99NXDJ0 zbgPD!M$bJ=X$LwmGdgId>d3tKQc6H+7shH75d%{BX@tfU8v#k;sw+rB-N$A__S6`4 z$h!SQ_S{YV#v%CObYZm8Le zm1b2xG(i*{?e#gv8mI{TAHTESLe6VVYwJgp`bUyf_9v;@d!!(htW3SiccSatyNY199HJ zp_2X?M9r3(NSw&?q@#r&Vw>Yh;Ch!CE@K%&(5s{dH~YJ<1}5u(E+<_(ldZb5h|N66 z_Q+u1UmO{SKo@e-=b zVtu8}?!j^uSEE7^x-eG=mGFLQzl00I`^@5m=S-We=Shc{gy-fQ1C?<;bi!5*LpJ5! zWE?ry$vhfW;TzWl=FFt*r%gDAdhlzI>gD5Y3fPrh7it-)`UQFNY|{21xeXlE~h%5w$PKnx|$Ynq|3t{Mal+-?MAIF*WKX6_?)F!5lRLvC zSv%ZT#fE2|m2o42x26xsRz@1Y;8lok5u?malP1W1blIX>7o794v(4k zk-~&XvD>8L)O!K~NV*;`>b2GbD1>Fhu0{i~d{caCu~e8E&6LFuTke%(=kM?GWdl6P~3U*P_*-=AEaWVRV+B#`5j^nWc8kg zSV@bmCyx977kFAQa7hC`)(;$Ft1LU4xYpY#&5Ue4g71g-)*MVrINqT5iNZPYNLA}=>*Wio6*#X0!{&x zaX*I#{IZm~L8ug45D&&dq%O!J5G>s3;S#}6 z8m~u_G6tpniupQ5)o-Hg@zV9osc$(8rBDvwL9hwv7ryCE5m8(v|f zWC9nNCrR&+l9^jXinblEY`K$}iv=BSTu|qDXAy2G-2948Z6BfCo&Oe$3Z9w3=|ALW z)o#E$??PI*?TXA>1hQz=Lw@`3u1Is?6=61I8&6}7;F?_LQSeaqUPcK9RvA26t9jhK zQ5hP-Sx)-i`V2=aN4ff1Cj9bFys{LgxM|H9-}Z;-L@c5Oo44~axxn<1UPINn$=qp6 z*h^WM=CkYU_jo%38t`G6dkdx+NG>=11LHuZ;bw??Y1r-PUArsw6*?-4VViwAlJOQ) zt+JF;cuB>930d|>aI_N#qMR5h6NaEYVQpbZZ|1h;GW1u=xi+Z&iPJ-P;J|Kg60BMvp z`LgQt=NRhSj_uE-=$o`?VV`?DA~Q!tt#V=*k}&0jjBL=A#9q=n3B%N+9OdmO8fxG6 zQ`EM)VYK6lXIhBL?0>;O8j-OnhEYmYl-h}HJsP>W{_wL_>UphHpkJ&kCU_noVi{uz z_;c{iA94GEUeT*L=IqWM|6Ws2Wz2^gdK&6 zsBP@$82f3(pW;yaE3crOa&D+L^#_ZY#|${P4_(Wu@tyz?>0gxVKmJ^ykW24vgOqnD z<=_2MLcIHmBkWC-@{B)av^zZ_SQ3`5Vh3fJZumq$0rxPK&G(m`;7;!+;AURcPrwz+ z6g~fBMnBQg`x?MGL2zRIa6l4kBeY(F8)_hVJVRmKtQs~5 zSMR=rVc&SW?o}9S{Qz=p%LD*K=-#i`&k^?XF5+(EHOLpOhb%s&D^6vN^Khe37-hNO z+kwF>rROS5RNaa!t!eBOaUW%JeD-MbSaBDHdFL`bl97K18@p{6PKKJy_M`PKYb)M# zj3e1Xqil>bs#c6^cldnC3rL~9F(0r?DAj#$>lInn}v#(`*#p?C35e`t7kRkR)$D_ai`#7Ugvb2*4zopzT74%kWq6_uVN3HE+jR;H5JXVJprK#u#1G9NTT?~~wm0-kp-if^-cL+2PKmbG)M*dBy*>1cbnwbg?*L8+|W`zXhM$T|s4>S`KvtSoC zcVo|7m*H>1t9WeD0C}cSC=x=mDHH>t63p$2Lwb06sOA;qxT|t6*1`$lm3zt4!!dLh zb~Dgnjg`AyBWdl+*iDYc-fvJjeH$R!;1f~fRT5i)0n)ScKe}~n>^Ww0>kfY%HMX;eW47t@2&T+ z`%2VMbSm&RxVMa?wfpV2QF6WJZOUq|#z{ISOhdFy(Wwc4zyvEL&$5iHh#I>cW3LJ$|792ioAS1r@E=V0Ih0n0(|wvnEa>Fd_YbVio5nO{49Xa z;%IxA4#L^w{cpBE1GH`*iZSUd^^FJ!|BecB=&OsLqwzBmFN7G)Dv6!MN>dhWjACS^ zp`n~|X(BZt8pGdBr1+s2{&Heaoi}65M-#OM)`!Dq{X{gvL_%AA6HWBjK!33__IanE z{+En|ZOk;DGL5H9<0;d4&b}2hiAIL6m>NRVB*K~_+>bBcM7+3ZhP@p#=NP$Q&&vAW z5$|5)*RHENN8`O5Rudfw3Gy=Y&jnhM+^(+6nl1YXAH4LO1XX|HKLaw>Cqs}H7r#mp zl-T`%FwlM%qV_)qvUI*GlM%Y8s>i2W8H4AxK#Q^2>pzDq|G@KwCqZJts(jnAM#YAJ zx*wP`R~XDusXdbyM|Hy z%m5z(lNm4iTt^p*?R4LSGQL~6j6Oe65Uz)174IzQpxZ#*q3Dad(`BMu?U&I%=oETW zxY{nO8}trPPEvT+^T-nRVj3rSWjEF#xm(defFi}c?UYo|>^i2Fl(%4%?7~cXiWT=_ zt-!<%!H;mW<$}B!BcvZ>s_v*FyD_C&CpMW{!i2|9J+(N zALriui(_CQZ(pw-+19)t5gMLjuqhQ$!6X&VZd-eool?Q0Wu#y?DA5h=27c!e9gD@| z2aI-`UEP;y3x`~Uu65HVBi2z-!REYM{lrR^RwW+wTIJoB{lq$i5i4#DVeO>t%bU5r z-=NrTfa?9kAJ>d!JIMbi0(Z$WFDrNZR9}lppgRg?x9c)C4gD+>$IC>ZGiM1FaeqjW znCNq~!|cG3@9_zhkSC#$cRFwlw9jh?$Td1*xpXd{;1rFj0?M!A9Pb9og;6=jKlvT5 zp+A#para4R*2+lVNY_G8pLd^uFG!62ncCrsR(}W51|KWI?*|B>#{=B|>B>ud#+k!u}yQkvMUv_8X&r|I5qdU!)Eq31^eYGOw z;C|nP&GU@Nqc%f}lz*}H)BBBPFSACrdVw23(S7m5P5b5wXg>qvc3$%#g0urfBTcAy`kYnXxXw$sY zI?ney)|OeUE$AZ-0##WDCmk3530MtH&8SS^96x!t)`V4uLbCTyGG8+Y0;$d;f?R!7 z&7cejIWBnCFx#85JQ5efpkqvf*P@sI8K8$3`uvB#O|JS?rbMF|h-D2qNiV8Lr&?p> zhA__i17(SnV=+0tF>BEgOk+7_xSz&6S;qQJVZdNg08c=$zoKZbH%mDJfm+Ou`$64? ziqMogGwF?&RsVo2=ISh`UXJe)S9j~A52Vz~Lav!kD{D6GQ0a_V_~>SbsM z|6~#Hh2~T`++7^iY>mW=@s%f_GO@gyo5{PzptPUS3CiL^ved&b(Q2 zMmJgpzT(Ic{-h&R&gmMHa~^W&GcHS?N*P^pcBI>IS3fReUCPVhG-`(!=){bUvZ&&_m1m*YY^d40rP%EKq1dd* zrYl;s=3BZS!Ez8fX^^LP-TP>3I(77Nd@J%*9J7Qbspz*O1-1I6}(omOfBoOzcn>&=dMKXjF`ce{o~ugIu)e9!G3V z>u|@Iq$Z#g@qi)GW-2R|(=R8q2&>{7+^ITtxq+ho=(=nQAA#4|snLoqf))e$@h$)) zXI*w1?$-UlD05nely$jcjIJfVRqUQ#e(f$Ki1==FcR#ND<7d=H{VJ8g65s0mifH|` zJ40vl!>Q*1C5^{I-kTMbAb*p%O6m$EwId*sqCx8ZhOw><4~ zd<$9`x~EH79a<~8Y|?SuApRLI+zYf~XnYHuBqClp7O(uZnj~v`v$d6(i%xNC!+;B! z$UG=n73I$moK;m8jf_RIw#_WRKKUNJQ`Sl`<%57YnyqaZ)wC94$gF5>^Epo80o}RK zShS3#^&v8pj8M9JPxM9b&ODG`L|+u|d;kMwaVWe@fi*jB~*=Pw2R$y`1N>x zLh7!ze&V)%Vnds*^;1s4Tf)32MBlZf*gKAD=%V^u#X66JZEB7|>lMJXp)>Cy76(=F zZZs&sz@BNg9zrzAnWrpADih4Sa~J@uF+@1)g}9_-AtuQzM5nQD6MW;fFkP1VgzPT< z`FiQ7WNneNPt_QPK=L(^^{UFGA<4WGFVae9u~^_+IUku*TlrOxxpK`ApIL~U<~ms( zMq$VK_%@qtJ*8^{G3}q|4Pp;dO+%ByaK3lNw>4E_3Z92_v?yUWsN0WHQ@}vE>Q2aL z#9ROkdt8Sm?+bb5*WvjmI!%dXag!@h2uZN)5VtAex$0?tqRe2XLFgJ`;{;XFwB~yHvt(fq)ZnE18V{DL9IS`7pdP>=0 zWPAkR0(~RV;;C5ltj6mrVU6`-VazGv?d)^BZ(@zBQq|I)HIJaALp&@#$Ekdzk{pU_A(_Q^=T#_(LIUgbdO8u))l`XJuuON6k$Fb9Y6m}r zREYlDlpAAy?tz%Y?84ulLU2~aXj`v&u&M&N++`M$7@jr!VjHeAs-p*!(8OqZO_-(L zgBoTr-D|kvB0jL;^+Iz}07aEa(PrVCcROPw#X49um0f!DW6+izJ!n*T;4+JrLK#4` z{6s7u9qpPs+Qi-nVXD|0C8UeJ*9v3Y={P-Cei<;x@?x*qVN7&H3Wut%%kVa5DL0}= zu2;!brt7cRNdr+XP%t7_xm8blYVCjqyianrx6=p1;)r4Q;$$h8dvG@^S21Ff+vtuB z+7Gvyy7GGuJ_AIK(-c!fN~%V z6nmnCa7(?|6Cr>G!hm075|^AE%`OAVj})$}39YtXticN)CS_h+GYI}r-iok{^!psA zE%kF|2YCa-nlI-^i|_l=5>AxGRwmsJGBAV&fJkh(Jrz$$`~bY|MAPIud|X+0li_wY zXetO$buvvLH{<0-W1xt&x8@qGH@|mH9Q_ab9L)L#{6QFAGthZZ+AsYm7$%v7*n}Tf;N7Z%DFv-_ zXDszdH)%By>CS_~nMnhL^WM)GmDhw=4yNIPS`$J<*BzJuRXuon9?)s|RS?Ac6K~RP z-PFCG&{`T1aLx$6j1K5xD$C{GG>GH6eBPtlae`>N*bcbaUwyQe%oU;%9H!D6q~jp4 zT|T!>yFfe&KA8ov8=W_O-XEc(Zs87}dyU>F9sl{RPe5<6j+Y3aunQnC2#GnIjTYl$}gzJ znI>U$C2)otD}ggy=Q`-PHwEK`As9IjBg0(>1#e|fvg7NTXpD@;$N>;(gh*r{DJ;Gl zaw z3c5~55HWk^bPd{?8dww?pRQBO|q!@rKJYpmx2{)W~10Be;)@woJ#dR0%u zfiT67qV?cz&e7pL2*s-Pa;W!kb}f1Z(yn%`3GYb3O>Hq5FAL#npGFsiuL38lg0^q{ z?4Sem{Pd=JfCI z9J}L8@E)9GKn9kX*+1{!E+B_vHoy_qcnkh3WxV53&1MTyBb-YEEsG6`Tc=}E12K^!jdvoS8$w+7s zfoXcJdbO8OQEar=t9K&TvyFKS8rUT}`)3OGUq~@U3%{d&+<@0F>w+ZJ>FBUxQk(4& z{F`#uYRg^@b3t}M182_h?p8mGzN7s=yrVd1l}*N5ID!znO7*b)+`b0s(gKB)*FfT% z?foX`U7FhEbZiz$0cMQlB&b4Cc8BaxWNQaH+#1GPd;jw#`UoMBjbsKk)ava(5^5ji9$I^jgg zJ1gOP#SW=KIy%Msy4IA@pvB$(6pmvZ@-F2j7DmcbL?A5URdsmzqSE(AB#^r0bnI`j zx+8@rg(4r!Qj(v-hX7>#99R8Z;c7jli}i*&{KcDYTnF8G2FE8V`SZ?K$a75j7KW@r ziC~veQv=#q47*&1+L2dFK&*${hB$oFEn&Zu-#V-GTD)S1cUpA*t8`>*tKNDjVSmY2 zRZYlP#ZP_wt9=m?-EGM_@-#JGP#Z4|Uxn82N)*1V$85RE>Zci#{CuWE=y%5N^&V2} z($P3~(b_?~!<*BMvh`Szlpb1RZL3Z<)mTqer-y52|J<`9cVj>pTqK7SNqVs{gly3u zV4RiO;=82KDLQHhyE=s5fZn4@0pPf94K=b7{+hl;zpy{}d_}c*^HGtj9_OGFQq<38 zx|L|XUcGq$!ywH68skyEc{(7{%30BJdL%yc!#m$aC+Bp-kStR|55M+J_*!X7=;GJ? zo%|f7Pd(4!Y`yajXz}(*pg;W!6B>#v2dhrw1`BZLHBt)w4`4NQm{yDV zB&+G5=N~XA!S6{q@Z6KzIUe0*8oI+#1;QKP$|7mj^BX?Wae;R{cIapiMb3;#Anqe& zb_k=%S>2}ae`2c#@A^HS!p<~FQTBc(MqEC=+6qaD$#{y07ZWfW9pADXk-9JbAoWTu z@vZSk8%~G2H(kYXVO-+yR+=ZBQntc7Uq@uM$eEo9nO)L}@+hgry#aGcJyND(=azGv zZ3c6kr;{}YH>vlu@J@7!PUeWKX^mliB*1;p9cY5e-uVrOM=g%9j}!E9ntl9-K7M2$^&G)(Xb+F?O0dS1>m_SP?ZQw3n6QUVnVd_^ z?7m)H8;^8moBycl3rWZ-=Zy;O0#*M(2v zf!d`jAEw?%5E6!)+@Nb;dw~`yat$Kf!@{f!!v3_U{Mf(Pr>#ebT#wSHmcT=?xN;uNv&0{5v0zH!$2p z$xNd*d*FK_p+6ouK)q71GSA$BNo5Sw^(yk5qH!RlPdZ^8Q z6>_#AUz4H5`>`fvVhcM**8-10}YyN(>7tO_C-kx>?Y2#*0(QQ-GLQ53M# z7=TXBZhd>^Jm8Um%~GN2lw*I;4n_^p`Zt{O-?t*QfyO-%XI%VIHn+6nGoJ@$hW9&m zEz}<+8LK=~Ii(C}+QNnO(!eqt>c zgwQ;JV>{{ztJRVG&f(9YJkYBzA7VKYXs)^q>~>xLx&J+FSWa2T{2d8bAJbvSn#s59 zOEL=YB=N$oB$x13<(gY|R|8l$JKzNi8$<{Hiz7_g?vV|G_6n|}^q zUu6DQ>Ww#5ox`ZXgqUXX+e9CxUp=8X=!z2s*a41t*DYo>FC z!avkAhM2{%jdYz9nP4`w8!GP~-59Ob=i7e%*Nz&#uDPl*7Xr`2w5zR^UpTt)d+$En zCq(gGI~R79c4|HJpyzLR6>ZJ{7|U}3xz_u+wui;8c$U*l{EieIQIzxny9ivKec5f( z$>}5cos~5l-Y`^V!4=;meFCde!`BA+@sTyoySG9Ti1}mF_?_!9Ta~qwBQM41gvK?e zSd~}NHdfGtm=+0L;dczeL-4JV4h0zJ-A`lXArRPvwP(dZILjo5i~^)`17IBtsZ8Wn zhZTtx27`7B;;YTZQ-CM~aXvXMMx3Nu85y|s&s*aw8L1MYoO)SKiIzFqC-IF}E?o4} zBkwFgq^3iLkyVp&tvPEQd&Cx>r^oO8lamvSrx1pxj{pt4b3D2+1ZtTAK;nGk;TP)o zW1tRUxV-YRJZEH4)gJcTo^~|WcqMLfhRG4B;w6I=AuMh9(!lR{=juk#oZTsBn51Yna~`KnILk@P5jg{fH3X}K$$2A8&g)@vUYjcJk5;cr{5&wIo-{;U z#z=X(S$68NRnVlII4ML-;2a^)vW#KPM8?u3g#^t;IvXgb#j&e$*;~iCucT};PD{<|$(*>G%4YHKkZKn$x>EH{S_tFPS7~+R6*x`44 z*zj$%B-4rQr;yVG?ORrLjz_~oI~gGeJ-CrcT!we{*EvKxp$@!Fj=}~S_l2QSQr87ZLJNq|&T!-|myEoV*vus!ge+t` zmyphRrx(qt$?Zc(WS^w-uL6AaV4Nbu5vE(zXa&SQq!r$U^0nmxHftg^OSq?MZ@YT( zT)4w^0j4hQJ(={6=6}Ei4P>2F={YG(e2WC-osGj0lyGB+!uU384L<^ z)TAIY~ zbm2yt?8Z&Bgcf0pJFUR>p#83I@f6G!lrz$M z%w4692)_=Wc&NHWqvFIvaO{MIJr#>>IY8cM$*1t|1p|2tdoGcqv$n>2{`@mB4v;dB zURK>>=mb$tRzw%ns?rVqQqUJg(L-E(xMq< zg3*nF9BKX=E>y?R2v$eHJ9GezxA#+g6ToV!nWb}{lp2KXmAzwy`zw3ng(;Q2MZEJ_ zq|;tI?|cfkfOSa_RgC->V&wku^Ojo_C&s z#H6vj3(q>pQP@j&s;=%by9x!`5&%(?rE{mXCWZ6s8*q}RhNy#0nHffiyrg*4ckq+i za;`(wd7bE=L7XTVk1z4-bv~TH(e7%TK2j8&)k6G?74orpL)>Z4CxxvX#_wwsl>!g} zs=mY}KD>pFcCpq`{&?P1O;QauL?=Yh-16X^Yk`wsYyinGr#%G`=B4x0o)d2 z)kI+}Y8@fozlgVDFDpF_xaXW20%a>#`4;ld4So#^_tHES@L7|p0}g}Lhq8w)yM#mkBE(W&v87<_81<(`Vc~%e=+h@X3`?$7}$R= zLAeJM8?QH8m9=3-Sq&N(@;=TX$We4d!TYc%R9zx2nieADsxx$&T4WERVs)rI9QnM| z*wABWI2|Xp^9}7W;U~fyX)2(7vAqIDD7>-iOL}VS{VF^mvQ?GfE%n|vnKJPYQn&mE z?K|m71rq0Xo>eW*LfUR*(QoeqJ*`Gp9g>z>)$=n%toU*FnsAV*`-$?k*p()(l78#( zQ3bj?17?U*+X@;|*#nb~p4yGVni8YvuCp9=<#Ck%R=CQ<+l0H6!I$yDOWK$dhG3LY z>>eb9`+ZV_Y~(9`RA+C8bi&)NtVH&AfC=YDgzeZ;*>jsPKujjnvg2j1Th)ymo!+%s z%3HmvIojb0x+ua7!El#eFv5U&J!v%| z=@4-aBF=li%d#&(KechtgxPu8k!`Vae3OxTi=0IwQMcL0{7A3{jBX~##9pxxyz4l} z&So}n{_A=7(7m=XvK}wB7Ioqss=}CBghmd_tOq(_nr|Y;k<*GY8hPR@ zx^C4}9HGQR$7d^V9P@8S00&dsAOycwP>Z0Zdb@1OmuK*eV1+2t+?1l@W_q9Zjc35e zo32%Qc;jvj`ij2tDbgU%fj>Spn-BX~fD(v)vbW1*(d+nO?TYBlqqnz??= zb*PIObm6ak!7@x!s2R(6TxigG3DFRH3~%DY-DfeG)>%h59pN2@jYUR`{)~6)SSOe~ zXz@YkBPz?0>tZ!{DO#9hJrIcf1c||?t0-!=wvd{TeL$bxA|}()<%mmU_aH|5tSw?$ zOIUfkxa2_P6z{ue{-2>dR>_1|N4upSB(BZ%K1T~XZ*HK2;D@r5b4O85kxLZ%wl(lFoWjBJ;geu>l`B#ScJp- zwYnF&M9r-U%}5&SxWrnUqx61B0v?{NupdRpbB^F{)?3QK3nccwD94h7?AN9?soK;N zs)v|H5y~s=(1~5|qTAOT-YEk><|-E7RM~(YW1dx){iMJk;uCMoL>iN z(+)+Q!)XI+kn1GC9Y|`!!Z0n@F2*z~=(#dnv!wjaW~&le848JSs36>BUAb;YXO4E0 z#J#72Nf-3qnvj`EV>BOJYnPm43xo^D?#TKM@5 z_xb$n3LmmyCb{4Fr{P(RI6{Ue(Ki{Ziq9Wc!2mX_ZSa>J08rKDt1bAm;@Kz2T92ky}6Nh8>%dY$HXpmzu zHQ}gqynH6!5QUZuYbS2hb|#~>oZs*slHFRAlj<;QEtX8F!@qJY!b?mutQqW1Gu0V> z18~LPYcWaAGmII|iedArPSe)Zneh0d3Fpc~q;s`smaoIjirlOjwE_705StRB0MGeC zNBz>}cY$sc545mQ-D(p8dm_33wFzM=hF}yuuVBBTutjusMiXI#=o}DXa(x@C0hDK* ze;pX4N#l|uQYzED#XW-_rg!B)f>%jmfUAC07>zZIRg2GiiEZr72+V%P_Y>Mu@?g>* z5k^+tb(?naI?|oL88>QeHn1lTa8_UjXxt1o3%p7Y?H|roX+iqRF-W_4p>iX$gX7tn zR&US7Y*p6*iHa=$t6=t#T|}@lPFU508xz9sK&Zvv+ki8kWt?#&a7L&|7zR;4v8X{1 z6@fN+%SrVH6fqgiA^H_(?TA+Gagh)u=WF%m1mRdwRq`ZA%lh7N(0h=1X30@;5JMuk z*bpH#9z8vym}8OfeYBmu`GW55{OhQSnZ8yv-P|16VG{cWWK~@6&rV>Dw#&{pMms|T zd&ZQ!N2{XkXuH%Xo{enyHYDMb()nUC7lVSe>{^7CINSgcLY&(vD+{G2#w|6 zX*t?6bwr~I$sO~Q&G*(dRJ`tIO?$1}v|zd;H`35{cJptpA^AMs!!M533Y zJx9;XaF_Z;6Q_T+J=Kcw_(7vOaCYG+F^A8X|_ zXeOwUZDe$~IB_&Y9sOEzp(Ay}StI{WQ+0#98NZJ9*f|`wR=qI>x&Cz9joUF^84u#l zEcT3r^H7L}OoYk61?HyI(BKI}(*3sKYoigN>HlOxf|{Xt0n$ta0)oYQKahS!m9VKJ z_BWgfvsdCG^uz!x|KKm@M^ytQFv=oRyPtlQdp`}L2^DgYT!{sWMsY9zkwwYeR^C|= z!d`>pooTp|pd7IGC=+{JXpffNh(O7WNUppGM6~E%X|lM>;KZ{X&Trs5s1~RqMe5^S zt!M-bb=FtA&HxzU8mcDeDD#kytlW#Sw+Z?T?}?^Rywpe=ykBrMc{8RZZp7+%F$;w~ z%6+ukrhJ6P)A|4kX7bfBx}dfqV{$)1?BYS2Qb@V+f}ZcWD>J3}ZX~Gg7@PYqn4jO7 zZqQMbxEsGYN1CkHTz191M0UI@lPH)ZJ0VK#6z}>S#MZd+L%Jvt)m9Jm6r#O$M|vo~ z@BTPbRbw?$oBJ4~HBF8)aWitI&8WAV?w5jN-FAuxeR)-~h+X>*N@6p_FjI}4gzpDoZ?^mgPST#5}8&BEfSWIg8 z_IhtCizYK&;}oC_p~v&p&sQ?uqo<4HwL#QS>1dJH;^0v#6D-&HXts)b@vo78@Z)3NBdr8e~+kaYw)Oxf%Vb?IoBrNbTc&_vG0@&B*QMZ|k zNBRO94=C6F?4wuLairYzBMg!^<0O(cBMo>KAZCAsiFxjWKu&-jp<*Mh@;0r)4 zL=(Of?_?Ca4ZL#?1wwh}zbG(}cfL%40laf71tNLppCLexeDcmGLU60caXkoB7nwj6 zV>t*Sm5I|HSdv=sV4C$UTX71#w8DQzVwB||2vVO{mNfv7L}Dt|cZ($JYy8f7{+;@| z(S0x}cVsv4?;O#!){TWP$k1E_Q*vjkLoa6^+r?3w<9*2%SLC|D@3c17VHCgf6HITT zbjfDmcVr#_d7Cnqy~n@)ek~j8gViDJl|EGM|>L+iEhmy3>K_ z$k|W3?~m5i#z9Jai!?kMb40~Z<1!nbk*u38UUJ()q}X8;Wo>|_)Q!Zji>xIFi}1N& zyfme<>=d_plx#gEw)4;j$a}zYFrkrme~Mc?uV=p`Tem?^v2mblz+V$BkL`8iDaH(c zyCEa-N~sOn$M4L34QRGe2(uid&8MQOve&o}#}9H8qH9d%R;dj!hhGJiVtsBc7TVsa9Wv$d-%y4i?9jzr891apDkfaJ=u@Ei7`wu5bvqcE9& zy+!(9%y7iOstC6sE*ZIRc?#a)j@Mg!@XXuTo4N@Ez9W7=u%HHg6r$YDT?l2K;>Fy9 z%D2Z=U4wU?qXCy=v692xVvinHU&zWfVZ|N;^XW?@H1KXTWZ;C}@GpuavUL9qSur-R z78{+C&|F82e-bZ(uEp-lv6w0~jETYtA$}Wj^fVD#b;Hp!WAeN7u}JYun?=dc=jbBY za7O&+Bo$6k?t=EB_?O?wBtW{mGa&qF0_v0R^#zP3ybStyV_;RX)O))EE0*Pmw?oeE z^nNi4MFkIDNI0jUfeRP{(^jTZICuM6Z z-bmmVIWPr8=N25BVl&;$8%q~qm_b=_;aRwv>|@R&yz>kOtzRVZY**5GL};z-`AYcU zW$dQofLK=V6D(rc0nRZ-?X%^GZOVd!Oytu~@g8fUv~iXTQ^dZIid&%6xKlRe z7Rccqc6YVtFE|qm-f~ct05WhN-l2P-$$2;C;KZ^P&SA4-7;j&B-~-KT_c9$RZLP6> zBxRebLqL-tX#-e|0<7_DLwhv8BmWCsV_*QKSR7E#1ajz9;rSTW=kia!id>G#V1A*B zvMDK`s?YX3fuxI#+3zph_`a% zELS{uy|qf59`shxrqZ>VL^rG^`y(KlAc-zIV02^qgFghxb!U856A&|6Z+`MThyc$- z3vJ%d{)>&}PQSIeo2~bwV713Le21d}1^BXGQ;AeVK}MD9SDdhOTanM1$*2;o=swnr zD)m*#55E}7J#@8>bG+q!izca9W*U%HF&LUC8#a%w4>E;J%&SM9yKpP2c!?9SR^GXf z1pV<4S9J+%;5XFKB5D$q$Y(Al3y|PmiwOxW($RM@P#*4nhHD4)&>Lds+C#Zqw*hr% z&X%J*a!k7@b3BaY2CGR?nJ8_W?W^sy6gY-agx9DY9pJiia>a@^Yp z&(1+xr54hc0gbC5SHtNrsbvOy?82^QcgV5tY{eD0Rcfdm2BC|sBN}SsD5}9dELyg9 zs0HPyd03)JKRlYq#~pK>*1Z|Z@+1B=gLnQ7#RQGn_vln+Uw(ky59?BN0cL-QjMa!y z=Bzi`-1pgexN7S;VJJbG!0yU-gjbfG1NC@{x4kKhQ}6VYvz0^|Azn;J za8s#EH{xyYo$T62Ilr@NKiVisd$r;&g}94s;=-NUnsF;ZzL_RD=Xm%^1_wpRux(Rj zf9dnh5feFKy*u56Z_X5KFyyAa1sH4AkV_*bW(tbXj(@aja@rt(y#inzU%K9bE>7@b9J#t{Wdi*8|mJ z5}vOhdv`QB#YSPArCz=_GQ35O8jaS~cJWKI0F~L4X&?D~Tcc5dZ4ZG_an?5*F}oRJ zgtz&3je{ZJt*ynXQ?e6{SdH{m9e%Ev!!|!^u`WFRive_7aO|~ zaE>JbgbEbI*-g>h#(q%o)B6$(J!Z!b9D3myI|i>9_Kp39{mVlz?E8#^Ahr&nLl~afYR${P^c3Zbp7ZxYoa$s!0;X=C`6X%lk@r_IK|v~dhm`_r!%?rK8U zKh=I~CnVG{1WI;9U|-otX}zX{;&OI$j_XL4oQXTP!c|2Vb(KEpoO^}NF|bA_HiX<) zt#^EjjN*-Zyj^tY;tdXceo;2_RdC!&nv8CGG1F#8TNwyxDaykiXhK?h6}_i>Uq+V2 zaZDBE$kD9WuH5O*wVS;hT4%-qdzT)dt;0DdD&cjA5+;cL$^Qfki7YTJ?Cmg2dc02S z7|gzaYxzCOjc8Z1cFmHryZ9YxF#BY@SV#I4?>d=ofT`Fdri z%y^i(2W0CpDZAyFgzOf{`i_)c&p)}H7VCP5SreXMJ-~}7lF69|#y~Zhr$}G|KqN9r zU9hkQ&(U~L1oI)XRh{-y<^e`EmXqp?Z(*c!{2-pgKBcpo;;oT7qpD*Eq%FOpeMnh{ zs<2=tR@a+#dc_{)Ft)s zFaG%7dtNb3?X?klU3&KzhXN&!e$A-;g5)?Q!~d%O`fxw^|aj|I(3%q9T2hjwqq707CKxT1M@*@uKI@S!W*r8 z+*YK4Zpb80ybOP5^3K~sg2XwKrn|qso8%SVbpgl{%B7$reNsnfLMszMw0oCHfzsyA zv*<;Qe`~^>2dmv)2qDX8uqnj^WUgaSMZn3?MBo zgE^h5?7YM_4tZBXKptFmL(OKdA1y&r)u3PKoiYule2+|ctRd`4G_cZMOhGk1!ZQlj z$Rp*Zizg&%i+0KX9(1bo;9b&c42r0!d+^34de12*7>_>yJv2GT(Q^(SbiMPb?#U?4 zS^U;=GRGtJ!Ki~`;qV063WlR>N3W^)h~&h*_}9cgiB8%tbDRN)8DBkeU04VpNSP}i&9b)xEkc9NV#~Mg!IuIN(RyY z1D*B`@WCT!e>L4sa-rfYvA4o=m#^P`!tH(P2|ZjafT`S5{_D%c#P@!6nea=%>dR*V z+d{yqaI&O*gzimCk0;kbF^Iw_13lkX=-j6rrY#AGR3eX0XQ3>L?@ zX5;;;?BLzr&&|U7H-K{;^K*IUB~;qaT;FiUSZsESm~Nw7 z442HZW79U=+jgQBc;)swo?4~3i)+gFnu%ccTQo|%>oY|6c5+cr4F!A1P@rz7zd(ip zXRx8*N!3trz4N4S6~Ax4O&LhQW;#rjy<{ZlKqEoG0m6-;#3;67ZlN7>jDZoeDR=+O zw#>Co%;Kx@VWP9XGf@}rh&|uz$ZmImvE;JNe@0m?P^!?*Qsv2(~Q0=rQK0bt-0SsND z-G8NcJ95X)e!JpVVdn=iJBBb^t*$(Vnpi_nssSp!lGSfloB)=$;;#77Ad|uMzqTJ9 z8MJ;~AJ_^1B*-q%5^NWsjj?{4-yhdrvG@HKAJHb;#5eL!zKfQClPHAHg^z6e`__N? zx4*vv9qAX_-7CvnCmjpqSZ$lTRomuvZ^wP%897SoC%?W)jc-J#o79rSBn*&=6g?kb zR!_YJW|OA@;_&t>|7NrD7TbqjAGBID_1|emm1raJPP}-pn5&I$M*-f%?}#$DqaJ5d z%kB+K83W<_UDP*lK9}e`3*+AzpB!cEoU&3^$Ej^)i%^8_$cCWcR zNi&k^R3;sIa(0M0HND1e7H@cDf;l{M$!BdvB z#^d>_FYs_e42)B442@Dd_RQL0D~|MS$FLGfxA7_nyFPIXM(x9~;l-P2X~EHx%Q~jG zT^;_uW+|WIdso&roBfY?9#VQ!dr0X?JYABo7qjxN|1jR4;OeALH0SHLDBt7Zd8}q? z`Uns@5YrmeD)dL87-&s`i$PgWybOyaZbq~_R!@Od+84^LyvjZKPljX+uDGT-6#3yk zyc~oO1$2` zN!>+btQ}K}>X6`n?Mf5%+3r>{;-hF&u@5cW{Q8IxErzGtAXg3udT-tB8cmYdAx_;z z*|SHJypFrKpkq*${jZ4U5pOUbsPfz_`->P6twm&H*G+XGV4-_QqBWi^_PE2S)b>?G((TrGR_|0T-b~b=M*E_4lG*##Dj1 zA$bz9{VEs+b4L`SMD;!(e|DR){B_26KTww935>a<@&q@KHbIo;xBV^xM{#lmk9+)U zOyDcONgek%Eh1JO_psMg7uP5M#NPd&A$px~n2c}3@axg5$g|4tNg)$g#O6v}N88;` zt2n`-OK1XtrR;%SxSy4{=8e%pN>%_{xr*;nU>kl2KH<<6IHQiV9bl;hK>`TU39m=1 z#QQJSfEub?b?D-Et_^{-N9*I{;aEuAALrf_jXqTgM+HlNyz)DJkbVFCG}=O*(z z9|&=$=@QNND)dFfGe%IP4Q9#nD@(Qu7@2nD+_m#9m!ROaFGdpT_ok?m@8= zisMA{?#=QEe;KW;rm|FY7Gv37*2AaE9BMtf@kq@xu?4dQ zE5NRJc`Hq4>$#fDbAC)$Iz=iNg7j;Sbh~JHSn$s6v#77@eTaWjKLJ^Uaga?UA*gBR0PT+eQYz2l6aTIQDmQ^ zvSCSAh)N$v3%e4_x_A-yQMEbPbM)IfkN0)Z;WoKuI$!TG@H-l&dKQzB5Zb_ubzSkjS}g<@ zX7-&}o!UBel2T>V%J^2dGmNXe&g z{_qTwXS-&`Op%%z`mQe$D*(&;9cDS#WI34d1Hb+bWU*_l@HgQEzb+YB81gasfk?y(ADlszd%y2hO_7)pO_BH;ox*GIkh67rOR{LYn;V!J^<5%U(| z9+;2viOtc{IdLxrIq#t+J(q){U;20G&1NiHJ!F=+m&RbGFd78&gIDfbV-e-0MtsVO z^6T@wF9P^l*25Y?M|CtvfwXS`dL<4r(~IR?gIoa^JVma$lz|+R=|)3M6CBAvFmV06 zX@b;7wrl)-kaqZGuy%+SA%bL#orn3|`5D+^@HfyHi zR!#lP2addxo&lq=AWfgSzDoq&^V;R0>u5Li_4BH6_4PAauIR6ZKB8Vc!~|)#YwRzC zrN6x47eO3h+S^xFlY0y9Q!(qLDj1#JrbiHe5-oJwwmB+-WNtzh7y8?yxlip(+|BFvmY!wBb!a(hwJ#0HxQXeQeaWv#< zHriuCI2L+X-2_!;y^aW<7sGBxfu%!D*p<>Sj`Qxy7LzfJhpv?`m!q(lJRHHuv6xey z{DC2DYC*S(8^lOt~VUDDet{T7^y{| zZkw*5-6+Lk*oe8kP1<8I_A^b@v3GGdBT3XELMICTPRVt*Up=laHd9gtv)j;GG6N2Q3*zjg6V@eQ>}tQ}%97SOF&pU_b8jkii`-rLmjlkPXLmGqc3 zJ1@cBJ;*SuJJ3)cz3#v$ToC2yCaH1Ve;OL1*Zs$GlHc~h084$tmjfD34+w7wKOs+# zw478^!%sALVrPf9sE#<9rYu?KhlFm!_Zlom)V%z*#-Wyz4edi4JmKLd!dqr*&O35S zWT4FTpiZhrg8z-vP|28;0G2>$zyIB7s05vcR{qjysP1@Y+D$VaF9Ml{ITky2)4^>O~6tw+D5U0|sd)?TQ>`>eLr zZ?4^izChM?y%Ax^Ws#Eg6yUrj^Aznl|Fiq(w-+1C9PRhCT7a@TwG(JxnxT`p89ucp zvwcL@Q3X?vv0Hzy*rf09IgZKs@V9f?h;vf5qFn7mv)ERY@L$4iy*?a&vTVv)5IDEa zKnJb^aWJcI=XcaMwChF1-k=!dnD-W=^P1s3JNk8XV8dgT81+STsui#h)yG^zpQwJJ-iGY$a+bs1eb<7BFu_+sY zHtSlkKIH(aulVl)tl=AH9DrlC7uL z9pHD?*Bu~F)Xt!4(S_)QM%?w`Ei-J&)mUu{Rdk4)thiWq=`20yQ;V*2Du8BVJ7ho) zJ%a3sVX77mb1)w8jU>dwOy5Mzui#stELc}b)i^P>JP=z=u}@$uzS3E@k-j&f0}0g_ z?TfWl9!ZdZ^1L)LI;RM5=6pM)Q<1vcxSoso)s=tjPKw*C* z(b(Y2IfSIVE3q_-9D$0XeG@T89gAyUqPyX+k?8$HnWOO{G!My~YU@w+p;s3<1Z!7V zD%*hNDt~8-M6+O%!$5rXt&H)ljGke$T*#4!pF%>WE2q1ZqrIvli*ShTjV>(a^m9!^ zRz{A=@4VL0m6N3;Lc?dywkguz*@bWYw%NqanA-XsHy6*dlMaMfM zbnN`f6CO5u_$S+OS=mOdxr`2k*IaD7k@>&0L^o3uN{HlMQf#1ZEAwz0Hx`q`M#D^y zeJ~beYK)of7+F*sLM?&@iuGY)d$)V}Ww+rf9bH~ghnc(^ij8*MK~!P^R915-3PJ$PX6XZ|VmV?29?9RqunWt)GbC-5JKYR1Yq!kd%k_dS-U{ z2qR5~K}dq0zo4p%5n^{A@B9?{m?8+ZPZR&>;CDpJQC%q1w7L!w^KW2jvvK zhU@+7K51x-UiXRAV)2EyN+-g5sFAX@L#)@MA;j9Dw|0$z<>5htSU;c+VUz1Mz<`B{ zLGgaTDuQY<6-Rn)5sZ}OpuY+^wsquwHN-i;^if)}kiBI(sIQ+D}|AYGei_=^%+g==>G05L2)ur?+@7T)*& zpUGb%UDj?E(xwDxOXPF75bsLcMy_)vM&c&cwK5&P-B?TakHiMmppHX)Bdf~$G|(e) z=x*w3Wpd%xP}+fLXb-9D@=rrN0pzU-+KtdG&Mlm(e&p3@>PL)BX=;VZX;~S0`1q9S z6CqolSa(2d=ZnN{gTo_lM_o+n()!<2w-wjl9oDUNZ>bJ}C}%K#K|j}(-RLstUk$@s z>I|{Smp3vd{SuW}6DU#lDg#h~v!&<3k3qNu6>#0(#31CSR5viaI zp-p;x+F?cPxvu=YrM|8nqHDKO)8aq|a2wu3re4>nc`bTkX%E5siT@B;Wik>eu&%xS zGlf$2DLn{7*=_y27=6m87u7q$HdH}grL~*619$Px-;=vpmz)|cKN!OVwpv7xY>`(R zBz$nLgLyEL`{FTlUu@Of7eD(+b6<4f6?}OhWb{ z$yzUEA6S_pXCHvC5@Uk3rSuMR<{Vzm1}}L8tDQh z)uR!8*ih=m8yl=2sfSVi{s;eIl#l4HhIV&ZXHzJbt1P4U^zxYV1v_OF>?;^S1<+CO zQJ76hxyox7)rX86hk_5L1=-QAk_(RoZ2%N9Io^9#&Ih%nOUiG@v!O@j%#QH=QsyZk z6qY=Yw8Yn6$?a4!;zG{@BR<&7aOx{ zry@uDimnK~T!$a(3uoC4?Ge&fMta(ZMKk_XI}$#!X);T(7_J?S^^sLjip4OqAjaZZ zmfEodozAsLv117g-J1;^X|nd}XyjZcSB;t`_WFdu#X7gO*QUJjZ}Q)pHB;!&uE8f! zy|S#A^BzZU_ReTAxgG6cLR|39cmSsd_ZLUFtz9-{A;F56Im_`0%=Mz=>t!Jn{yyhu zt}Oe}BnTVG>6_cHo5Ild6v4KP1kxSt1+V!O#%?^r{jXncsQ*r$x~ zG1`BNctD*Qae^p-Ww)3uyws8t|H77-X3ccSc;0jZtxD(X2xEvDMU18^7}Z;@6gQ2R z)*-flpeX=qe7jGbqj#hEWf?|>P#r6%j*ywNc-M{OIfapOpX#F=jk)p0ky>nHb^-yH zz7lSzO0L`v)qv_OTqVb1nBTFsa&rimCearf(IC-|QO!omi!C($i*CdIkG3W9G`^NP zxfr^;&DQJ^dbG`tRcc7N8Mp+y8BRP9DTnzcyS9nVhUt#;xQl1q#ycCyhte!_lB=>u zb;uFdY}v*+Les_G=oRM@wqU%p#R-2)LnZnm9|v*GcF3il?zoV!ow96y0{*TDmFP>( zG|QVQdQh`#aSz+9s6Kx5MGPly!K|g%%9FQji>Fk+`gUkY`e8~=I9KwOJbAl6X(%M= zDJ(&(<>d5c*VAeT-DNMi-Os{@5T(Cfx*A`DZ-DNdgFag>$k)TS>m*>*2&x}MzWXVa^O4*Gqx_H8JA;FD3ZFX(aYS`OB-_<=n`X_B(PTvcC8nV~;(Qa2m z{F8Xuf$Ty^@_$AXQjoGr0TKKRZ>#_^0Kl&oZq{y2wYXT)RP%9?O z^fiXEO-+~RE8!^Xfct*ew$d8_t%s?+tYbx2@agdsNZf+(NHtUTGfx4kR7*&U1nNr1ilbksWbV1P2vWLlTDzOctfmPe6K)w~i6+Jv!l`sldTTQd@=>qs+>8RP>|RARVJRu5 zO}f9$z|gN#K`bP^Ax`)w(Gk0b!ne?%;Pb0gvbxFbbR)?mG)ol0uf=PRny4`gWE$@= z?&bYPh>eVNu7=`|dK0%GeoAkaSr0Z-y9f`G;kfkBaf5yf!#rjyInIFIt6mG{IwzPc zpC9(R&N;f-zC454Zuxxbh%Sc6L??A!u&@rsQ;vR_eQwNmWdX-WJ~z^cxEKHWc-MHm z6rRyJ%^*h4{08o4dK79ePFfJ$#l4uQ6O8>#;&ND`HM(>pyFCBT_5X?<-B=`tRTI{V z*jT{?_Ot-1$5^A~%($AERF*1d#}vtiH1F|Uq@=zk1D#}=E%mBqij{yeydNbDfTYlo#U{;jt6w{ABx`Sqf1UDe9o_Z z661C{uf=L_w4Rc44eq2yR%+$@m>Kdx{@!TbiSILuy*%$60|6{MAgC&Bp zWp`rpKld3CSsKcmXu7W|?8IYhvQft>o(~ZeTdrHCwD?_B?kT}NL84sT= z(g(bV;v7jTW-_`cHEZVqylH9GRrs3@DPntP(+-EfKUi2lp%W7l5lChbHVdg*PGS@4UN}SAH3}0UBhfuj;HsKM|*^5|$fW zcv6z_Ih*qDc5USR@!=Hjqxj^ZcqC+qni57S7zHWU2d6Mt*Hele(O}2(Cm5`EAWc%!L4z`{_NqVXk_IRfUF+5~YaU!^^+7<8az>lG@EMjqL3vw0aj` z=ZAvnm|Y2FP^Okg25^Sgv`$us+D91G-t(>MjKmk~iIT-WgPcq(ZQT#(r`|2LUoW0D z8nMX@-y0!Wa&;o(Ubj0aIfat+l1rha^=c9?)*BkWH;88qReQ0}b+}{b>cTwhMYQ$p z#r)Ut>sQdWUE&r@Djg&Ch4Aafpj;HQg@Zmy-RWX`Si|>v@vNTZf%V(~T`u`p>>a!^ zPBu_BkU|Fo&J3z!&k7}gd$e>F4=Envrqp13pE|GNTXJ!|xK81tH8OQkPrZ>`=V@id zzqQ23cRD%bVhNi$5>vWqfxfH?bfpCvyMF-L{bo!Z(Zd*i3~<(2I%LB9&RK?|-vcp9 zu{fOk`j4qr0{ASoF-6)!uiaA|tDRL?^1RahgU|PybmiNQZFg@$Ahi#N<0b-)Cu3A~ zSWNlmoZ4w&aDYDiuQC2AmDSFJu-WnTX(LZFHl z#6I1M8CZorxQY<*Y=~CHGyW=g=k4Us%*GU(KTX=ihC5JEyC({}bN+{Zb?Kn4XOu63 zBUKjrtp`1Ql>*dzXm}K9rWz|&hG=llzsIEx1jsK--Ik= zNHSt85~wErNyMG&LiubBAv0<*KEa3?%a+MxZIW8$;TSs#`xSqbgdTQ$Fw2%3|GBcP zk{uVsymXatBtZ0I=CvUE%B_JH%zy1lVdWa!LknuaSf3g zD}B_n5ZL_|jOH8sSxf!bmDMe~x5F2OS^Pi>ODw)YG0~^y6p?QddriFa9pYgo{>eX3 zAWTS=CvGKW0pUOTp{@1};E=k*4eh41@HVmMfg;HX!ovWN7BNHlV0VVD+4!t#pQ*#5 zVlw`Xs|ZuKSnOy+wQq$ob}ZOzq-4a$#0pTl>ggTJ$Yz5JQ_W%Ku$1I)@U+Tz-hE_E4=J?_Yfc#rsq(M!D+CYo^v=$h($gpkD#Ts%1o>fjLO`(PtA3=_}~s z0LrBKwh%;o;+Z1pnWkTVFnU`!njpi`;P_TJnKNGvrw5~73J-cP8b1&krqyCT|AWy) zx^Lr{y&D0|%91DU!o2w=satygtmQ~`>(`a8ll-Pe>C?AqEWa@ZrAWgu_iU*PX((`y zYFzCBQsnAMBkGWv<>7}QSlfc%nRqP|ZrtRbvRsh5LASWrI-+evPk5s{CPD(;z@(3P z6F8kdW_vp-TKlS7;pb>$hOS5K<3UTw@07|qrBBQETP~;@?ou0G_tZJ!M0g|6G)PGR ziQrTb&jd*32!eFX56RkP>2 z0F?M{n?LdF+{;rc!n1NHgLg*`q$v1cnAil1^F4VL zXT4|WU990)y?ExHCJ{4MQYGo}ZMI_0EwXA(Jx;E(V(+Ai3Dow6c0EC@i`#+Bde{z? z)jmeHkC`Cd>&ts~5#q=zlA4$giFmax`>KANdHuZZ_qg&oOn?*R^~do1hFBKOxzqJP zsB?Jdt08!X?oW@Qy;(n#yqPN^0`ATB7yqWi{YK>uEZUSe#?d}Y`8^;c7q`anmA4#B zt!W;@s-^seurTIKKa(vY&}I%28T!;1lP%~8g@}Amum~B(;iqSc8Vb(O94fSQ7 za@ALS3M!7FyjF$^cjOI#!aB9EaF=xaih|c+L9bfyBxZ8xo5ElU5B2;2O=kz!zWJGs zjmBarvHhMJLv(f66z_Y$*ZN1%SZ}1)wGfq_A2b5VM&F}6&qo^NSTEDVMz~}! zq>-C93xejZjKXwK3}#h$Js0pnNsS<1Sjo<<3lU?i?P7PB)KqTVNB1RXw>KHC8tKXY z8Q1nAIm$Eu7b5qA#?G%RLGX0e3lY-$5axH(YY&?Q=gQi%b)Al*yk=*;BWjv3So;vp z)mTliM0{Pz+#qr3R~LVvLsa%~<4N=Uq~mgylkNv~mU<}Seo+5LCHz|IcblQEgb9tj z^Dj(a4_(n|sV{P!6dtQ?Bk)oilqy2$;_FJ;8a==o1EmL8;|NU18_o1s zw}l2gTF~e7Dn;_cjRwzrZ7l^p;x1G6-O{P!F29Xik>|D*RVAB&L0vn$s2OHkd6V^o z4nn8yfY9d#2(?dy(CIJ;b=(P|uk`}TFYFx?4q7c<3c&Ottk#|Sa~(o)r(U+%M?!>s1pHAZ00DZR zu9=+eQFHaFxqi0UZ-fYM8wqQclVUQ)hrzl%)@_2QnI04WX#&jR+}) z;8;$&E;w4#t9tpHfmb%GKvo>`zJn~km{XpkeZ<+qc`7>9My=xa4Mz}m{6k$7v?F+` z7PEjLczkLdhP;PCY!r-QZ-sY9GZiPfagWb97E}MdXAXW!V(&G=5V7}K-i6nh?ny%K zfi7ix?#2*uzdb83gcsXa_2LCOpdit2#dTG^csqg+S=C!ldKg|av}X+FzKwF@$s^%x zRWIIm?QP$4E2p~S>{)}M0Z6OVXjSsWc4@-71K%z~Est=COU~C<;dVb|pE#D5TTBX? z4cVwZ`Llm=6&IAHnSe9dS3?Dr5X(#rb_Y(knXDinEj|+)DI*?W%X2 z&Qku3g3bO&@7XM6B0AfBtsOV0$rz9nCeJbO>rrEbg`f{~Hc0_5_x70KzN@!XxkQtxf$ch=hw zw%ZVABbhQJ{T3)N3$Nh*!e(!WV%}yz#8JEXEI_ze01*B}5a+?S_f@}0$>R7^*~co$w@Q2BTy$4hvr+U{&Xqxd*pnT01KzjWMnxO_d@9^}AwlLWfxD z*|)AHeLxZ@>PWaD1Qa)xl8n3)1OW~c4Z_=G8HnQJtLf z6-0rivmD?wS=%|KV=m0A+_C)5DK~&r?|BfVJwiX}^36sZCys0H^NfJc-5a2o$B4JB z{}m_Y-=Q#Za*ZYD;CqsG^Y@S@&t;@@L5QwOoSSKzD-06%M~i2p@tQ}K&MO}`=^UP# z^zbB|U`R4JJ}-`jY1N~?q}!ThpNEiA=OQWMUFOWCtdVNtcTOA#EUw{e1LJ*HoqZd5 zAIO6Ij<$v~CKelemLlrI_cxr0aElz*?Xw(7<~Up(9*Wc$ex5omD<6a`uyiIgtpw%` z5_^Q(Fg~GeMTq4B^dprn6U$L}pW47!JDvxGKRl=OkUP)pIq17YfQ5m(wHZw}d{~Zn z&k+Dth0VKDJ)dMb2+CZ-al8@T5nVR4CInvtz6AA!vEbR%gyU;G3<#UAwb4cpwpN)r zGUP=&%IPK20sd%5VQz7VvgJ`2e6#X=F)XKgHp|dEP?#+CPOZ2H{s?!XlVC==vIeq< zz4zsnf00{!pHlcJ5)^=%g|KD@4h9r+KASnu+f{sx_k&`yx4AfkzMm@A;V)g}7r4~i zYLYW!KtqQ$F$LO4UXz`2ew?j1Q_(+)n%{-Fyz`H!^~EW@i-6P&BXKYQA3mjnT@jL4 z)+y~T8!tP$GO{f731teusos{OTx6-0iJTCc4u2gzm5=*4L6<%y124TiMrWluv7)~e z<3sI<+$>>q@zu)aMYzd{o4R@K$%Ax~H4>JC`vTL^^Jp<*%=<~P*|R8c#{eG9B7-UP zW=|S6_*UgUNS~Is`X>;s?tx%JpL8y->}Ihyyxdxho`YS=2-ZkjmR$xK1{^=kZnWuL zb6f*rRDnP%B7$0R)=uO0jUAVoH-9?ph`Iq*H3Dq%HbU=1^&1{C6yNp_WLu$8lZg=iR&Sc8aUyj&L7Y;9%k)Q4y$vNt;j z&V>|%!7)(u4JZ$Pz-K)Kfr^V_a%(TT6;v-W;VN*9KAat4fe+V>@S(JX`h2u=E1Xx0 zsE}7>D6fX%y%McL63Z}Aj>Qb1_HQ^IiW+^ZzjogFSBROBYv;Ov3+`Kxj zINkACcmlur=|Cx07L-y3K7toJbgAj9tU*w3gme(jLm@|=Jq2OUouwiVGc+5q2w}z8 zqK0Pj&XcgDiG9($vx)+9c;_k#4CI|Z8ZfYecX}ug#yeXmpy!>B8MLRK2ciwRFM@YI zgllPE6z`lyfl&5}oS1wF8|sLvHSJ@sM5ARy>?;(m5&IVKuD4K+2UR^r`LLLD{9JTH zxWL{jJP=rfW$U40ovzy^=g0UQk;*l6TE7Jy3$qW%nJqPjh-!UWx)Ytl9i17(xI!zF zA~?qvO?ob!zORBQl*8)6H-y9kF`jR6pR2P7o1oZ$LW_09Ak@X!KLZq0?Z>~hi=X7U ztU7$F-u@KKxLVU%j;ni?wn(&h;uYU~zhC{+Xn?yQb!Aj0#c_^{VxO*jylidJTMx+D zG4YKvVA{9nx@^jJ7^NJT(Jjg=5E|n+pmW3k2u~iAr+t$qy}2nJWT{5%Ij8G}X4zPi z&{EQiY@lyB?-J17(iB7mcu|XeD~^6a9w4;XT+HDjtvvGx_Okev;_I{Q&*SoUA2r&{ z?+djlpDfVs4ZNE}f9`La@Bm~CI=N3YkxT0_n<8B6^JS1swP)yBJd18`$7*_V0f#FW z;+?C1y^L4(0lak!n7j_4z6X#F5S)+<$U?LNGS!4u>od~vb$XV-1qm<3vA{4D*61eJD4U?MvZ~8E9;h!Gfjm^emTD$kr&5Vo+kp%zTt&yPj8T&g}aaRt$ zw!Kd5TPTbW`<4mA#J&fFp}1+$cdeA&!aLD=Aok7oe0e!&Uh>XRni0!*=V#cjeC$^* z-mj-jU^gZJ7^sM?YG`)D#Q-m1z$}BX75imtOnjS-$mwA~)0q4gUuJZCK2lU-S@as+ z17g`BkQ|`-Vtr(SHM&gi%RJ<7fpClc2)2KG4qfTsa~$$HqLu7R=o5hASX>U9EqI3< zq~}70;>cpXQq+yw3DiBt+JbZq)r<8ZHs$z2#8gWYXKqRXY2F$W;2%#(K!Ts$WC*USu7>_w>|3_I@HRITX42xW4R=ON(3mfyL)-2Ee)=cN#+G z-J!ifBPE1R@r2>QN$5q4AD8@wb3Ls2PZZPDluFr!el33;&&N~{zLWxDu0tTD z_$t6iTLI0lk70~+?dBg~knebia{Tp@nqvn(ojVbi40{Tu4|&KB?5_o^!Ba2M=88I5 zJXyHee{(i5)9nR8eSuY`nj^lYl2#9EeDT%AarUhUd`A`|bak$o~v z%1_V08>hYh3|@Er%w*feexKDB{jc<*qHj5A@u@c{kS%^H9+fy}Q(S9R=JmT8>$#*T z;dD~Cu+rrdOqFHlB82%CA4WecOc%>KImbP&lfv+%2w?z-V`aOl4R@q_|J7u;1Np4f zMw~Y3MqyBrS$GyQJo+9(wGZnbNTIjA?+Rlf6v)J2ZnEz2a4yYX@ zvDr@<(ImDOs(ZFivpG0Xc4d)e1?>D$09Kw*FQ=PcMk|+N3TR8$yp0(%WNSywAicG# zIy%*7?Q$M*ob^5}wucB$5gb^aw#~zH88%;*fzFU=;OM-@^l~dZLF=!%)L=Sn%A~mn3v?(2K2dv!Jphy_S=-kP)mBAALhG6t&Bg=j;!G%YmEyjg zxE4Lm71u#wgq+DK5)B{k{l zmB#dHowuV&H^=)$%@B85YkE@n%Ihr`ptPur2OYjM^*+<2tMqPa(%t2KvPt)_w*~>bnsg>_Ws@$FUN&#iMR=Ce zZxr1i+@v#m=FxAsCyyy1X!pxf7UkpdgE+}BGD{ieQ{OfVGBNK?c^mpUfZx{u{VZFV z1Wj4|6Er2{;k2fZ!nA~QC8wK0xY@ff8))cFA#>cRscF?A&|At<>OIK<4||U^beqKX zFbInE;~`6ROMSNiBGTYf{4%UMB+Z>V-g}@r!uyiHdG9|QXkJlJ^N2}D+N&dBE>@x4 zgD(C*==mX&`euIv6YQ8^7^$4fRA;cg4Wl1aqu=vKb5Rg|mm2+=Ke~mj2KISa>XnCs zqbUv-xJ?vIwhXs5lGeNsF0h3!b_&oByq5>arrF48cVoq5Dc{e=OQps}q3?xrW_d*5 z^kDHwJg#)WhAs+EF#WKan2M@JCpw(c@v^wegi)Xlfht&;0P26L)Dqv8Xmzep#J=!y z<39A?wH!%wR7+iDdf8f?&{%e@xMuSKPKcDlq{*8Ph|PvH?-vx_4x0su;K{1(KR3w-|KNgqGC%R(~x;VP>>KB-H4WM)J;9;Dt$} zgj9ZCi|e4n_;w|#ve;p_O;=sb?M2@g{0tZ_nkl)d64SU{_?O87){VAwd&+LKsH3JU z?dSJ#qA~(k-tPRB?*a+hFY5fTS@}`k+FEQ7o_{VMI<+$Cy~)^@I*b#-m9IAb5g}z0$;$uLVO3x@TkOzMiWF&$7pDP`4*!v`_Fdb{$H=rW+ zS1U~S;3ZD~7d7&)zwf#F|ETr4!=4ZSkD3+#zI51A^}hnf@P!w1l*ipyne;Jbkz&<6 zhL16iK>~FQnr#_b#k_6JQy0+ur@3`zb|kuHOUG?lW{H zPJ2G-YJNRF{6fW_|6dhP!Q#*L{@)7uTJaj>hbiD)o%p(Rm_frpb4pU(1^ejS!4WF;o z`>dPLD8RdplD_t|=Yt-#ORoCe7FaIIhxc!@BT6m z4rx+iN7)3tTbeME)(}rm-~W=>UGpym z20Z7|uMBwVC2hcmB_#?`NrjFtf!sgy#N$IkF#01d;pqP-&HMiUT;UAz7$7QXwOmLF z=hxo}B=Bfc1i$Y{x?2cor4$edJ3Yhyk7zpluqWiw{{|V-;fseopMpkO`M55Lciq%Y z-FDUs;YoKpe)7x!AW3)guG=BrW4**y>{P<`g9?iKQbX{H&9BFkQ?P2cck8$eRiyDu zL1RZli1+(cPZHfCQms>y_$S9)B$3k0-CP zt3AD_sFyv#l@E}uPc%<<)sF`%$?$YQbZU(bL~KOwCqZ8;E_j-;OjC%~oLv`!9%#jr zs@7;Jvy*NFIL9?ve}w;j&|Xkf-(zbgQK?Bcszz_|S&pRQ)e~og@%%pP8BsBd-Ff_a zd^im{p4X$}YV_5*RMJlolbAD9>IRgyR+jz13B%;fP7N%pgy5!D>i}?N*^iuHma;*C zK#eKUs-Q%t$l1|Sh`|q+jwc~WjYoMi{>v| zCj4gS;UD(<{zXe2tDx)9ibBD$T0g=6Sz_V`;d3L_v#ARLH>eB9_!3l_r9So&`PH-GW6 z1&=OXR4N2Q=8Svqw{i;#1pJSE+g`U5jEQ|~v=o_g<; zsrSQw59LF`(xOF=6fIg@7!+j9Hcu{`?|8%vgI8!?RB9F+KmrTR%ZiF3ek*Bd1h)_q zxQ8GDK5v7}X2D))Ug*z0jw>x#0Zm@GsC4<_g4G4fmvEC=(41<^G^gGBK$dyY(juG- z!lGqM$8j?XOAAY|M0RPxd}!K?)J&}~OcTyLY9WyK0%2K6skxw}&|J7=e&ND}g$u_; zaH-ZAnNvB6V1Lb752a4ATINnPPqyaVn{MTb3KlP(kKy517MBmH&?cbKyUe3XBXAm+IeX#a<@5*hL2ABvwk`FchpaQEo5zhC zm(ST3L5G(vDO~E{7A;v`y1ZoB{6daR8})};Y@VGuV+t!V8|Q&aqqhPEAX}+`_0sg> z7A;d@uwV1!8TaNO=?klu7XqIu6y}!#CV(9AciHm7rT7bMfp`YD#Lu6oS1?GoE?bUc z$uTCvA=@ZeAS_x@2*Ks}pZTE&=29i*j2RDPvLH9oGLo|{T~M-mxlp)}p<~IyiS*4e zhNAvl**g}ybeUu6V~dve|GF}(`QD`hG^${+c{xm;5~Ss&%T`idK)M`7vcKlp8TY47 z$%l^;VQJw??bmEeo$-+Qp_w)-5*Gx4GAIpkr!EbDl9FfLAlGEQvkex!Vz3aVZlQBV@{nsc?N_C-!tgPyn30V#LNhB zoJz_X72gGcrT9~V`SFi=Hk%8;6eg$Lo0^rMPti-4ttc#6RJ5AS*21C!7*uGr1IQ^E zeoL1Z7B0lV@?|9yfjyxFVcBwuFDO|gtj0x+Tec9U-wI$|Fpn3(0#{hNpa5`FxN5=T zf+gHi2h7Zp(nXIfm%&Zpin;r^Y25wL#U+c7)naEH zz^#7oScW_pz_5_8Xz{{AuGGE=p<}BS7nIr|RKh*R&EoR76##X~k^&AGNhu;?(Xxdc z@cja;@AnR1DmaY*eWkcWaTyja<906N4lZK?mobscxRcBH9hWhQ%SeEv@xY1~7ebw| z_&-{>TKzH4hN(8qI+IN_2*4ajw-+vWbkWjB%!`W5H;gL1!Cbfs7Qa#;K{Ko+Fcp?A z15Pxo(UL-t z4{^!?_bn`?IS7DY{=iIMX2t^XY7k0b5TV8Un;gMK*@(#$EM09z0uh#(k+NYrVXJ`f z0L3topwfaRg$RCuqoj0M$*l#9IZ@2w!h(`pOBbMkg5NYhfEB>3g|?yeM+JebgezkS zD7Jz@ovT5mC6w$GYFZ>?TZ$aa#Mld!U|a$h_Nj$ zSPCr3hTLzVdHJGMuxL+Tw)9pKam^FPns1+Yr;4tmCf2Q2_= z8gw-O3i;kvvS_J5qG3SV285B!2O=h=_$ASCztj)XaOuKK4`kg&&AL?;y+P_-U^m+f zO3m|uY)H`q?Ej*CpnfEF7{1c~O|5}{_ajkI@!-m-nEBo!v&tQi3}C5Tu&8KJ;li<) zpS8%m2$&*dSTuj}>aoz|LP#lL*uZ|N&~Q;K0MVMjs8nVKDIW0jU)zTNCNC-~LV0E> z>3erEq6AGie{3N5-}FDVd;!A|$U?x2fWZFOfYO&O!Ns{hMlI%*iv&BxkrD(vXQ3+W zGcAEC#a^yJS*H{iBw$Ow*4cD>!O}+AYQ%4`O zFIoyS7I=bMAJE;ev=uY@D}^|$l68;iMp&#sg#hJl$e40l+LRl{nKPzPchaViHdMNL z$^2!D7cEdTBDaMGrv6&Id5HtC1M?M@BXus60^yLJI@XMO=vXtUpkvLbeU1fg2_&uR zoR9%E*|Fw;DvM?jRhQMG8IT}tR{LN8{rapH^aE!aEp?2v+HvMI2Vh|7;?*jFl|a)A zX?UoM<^=^yu`7OTrcD`Vo(W@u@oa53-@r8E8*p?1X^YsPtt(!@R1Tw z9@Np&Xz_k+Q7{9iQP~J6&yEtt!I0$t>m2?Fftu2@ z?&=@^08PxG>}tH_&R@^3#!tR7-VfglqQfJC{jMwF{CfQ4E8+wFo4zcd&KD8-aDvc! zpb0wv^`F^#Z&s=~vvA3>lGO|fX=+6U3xc`fZv!!Fx>F`-m;Zmt-@j}n@V_P009Za9 z)5e;!aq(57K)_w5(%l04qUFdPQOJm=tN<2tOtk?sh*3=jt*2zsasjY_2E|3lf|e`+ zkqkt8pyHxsMBt-UzK2uy&IyR(_}}2tFmh-kFsBuO)~Hr>7aL7;o_WHQH1il{FpFTr ze7`zOzmkPn)2^sSv&pQq1FM-bBRdU<9Hs=Lb=AnB%4%j(t<0##t4rvT0>H^qMD$po z?*)q;3vnu;^b3;-$eY&M<@VL3ixz;?H6u0CtV+j$mD);51_H}M$=hrhH!)znQJJ^j z>{A3IYtBrYfsy!7RmOdrA3a#zsUo#K(vM88mC8oK}=XPEn$lhVTdTL zJ*C6|m;2j9LenzMz_wx$)Ty=#WtsxD&%e%!%o#z(D$s06{bR-tX5jlT=}UoD2(_wg znSR^U+p^5bARgRC{~t@s)GslHImVK0h4Wj(m~F{CJALN;_fDT|onfA8O`UAcvZg=u zzzoz?A40cim%hUo{Qe*wxD^9xGJf=ex8 zBdReYhp-Is3z--DWwEJfwhT5jVXesVaT={CSVX4UWmwr*vJRUyOYm~ytBz76DE!t| ziLqwKQnY$d)0xc77I$VlG|$saq&JTX=1*uAg?ZMG3JT_fMrEGwShN_lSTh+^mM#Rb zXF7=1IH$B2MD@~}K}oZN=t80?mg`?9!D2IFrAY?J6WB~(g8D~MT zmT?oV5Mu-yMx?j-n!dFHX2dc_sX5)2t#KQqSk^X}lgnTN3M7dwUbbxcZ}yPnCzyk1 zpC;A2V9CNorH?X^icMqM{?Vjes(%p*gwz~u>J}`AJ^@Dr5=I0A2Zg1;FWoZ;WJOWA z{Ze)L{vY+H+=3Fc+uYTU92VXT@*z{~QL+S~SEUzqjq=Yc|8j;?pdcck*D%&1fbtT= zX#$D_gL6C1XP~dralb8}Xy&BZXmUlh;%3-h(bj%5ZR zW%A@1kb61&m;S)?jC-eOPD3K6Dr&0q7ioC_dCw+}| zh2XyLIWu$b-OWERef_=n`Q+l+J9qBPnKLtI&YW}R+(<*0tyX|8RZ%H@PE^tnrB0s&L@-*S6huOglL*r zjXSE5YUdQD0;;ySn3Iv_ln6!BQ z>w6qDLGcBhgV1;9n8^4>dQFF86=lZxa=>aV9D~pu%wRdh*iEnmDpx>7rqP*~pC`}% zdZU!!Wa zU%{y$^&?-@dH>S5BRrNYd<;m3S;46Cj;$kDjSz$`f9bkouMdHn>iQHm}r`LbvK#v$S-JlG#V@Q@?}dw zFMJ?ZwPovSiev|!&YxiO%9TVJ8$rtuD4QYAOf$0040UWu zNp*5cNj^EHgg!;h;8l=eouy{Pkr*>8CU*FmpfuBHa{^5?YI+X^?~uz_mF-iV>viR0 zyIjonc|?bA6?z(HvlW*!cvMSdoOXNn3CwdV^-I)FF42hRH{dEUrN;5e_0{ zp5$Zn)}9_}qb2}#R!+waiji(Giwm6A5p~Y2E^n-0!~<{f^t`0adsEUm~P z1E`WTDB|L^B!t+Muspz07+_jS(169{YNhy_W>S-aW+Cah(m<>x?Po!W-s*X0!Q|DQ zFJ-&jiu$L2;-s9(Q!bc#;YAluo1T|nQ0Sk1`JA~|Tsg03{(|DGt}aE+I0MF#bu-qBH2fP6I&_kElPSnhgEMlBW{2DhFWQSEUKuHkh^XCZ3g0)<+% z=!rf}1!t4#6r3=q1k!>>btgt_U1d-lO|*p&LJ~B%OK=bF5Q4jBaT46!{R{5yvbeju zyR$efu8aG^VvqNJzpC!Kb-KHzW@@^+duq--=Q4KKu@QU2q%KNcuIZLfc>Z_nJ^3Hz z1bmKq(eZFu%yjXpM#Wkx|8Q;*;eB{f%L@on;{dCes`1f>5QuaX+_A^**nu{GbzWAO zA>rp;S^JFnFC*%Iv;M0a+lQsA4o%Pz7??yVV*tiQ5EYO*%cb>3|z401#B@-YYd)jT)C^jSS7broqi5qbVKihVo-F6+Os}O3|HvBjb4Ddr9Po- z87Pb;DmGmFM|}$#64SMSw$*7%6Q9e!!dOjghOr+h-d(a|(m%6B5i9cvOUn|3={4wE zalgx5{V_mDZlFa!89HQ2ij{hi zjL_X7$>O0#xHQ3Zs=I(7tuJ-&uqD%CGLkud`Uhj)S(OfuM}SYoZ8@V>7ejZaZcT+eJ=8ff zw@T$O2xdm&#X$PPaGo@@LU9J9b`mXdH z4~owzoheFv>FT>r4OnIO8%6OO)s-f+NxIZO;q^%p{t5x3D#m^?@|DR2%M{8ES6Udw zY{;mPG${1KWd&WWI-V+G)h)1F7S!8nIwhx>IWj6Ti)#V*BZZecp1q$?>Dlg7B^)mS z9#QlN)z)u84Izo`alviz3KkiE>IuEHnGvloM}y}z)X8z=+F<<5SeA5h4lPc?^alf( z3dP?}#;k~>M?PvYjr5x`)wKrsmI76l{$}AMPVAfU;aVq^;9He858kTT;6}?%5H*;N zPu7j5b$m5xe$t|y!fz1%H81{UzBk>GG@G3vgFcH5)N?)?UOXVQ6$ST#4G+iPGf*2^ZkcgP8|MUU!gT`%W34; zHtBfaQDS?*X;!@H9~*g>AYDjVN}JG%TC&p(-XCCvovuy2b+rl$y#dxZhU1blfArUf zgb4r50m|4~?}l~<=|7O?R^%1#J@=j+M8G&L0ga~WDHQLTL+T5Qwtb_wD%-zhnL`%c z@8fE>?`HzU!DlKYn|BlUjVJL}+IymS6nY*UwpC|x!+Ch+KPEp*)mG;h6~|NglWS8n z_`ZQehBLXwnKYF-J^nR@Eod;P&1|O?b(NV6Q`}P>lfP>*|Af!AwJMh0{`K|wdx0VNy} zf6A95g)mi~Y71l%A|96VkyRmil4Y07)=SQ*PBg9+gRL#wM*j}2fcJR81-+Bp#RiE9 z2{wuuBCX9B_D2TGUs9G5Gypmq0oESpB-%IJ#4G~(22%T|hTD$3%C zMbm8@TNtuDj@&gkrQplyG{jgdVi&9(`_$ZnaB>*P7|sgNR5V!C)00}QJJB%$%4X)R z)z*2blG=Z&C&c>Vj+P!L|VksRv9VwRKH1HV*}5ylc{zCrJ_0qbH&+FRjrk!2K-m~ zSa}wu^V$4}(E_hY=tLH0{{}aN23Jl1JtyJ0t8exp;FFx285WpdWLA@eu0~f{PLt?! zUFMO2)I<}ueKI{KU@Xb{u3iP!m>6gxmL%ioqG1T0p}h!$g(wm@%MX zIJNO$xbG?!iYjkCtVU}BvEeA2L=8X!Q=o-29r=DW+w0WiFZqv5(q2( zR+7_;;l9_x)b|L#+po%EV5^wWL*LdskH5DU|A^U&<58|g518)OP4)KMibTmyZ)~-E z#>^^N!pHbNiI}bLy>n>!I41mIuq1J7vCe04w;T-d`)cLGQCzFYD9n`M$UXT$A6f1| zmyT&#(Ad7@Dk%pyr*!gdFOA$txshNreB9|ec%B>&zm;oQZ&JUY=c|S0C--0mA|jVS zWuwC9s-AG#GDA@{+|}3 zo0lF|N4Qk{Y<2V;aMZp)CxgNE^4`Xow1~{}=mwMKvtQPOQOXEv7z~i_oH0pG4T`IY zY0{mfKdrVCoc=o)Y7@qlu>jMO77*8B!|;MICJ(033rtn2xp7)KYX8!Tkg)-fERXqM z3CnFO1RD%5`}}ljq~$|FKHPOdpZ0YesqRshMPWwB_0Z-YzaK!g6S0EbMZGS*C>1_S zf?Jlr9ETVzZR{BnsSqd{YQ6qwK)A~$ULG38M`vM%-XP~2C~7S!#s}{&mvDasw%B^G z{Pp~W{CVI>{Qcn25F}rFFob&&-TblaIsQ=o;ni;Gjw%;@*NP=R!2x#~NnbZpL>99p>Zv9RtVjQSCC`#e6Ywgy_u zU~x`XT;TwI@vGqPQYC<l~N%)Lflx;EVb&D;H*3;jxt;K&9EuDHViqK9B;zW-iHI}luJXdS|y)^ zwg?6^n9BQipMDTb^NLJVu(+houOxP|$ER*^Ew+F@zjFKy>0rz*kMomb;eAxjGH#>y zEpCa9nm(32XukSrr<@L>LPJG5+SZ)={a=HRW?47mnaiYF`{uPQjOCA`if{Fq&DMQ& zA`+tK?cJ9!!OzN4Uwpglav_ae~Br<9(!2;p3TQ+ z(qJ;;tgMnBvT`qJ1Ks%7+>R*GlH^F~^3V~`fpoDCg{{>#5?%!1@^B3Zo07v^$*|MFo7t-K&$1^F)+LtxkR(WTM4g zTpH)#Ia%X_NiyNfHN;oe)u9|EG;+PHPLe|wt+XYnb9%=3olB+L%d`G!)X=pastf-i z@l{Xd(HQgP8oBti$Mf;{Icn%9lmAR<**1Bqu&0HM10Png5>Cn`5+OSeX+Vsrfr1PYe$paMH-7n9f{$*OriUUi^N^T|ITi_@_zL@7}rd@dE%; zs4$|#{qh0C`Tz#5L0Jk>pwHdX!P`Vq$~#MmymW?3z#*D#L65hYiq$W>JGLS7*)&on zh+ctJRr3%RXGA(+rxh`;ggoZe9o1(jB*TK`5-;}_<#%q*I^ZWt`Qf*n^q)pp)~Zh5 z0zWD#PzdCN>K##jrk2eLnB<)wMv=Rj$cSv|B$hkSUHpaXv;>`mrlc=|cyYiz2!`zuaxmnM5R*+9Km9VJ)AA6epK@n2{1}3B%&bfbnOm*+u?sOm22CTreN3FXi#Vhq+!w`Pho@!L|IlXZ51BYK7({KN607?R|_H zbneIX2?0GKxcrCY7=U+A3SKJ>*;sD{_@y?AkrO8kR0_~x%{RjiZZX8xpcaB+Km49P zZ06_9ZOZHxEw>`2624453>j`0jZRBs2&ZH0!m=~AE_~(>(W^`%-m92w6*gD#!!DUH zP~Ga86e8cDRix7Yg!FX5Ht<@#Y%c+J@~hdxAOE&TDz&m36!aAu-@;whP22Q>6EIW5 zf9``Z-3+Gou3I@WVS#Ly+4HxKWSZg|9*JL-f(^vSZf|a zUqUtD5RXSVK=A#_dpaWUBrL`Wrk(3ncbi@^Iw3&@NAk0NP=p0%0bZkahsA1;@A#2Q z*B*avJ}zvYwlno&9j_xD+iuvUq=nszLD%+U_&4%*pG3u& zUM-oFH@=_`37-3`=v zUo|j()v{@*9i4p<(!T}&Ew35NDM)BIE*oQvXDL${?CU1+Wo58qy!;?I~4hM_nL~qGR$i&{;Cl(+LrkGeGA}k zP$DRsA%Jove11Zj@_CZM1(rhX)9P-!Nz|^mTdhMH zccFxoeB%e_?Vc?-MQz)!J@QF@Q~`t4h;%j9uUE@9?p_$?e>-1~HMrT0?kfT7yOP;K zP4xH-iKtS-eTwzPhD1zXg?5v_d<4x+DSY!2gIN?5n?+$Z(MFT|VB7C%lKg;U|uZ#6eL^U$%0h=swQ!JfxbiAq zoj{f5kB|jGG+qLEyKG!lnp?D{_`AW?)Ce}C11plTsd1P#co_#ea|zG&of`>;(G`|cAR^Y_Qf%|*v&vS}c=yjfkDj#doFYU}xeAOUvh;r4DlufVS07?nn)P`v7;4u1>x=+d)(C9aVT6Yu}vuIzf3vUJuDxLp3 zssRNVcFS(k$coc~Ha#_}O5c8Yu3eyBkwo?~cBh=w?z)V$@Sw!qiHWsrB<`@8~EYnv2beP(?408R5tc(A4LczUa0-O-=>#+Y*POP}Z( z9Nkg<{h|tOWe7pKIp;ja!LLkg#|smJw#VH2?2~t$Oxao4kMR_ZpBM3}^q)|$G=ed_ zHXIa=6kZT@8F?8!6s|)`l=Tn8AG9t0p9ov7JwEA}IHen*W(Z272+;=a6(DFDxkzz??$r}R%Q5`GWvD|`ez*O#eT z%$@t@eL>sDJPg1({eXnO4jlADHr(?m76sae*KlX78}hyWPZiU5GX!vW;P4k*d!jAc z=GD5}h_4s%xx= z-k`Sdz;S;#M|#G-6zF+E@`BP;qI;q;iZlYf{|+3|3gm3_4h0*QISv!<)S*R z9#=d4y<&XC?;pbw`>4a3%%&41M{ZXY^y-qOmu=X!XlD4L(BsP^dLWXpE)pWXu$~VL z17cz(s7V%Qr@G3*QaMPB@LUwIUs~ZGJ7>ESF1y@NuNvJ%1d2f@3DM4Z0s84;Fas`{ zFRN;~2=J0$>2EsxKf)oV&dQQin%~|9h`={u{zp%cs^)J)WeJ5Hb96aq zY*4aR4u43p-=5%0@R~HcVDOSO7YKE3gv~Lk?!nc?t1XM_9Pcg?CfS+)8a06b&Ml;~ zLP6>xzwqx5sck`N*Tb$SQ3$1x@|mrj9nWiy(>T-xjQ(bJ5gG5UJ45Pzx}0myZnK;0 zqc0uZz*3ZvC&)S=P4lz_ecl{BA=SS-;8HsO@>bX@_#|TBVY+10bw`%<)JKv6gHwqm}D58Z3Jt4HY227FUgR6q4zB!GzQOLlKhRMSMoD$znxw;vM9mZ zztce7JI3Y-0XM7H+y2?8w~njm$ZI6a&bbW%?T6QDQs3K!Zapp6eb%>?%iC(dyS~cJ z3I5F1mlp*-vaW3RAyepWXZ0K8z3%@serX>5t$)+M9z=lE){QIFyya!KeiHy$>jK?? z;|r4vd{>?dQP;^N4RlRyARubzm8(U$=%aJqfBD*Byf_@ge zD<(90>uKajy2~qHzbhs@dgtlr$h_+*PgwFa;wuj_yw`Yv__=h-mK|1f?szdP2^s$8 z4-fCbi7QmKA;1Kr8=N_pqVK@;z)~d?Y^rje8a|5lQjY!aO=3y>2^&YJ7q8l8!eSy0 znzH{C_R^Vhw}~9?8G06$hxwhUTT=Z?>rxyzZxf1}Xm9e?v0~~e{{j&IbMw~ii*9gz z?Dy(NyNS;J*1z<2cEZgh-(Q1BWWoEKXc=DG(zrD8T-qn@i|d?Db(ifcAG}r-Q1KQG zQZQ5q-nM!m>WA)UGG;)yKgrL?}~ zwS$)_?K%Sd+=uNho)wC;O|IhF2J)+!z|d=ECrlw{M!Dyj#_>+s z3e4Gq>`RZIYi$B9!i0g+?*^e(&8%T(Z$5KcRzdp?98SmBgnsel!}Cu#2rB|&v>!mg}C&(=EFq{9JuFAO!@=&JHdk>8!x^Ft=(F^8T znw7OUU1U9-TX)y*PSp?^_qt?JW=}cKwZtTeyK&5Nja+ih?H1p*oW8O?QigDSD@?Vq z%XreSoxujT)(W1H3-Y_DA+hIAX4`W!7{b`_vS@X5x4!_bO{6j?(Q`y>Ue9B@1x&F? z=IsNrj5xWj9k8{(w(_Xl^yCj21^F7{)hy*tpP8HM8^?I-J1<> zFYr1F3q-3B4$n_V8#N5Eoz?I1itf@8qae-OQ@DUHIl_EO41`P1>R>LHe@pm$%5<5v z_uH0p9g~vkeyyz9;)eKbRNj>@q6+0%e7J_T@ThS8&Qeq>OJ#XQEa%r*G)FGVM_?RuBNj#Pm0anj-#|CBj4Y%H`7oF#RAay`8{ zqa)s4UD#Iih*tg5&fh`*zQG=d1ZEBVavk}#=#6CiB4BDyh*)GG*9iF zku7m-f9La1xe;tr19N~udXyd_Rdf->zP+t>3}KgdEPtBoZ=_crIeo@HtH9h|FmocA znQPmQH6QXN7M6XwVl5RS&x`px65~K8=%rJ^ypYLvE9qTjvF8 ztJ2yX+9wdL_}B(F)Pk)u#oUlXx0b-Hm^2q93W`CGMDlh(Y z=v9(PsosyBavKY{lL!)=hb*;w4{_4Yxdd&Ju%`r%=(+KScZCmo(syvd-D@+BhAgpt8lWxZhFB{051i0b@~ z+Y3D{HU}Du`pw})Gvd^iroEguvt$(Qro&}q`_w+vSjZ+W)#5}a^_H1sL}03}tG)>6 z(fC#O%kBh*117?UKX#f`e$xAq_{6mr@#JbcGT6``=s{c;cS~Oc*=Pk;eqiSGBxHYQ8#OrJn9IlL52Ti!ssyF_#= zvlqrKA{@PrJkcnAl?V~aRkbUj!_i(m04ed{k=&ipMKzrvs^NRpj%~t+y(%@gg%R=C zhAPWhRqUn&xi#8KV=2^A7-$!T70J240}c_H5G0O_Es3j}LnqI_O?5E8=4Y^d)OoQ` zIraTEbH}j}sa12_T33q9EVp(lQrCKWd61{X%^Kl9MCrguYD(B%n`A|Z&K9*Ic>25i zTTy@7&6inGCMLcLmu3JObf}6cnQ8ICyQB3Mm=PhodaPu()&QK!@SWFCdZe9ogUfiE+L;PUG@dawg1@688mwH ztknF?smGeE;8(34(ET#z8lH<>RsP4XyK<_BwZeblU(3PHsV_y|2l1nHGNg6Kn`)!g z+IE;FjNi(BwWZjF(4pDQnRhJs74*UD@q*ZGm|U=-I!i@cin=Rl9SN^2^Zx~?zuKw$ zw&}f*cxM0MN@k=#06ak!%pb!gW_vkmyq&AlPuVY^_5@x(xm^qAz9L-M?F4K9Z|v%& zm^(hRc4SPcXXF45z1yXjxhV>iI5fiWt(-lmYDl;hjCiPIO45AMfB*SilE`_GRz)6} zYkT@7%Sf6vWQ)8n4rM=H{M7q*R}grHQGI*E7l8PPNqt|B|3uf9E&XUt&V@Fck?EX& zCmCa1%E6~dt_l{#igL*PHFXylE^}fz4vin_qf|aD9?SWls7$lrnq1S7 z_N%UP`NSRaWq)jy6p0YMle%^nBAAwkAZvnZr;|Ol*i9O;FZt1zE${Q5sCm`FskHmF zg>3uZHmyzT6m|v9YJT1IUy?PNAJ+$^L}+~bfab4`!`&=8#tFL)#6Qxa5A>g+!){K&D7rt)&*MIhUMshp*J^iU_^yWKSZ3t3EE(2H%uFd^ ziwcD4WMw<6%CD#jxR*z0C=phfMGq-k;%JRE0b-2NHj9vgJms?>7Z$=X3Hq|>g0n(i zsr{+rPLJr4XQPKAQL}s@1OvTz;Rc@b1!D8k2gLLdg5v03&1}mC20nXud(A)mmM$a9 zLm~x9A9{`!RtM$6;YhJ|#Dr6OFmq(P_nwQKDK^Y|{`$9L@O{GWTv-LZ`IJIpWWjWX zL#yYHGBmK$#>2LVBG3Hj$N{va@tQ^Jo_m5Lj?5VMx|KhF8`dWF=^MWA4OKBmVX3`F zAA?N1bw?_gE`|gY?XQ+pY_>M4D_1{f{;sxIzruXOH+acuq^s`AR}k{!7mhHmL=c&a z7%9s~;OT_+sj(Pj8=i=?@xgl0(9ruia8ua2_AmIvhMP$7RkIqoE}3FSwbYHasW$(= z+gp~-51McV@o<7lV;^MGnNS72FfSk}l?B*W=1tc>bS$)Xpc8v#1HaY9r{V`zGAe7V z!_NBhqetiqkq)<2rzgDK^2?ow6%0$MmYIv`J67siDFzy#= zS-pHKM=rT*nZvF4c5CEmjNZT)|7-Vdu2_>jiqNv)_gOWV_s421p|2PZ zWwZFW7dNQzz+=Ka$A&_Ss+c6%(8@is!Lc?+fOR`*ukt)6sDX=q2#?l8)y=&CJB<)( zWKE@Plb*x|TDzMKi-(tMmmVF3+W%{WR}6HlAC*Mp!PYv3$c#+ej*p|s1W!(8rvbZ6 zKXSM?>GtVa3bi;FR>ew>Ok0kRhwJR`O;%DGV2M1Djzg*TJX&M)Do?<977QAbE+Hd& zqC}DwnkF;c|I}+U^jj*t6Cr|J>evS;9XUy&^U5al?A%v1F0)6^5+~KE40xXicZMpT z_NcYPM;$;oHkZNB>>MAV$`eO%HBu-mt$JoK)aDV=Hq4g`ZfJVuO#Z_6%rNOWI4GEz zHkUT#a~?0TdVR|CyYIe)Pf@rd9G>2DPEKy22jf^soE`H%cF8>9DCcDx<0VzDhaBBm z$4eS~l1#lwdfiLW7-BC6sgaRRCr^` z9{!h;#KR#{thM$8C~p3ns5uKx$T;tjcEO$N2t2s7v!r81hW!-9rIc%2lB@^Ec5Yu# zTbBFpDW~h|G|3_Fc*_@J|0iIe4=R3zR&g=dF;O61XoKEf|DtMxPrz0-FBkn?cOtB; zmWxDa`qL5oE>l{*E@R~NtcTVYnTyfci>^Fa0i93cN8$iw3w|lN%LJ;`&)%Tw*-zbEo-uM(}{xZM2@v;T0Iv;&YaunZ$`H ztT9khAXCA|%arNdxjQ;}CCOZ0bUa|Lqs}*}#5A2}i%X}Vo_0SzRq95+vVYNQ=;V@J z5c$D6;car`5pGxm?B?wf{}02E${NdB{wiIRJb+nl2l$LW0YtbN)*N(y0PcE2jkA2- zTD-2wdf3Q0j8=lah^6yKSy0Sief8Qwet&*T)$a^)J$NDzS${fT^J#xt^Lc_kRw<#cOZxt8n_M)+VRGr3>!iE0FAd1J zeO+nW-1)INp+jWXX4qkZyUXk20yDLgO}qe(7yp}{sta}`c}gj}7~3S9QHaB&T&g$F zBWaOS-X**PxDd5DOwHlfcej>ADsi;bo|m2q6j3tTzX3ECe~&5N^mpHXG9~ehQ02E|m0bR;dbSL!oVw*jBs zJJt0E<5=%i!F)L7rnOFEPKU<)!%Y$Z`SB^{q}>YU3Jj4g?mOR7rKvfllzQu zvQtQwKV4Ni_7j)>?Yzz9TC)?D50X&$=8H{jSXE2MZL}el&#_(jOM2ISD$k|Oi~_QP zpv#G)Qh&dQV?^mgp+%t}&@y-9x}4a&3$~G$T_n#o@5G;2MbiC^hH_5M=*Gg++BQ<~ zK!^UiZLdQ%4v_TyLL;0_BS@nVUrnLD3cKw!84%89H^cs0gJh`U_{VR3lA#XK@l=)< zhvT4DRsPu(*OVh9OR0#oLoX+smuE{IpQGJhIGy?PI6PJ zZJ60d&iKsYWc2F|^X)akp3}6Z*ZK`6ZzgCwU@h9d{?G;yd-!?|y40Me()S9hpCpJ< za=qb6YWT{aM>=zjZ3u;;lL|g;w+DpW9~>v6`abo#J?_}Pb}No2c6+{-VQrL_YZwm>bKLa<%HV&luUf#m zd0aC83>E9*%xC(=g@5X6$E`(;d-{}W8SGqakhV^= zl*n0!TC>fsSe_;uV2{Xayl`ffMu4r$d<%!H;?dBpg^A5KVAQ$#iC?UF!(JC#=7NnZ ziFWO6ZWcEkcKy7fsw%yX?-|$7nN$k5SUirc7kZC_6!eeh(L9qq%lH9u*&8^W=Xaby zM;B1JywQebQP-9aS~sn1?P7`MntX*#Qf-q~ZBx?V>hJKzN!H(3zr0!wV@RnL#P6P% zI!qXfQ2nyX@?Wr1X9Jq}cm~UMP?pp_G^!}rowko{39$nWll}|91rVr1BJ0O;ybQVc zjppw5eAQ1DU@vk+fhNNd!a*dob(?4^ub#Ed5%NO%SNl7ImJlhSKeXj)zN+<$Yr`C! zcnlNCG8=6@cxH^HF`OU)vuE2ohSVL>UpnmBeEEh zrE5*C)R%?79SbdNc3f4bel=w&BBel^4I(;WM@w;KbL&^bn#-Ppf29b6T{@_E|Bh{S z512b1xy54Snj&oA8}IY=f6_785j>h$;FT+ea8Q`13pDv?%yD;iOz8V*T(7EvP3Z;; znuxX8|BFLgzq7?dMmSg3AM;F;t9jg~7qk{+XV_ z@0egywIq}ONA`sqhwu|O5036e&f*0Y{`3W8uz@e6%r#91_v7$6dgR1hB{+ItVeP~m zw3M@vlrzsGRFhiK!xAulLs<-I?^L{6_@tBEd0r!Nj#qF|l7F*4N zFLwtnQ|Qva;rX}e4NQEk68*YmTqf*)G;F;_*zf>~W(TjDnjh|wpn34KWzEdoT`8$TTA%|Qn7Oxys zR<14$9aNrJR=5-*_EN53B}M7bLt|#1#Zl}ut`vzd)IH}uISNvtlX9~fUCB*kC^Dk+ zO(Q=Bk(8sMlfpi|8P27MJe%7u%tUX^{IQ?zIS?{bI}33;TdB2-ahwpU6EtwzipzFu zLJE24L}GZ-{cn>N+*#Dz4DH|U^!toLx|{*z3OUg8G^T?A|B9e?ICqx%KCGv!9v7Dg z-^6WYH1-lNQL?g)y^WwVaIo(M31|i7V<-MYv8yhfdYtJwpqN!MTFBK;XHi`s0U_S= zF``Z$>pPbU!izn}FYqP{=A871+ROyddUyG{7nh+SbuRV&3-NoN`g1uGO|C#Th5w!{ zK83_hhWS$eiJJ_=wgLP~q96HO1cv9*1bZJ1pn`4|3>`hCSK5vqCmgCa4Qb!Vwf0y@ zjg&KA2)cRgZb~Kh_w&nZY_h-crJ;A?z^aX&EkkWTMx%U!o_#*Q$u?rIg!w(*Ru5Ki zSl`3G>9ezRUd&$3cV!fA{j&laR4bM;B@uPs*ELz3g*SeOF6%H@i+U*cc2YC=Zi_Tu zZ+;B|A8s;XlY+q*4^P#=O_3N(b?F;{>-qAtNiLQ%ErI5XZ2|YWBs^S2O~%E=J$(;3 zRwnr~ulBu%X8xkCZ)coVHfpy08DsR&egJ)PE#OG$ta}FNg^s=Jq;w{5z^o}hu9yE( zoKiSYFJ$K7v-QwUnEEtsi?!+3(H;eyS0ddg_O8FWv}D+l<^>%pPlgF>SL74Z za$dM!Ipuhy&;UX_Iie|3nAp&cr^bXDJu9&sAg%W748dVzTYi_XyYm!TYhjkNWaY09 z4#WIYy?UyJ>XPh=%Pz*;uGN$}`A*a($zPXi>nwH4<$KP8s`}Ji!9+SdV=jOR`rtwg;(kZk3~Hk>P1WH2WAy@7#wsBm ziUfMVklJ<$RuYk+EwF=Tu3LNRey5v#fh>kWqzw1!Mv|01Pu(;@z94UkN=O?03263s z$QeRuYb}JssS$C1S`;XU{?}`9@?96`f@zk_&8S?B9?;M}B?%)!ZT~x)Ed!ZeSUDX~ zNnukv0@}@YD>5&zpR6ppTtGXf*(#q4?($v+xDh zd^Ww`9nYP|NOaS0&c7PFgMPi;vuxTSqdqqc1TD8$tZvc|#UMSkPk^`@s1ESLuR+WP9Jx^!-rn1XkC+`1{$? zwvspZ7f)hgxnhR_Z{@FP;GU<+!=Ioo8_c&PXatu7O_`TUX~fcx=mnxw5&!~#amt98vv5f{aUGTWI+5%=wn;|EMl`iI0cY3FxIJT#XQ-?ad0j`anBEI@p6 z=_7$yQ9|pY?>7X9-7tY@6gVZHQ%*WrC~X2*=Q~#CV&a9(A;r=+-fMHLT6&mk zy9-}m_#s47@jJ><_iqUl zTblyb4$(3;l;T5DkcckLV3s6$d{=lC5Rzmk;h9}M!y0$sQsC+G#(zZudaAg761LDk z)UiJ25$6}1Mu_1kihX@I;GH)RF}lTv9J#0lS~Unq@vp8szhoT19>G`Xubn|V-Klqi zoxgjRs%d;?-)#j=JOAApOcy>8bOtwMs$TnvK#)tHlL=nvAQ$@8e*GzTP6Z<0J4cRu z3i6GCw)yYR)bCWdYy*1YhL~07Jujs{$N4(7V)GEZk;VGney5LzuT(1fZ_jC7xXZQ* zC!a7Ld6py4AO=GEhqI4wXObRt%J3-S3<$6dbC=vyzU{Q9z!tF zFU8Hw)}ECQ_O)oj=1D(sB0Rg!KTP8EBbia%eX|5fwHG{u*G}sdQxB8&NxK1)Im|0Yl z&j#yr_^p_6H|@k-dcw$C6tx#;?0LaEA?j+9{AGuj{yy#GMjGhAy|Ss>op?LXSl|xc zgVKO5z`6{ZRFDu{Ifs}pB0oJBb!`k5+oj(KR;;3CS>w-nyNzR(q^H||hs()(Uu3JN zD>cM+hRFDdKZ>jm_(k3>waMN2@lRSbDZjK%n#*|N2^pwOz8r8S9Z*^WtBS6#&uCsq z7l4QxH!?7~{X=1_&8z~V!z(C*RThoU)OGwu&VhR2lgLk4kX3;>*OiDUKbT=KW#UDj zJWEI^+%E0%A8j8e2U_tV-r?XG#iPeJl75pbpHu%*hX~vuq9jsV2Fy zYsv0^Tsk^-K+M&>VpmGqR1S&pDvt3=iFra4KF5Q#80_u(*2X+h3!fuDgD&tyiw#h+ z)_w7wcaE+(^i!(uo+p;}&AM4c5L_QkYQ|Xu^nAHbug5)745nBw#~%@W`7UlN&ATX` ztrs9><%%LYF0lO$oswbxIiTxVam|sri0UrCB8GpJV?phN5Dt3A8Axj%q_OWPnlv7y z!GfpJs;j&2D3c`TmNfqF7&|)Q=vdwDH*I@8|9aNKm*PXt#dVk24<^2LPqzP1JEGR{ zLKcVf6dAUu5~ZjEwTm^{8sr9}DtCjwU#TySw&gkxh4HF%m0ssT|9BdWn$xY3IrW$C zdP3H8m3?LTv13e1DU_~v8n0BEkcv8>W?3a?o!Bw@+IWj-?=ys&IHvf!XNZJAfv1f| z6JkC$`~-VvcrJcl+jo#pMqRdxdOWCukXhaIw)EduD0`}<)e`skH&@U)*dK# zD%v~h3BPg|a$UfM!wV)F0UZL=a|GeF0KFP3-4RFDCK@fq*Bx%)szj~Y0Hlc_+lOAq zH*D%VL}5W^2uGAxlE=x8O1HKb-(}}FF?GKQbAKi4_}@~!3ihhIf^^TVV9Jv*N_DQ( zx%fzdQOg909j$MU?nJ-VTei8n=TQ}zhU{bdUc3*Su^7tkd<(B%J=FCOD( z8G8g$j7bkMo7V9!^Aa@`w&P3!BdI|9uJ@J*DS53$9J7bkk@vLoK^2|!6~Moq-e7r4 zH3{2OcH|)9_O4{WxG(9Ds>U{Fl9XHuooPFFsT6mDqfK)-q4n9v=uL;;%cC1VNmw1? zy6jCmn4cKB7nJH=h}9x~X~>*eX^7h#=a7gEjTY^kD2$h8W8Ww{^ygQMu6g9Cqc0{l zQY}vY&%Tyr@AUP4_RQ;iZs)$)@uyab-TbC!cRp<5iZbCp^N;kZ%2e^Cw&(O%?McpYRx2yMaihpXb6mkz-S22KLpa4isqExWM~j$006XyRlWcK literal 0 HcmV?d00001 diff --git a/extra/mtoolsrc b/extra/mtoolsrc new file mode 100644 index 0000000..df1a26e --- /dev/null +++ b/extra/mtoolsrc @@ -0,0 +1,2 @@ +# For older versions of mtools, you may have to remove "filter" +drive v: file="fd.img" 1.44M filter diff --git a/extra/qemu-port-e9.diff b/extra/qemu-port-e9.diff new file mode 100644 index 0000000..d8be044 --- /dev/null +++ b/extra/qemu-port-e9.diff @@ -0,0 +1,73 @@ +--- Makefile.target 17 Mar 2004 23:46:04 -0000 1.19 ++++ Makefile.target 18 Mar 2004 14:20:29 -0000 +@@ -217,7 +217,8 @@ + # must use static linking to avoid leaving stuff in virtual address space + VL_OBJS=vl.o osdep.o block.o monitor.o \ + ide.o ne2000.o pckbd.o vga.o sb16.o dma.o oss.o \ +- fdc.o mc146818rtc.o serial.o i8259.o i8254.o pc.o ++ fdc.o mc146818rtc.o serial.o i8259.o i8254.o pc.o \ ++ port-e9.o + ifeq ($(TARGET_ARCH), ppc) + VL_OBJS+= hw.o + endif +--- hw/pc.c 14 Mar 2004 21:46:48 -0000 1.2 ++++ hw/pc.c 18 Mar 2004 14:20:29 -0000 +@@ -371,6 +371,7 @@ + SB16_init(); + + fdctrl_init(6, 2, 0, 0x3f0, fd_table); ++ port_e9_init(); + + cmos_init(ram_size, boot_device); + } +--- /dev/null 2003-01-30 11:24:37.000000000 +0100 ++++ port-e9.c 2004-03-18 15:18:52.660493187 +0100 +@@ -0,0 +1,38 @@ ++/* ++ * QEMU Port 0xe9 hack ++ * ++ * Copyright (c) 2000-2004 E. Marty, the bochs team, D. Decotigny ++ * ++ * Permission is hereby granted, free of charge, to any person obtaining a copy ++ * of this software and associated documentation files (the "Software"), to deal ++ * in the Software without restriction, including without limitation the rights ++ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell ++ * copies of the Software, and to permit persons to whom the Software is ++ * furnished to do so, subject to the following conditions: ++ * ++ * The above copyright notice and this permission notice shall be included in ++ * all copies or substantial portions of the Software. ++ * ++ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR ++ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, ++ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ++ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER ++ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, ++ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN ++ * THE SOFTWARE. ++ */ ++#include ++#include ++#include ++ ++#include "vl.h" ++ ++static void bochs_e9_write(void *opaque, uint32_t address, uint32_t data) ++{ ++ write(fileno(stdout), &data, 1); ++} ++ ++void port_e9_init () ++{ ++ register_ioport_write(0xe9, 1, 1, bochs_e9_write, NULL); ++} +--- vl.h 17 Mar 2004 23:17:16 -0000 1.14 ++++ vl.h 18 Mar 2004 14:29:06 -0000 +@@ -268,4 +268,7 @@ + void term_flush(void); + void term_print_help(void); + ++/* port-e9.c */ ++void port_e9_init(void); ++ + #endif /* VL_H */ diff --git a/extra/sos_bsect.lds b/extra/sos_bsect.lds new file mode 100644 index 0000000..ac42f23 --- /dev/null +++ b/extra/sos_bsect.lds @@ -0,0 +1,61 @@ +/* Copyright (C) 2004, David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +SECTIONS +{ + /* *********************************************** + * The bootsector is here. We link it against the remaining of the kernel + * in order to automatically figure out its size that must be loaded + * from file to memory (see the load_size definition below) + */ + + /* If we use one, we put the boot sector here. We don't set its + * address to 0x7c000 (aka 0x7c00:0), since it reloads itself to + * 0x9f000, causing the 0x7c000 address to be meaningless too. So we + * chose to pretend that the address is 0x0, and to make a little + * address arithmetic in bootsect.S */ + .bootsect 0x0 : + { + /* The code for the boot sector goes here */ + *(.bootsect); + + /* The load_size symbol contains the size of the area (in + * sectors, aka 512 Bytes) that the boot sector should copy from + * the disk. The bss section is not included since it uses 0 + * bytes on disk */ + load_size = .; + LONG((__e_load - __b_load + 511) >> 9); + /* ---> This is equivalent to ceil( (__e_load - __b_load) / 512 ) */ + + /* At offsets 511 and 512, we set the boot sector signature (AA55h) */ + . = 0x1fe; + SHORT(0xAA55); + } +} + + +/* This is to avoid a cut/paste here. Please notice that a multiboot + * section WILL be inserted, which is NOT mandatory (we could have + * removed it without getting into trouble). Please note however that + * the *.bin files will NOT be multiboot compatible (they are not in ELF + * format): they are expected to be directly booted by the BIOS (or + * by the "chainloader" command of Grub). */ +INCLUDE ../support/sos.lds + +/* We overload the entry set in sos.lds, just to avoid an ld warning */ +ENTRY(sos_main); diff --git a/hwcore/cpu_context.c b/hwcore/cpu_context.c new file mode 100644 index 0000000..248c741 --- /dev/null +++ b/hwcore/cpu_context.c @@ -0,0 +1,959 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2000-2004, The KOS team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + + +#include +#include +#include +#include +#include +#include +#include + +#include "cpu_context.h" + + +/** + * Here is the definition of a CPU context for IA32 processors. This + * is a SOS convention, not a specification given by the IA32 + * spec. However there is a strong constraint related to the x86 + * interrupt handling specification: the top of the stack MUST be + * compatible with the 'iret' instruction, ie there must be the + * err_code (might be 0), eip, cs and eflags of the destination + * context in that order (see Intel x86 specs vol 3, figure 5-4). + * + * @note IMPORTANT: This definition MUST be consistent with the way + * the registers are stored on the stack in + * irq_wrappers.S/exception_wrappers.S !!! Hence the constraint above. + */ +struct sos_cpu_state { + /* (Lower addresses) */ + + /* These are SOS convention */ + sos_ui16_t gs; + sos_ui16_t fs; + sos_ui16_t es; + sos_ui16_t ds; + sos_ui16_t cpl0_ss; /* This is ALWAYS the Stack Segment of the + Kernel context (CPL0) of the interrupted + thread, even for a user thread */ + sos_ui16_t alignment_padding; /* unused */ + sos_ui32_t eax; + sos_ui32_t ebx; + sos_ui32_t ecx; + sos_ui32_t edx; + sos_ui32_t esi; + sos_ui32_t edi; + sos_ui32_t ebp; + + /* MUST NEVER CHANGE (dependent on the IA32 iret instruction) */ + sos_ui32_t error_code; + sos_vaddr_t eip; + sos_ui32_t cs; /* 32bits according to the specs ! However, the CS + register is really 16bits long */ + sos_ui32_t eflags; + + /* (Higher addresses) */ +} __attribute__((packed)); + + +/** + * The CS value pushed on the stack by the CPU upon interrupt, and + * needed by the iret instruction, is 32bits long while the real CPU + * CS register is 16bits only: this macro simply retrieves the CPU + * "CS" register value from the CS value pushed on the stack by the + * CPU upon interrupt. + * + * The remaining 16bits pushed by the CPU should be considered + * "reserved" and architecture dependent. IMHO, the specs don't say + * anything about them. Considering that some architectures generate + * non-zero values for these 16bits (at least Cyrix), we'd better + * ignore them. + */ +#define GET_CPU_CS_REGISTER_VALUE(pushed_ui32_cs_value) \ + ( (pushed_ui32_cs_value) & 0xffff ) + + +/** + * Structure of an interrupted Kernel thread's context + */ +struct sos_cpu_kstate +{ + struct sos_cpu_state regs; +} __attribute__((packed)); + + +/** + * Structure of an interrupted User thread's context. This is almost + * the same as a kernel context, except that 2 additional values are + * pushed on the stack before the eflags/cs/eip of the interrupted + * context: the stack configuration of the interrupted user context. + * + * @see Section 6.4.1 of Intel x86 vol 1 + */ +struct sos_cpu_ustate +{ + struct sos_cpu_state regs; + struct + { + sos_ui32_t cpl3_esp; + sos_ui16_t cpl3_ss; + }; +} __attribute__((packed)); + + +/* + * Structure of a Task State Segment on the x86 Architecture. + * + * @see Intel x86 spec vol 3, figure 6-2 + * + * @note Such a data structure should not cross any page boundary (see + * end of section 6.2.1 of Intel spec vol 3). This is the reason why + * we tell gcc to align it on a 128B boundary (its size is 104B, which + * is <= 128). + */ +struct x86_tss { + + /** + * Intel provides a way for a task to switch to another in an + * automatic way (call gates). In this case, the back_link field + * stores the source TSS of the context switch. This allows to + * easily implement coroutines, task backtracking, ... In SOS we + * don't use TSS for the context switch purpouse, so we always + * ignore this field. + * (+0) + */ + sos_ui16_t back_link; + + sos_ui16_t reserved1; + + /* CPL0 saved context. (+4) */ + sos_vaddr_t esp0; + sos_ui16_t ss0; + + sos_ui16_t reserved2; + + /* CPL1 saved context. (+12) */ + sos_vaddr_t esp1; + sos_ui16_t ss1; + + sos_ui16_t reserved3; + + /* CPL2 saved context. (+20) */ + sos_vaddr_t esp2; + sos_ui16_t ss2; + + sos_ui16_t reserved4; + + /* Interrupted context's saved registers. (+28) */ + sos_vaddr_t cr3; + sos_vaddr_t eip; + sos_ui32_t eflags; + sos_ui32_t eax; + sos_ui32_t ecx; + sos_ui32_t edx; + sos_ui32_t ebx; + sos_ui32_t esp; + sos_ui32_t ebp; + sos_ui32_t esi; + sos_ui32_t edi; + + /* +72 */ + sos_ui16_t es; + sos_ui16_t reserved5; + + /* +76 */ + sos_ui16_t cs; + sos_ui16_t reserved6; + + /* +80 */ + sos_ui16_t ss; + sos_ui16_t reserved7; + + /* +84 */ + sos_ui16_t ds; + sos_ui16_t reserved8; + + /* +88 */ + sos_ui16_t fs; + sos_ui16_t reserved9; + + /* +92 */ + sos_ui16_t gs; + sos_ui16_t reserved10; + + /* +96 */ + sos_ui16_t ldtr; + sos_ui16_t reserved11; + + /* +100 */ + sos_ui16_t debug_trap_flag :1; + sos_ui16_t reserved12 :15; + sos_ui16_t iomap_base_addr; + + /* 104 */ +} __attribute__((packed, aligned(128))); + + +static struct x86_tss kernel_tss; + + +sos_ret_t sos_cpu_context_subsystem_setup() +{ + /* Reset the kernel TSS */ + memset(&kernel_tss, 0x0, sizeof(kernel_tss)); + + /** + * Now setup the kernel TSS. + * + * Considering the privilege change method we choose (cpl3 -> cpl0 + * through a software interrupt), we don't need to initialize a + * full-fledged TSS. See section 6.4.1 of Intel x86 vol 1. Actually, + * only a correct value for the kernel esp and ss are required (aka + * "ss0" and "esp0" fields). Since the esp0 will have to be updated + * at privilege change time, we don't have to set it up now. + */ + kernel_tss.ss0 = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KDATA); + + /* Register this TSS into the gdt */ + sos_gdt_register_kernel_tss((sos_vaddr_t) &kernel_tss); + + return SOS_OK; +} + + +/** + * THE main operation of a kernel thread. This routine calls the + * kernel thread function start_func and calls exit_func when + * start_func returns. + */ +static void core_routine (sos_cpu_kstate_function_arg1_t *start_func, + sos_ui32_t start_arg, + sos_cpu_kstate_function_arg1_t *exit_func, + sos_ui32_t exit_arg) + __attribute__((noreturn)); + +static void core_routine (sos_cpu_kstate_function_arg1_t *start_func, + sos_ui32_t start_arg, + sos_cpu_kstate_function_arg1_t *exit_func, + sos_ui32_t exit_arg) +{ + start_func(start_arg); + exit_func(exit_arg); + + SOS_ASSERT_FATAL(! "The exit function of the thread should NOT return !"); + for(;;); +} + + +sos_ret_t sos_cpu_kstate_init(struct sos_cpu_state **ctxt, + sos_cpu_kstate_function_arg1_t *start_func, + sos_ui32_t start_arg, + sos_vaddr_t stack_bottom, + sos_size_t stack_size, + sos_cpu_kstate_function_arg1_t *exit_func, + sos_ui32_t exit_arg) +{ + /* We are initializing a Kernel thread's context */ + struct sos_cpu_kstate *kctxt; + + /* This is a critical internal function, so that it is assumed that + the caller knows what he does: we legitimally assume that values + for ctxt, start_func, stack_* and exit_func are allways VALID ! */ + + /* Setup the stack. + * + * On x86, the stack goes downward. Each frame is configured this + * way (higher addresses first): + * + * - (optional unused space. As of gcc 3.3, this space is 24 bytes) + * - arg n + * - arg n-1 + * - ... + * - arg 1 + * - return instruction address: The address the function returns to + * once finished + * - local variables + * + * The remaining of the code should be read from the end upward to + * understand how the processor will handle it. + */ + + sos_vaddr_t tmp_vaddr = stack_bottom + stack_size; + sos_ui32_t *stack = (sos_ui32_t*)tmp_vaddr; + + /* If needed, poison the stack */ +#ifdef SOS_CPU_STATE_DETECT_UNINIT_KERNEL_VARS + memset((void*)stack_bottom, SOS_CPU_STATE_STACK_POISON, stack_size); +#elif defined(SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW) + sos_cpu_state_prepare_detect_kernel_stack_overflow(stack_bottom, stack_size); +#endif + + /* Simulate a call to the core_routine() function: prepare its + arguments */ + *(--stack) = exit_arg; + *(--stack) = (sos_ui32_t)exit_func; + *(--stack) = start_arg; + *(--stack) = (sos_ui32_t)start_func; + *(--stack) = 0; /* Return address of core_routine => force page fault */ + + /* + * Setup the initial context structure, so that the CPU will execute + * the function core_routine() once this new context has been + * restored on CPU + */ + + /* Compute the base address of the structure, which must be located + below the previous elements */ + tmp_vaddr = ((sos_vaddr_t)stack) - sizeof(struct sos_cpu_kstate); + kctxt = (struct sos_cpu_kstate*)tmp_vaddr; + + /* Initialize the CPU context structure */ + memset(kctxt, 0x0, sizeof(struct sos_cpu_kstate)); + + /* Tell the CPU context structure that the first instruction to + execute will be that of the core_routine() function */ + kctxt->regs.eip = (sos_ui32_t)core_routine; + + /* Setup the segment registers */ + kctxt->regs.cs + = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KCODE); /* Code */ + kctxt->regs.ds + = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KDATA); /* Data */ + kctxt->regs.es + = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KDATA); /* Data */ + kctxt->regs.cpl0_ss + = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KDATA); /* Stack */ + /* fs and gs unused for the moment. */ + + /* The newly created context is initially interruptible */ + kctxt->regs.eflags = (1 << 9); /* set IF bit */ + + /* Finally, update the generic kernel/user thread context */ + *ctxt = (struct sos_cpu_state*) kctxt; + + return SOS_OK; +} + + +sos_ret_t sos_cpu_ustate_init(struct sos_cpu_state **ctxt, + sos_uaddr_t user_start_PC, + sos_ui32_t user_start_arg1, + sos_ui32_t user_start_arg2, + sos_uaddr_t user_initial_SP, + sos_vaddr_t kernel_stack_bottom, + sos_size_t kernel_stack_size) +{ + /* We are initializing a User thread's context */ + struct sos_cpu_ustate *uctxt; + + /* This is a critical internal function, so that it is assumed that + the caller knows what he does: we legitimally assume that values + for ctxt, etc. are allways VALID ! */ + + /* Compute the address of the CPU state to restore on CPU when + switching to this new user thread */ + sos_vaddr_t uctxt_vaddr = kernel_stack_bottom + + kernel_stack_size + - sizeof(struct sos_cpu_ustate); + uctxt = (struct sos_cpu_ustate*)uctxt_vaddr; + + /* If needed, poison the kernel stack */ +#ifdef SOS_CPU_STATE_DETECT_UNINIT_KERNEL_VARS + memset((void*)kernel_stack_bottom, + SOS_CPU_STATE_STACK_POISON, + kernel_stack_size); +#elif defined(SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW) + sos_cpu_state_prepare_detect_kernel_stack_overflow(kernel_stack_bottom, + kernel_stack_size); +#endif + + /* + * Setup the initial context structure, so that the CPU will restore + * the initial registers' value for the user thread. The + * user thread argument is passed in the EAX register. + */ + + memset(uctxt, 0x0, sizeof(struct sos_cpu_ustate)); + + /* Tell the CPU context structure that the first instruction to + execute will be located at user_start_PC (in user space) */ + uctxt->regs.eip = (sos_ui32_t)user_start_PC; + + /* Tell the CPU where will be the user stack */ + uctxt->cpl3_esp = user_initial_SP; + + /* The parameter to the start function is not passed by the stack to + avoid a possible page fault */ + uctxt->regs.eax = user_start_arg1; + uctxt->regs.ebx = user_start_arg2; + + /* Setup the segment registers */ + uctxt->regs.cs + = SOS_BUILD_SEGMENT_REG_VALUE(3, FALSE, SOS_SEG_UCODE); /* Code */ + uctxt->regs.ds + = SOS_BUILD_SEGMENT_REG_VALUE(3, FALSE, SOS_SEG_UDATA); /* Data */ + uctxt->regs.es + = SOS_BUILD_SEGMENT_REG_VALUE(3, FALSE, SOS_SEG_UDATA); /* Data */ + uctxt->cpl3_ss + = SOS_BUILD_SEGMENT_REG_VALUE(3, FALSE, SOS_SEG_UDATA); /* User Stack */ + + /* We need also to update the segment for the kernel stack + segment. It will be used when this context will be restored on + CPU: initially it will be executing in kernel mode and will + switch immediatly to user mode */ + uctxt->regs.cpl0_ss + = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KDATA); /* Kernel Stack */ + + /* fs and gs unused for the moment. */ + + /* The newly created context is initially interruptible */ + uctxt->regs.eflags = (1 << 9); /* set IF bit */ + + /* Finally, update the generic kernel/user thread context */ + *ctxt = (struct sos_cpu_state*) uctxt; + + return SOS_OK; +} + + +sos_ret_t +sos_cpu_context_is_in_user_mode(const struct sos_cpu_state *ctxt) +{ + /* An interrupted user thread has its CS register set to that of the + User code segment */ + switch (GET_CPU_CS_REGISTER_VALUE(ctxt->cs)) + { + case SOS_BUILD_SEGMENT_REG_VALUE(3, FALSE, SOS_SEG_UCODE): + return TRUE; + break; + + case SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KCODE): + return FALSE; + break; + + default: + SOS_FATAL_ERROR("Invalid saved context Code segment register: 0x%x (k=%x, u=%x) !", + (unsigned) GET_CPU_CS_REGISTER_VALUE(ctxt->cs), + SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KCODE), + SOS_BUILD_SEGMENT_REG_VALUE(3, FALSE, SOS_SEG_UCODE)); + break; + } + + /* Should never get here */ + return -SOS_EFATAL; +} + + +#if defined(SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW) +void +sos_cpu_state_prepare_detect_kernel_stack_overflow(const struct sos_cpu_state *ctxt, + sos_vaddr_t stack_bottom, + sos_size_t stack_size) +{ + sos_size_t poison_size = SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW; + if (poison_size > stack_size) + poison_size = stack_size; + + memset((void*)stack_bottom, SOS_CPU_STATE_STACK_POISON, poison_size); +} + + +void +sos_cpu_state_detect_kernel_stack_overflow(const struct sos_cpu_state *ctxt, + sos_vaddr_t stack_bottom, + sos_size_t stack_size) +{ + unsigned char *c; + int i; + + /* On SOS, "ctxt" corresponds to the address of the esp register of + the saved context in Kernel mode (always, even for the interrupted + context of a user thread). Here we make sure that this stack + pointer is within the allowed stack area */ + SOS_ASSERT_FATAL(((sos_vaddr_t)ctxt) >= stack_bottom); + SOS_ASSERT_FATAL(((sos_vaddr_t)ctxt) + sizeof(struct sos_cpu_kstate) + <= stack_bottom + stack_size); + + /* Check that the bottom of the stack has not been altered */ + for (c = (unsigned char*) stack_bottom, i = 0 ; + (i < SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW) && (i < stack_size) ; + c++, i++) + { + SOS_ASSERT_FATAL(SOS_CPU_STATE_STACK_POISON == *c); + } +} +#endif + + +/* ======================================================================= + * Public Accessor functions + */ + + +sos_vaddr_t sos_cpu_context_get_PC(const struct sos_cpu_state *ctxt) +{ + SOS_ASSERT_FATAL(NULL != ctxt); + + /* This is the PC of the interrupted context (ie kernel or user + context). */ + return ctxt->eip; +} + + +sos_vaddr_t sos_cpu_context_get_SP(const struct sos_cpu_state *ctxt) +{ + SOS_ASSERT_FATAL(NULL != ctxt); + + /* 'ctxt' corresponds to the SP of the interrupted context, in Kernel + mode. We have to test whether the original interrupted context + was that of a kernel or user thread */ + if (TRUE == sos_cpu_context_is_in_user_mode(ctxt)) + { + struct sos_cpu_ustate * uctxt = (struct sos_cpu_ustate*)ctxt; + return uctxt->cpl3_esp; + } + + /* On SOS, "ctxt" corresponds to the address of the esp register of + the saved context in Kernel mode (always, even for the interrupted + context of a user thread). */ + return (sos_vaddr_t)ctxt; +} + + +sos_ret_t +sos_cpu_context_set_EX_return_address(struct sos_cpu_state *ctxt, + sos_vaddr_t ret_vaddr) +{ + ctxt->eip = ret_vaddr; + return SOS_OK; +} + + +void sos_cpu_context_dump(const struct sos_cpu_state *ctxt) +{ + char buf[128]; + + snprintf(buf, sizeof(buf), + "CPU: eip=%x esp0=%x eflags=%x cs=%x ds=%x ss0=%x err=%x", + (unsigned)ctxt->eip, (unsigned)ctxt, (unsigned)ctxt->eflags, + (unsigned)GET_CPU_CS_REGISTER_VALUE(ctxt->cs), (unsigned)ctxt->ds, + (unsigned)ctxt->cpl0_ss, + (unsigned)ctxt->error_code); + if (TRUE == sos_cpu_context_is_in_user_mode(ctxt)) + { + struct sos_cpu_ustate * uctxt = (struct sos_cpu_ustate*)ctxt; + snprintf(buf, sizeof(buf), + "%s esp3=%x ss3=%x", + buf, (unsigned)uctxt->cpl3_esp, (unsigned)uctxt->cpl3_ss); + } + else + snprintf(buf, sizeof(buf), "%s [KERNEL MODE]", buf); + + sos_bochs_putstring(buf); sos_bochs_putstring("\n"); + sos_x86_videomem_putstring(23, 0, + SOS_X86_VIDEO_FG_BLACK | SOS_X86_VIDEO_BG_LTGRAY, + buf); +} + + +/* ======================================================================= + * Public Accessor functions TO BE USED ONLY BY Exception handlers + */ + + +sos_ui32_t sos_cpu_context_get_EX_info(const struct sos_cpu_state *ctxt) +{ + SOS_ASSERT_FATAL(NULL != ctxt); + return ctxt->error_code; +} + + +sos_vaddr_t +sos_cpu_context_get_EX_faulting_vaddr(const struct sos_cpu_state *ctxt) +{ + sos_ui32_t cr2; + + /* + * See Intel Vol 3 (section 5.14): the address of the faulting + * virtual address of a page fault is stored in the cr2 + * register. + * + * Actually, we do not store the cr2 register in a saved + * kernel thread's context. So we retrieve the cr2's value directly + * from the processor. The value we retrieve in an exception handler + * is actually the correct one because an exception is synchronous + * with the code causing the fault, and cannot be interrupted since + * the IDT entries in SOS are "interrupt gates" (ie IRQ are + * disabled). + */ + asm volatile ("movl %%cr2, %0" + :"=r"(cr2) + : ); + + return cr2; +} + + +/* ======================================================================= + * Public Accessor functions TO BE USED ONLY BY the SYSCALL handler + */ + + +/* + * By convention, the USER SOS programs always pass 4 arguments to the + * kernel syscall handler: in eax/../edx. For less arguments, the + * unused registers are filled with 0s. For more arguments, the 4th + * syscall parameter gives the address of the array containing the + * remaining arguments. In any case, eax corresponds to the syscall + * IDentifier. + */ + + +inline +sos_ret_t sos_syscall_get3args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3) +{ + *arg1 = user_ctxt->ebx; + *arg2 = user_ctxt->ecx; + *arg3 = user_ctxt->edx; + return SOS_OK; +} + + +sos_ret_t sos_syscall_get1arg(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1) +{ + unsigned int unused; + return sos_syscall_get3args(user_ctxt, arg1, & unused, & unused); +} + + +sos_ret_t sos_syscall_get2args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2) +{ + unsigned int unused; + return sos_syscall_get3args(user_ctxt, arg1, arg2, & unused); +} + + +/* + * sos_syscall_get3args() is defined in cpu_context.c because it needs + * to know the structure of a struct spu_state + */ + +sos_ret_t sos_syscall_get4args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4) +{ + sos_uaddr_t uaddr_other_args; + unsigned int other_args[2]; + sos_ret_t retval; + + /* Retrieve the 3 arguments. The last one is an array containing the + remaining arguments */ + retval = sos_syscall_get3args(user_ctxt, arg1, arg2, + (unsigned int *)& uaddr_other_args); + if (SOS_OK != retval) + return retval; + + /* Copy the array containing the remaining arguments from user + space */ + retval = sos_memcpy_from_user((sos_vaddr_t)other_args, + (sos_uaddr_t)uaddr_other_args, + sizeof(other_args)); + if (sizeof(other_args) != retval) + return -SOS_EFAULT; + + *arg3 = other_args[0]; + *arg4 = other_args[1]; + return SOS_OK; +} + + +sos_ret_t sos_syscall_get5args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5) +{ + sos_uaddr_t uaddr_other_args; + unsigned int other_args[3]; + sos_ret_t retval; + + /* Retrieve the 3 arguments. The last one is an array containing the + remaining arguments */ + retval = sos_syscall_get3args(user_ctxt, arg1, arg2, + (unsigned int *)& uaddr_other_args); + if (SOS_OK != retval) + return retval; + + /* Copy the array containing the remaining arguments from user + space */ + retval = sos_memcpy_from_user((sos_vaddr_t)other_args, + (sos_uaddr_t)uaddr_other_args, + sizeof(other_args)); + if (sizeof(other_args) != retval) + return -SOS_EFAULT; + + *arg3 = other_args[0]; + *arg4 = other_args[1]; + *arg5 = other_args[2]; + return SOS_OK; +} + + +sos_ret_t sos_syscall_get6args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5, + /* out */unsigned int *arg6) +{ + sos_uaddr_t uaddr_other_args; + unsigned int other_args[4]; + sos_ret_t retval; + + /* Retrieve the 3 arguments. The last one is an array containing the + remaining arguments */ + retval = sos_syscall_get3args(user_ctxt, arg1, arg2, + (unsigned int *)& uaddr_other_args); + if (SOS_OK != retval) + return retval; + + /* Copy the array containing the remaining arguments from user + space */ + retval = sos_memcpy_from_user((sos_vaddr_t)other_args, + (sos_uaddr_t)uaddr_other_args, + sizeof(other_args)); + if (sizeof(other_args) != retval) + return -SOS_EFAULT; + + *arg3 = other_args[0]; + *arg4 = other_args[1]; + *arg5 = other_args[2]; + *arg6 = other_args[3]; + return SOS_OK; +} + + +sos_ret_t sos_syscall_get7args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5, + /* out */unsigned int *arg6, + /* out */unsigned int *arg7) +{ + sos_uaddr_t uaddr_other_args; + unsigned int other_args[5]; + sos_ret_t retval; + + /* Retrieve the 3 arguments. The last one is an array containing the + remaining arguments */ + retval = sos_syscall_get3args(user_ctxt, arg1, arg2, + (unsigned int *)& uaddr_other_args); + if (SOS_OK != retval) + return retval; + + /* Copy the array containing the remaining arguments from user + space */ + retval = sos_memcpy_from_user((sos_vaddr_t)other_args, + (sos_uaddr_t)uaddr_other_args, + sizeof(other_args)); + if (sizeof(other_args) != retval) + return -SOS_EFAULT; + + *arg3 = other_args[0]; + *arg4 = other_args[1]; + *arg5 = other_args[2]; + *arg6 = other_args[3]; + *arg7 = other_args[4]; + return SOS_OK; +} + + +sos_ret_t sos_syscall_get8args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5, + /* out */unsigned int *arg6, + /* out */unsigned int *arg7, + /* out */unsigned int *arg8) +{ + sos_uaddr_t uaddr_other_args; + unsigned int other_args[6]; + sos_ret_t retval; + + /* Retrieve the 3 arguments. The last one is an array containing the + remaining arguments */ + retval = sos_syscall_get3args(user_ctxt, arg1, arg2, + (unsigned int *)& uaddr_other_args); + if (SOS_OK != retval) + return retval; + + /* Copy the array containing the remaining arguments from user + space */ + retval = sos_memcpy_from_user((sos_vaddr_t)other_args, + (sos_uaddr_t)uaddr_other_args, + sizeof(other_args)); + if (sizeof(other_args) != retval) + return -SOS_EFAULT; + + *arg3 = other_args[0]; + *arg4 = other_args[1]; + *arg5 = other_args[2]; + *arg6 = other_args[3]; + *arg7 = other_args[4]; + *arg8 = other_args[5]; + return SOS_OK; +} + + +/* ======================================================================= + * Backtrace facility. To be used for DEBUGging purpose ONLY. + */ + + +sos_ui32_t sos_backtrace(const struct sos_cpu_state *cpu_state, + sos_ui32_t max_depth, + sos_vaddr_t stack_bottom, + sos_size_t stack_size, + sos_backtrace_callback_t * backtracer, + void *custom_arg) +{ + int depth; + sos_vaddr_t callee_PC, caller_frame; + + /* Cannot backtrace an interrupted user thread ! */ + if ((NULL != cpu_state) + && + (TRUE == sos_cpu_context_is_in_user_mode(cpu_state))) + { + return 0; + } + + /* + * Layout of a frame on the x86 (compiler=gcc): + * + * funcA calls funcB calls funcC + * + * .... + * funcB Argument 2 + * funcB Argument 1 + * funcA Return eip + * frameB: funcA ebp (ie previous stack frame) + * .... + * (funcB local variables) + * .... + * funcC Argument 2 + * funcC Argument 1 + * funcB Return eip + * frameC: funcB ebp (ie previous stack frame == A0) <---- a frame address + * .... + * (funcC local variables) + * .... + * + * The presence of "ebp" on the stack depends on 2 things: + * + the compiler is gcc + * + the source is compiled WITHOUT the -fomit-frame-pointer option + * In the absence of "ebp", chances are high that the value pushed + * at that address is outside the stack boundaries, meaning that the + * function will return -SOS_ENOSUP. + */ + + if (cpu_state) + { + callee_PC = cpu_state->eip; + caller_frame = cpu_state->ebp; + } + else + { + /* Skip the sos_backtrace() frame */ + callee_PC = (sos_vaddr_t)__builtin_return_address(0); + caller_frame = (sos_vaddr_t)__builtin_frame_address(1); + } + + for(depth=0 ; depth < max_depth ; depth ++) + { + /* Call the callback */ + backtracer(callee_PC, caller_frame + 8, depth, custom_arg); + + /* If the frame address is funky, don't go further */ + if ( (caller_frame < stack_bottom) + || (caller_frame + 4 >= stack_bottom + stack_size) ) + return depth; + + /* Go to caller frame */ + callee_PC = *((sos_vaddr_t*) (caller_frame + 4)); + caller_frame = *((sos_vaddr_t*) caller_frame); + } + + return depth; +} + + +/* ************************************************************* + * Function to manage the TSS. This function is not really "public": + * it is reserved to the assembler routines defined in + * cpu_context_switch.S + * + * Update the kernel stack address so that the IRQ, syscalls and + * exception return in a correct stack location when coming back into + * kernel mode. + */ +void +sos_cpu_context_update_kernel_tss(struct sos_cpu_state *next_ctxt) +{ + /* next_ctxt corresponds to an interrupted user thread ? */ + if (sos_cpu_context_is_in_user_mode(next_ctxt)) + { + /* + * Yes: "next_ctxt" is an interrupted user thread => we are + * going to switch to user mode ! Setup the stack address so + * that the user thread "next_ctxt" can come back to the correct + * stack location when returning in kernel mode. + * + * This stack location corresponds to the SP of the next user + * thread once its context has been transferred on the CPU, ie + * once the CPU has executed all the pop/iret instruction of the + * context switch with privilege change. + */ + kernel_tss.esp0 = ((sos_vaddr_t)next_ctxt) + + sizeof(struct sos_cpu_ustate); + /* Note: no need to protect this agains IRQ because IRQs are not + allowed to update it by themselves, and they are not allowed + to block */ + } + else + { + /* No: No need to update kernel TSS when we stay in kernel + mode */ + } +} diff --git a/hwcore/cpu_context.h b/hwcore/cpu_context.h new file mode 100644 index 0000000..b16fcab --- /dev/null +++ b/hwcore/cpu_context.h @@ -0,0 +1,401 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2000-2004, The KOS team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_CPUCTXT_H_ +#define _SOS_CPUCTXT_H_ + + +/** + * @file cpu_context.h + * + * Low level API to manage kernel and user thread CPU contexts. Should + * be some kind of architecture-independent. + */ + +#include +#include + + +/** + * Prepare the system to deal with multiple CPU execution contexts + */ +sos_ret_t sos_cpu_context_subsystem_setup(); + + +/** + * Opaque structure storing the CPU context of an inactive kernel or + * user thread, as saved by the low level primitives below or by the + * interrupt/exception handlers. + * + * @note This is an (architecture-independent) forward declaration: + * see cpu_context.c and the *.S files for its + * (architecture-dependent) definition. + */ +struct sos_cpu_state; + + +/** + * The type of the functions passed as arguments to the Kernel thread + * related functions. + */ +typedef void (sos_cpu_kstate_function_arg1_t(sos_ui32_t arg1)); + + +/** + * Function to create an initial context for a kernel thread starting + * its execution at function start_func with the argument initial_arg, + * and having the stack defined by stack_bottom/stack_size. When the + * start_func function returns, the function exit_func is called with + * argument exit_arg. + * + * @param kctxt The kernel thread CPU context to initialize. The + * address of the newly-initialized struct sos_cpu_state will be + * stored in this variable. The contents of this struct sos_cpu_state + * are actually located /inside/ the stack. + * + * @param start_func The address of the first instruction that will be + * executed when this context will be first transferred on + * CPU. Practically speaking, this is the address of a function that + * is assumed to take 1 argument. + * + * @param start_arg The value that will be passed as the argument to + * start_func when the thread starts. The stack will be setup + * accordingly to simulate a real call to the function and really + * passing this arguement. + * + * @param stack_bottom The lowest address of the stack. + * + * @param stack_size The size of the stack. + * + * @param exit_func The address of the instruction executed after the + * function start_func has returned. This function takes 1 parameter + * as argument: exit_arg. + * + * @param exit_arg The argument passed to the function exit_func. + * + * @note the newly created context is INTERRUPTIBLE by default ! + */ +sos_ret_t sos_cpu_kstate_init(struct sos_cpu_state **kctxt, + sos_cpu_kstate_function_arg1_t *start_func, + sos_ui32_t start_arg, + sos_vaddr_t stack_bottom, + sos_size_t stack_size, + sos_cpu_kstate_function_arg1_t *exit_func, + sos_ui32_t exit_arg); + + +/** + * Function to create an initial context for a user thread starting + * its execution at function user_start_PC with the user_start_arg + * argument. The address of the user stack before any modification by + * the ustate_init() function is given by user_start_SP. The user + * thread starts in user space first and needs a kernel stack for + * the syscalls and for handling interrupts: the address of this + * kernel stack is given by the kernel_stack_* parameters. + * + * @param uctxt The user thread CPU context to initialize. The + * address of the newly-initialized struct sos_cpu_state will be + * stored in this variable. The contents of this struct sos_cpu_state + * are actually located /inside/ the kernel stack of the thread. + * + * @param user_start_PC The address of the first instruction that will + * be executed in user mode when this context will be first + * transferred on CPU. Practically speaking, this is the address of a + * function that is assumed to take 1 argument. + * + * @param user_start_SP The initial user stack address. + * + * @param user_start_argX The 2 parameters passed to the initial user + * thread function (in registers). + * + * @param kernel_stack_bottom The lowest address of the kernel stack + * used to switch to user mode and to handle interrupts/exceptions. + * + * @param kernel_stack_size The size of the kernel stack (@see + * kernel_stack_bottom). + * + * @note the newly thread context is INTERRUPTIBLE ! + */ +sos_ret_t sos_cpu_ustate_init(struct sos_cpu_state **uctxt, + sos_uaddr_t user_start_PC, + sos_ui32_t user_start_arg1, + sos_ui32_t user_start_arg2, + sos_uaddr_t user_initial_SP, + sos_vaddr_t kernel_stack_bottom, + sos_size_t kernel_stack_size); + + +/** + * Function that performs an immediate context-switch from one + * kernel/user thread to another one. It stores the current executing + * context in from_ctxt, and restores to_context on CPU. + * + * @param from_ctxt The address of the struct sos_cpu_state will be + * stored in this variable. Must NOT be NULL. + * + * @param to_ctxt The CPU will resume its execution with the struct + * sos_cpu_state located at this address. Must NOT be NULL. + */ +void sos_cpu_context_switch(struct sos_cpu_state **from_ctxt, + struct sos_cpu_state *to_ctxt); + + +/* + * Switch to the new given context (of a kernel/user thread) without + * saving the old context (of another kernel/user thread), and call + * the function reclaiming_func passing it the recalining_arg + * argument. The reclaining function is called from within the stack + * of the new context, so that it can (among other things) safely + * destroy the stack of the former context. + * + * @param switch_to_ctxt The context that will be restored on the CPU + * + * @param reclaiming_func The address of the function that will be + * called after having changed the stack, but before restoring the CPU + * context to switch_to_ctxt. + */ +void +sos_cpu_context_exit_to(struct sos_cpu_state *switch_to_ctxt, + sos_cpu_kstate_function_arg1_t *reclaiming_func, + sos_ui32_t reclaiming_arg) __attribute__((noreturn)); + +/* ======================================================================= + * Public Accessor functions + */ + + +/** + * Return whether the saved context was in kernel or user context + * + * @return TRUE when context was interrupted when in user mode, FALSE + * when in kernel mode, < 0 on error. + */ +sos_ret_t +sos_cpu_context_is_in_user_mode(const struct sos_cpu_state *ctxt); + + +/** + * Return Program Counter stored in the saved kernel/user context + */ +sos_vaddr_t sos_cpu_context_get_PC(const struct sos_cpu_state *ctxt); + + +/** + * Return Stack Pointer stored in the saved kernel/user context + */ +sos_vaddr_t sos_cpu_context_get_SP(const struct sos_cpu_state *ctxt); + + +/** + * Dump the contents of the CPU context (bochs + x86_videomem) + */ +void sos_cpu_context_dump(const struct sos_cpu_state *ctxt); + + +/* ======================================================================= + * Public Accessor functions TO BE USED ONLY BY Exception handlers + */ + + +/** + * Return the argument passed by the CPU upon exception, as stored in the + * saved context + */ +sos_ui32_t sos_cpu_context_get_EX_info(const struct sos_cpu_state *ctxt); + + +/** + * Return the faulting address of the exception + */ +sos_vaddr_t +sos_cpu_context_get_EX_faulting_vaddr(const struct sos_cpu_state *ctxt); + + +/** + * Change the return address of the given context + */ +sos_ret_t +sos_cpu_context_set_EX_return_address(struct sos_cpu_state *ctxt, + sos_vaddr_t ret_vaddr); + + +/* ======================================================================= + * Public Accessor functions TO BE USED ONLY BY the SYSCALL handler + */ + +/** + * Low-level functions used by the syscall handler. They are + * responsible for retrieving the arguments passed to the syscall when + * a user thread makes a syscall. Some of these arguments are + * available as registers' values in the user context, some of them + * are user-space addresses given by these registers. + * + * @return SOS_OK on success, <0 otherwise + */ +sos_ret_t sos_syscall_get1arg(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1); + +sos_ret_t sos_syscall_get2args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2); + +sos_ret_t sos_syscall_get3args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3); + +sos_ret_t sos_syscall_get4args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4); + +sos_ret_t sos_syscall_get5args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5); + +sos_ret_t sos_syscall_get6args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5, + /* out */unsigned int *arg6); + +sos_ret_t sos_syscall_get7args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5, + /* out */unsigned int *arg6, + /* out */unsigned int *arg7); + +sos_ret_t sos_syscall_get8args(const struct sos_cpu_state *user_ctxt, + /* out */unsigned int *arg1, + /* out */unsigned int *arg2, + /* out */unsigned int *arg3, + /* out */unsigned int *arg4, + /* out */unsigned int *arg5, + /* out */unsigned int *arg6, + /* out */unsigned int *arg7, + /* out */unsigned int *arg8); + + +/* ======================================================================= + * Macros controlling stack poisoning. + * Stack poisoning can be used to detect: + * - unitialized local variables + * - when the thread might have gone too deep in the stack + */ +/** The signature of the poison */ +#define SOS_CPU_STATE_STACK_POISON 0xa5 + +/** + * When set, mean that the whole stack is poisoned to detect use of + * unititialized variables + */ +#define SOS_CPU_STATE_DETECT_UNINIT_KERNEL_VARS +/* #undef SOS_CPU_STATE_DETECT_UNINIT_KERNEL_VARS */ + +/** + * When set, mean that the bottom of the stack is poisoned to detect + * probable stack overflow. Its value indicates the number of bytes + * used for this detection. + */ +#define SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW 64 +/* #undef SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW */ + +#if defined(SOS_CPU_STATE_DETECT_KERNEL_STACK_OVERFLOW) +void +sos_cpu_state_prepare_detect_kernel_stack_overflow(const struct sos_cpu_state *ctxt, + sos_vaddr_t kernel_stack_bottom, + sos_size_t kernel_stack_size); +void sos_cpu_state_detect_kernel_stack_overflow(const struct sos_cpu_state *ctxt, + sos_vaddr_t kernel_stack_bottom, + sos_size_t kernel_stack_size); +#else +# define sos_cpu_state_prepare_detect_kernel_stack_overflow(ctxt,stkbottom,stksize) \ + ({ /* nop */ }) +# define sos_cpu_state_detect_kernel_stack_overflow(ctxt,stkbottom,stksize) \ + ({ /* nop */ }) +#endif + + +/* ======================================================================= + * Backtrace facility. To be used for DEBUGging purpose ONLY. + */ + + +/** + * The function called at each step of the backtrace iterations + * + * @param PC The address of the next instruction of the function that + * will be executed + * + * @param params The address of the array of the parameteres that have + * been passed to the function considered + * + * @param depth The index of the iteration (ie the depth of the + * current frame into the stack) + * + * @param custom_arg Whatever you want: this is the argument passed as + * custom_arg to sos_backtrace() + */ +typedef void (sos_backtrace_callback_t)(sos_vaddr_t PC, + sos_vaddr_t params, + sos_ui32_t depth, + void *custom_arg); + + +/** + * Call the backtracer callback on each frame stored in the cpu_state + * + * @param cpu_state The CPU context we want to explore. MUST be the + * context of a thread in Kernel mode, or NULL. When NULL: backtrace + * the current CPU context. + * + * @param max_depth The maximum number of frames to explore + * + * @param stack_bottom The lower boundary of the stack. This is used + * to make sure that the frame addresses fit inside the stack + * boudaries (ie are potentially correct). + * + * @param stack_size The size of the stack. Same comment. + * + * @param backtracer The function to call to handle the frame for each + * iteration + * + * @param custom_arg The arg passed as custom_arg to the backtracer + * + * @return The number of frames explored. + * + * @note Might be inaccurate when gcc's -fomit-frame-pointer has been + * used. + */ +sos_ui32_t sos_backtrace(const struct sos_cpu_state *cpu_state, + sos_ui32_t max_depth, + sos_vaddr_t stack_bottom, + sos_size_t stack_size, + sos_backtrace_callback_t * backtracer, + void *custom_arg); + +#endif /* _SOS_CPUCTXT_H_ */ diff --git a/hwcore/cpu_context_switch.S b/hwcore/cpu_context_switch.S new file mode 100644 index 0000000..f089426 --- /dev/null +++ b/hwcore/cpu_context_switch.S @@ -0,0 +1,159 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2000-2004, The KOS team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#define ASM_SOURCE 1 + + +#include "segment.h" + + +.file "cpu_context_switch.S" + +.text + + +/** + * C Function called by the routines below in order to tell the CPU + * where will be the kernel stack (needed by the interrupt handlers) + * when next_ctxt will come back into kernel mode. + * + * void sos_cpu_context_update_kernel_tss(struct sos_cpu_state *next_ctxt) + * + * @see end of cpu_context.c + */ +.extern sos_cpu_context_update_kernel_tss + + +.globl sos_cpu_context_switch +.type sos_cpu_context_switch, @function +sos_cpu_context_switch: + // arg2= to_context -- esp+64 + // arg1= from_context -- esp+60 + // caller ip -- esp+56 + pushf // (eflags) esp+52 + pushl %cs // (cs) esp+48 + pushl $resume_pc // (ip) esp+44 + pushl $0 // (error code) esp+40 + pushl %ebp // esp+36 + pushl %edi // esp+32 + pushl %esi // esp+28 + pushl %edx // esp+24 + pushl %ecx // esp+20 + pushl %ebx // esp+16 + pushl %eax // esp+12 + subl $2, %esp // (alignment) esp+10 + pushw %ss // esp+8 + pushw %ds // esp+6 + pushw %es // esp+4 + pushw %fs // esp+2 + pushw %gs // esp + + /* + * Now that the original eax/ebx are stored, we can use them safely + */ + + /* Store the address of the saved context */ + movl 60(%esp), %ebx + movl %esp, (%ebx) + + /* This is the proper context switch ! We change the stack here */ + movl 64(%esp), %esp + + /* Prepare kernel TSS in case we are switching to a user thread: we + make sure that we will come back into the kernel at a correct + stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + + /* Restore the CPU context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + popl %ebp + addl $4, %esp /* Ignore "error code" */ + + /* This restores the eflags, the cs and the eip registers */ + iret /* equivalent to: popfl ; ret */ + +resume_pc: + // Same context as that when sos_cpu_context_switch got called + // arg2= to_context -- esp+8 + // arg1= from_context -- esp+4 + // caller ip -- esp + ret + + + +/* ------------------------- */ +.globl sos_cpu_context_exit_to +.type sos_cpu_context_exit_to, @function +sos_cpu_context_exit_to: + // arg3= reclaiming_arg -- esp+12 + // arg2= reclaiming_func -- esp+8 + // arg1= to_context -- esp+4 + // caller ip -- esp + + /* Store the current SP in a temporary register */ + movl %esp, %eax + + /* This is the proper context switch ! We change the stack here */ + movl 4(%eax), %esp + + /* Call the reclaiming function (remember: the old frame address + is stored in eax) */ + pushl 12(%eax) + call *8(%eax) + addl $4, %esp + + /* Prepare kernel TSS in case we are switching to a user thread: we + make sure that we will come back into the kernel at a correct + stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + + /* Restore the CPU context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + popl %ebp + addl $4, %esp /* Ignore "error code" */ + + /* This restores the eflags, the cs and the eip registers */ + iret /* equivalent to: popfl ; ret */ diff --git a/hwcore/exception.c b/hwcore/exception.c new file mode 100644 index 0000000..cebdb6f --- /dev/null +++ b/hwcore/exception.c @@ -0,0 +1,181 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "idt.h" +#include "irq.h" + +#include +#include +#include + +#include "exception.h" + +/* array of exception wrappers, defined in exception_wrappers.S */ +extern sos_vaddr_t sos_exception_wrapper_array[SOS_EXCEPT_NUM]; + +/* arrays of exception handlers, shared with exception_wrappers.S */ +sos_exception_handler_t sos_exception_handler_array[SOS_EXCEPT_NUM] = + { NULL, }; + +/* List of exception names for the x86 architecture */ +static const char * sos_x86_exnames[] = { + [SOS_EXCEPT_DIVIDE_ERROR] = "Division by zero", + [SOS_EXCEPT_DEBUG] = "Debug", + [SOS_EXCEPT_NMI_INTERRUPT] = "Non Maskable Interrupt", + [SOS_EXCEPT_BREAKPOINT] = "Breakpoint", + [SOS_EXCEPT_OVERFLOW] = "Overflow", + [SOS_EXCEPT_BOUND_RANGE_EXCEDEED] = "Bound Range Exceeded", + [SOS_EXCEPT_INVALID_OPCODE] = "Invalid Opcode", + [SOS_EXCEPT_DEVICE_NOT_AVAILABLE] = "Device Unavailable", + [SOS_EXCEPT_DOUBLE_FAULT] = "Double Fault", + [SOS_EXCEPT_COPROCESSOR_SEGMENT_OVERRUN] = "Coprocessor Segment Overrun", + [SOS_EXCEPT_INVALID_TSS] = "Invalid TSS", + [SOS_EXCEPT_SEGMENT_NOT_PRESENT] = "Segment Not Present", + [SOS_EXCEPT_STACK_SEGMENT_FAULT] = "Stack Segfault", + [SOS_EXCEPT_GENERAL_PROTECTION] = "General Protection", + [SOS_EXCEPT_PAGE_FAULT] = "Page Fault", + [SOS_EXCEPT_INTEL_RESERVED_1] = "INTEL1", + [SOS_EXCEPT_FLOATING_POINT_ERROR] = "FP Error", + [SOS_EXCEPT_ALIGNEMENT_CHECK] = "Alignment Check", + [SOS_EXCEPT_MACHINE_CHECK] = "Machine Check", + [SOS_EXCEPT_INTEL_RESERVED_2] = "INTEL2", + [SOS_EXCEPT_INTEL_RESERVED_3] = "INTEL3", + [SOS_EXCEPT_INTEL_RESERVED_4] = "INTEL4", + [SOS_EXCEPT_INTEL_RESERVED_5] = "INTEL5", + [SOS_EXCEPT_INTEL_RESERVED_6] = "INTEL6", + [SOS_EXCEPT_INTEL_RESERVED_7] = "INTEL7", + [SOS_EXCEPT_INTEL_RESERVED_8] = "INTEL8", + [SOS_EXCEPT_INTEL_RESERVED_9] = "INTEL9", + [SOS_EXCEPT_INTEL_RESERVED_10] = "INTEL10", + [SOS_EXCEPT_INTEL_RESERVED_11] = "INTEL11", + [SOS_EXCEPT_INTEL_RESERVED_12] = "INTEL12", + [SOS_EXCEPT_INTEL_RESERVED_13] = "INTEL13", + [SOS_EXCEPT_INTEL_RESERVED_14] = "INTEL14" +}; + + +/* Catch-all exception handler */ +static void sos_generic_ex(int exid, struct sos_cpu_state *ctxt) +{ + const char *exname = sos_exception_get_name(exid); + + if (sos_cpu_context_is_in_user_mode(ctxt)) + { + /* Exception while in user mode */ + sos_bochs_printf("Exception %s in User mode at instruction 0x%x (info=%x)!\n", + exname, + sos_cpu_context_get_PC(ctxt), + (unsigned)sos_cpu_context_get_EX_info(ctxt)); + sos_bochs_printf("Terminating User thread\n"); + sos_thread_exit(); + } + else + sos_display_fatal_error("Exception %s in Kernel at instruction 0x%x (info=%x)!\n", + exname, + sos_cpu_context_get_PC(ctxt), + (unsigned)sos_cpu_context_get_EX_info(ctxt)); +} + + +sos_ret_t sos_exception_subsystem_setup(void) +{ + sos_ret_t retval; + int exid; + + /* Setup the generic exception handler by default for everybody + except for the double fault exception */ + for (exid = 0 ; exid < SOS_EXCEPT_NUM ; exid ++) + { + /* Skip double fault (see below) */ + if (exid == SOS_EXCEPT_DOUBLE_FAULT) + continue; + + retval = sos_exception_set_routine(exid, sos_generic_ex); + if (SOS_OK != retval) + return retval; + } + + + /* We inidicate that the double fault exception handler is defined, + and give its address. this handler is a do-nothing handler (see + exception_wrappers.S), and it can NOT be overriden by the + functions below */ + return sos_idt_set_handler(SOS_EXCEPT_BASE + SOS_EXCEPT_DOUBLE_FAULT, + (sos_vaddr_t) sos_exception_wrapper_array[SOS_EXCEPT_DOUBLE_FAULT], + 0 /* CPL0 routine */); +} + + +sos_ret_t sos_exception_set_routine(int exception_number, + sos_exception_handler_t routine) +{ + sos_ret_t retval; + sos_ui32_t flags; + + if ((exception_number < 0) || (exception_number >= SOS_EXCEPT_NUM)) + return -SOS_EINVAL; + + /* Double fault not supported */ + if (exception_number == SOS_EXCEPT_DOUBLE_FAULT) + return -SOS_ENOSUP; + + sos_disable_IRQs(flags); + + retval = SOS_OK; + + /* Set the exception routine to be called by the exception wrapper */ + sos_exception_handler_array[exception_number] = routine; + + /* If the exception is to be enabled, update the IDT with the exception + wrapper */ + if (routine != NULL) + retval + = sos_idt_set_handler(SOS_EXCEPT_BASE + exception_number, + (sos_vaddr_t) sos_exception_wrapper_array[exception_number], + 0 /* CPL0 routine */); + else /* Disable the IDT entry */ + retval + = sos_idt_set_handler(SOS_EXCEPT_BASE + exception_number, + (sos_vaddr_t)NULL /* No routine => disable IDTE */, + 0 /* don't care */); + + sos_restore_IRQs(flags); + return retval; +} + + +sos_exception_handler_t sos_exception_get_routine(int exception_number) +{ + if ((exception_number < 0) || (exception_number >= SOS_EXCEPT_NUM)) + return NULL; + + /* Double fault not supported */ + if (exception_number == SOS_EXCEPT_DOUBLE_FAULT) + return NULL; + + /* Expected to be atomic */ + return sos_exception_handler_array[exception_number]; +} + + +const char * sos_exception_get_name(int exception_number) +{ + if ((exception_number < 0) || (exception_number >= SOS_EXCEPT_NUM)) + return NULL; + + return sos_x86_exnames[exception_number]; +} diff --git a/hwcore/exception.h b/hwcore/exception.h new file mode 100644 index 0000000..177d760 --- /dev/null +++ b/hwcore/exception.h @@ -0,0 +1,83 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_HWEXCEPT_H_ +#define _SOS_HWEXCEPT_H_ + +/** + * @file exception.c + * + * Hardware exception routines management. + */ + +#ifndef ASM_SOURCE +# include +# include "cpu_context.h" +#endif + +/** + * Standard Intel x86 exceptions. + * + * @see Intel x86 doc vol 3, section 5.12. + */ +#define SOS_EXCEPT_DIVIDE_ERROR 0 // No error code +#define SOS_EXCEPT_DEBUG 1 // No error code +#define SOS_EXCEPT_NMI_INTERRUPT 2 // No error code +#define SOS_EXCEPT_BREAKPOINT 3 // No error code +#define SOS_EXCEPT_OVERFLOW 4 // No error code +#define SOS_EXCEPT_BOUND_RANGE_EXCEDEED 5 // No error code +#define SOS_EXCEPT_INVALID_OPCODE 6 // No error code +#define SOS_EXCEPT_DEVICE_NOT_AVAILABLE 7 // No error code +#define SOS_EXCEPT_DOUBLE_FAULT 8 // Yes (Zero) +#define SOS_EXCEPT_COPROCESSOR_SEGMENT_OVERRUN 9 // No error code +#define SOS_EXCEPT_INVALID_TSS 10 // Yes +#define SOS_EXCEPT_SEGMENT_NOT_PRESENT 11 // Yes +#define SOS_EXCEPT_STACK_SEGMENT_FAULT 12 // Yes +#define SOS_EXCEPT_GENERAL_PROTECTION 13 // Yes +#define SOS_EXCEPT_PAGE_FAULT 14 // Yes +#define SOS_EXCEPT_INTEL_RESERVED_1 15 // No +#define SOS_EXCEPT_FLOATING_POINT_ERROR 16 // No +#define SOS_EXCEPT_ALIGNEMENT_CHECK 17 // Yes (Zero) +#define SOS_EXCEPT_MACHINE_CHECK 18 // No +#define SOS_EXCEPT_INTEL_RESERVED_2 19 // No +#define SOS_EXCEPT_INTEL_RESERVED_3 20 // No +#define SOS_EXCEPT_INTEL_RESERVED_4 21 // No +#define SOS_EXCEPT_INTEL_RESERVED_5 22 // No +#define SOS_EXCEPT_INTEL_RESERVED_6 23 // No +#define SOS_EXCEPT_INTEL_RESERVED_7 24 // No +#define SOS_EXCEPT_INTEL_RESERVED_8 25 // No +#define SOS_EXCEPT_INTEL_RESERVED_9 26 // No +#define SOS_EXCEPT_INTEL_RESERVED_10 27 // No +#define SOS_EXCEPT_INTEL_RESERVED_11 28 // No +#define SOS_EXCEPT_INTEL_RESERVED_12 29 // No +#define SOS_EXCEPT_INTEL_RESERVED_13 30 // No +#define SOS_EXCEPT_INTEL_RESERVED_14 31 // No + +#ifndef ASM_SOURCE + +typedef void (*sos_exception_handler_t)(int exception_number, + struct sos_cpu_state *cpu_kstate); + +sos_ret_t sos_exception_subsystem_setup(void); +sos_ret_t sos_exception_set_routine(int exception_number, + sos_exception_handler_t routine); +sos_exception_handler_t sos_exception_get_routine(int exception_number); + +const char * sos_exception_get_name(int exception_number); +#endif /* ! ASM_SOURCE */ + +#endif /* _SOS_HWEXCEPT_H_ */ diff --git a/hwcore/exception_wrappers.S b/hwcore/exception_wrappers.S new file mode 100644 index 0000000..fdc06ca --- /dev/null +++ b/hwcore/exception_wrappers.S @@ -0,0 +1,271 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "exception.h" + +#include "segment.h" + +.file "exception_wrappers.S" + +.text + +/* The address of the table of handlers (defined in exception.c) */ +.extern sos_exception_handler_array + +/* The address of the table of wrappers (defined below, and shared + with exception.c */ +.globl sos_exception_wrapper_array + +/** Update the kernel TSS in case we are switching to a thread in user + mode in order to come back into the correct kernel stack */ +.extern sos_cpu_context_update_kernel_tss + +/* The address of the function to call to set back the user thread's + MMU configuration upon return to user context */ +.extern sos_thread_prepare_exception_switch_back + +/** + * For exceptions with/without error code, refer to Intel x86 doc vol 3, + * section 5.12 + */ + +/* These wrappers are for exceptions without error code */ +.irp id, \ + SOS_EXCEPT_DIVIDE_ERROR, \ + SOS_EXCEPT_DEBUG, \ + SOS_EXCEPT_NMI_INTERRUPT, \ + SOS_EXCEPT_BREAKPOINT, \ + SOS_EXCEPT_OVERFLOW, \ + SOS_EXCEPT_BOUND_RANGE_EXCEDEED, \ + SOS_EXCEPT_INVALID_OPCODE, \ + SOS_EXCEPT_DEVICE_NOT_AVAILABLE, \ + SOS_EXCEPT_COPROCESSOR_SEGMENT_OVERRUN, \ + SOS_EXCEPT_INTEL_RESERVED_1, \ + SOS_EXCEPT_FLOATING_POINT_ERROR, \ + SOS_EXCEPT_MACHINE_CHECK, \ + SOS_EXCEPT_INTEL_RESERVED_2, \ + SOS_EXCEPT_INTEL_RESERVED_3, \ + SOS_EXCEPT_INTEL_RESERVED_4, \ + SOS_EXCEPT_INTEL_RESERVED_5, \ + SOS_EXCEPT_INTEL_RESERVED_6, \ + SOS_EXCEPT_INTEL_RESERVED_7, \ + SOS_EXCEPT_INTEL_RESERVED_8, \ + SOS_EXCEPT_INTEL_RESERVED_9, \ + SOS_EXCEPT_INTEL_RESERVED_10, \ + SOS_EXCEPT_INTEL_RESERVED_11, \ + SOS_EXCEPT_INTEL_RESERVED_12, \ + SOS_EXCEPT_INTEL_RESERVED_13, \ + SOS_EXCEPT_INTEL_RESERVED_14 + + .p2align 2, 0x90 + sos_exception_wrapper_\id: + .type sos_exception_wrapper_\id,@function + + /* Fake error code */ + pushl $0 + /* Backup the context */ + pushl %ebp + movl %esp, %ebp + + pushl %edi + pushl %esi + pushl %edx + pushl %ecx + pushl %ebx + pushl %eax + subl $2,%esp + pushw %ss + pushw %ds + pushw %es + pushw %fs + pushw %gs + + /* Set correct kernel segment descriptors' value */ + movw $SOS_BUILD_SEGMENT_REG_VALUE(0, 0, SOS_SEG_KDATA), %di + pushw %di ; popw %ds + pushw %di ; popw %es + pushw %di ; popw %fs + pushw %di ; popw %gs + + /* + * Call the handler with the exception number and the + * address of the stored CPU context as arguments + */ + pushl %esp + pushl $\id + leal sos_exception_handler_array,%edi + call *\id*4(%edi) + /* Unallocate the arguments passed to the handler */ + addl $8, %esp + + /* Reconfigure the MMU if needed */ + pushl %esp /* cpu_ctxt */ + call sos_thread_prepare_exception_switch_back + addl $4, %esp /* Unallocate the stack */ + + /* Prepare kernel TSS in case we are switching to a + user thread: we make sure that we will come back + into the kernel at a correct stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + + /* Restore the context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + + popl %ebp + /* Remove fake error code */ + addl $4, %esp + iret +.endr + + /* These wrappers are for exceptions with error code */ +.irp id, \ + SOS_EXCEPT_INVALID_TSS, \ + SOS_EXCEPT_SEGMENT_NOT_PRESENT, \ + SOS_EXCEPT_STACK_SEGMENT_FAULT, \ + SOS_EXCEPT_GENERAL_PROTECTION, \ + SOS_EXCEPT_PAGE_FAULT, \ + SOS_EXCEPT_ALIGNEMENT_CHECK + + .p2align 2, 0x90 + sos_exception_wrapper_\id: + .type sos_exception_wrapper_\id,@function + + /* ret eflags */ + /* ret cs */ + /* ret eip */ + /* Error code */ + + /* Backup the context */ + pushl %ebp + movl %esp, %ebp + + pushl %edi + pushl %esi + pushl %edx + pushl %ecx + pushl %ebx + pushl %eax + subl $2,%esp + pushw %ss + pushw %ds + pushw %es + pushw %fs + pushw %gs + + /* Set correct kernel segment descriptors' value */ + movw $SOS_BUILD_SEGMENT_REG_VALUE(0, 0, SOS_SEG_KDATA), %di + pushw %di ; popw %ds + pushw %di ; popw %es + pushw %di ; popw %fs + pushw %di ; popw %gs + + /* + * Call the handler with the exception number and the + * address of the stored CPU context as arguments + */ + pushl %esp + pushl $\id + leal sos_exception_handler_array,%edi + call *\id*4(%edi) + /* Unallocate the arguments passed to the handler */ + addl $8, %esp + + /* Reconfigure the MMU if needed */ + pushl %esp /* cpu_ctxt */ + call sos_thread_prepare_exception_switch_back + addl $4, %esp /* Unallocate the stack */ + + /* Prepare kernel TSS in case we are switching to a + user thread: we make sure that we will come back + into the kernel at a correct stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + + /* Restore the context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + popl %ebp + + /* Error code isn't compatible with iretd */ + addl $4, %esp + + iret +.endr + + +/* Double fault handler not supported. We must define it since we + define an entry for it in the sos_exception_wrapper_array. It + simply uses an alternate stack to display a message and stop the + system. qemu won't handle it correctly (see comment in qemu's + sources). */ +#define ALTERNATE_DOUBLE_FAULT_STACK_SIZE 512 +.irp id, SOS_EXCEPT_DOUBLE_FAULT +.p2align 2, 0x90 +sos_exception_wrapper_\id: +.type sos_exception_wrapper_\id,@function +1: cli /* Not necessary */ + movl $double_fault_alternate_stack, %eax + addl $ALTERNATE_DOUBLE_FAULT_STACK_SIZE, %eax + movl %eax, %esp + pushl $msg_double_fault_not_supported + call sos_display_fatal_error ; jmp 1b /* Not necessary */ +.endr + +.section ".rodata" +msg_double_fault_not_supported: + .string "exception_wrappers.S: Double fault detected ! NOT SUPPORTED yet. System Halted." + +/* Build the sos_irq_wrapper_array, shared with interrupt.c */ +.p2align 5, 0x0 +sos_exception_wrapper_array: + .irp id, 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15, \ + 16,17,18,19,20,21,22,23,24,25,26,27,29,30,31 + .long (sos_exception_wrapper_\id) + .endr + +/* Alternate stack for double fault handler */ +.bss +.p2align 2, 0x0 +.size double_fault_alternate_stack, ALTERNATE_DOUBLE_FAULT_STACK_SIZE +double_fault_alternate_stack: + .fill ALTERNATE_DOUBLE_FAULT_STACK_SIZE, 1, 0x0 diff --git a/hwcore/gdt.c b/hwcore/gdt.c new file mode 100644 index 0000000..a6fdfa9 --- /dev/null +++ b/hwcore/gdt.c @@ -0,0 +1,186 @@ +/* Copyright (C) 2004 David Decotigny + Copyright (C) 2003 Thomas Petazzoni + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "segment.h" + +#include "gdt.h" + + +/** + * The sructure of a segment descriptor. + * + * @see Intel x86 doc, Vol 3, section 3.4.3, figure 3-8. For segment + * types, see section 3.5 + */ +struct x86_segment_descriptor +{ + /* Lowest dword */ + sos_ui16_t limit_15_0; /* Segment limit, bits 15..0 */ + sos_ui16_t base_paged_addr_15_0; /* Base address, bits 15..0 */ + + /* Highest dword */ + sos_ui8_t base_paged_addr_23_16; /* Base address bits 23..16 */ + sos_ui8_t segment_type:4; /* Section 3.4.3.1 (code/data) + and 3.5 (system) of Intel x86 vol 3 */ + sos_ui8_t descriptor_type:1; /* 0=system, 1=Code/Data */ + sos_ui8_t dpl:2; /* Descriptor privilege level */ + sos_ui8_t present:1; + + sos_ui8_t limit_19_16:4; /* Segment limit, bits 19..16 */ + sos_ui8_t custom:1; + sos_ui8_t zero:1; + sos_ui8_t op_size:1; /* 0=16bits instructions, 1=32bits */ + sos_ui8_t granularity:1; /* 0=limit in bytes, 1=limit in pages */ + + sos_ui8_t base_paged_addr_31_24; /* Base address bits 31..24 */ +} __attribute__ ((packed, aligned (8))); + + +/** + * The GDT register, which stores the address and size of the + * GDT. + * + * @see Intel x86 doc vol 3, section 2.4, figure 2-4; and section + * 3.5.1 + */ +struct x86_gdt_register { + /* The maximum GDT offset allowed to access an entry in the GDT */ + sos_ui16_t limit; + + /* This is not exactly a "virtual" address, ie an adddress such as + those of instructions and data; this is a "linear" address, ie an + address in the paged memory. However, in SOS we configure the + segmented memory as a "flat" space: the 0-4GB segment-based (ie + "virtual") addresses directly map to the 0-4GB paged memory (ie + "linear"), so that the "linear" addresses are numerically equal + to the "virtual" addresses: this base_addr will thus be the same + as the address of the gdt array */ + sos_ui32_t base_addr; +} __attribute__((packed, aligned(8))); + + +/** + * Helper macro that builds a Segment descriptor for the virtual + * 0..4GB addresses to be mapped to the linear 0..4GB linear + * addresses. + */ +#define BUILD_GDTE(descr_privilege_level,is_code) \ + ((struct x86_segment_descriptor) { \ + .limit_15_0= 0xffff, \ + .base_paged_addr_15_0= 0, \ + .base_paged_addr_23_16= 0, \ + .segment_type= ((is_code)?0xb:0x3), \ + /* With descriptor_type (below) = 1 (code/data), \ + * see Figure 3-1 of section 3.4.3.1 in Intel \ + * x86 vol 3: \ + * - Code (bit 3 = 1): \ + * bit 0: 1=Accessed \ + * bit 1: 1=Readable \ + * bit 2: 0=Non-Conforming \ + * - Data (bit 3 = 0): \ + * bit 0: 1=Accessed \ + * bit 1: 1=Writable \ + * bit 2: 0=Expand up (stack-related) \ + * For Conforming/non conforming segments, see \ + * Intel x86 Vol 3 section 4.8.1.1 \ + */ \ + .descriptor_type= 1, /* 1=Code/Data */ \ + .dpl= ((descr_privilege_level) & 0x3), \ + .present= 1, \ + .limit_19_16= 0xf, \ + .custom= 0, \ + .op_size= 1, /* 32 bits instr/data */ \ + .granularity= 1 /* limit is in 4kB Pages */ \ + }) + + +/** The actual GDT */ +static struct x86_segment_descriptor gdt[] = { + [SOS_SEG_NULL] = (struct x86_segment_descriptor){ 0, }, + [SOS_SEG_KCODE] = BUILD_GDTE(0, 1), + [SOS_SEG_KDATA] = BUILD_GDTE(0, 0), + [SOS_SEG_UCODE] = BUILD_GDTE(3, 1), + [SOS_SEG_UDATA] = BUILD_GDTE(3, 0), + [SOS_SEG_KERNEL_TSS] = { 0, } /* Initialized by + register_kernel_tss */ +}; + +sos_ret_t sos_gdt_subsystem_setup(void) +{ + struct x86_gdt_register gdtr; + + /* Address of the GDT */ + gdtr.base_addr = (sos_ui32_t) gdt; + + /* The limit is the maximum offset in bytes from the base address of + the GDT */ + gdtr.limit = sizeof(gdt) - 1; + + /* Commit the GDT into the CPU, and update the segment + registers. The CS register may only be updated with a long jump + to an absolute address in the given segment (see Intel x86 doc + vol 3, section 4.8.1). */ + asm volatile ("lgdt %0 \n\ + ljmp %1,$1f \n\ + 1: \n\ + movw %2, %%ax \n\ + movw %%ax, %%ss \n\ + movw %%ax, %%ds \n\ + movw %%ax, %%es \n\ + movw %%ax, %%fs \n\ + movw %%ax, %%gs" + : + :"m"(gdtr), + "i"(SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KCODE)), + "i"(SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KDATA)) + :"memory","eax"); + + return SOS_OK; +} + + +sos_ret_t sos_gdt_register_kernel_tss(sos_vaddr_t tss_vaddr) +{ + sos_ui16_t regval_tss; + + /* Initialize the GDT entry */ + gdt[SOS_SEG_KERNEL_TSS] + = (struct x86_segment_descriptor) { + .limit_15_0= 0x67, /* See Intel x86 vol 3 section 6.2.2 */ + .base_paged_addr_15_0= (tss_vaddr) & 0xffff, + .base_paged_addr_23_16= (tss_vaddr >> 16) & 0xff, + .segment_type= 0x9, /* See Intel x86 vol 3 figure 6-3 */ + .descriptor_type= 0, /* (idem) */ + .dpl= 3, /* Allowed for CPL3 tasks */ + .present= 1, + .limit_19_16= 0, /* Size of a TSS is < 2^16 ! */ + .custom= 0, /* Unused */ + .op_size= 0, /* See Intel x86 vol 3 figure 6-3 */ + .granularity= 1, /* limit is in Bytes */ + .base_paged_addr_31_24= (tss_vaddr >> 24) & 0xff + }; + + /* Load the TSS register into the processor */ + regval_tss = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, + SOS_SEG_KERNEL_TSS); + asm ("ltr %0" : :"r"(regval_tss)); + + return SOS_OK; +} + + diff --git a/hwcore/gdt.h b/hwcore/gdt.h new file mode 100644 index 0000000..11e829f --- /dev/null +++ b/hwcore/gdt.h @@ -0,0 +1,52 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_GDT_H_ +#define _SOS_GDT_H_ + +/** + * @file gdt.h + * + * The routines that manage the GDT, the table that maps the virtual + * addresses (data/instructions, segment-relative), to "linear" + * addresses (ie paged-memory). In SOS/x86, we use a "flat" virtual + * space, ie the virtual and linear spaces are equivalent. + * + * @see Intel x86 doc vol 3, chapter 3 + */ + +#include +#include + +/** + * Configure the virtual space as a direct mapping to the linear + * address space (ie "flat" virtual space). + */ +sos_ret_t sos_gdt_subsystem_setup(void); + + +/** + * Register the given address as the kernel TSS (for cpl3 -> cpl0 + * privilege changes). Assumes that this address corresponds to a + * valid TSS. + * + * @note Internal function called only by the cpu_context subsystem. + */ +sos_ret_t sos_gdt_register_kernel_tss(sos_vaddr_t tss_vaddr); + + +#endif /* _SOS_GDT_H_ */ diff --git a/hwcore/i8254.c b/hwcore/i8254.c new file mode 100644 index 0000000..5198129 --- /dev/null +++ b/hwcore/i8254.c @@ -0,0 +1,79 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include + +#include "i8254.h" + +/** 82c54 clock frequency */ +#define I8254_MAX_FREQ 1193180 + +/* Ports to communicate with the 82c54 */ +#define I8254_TIMER0 0x40 +#define I8254_TIMER1 0x41 +#define I8254_TIMER2 0x42 +#define I8254_CONTROL 0x43 + +/** + * Configure the first timer of the 82c54 chip as a rate generator, + * which will raise an IRQ0 on a regular periodic basis, as given by + * the freq parameter. Second (RAM refresh) and third (speaker) timers + * are left unchanged. Maximum frequency is that of the 8254 clock, ie + * 1193180 Hz. + * + * Ahhh PC systems are nice toys: this maximum "strange" frequency + * equals that of the NTSC clock (14.31818 MHz) divided by 12. In + * turn, the famous 4.77 MHz cpu clock frequency of the first IBM PC + * is this same NTSC frequency divided by 3. Why the NTSC frequency as + * a base "standard" ? Because the 14.31818 MHz quartz were cheap at + * that time, and because it allows to simply drive altogether the + * cpu, the "time of day" timer, and the video signal generators. + */ +sos_ret_t sos_i8254_set_frequency(unsigned int freq) +{ + unsigned int nb_tick; + + if (freq <= 0) + return -SOS_EINVAL; + + /* Compute counter value */ + nb_tick = I8254_MAX_FREQ / freq; + + /* Counter must be between 1 and 65536 */ + if (nb_tick > 65536) + return -SOS_EINVAL; + if (nb_tick <= 0) + return -SOS_EINVAL; + + /* The i8254 interprets 0 to mean counter == 65536, because 65536 + cannot be coded on 16bits */ + if (nb_tick == 65536) + nb_tick = 0; + + /* We want to configure timer0, we want to send both LSB+MSB to set + timer0 freq (-> 0x30), and we configure timer0 in mode 2, ie as a + rate generator (-> 0x4) ==> 0x34 */ + outb(0x34, I8254_CONTROL); + + /* Send LSB of counter first */ + outb((nb_tick & 0xFF), I8254_TIMER0); + + /* Send MSB of counter */ + outb((nb_tick >> 8) & 0xFF, I8254_TIMER0); + + return SOS_OK; +} diff --git a/hwcore/i8254.h b/hwcore/i8254.h new file mode 100644 index 0000000..406b713 --- /dev/null +++ b/hwcore/i8254.h @@ -0,0 +1,35 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_i8259_H_ +#define _SOS_i8259_H_ + +#include + +/** + * @file i8254.h PC programmable timer + * + * Programmable timer routines. See the Intel 82C54 datasheet (on kos + * website). + * + * @see i82C54 datasheet on Kos website. + */ + +/** Change timer interrupt (IRQ 0) frequency */ +sos_ret_t sos_i8254_set_frequency(unsigned int freq); + +#endif /* _SOS_i8259_H_ */ diff --git a/hwcore/i8259.c b/hwcore/i8259.c new file mode 100644 index 0000000..d6c6c60 --- /dev/null +++ b/hwcore/i8259.c @@ -0,0 +1,79 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "ioports.h" + +#include "i8259.h" + +#define PIC_MASTER 0x20 +#define PIC_SLAVE 0xa0 + +/** Setup the 8259 PIC */ +sos_ret_t sos_i8259_subsystem_setup(void) +{ + /* Send ICW1: 8086 mode + NOT Single ctrl + call address + interval=8 */ + outb(0x11, PIC_MASTER); + outb(0x11, PIC_SLAVE); + + /* Send ICW2: ctrl base address */ + outb(0x20, PIC_MASTER+1); + outb(0x28, PIC_SLAVE+1); + + /* Send ICW3 master: mask where slaves are connected */ + outb(0x4, PIC_MASTER+1); + /* Send ICW3 slave: index where the slave is connected on master */ + outb(0x2, PIC_SLAVE+1); + + /* Send ICW4: 8086 mode, fully nested, not buffered, no implicit EOI */ + outb(0x1, PIC_MASTER+1); + outb(0x1, PIC_SLAVE+1); + + /* Send OCW1: + * Closing all IRQs : waiting for a correct handler The only IRQ + * enabled is the cascade (that's why we use 0xFB for the master) */ + outb(0xFB, PIC_MASTER+1); + outb(0xFF, PIC_SLAVE+1); + + return SOS_OK; +} + + +sos_ret_t sos_i8259_enable_irq_line(int numirq) +{ + if(numirq < 8) + /* irq on master PIC */ + outb((inb(PIC_MASTER+1) & ~(1 << numirq)), PIC_MASTER+1); + else + /* irq on slave PIC */ + outb((inb(PIC_SLAVE+1) & ~(1 << (numirq-8))), PIC_SLAVE+1); + + return SOS_OK; +} + + +sos_ret_t sos_i8259_disable_irq_line(int numirq) +{ + if(numirq < 8) + /* irq on master PIC */ + outb((inb(PIC_MASTER+1) | (1 << numirq)), PIC_MASTER+1); + else + /* irq on slave PIC */ + outb((inb(PIC_SLAVE+1) | (1 << (numirq-8))), PIC_SLAVE+1); + + return SOS_OK; +} diff --git a/hwcore/i8259.h b/hwcore/i8259.h new file mode 100644 index 0000000..0820524 --- /dev/null +++ b/hwcore/i8259.h @@ -0,0 +1,40 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_i8259_H_ +#define _SOS_i8259_H_ + +#include + +/** + * @file i8259.h PIC + * + * PIC Management routines. See the Intel 8259A datasheet (on kos + * website), page 9+. Should be not be used directly: only interrupt.c + * should use this. + * + * @see i8259A datasheet on Kos website. + */ + +/** Setup PIC and Disable all IRQ lines */ +sos_ret_t sos_i8259_subsystem_setup(void); + +sos_ret_t sos_i8259_enable_irq_line(int numirq); + +sos_ret_t sos_i8259_disable_irq_line(int numirq); + +#endif /* _SOS_i8259_H_ */ diff --git a/hwcore/idt.c b/hwcore/idt.c new file mode 100644 index 0000000..07db4ab --- /dev/null +++ b/hwcore/idt.c @@ -0,0 +1,159 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "segment.h" + +#include "idt.h" + +/** + * An entry in the IDT, or "IDTE" in the following, ie a reference to + * a interrupt/trap routine or a task gate to handle the sw/hw + * interrupts and exceptions. + * + * @see figure 5-2, intel x86 doc, vol 3 + */ +struct x86_idt_entry +{ + /* Low dword */ + sos_ui16_t offset_low; /* 15..0, offset of the routine in the segment */ + sos_ui16_t seg_sel; /* 31..16, the ID of the segment */ + + /* High dword */ + sos_ui8_t reserved:5; /* 4..0 */ + sos_ui8_t flags:3; /* 7..5 */ + sos_ui8_t type:3; /* 10..8 (interrupt gate, trap gate...) */ + sos_ui8_t op_size:1; /* 11 (0=16bits instructions, 1=32bits instr.) */ + sos_ui8_t zero:1; /* 12 */ + sos_ui8_t dpl:2; /* 14..13 */ + sos_ui8_t present:1; /* 15 */ + sos_ui16_t offset_high; /* 31..16 */ +} __attribute__((packed)); + + +/** + * The IDT register, which stores the address and size of the + * IDT. + * + * @see Intel x86 doc vol 3, section 2.4, figure 2-4 + */ +struct x86_idt_register +{ + /* The maximum GDT offset allowed to access an entry in the GDT */ + sos_ui16_t limit; + + /* This is not exactly a "virtual" address, ie an adddress such as + those of instructions and data; this is a "linear" address, ie an + address in the paged memory. However, in SOS we configure the + segmented memory as a "flat" space: the 0-4GB segment-based (ie + "virtual") addresses directly map to the 0-4GB paged memory (ie + "linear"), so that the "linear" addresses are numerically equal + to the "virtual" addresses: this base_addr will thus be the same + as the address of the gdt array */ + sos_ui32_t base_addr; +} __attribute__((packed, aligned (8))); + + +static struct x86_idt_entry idt[SOS_IDTE_NUM]; + +sos_ret_t sos_idt_subsystem_setup() +{ + struct x86_idt_register idtr; + int i; + + for (i = 0 ; + i < SOS_IDTE_NUM ; + i++) + { + struct x86_idt_entry *idte = idt + i; + + /* Setup an empty IDTE interrupt gate, see figure 5-2 in Intel + x86 doc, vol 3 */ + idte->seg_sel = SOS_BUILD_SEGMENT_REG_VALUE(0, FALSE, SOS_SEG_KCODE); + idte->reserved = 0; + idte->flags = 0; + idte->type = 0x6; /* Interrupt gate (110b) */ + idte->op_size = 1; /* 32bits instructions */ + idte->zero = 0; + + /* Disable this IDT entry for the moment */ + sos_idt_set_handler(i, (sos_vaddr_t)NULL, 0/* Don't care */); + } + + /* + * Setup the IDT register, see Intel x86 doc vol 3, section 5.8. + */ + + /* Address of the IDT */ + idtr.base_addr = (sos_ui32_t) idt; + + /* The limit is the maximum offset in bytes from the base address of + the IDT */ + idtr.limit = sizeof(idt) - 1; + + /* Commit the IDT into the CPU */ + asm volatile ("lidt %0\n"::"m"(idtr):"memory"); + + return SOS_OK; +} + + +sos_ret_t sos_idt_set_handler(int index, + sos_vaddr_t handler_address, + int lowest_priviledge /* 0..3 */) +{ + struct x86_idt_entry *idte; + + if ((index < 0) || (index >= SOS_IDTE_NUM)) + return -SOS_EINVAL; + if ((lowest_priviledge < 0) || (lowest_priviledge > 3)) + return -SOS_EINVAL; + + idte = idt + index; + if (handler_address != (sos_vaddr_t)NULL) + { + idte->offset_low = handler_address & 0xffff; + idte->offset_high = (handler_address >> 16) & 0xffff; + idte->dpl = lowest_priviledge; + idte->present = 1; /* Yes, there is a handler */ + } + else /* Disable this IDT entry */ + { + idte->offset_low = 0; + idte->offset_high = 0; + idte->dpl = 0; + idte->present = 0; /* No, there is no handler */ + } + + return SOS_OK; +} + + +sos_ret_t sos_idt_get_handler(int index, + sos_vaddr_t *handler_address, + int *lowest_priviledge) +{ + if ((index < 0) || (index >= SOS_IDTE_NUM)) + return -SOS_EINVAL; + + if (handler_address != NULL) + *handler_address = idt[index].offset_low + | (idt[index].offset_high << 16); + if (lowest_priviledge != NULL) + *lowest_priviledge = idt[index].dpl; + + return SOS_OK; +} diff --git a/hwcore/idt.h b/hwcore/idt.h new file mode 100644 index 0000000..2d165b0 --- /dev/null +++ b/hwcore/idt.h @@ -0,0 +1,84 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_IDT_H_ +#define _SOS_IDT_H_ + +/** + * @file idt.h + * + * Manage the x86 Interrupt Descriptor Table, the table which maps the + * hardware interrupt lines, hardware exceptions, and software + * interrupts, to software routines. We only define "interrupt gate" + * IDT entries. Don't use it directly; refer instead to interrupt.c, + * exceptions.c and syscall.c. + * + * @see Intel x86 doc, Vol 3, chapter 5 + */ + +#include +#include + +/* Mapping of the CPU exceptions in the IDT (imposed by Intel + standards) */ +#define SOS_EXCEPT_BASE 0 +#define SOS_EXCEPT_NUM 32 +#define SOS_EXCEPT_MAX (SOS_HWEXCEPT_BASE + SOS_HWEXCEPT_NUM - 1) + +/* Mapping of the IRQ lines in the IDT */ +#define SOS_IRQ_BASE 32 +#define SOS_IRQ_NUM 16 +#define SOS_IRQ_MAX (SOS_IRQ_BASE + SOS_IRQ_NUM - 1) + +/** + * Number of IDT entries. + * + * @note Must be large enough to map the hw interrupts, the exceptions + * (=> total is 48 entries), and the syscall(s). Since our syscall + * will be 0x42, it must be >= 0x43. Intel doc limits this to 256 + * entries, we use this limit. + */ +#define SOS_IDTE_NUM 256 /* 0x100 */ + +/** Initialization routine: all the IDT entries (or "IDTE") are marked + "not present". */ +sos_ret_t sos_idt_subsystem_setup(void); + +/** + * Enable the IDT entry if handler_address != NULL, with the given + * lowest_priviledge.\ Disable the IDT entry when handler_address == + * NULL (the lowest_priviledge parameter is then ignored). Intel doc + * says that there must not be more than 256 entries. + * + * @note IRQ Unsafe + */ +sos_ret_t sos_idt_set_handler(int index, + sos_vaddr_t handler_address, + int lowest_priviledge /* 0..3 */); + + +/** + * @note IRQ Unsafe + * + * @return the handler address and DPL in the 2nd and 3rd + * parameters + */ +sos_ret_t sos_idt_get_handler(int index, + sos_vaddr_t *handler_address, + int *lowest_priviledge); + +#endif /* _SOS_IDT_H_ */ diff --git a/hwcore/ioports.h b/hwcore/ioports.h new file mode 100644 index 0000000..69c6d15 --- /dev/null +++ b/hwcore/ioports.h @@ -0,0 +1,46 @@ +/* Copyright (C) 2004 All GPL'ed OS + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_IOPORTS_H_ +#define _SOS_IOPORTS_H_ + +/** + * @ioports.h + * + * Intel-specific I/O space access routines. + */ + +/* This macro allows to write to an I/O port */ +#define outb(value, port) \ + __asm__ volatile ( \ + "outb %b0,%w1" \ + ::"a" (value),"Nd" (port) \ + ) \ + +// read one byte from port +#define inb(port) \ +({ \ + unsigned char _v; \ + __asm__ volatile ( \ + "inb %w1,%0" \ + :"=a" (_v) \ + :"Nd" (port) \ + ); \ + _v; \ +}) + +#endif /* _SOS_IOPORTS_H_ */ diff --git a/hwcore/irq.c b/hwcore/irq.c new file mode 100644 index 0000000..6722027 --- /dev/null +++ b/hwcore/irq.c @@ -0,0 +1,100 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "idt.h" +#include "i8259.h" + +#include "irq.h" + +/** array of IRQ wrappers, defined in irq_wrappers.S */ +extern sos_vaddr_t sos_irq_wrapper_array[SOS_IRQ_NUM]; + +/** arrays of IRQ handlers, shared with irq_wrappers.S */ +sos_irq_handler_t sos_irq_handler_array[SOS_IRQ_NUM] = { NULL, }; + +/** Number of interrupt handlers that are currently executing */ +sos_ui32_t sos_irq_nested_level_counter; + +sos_ret_t sos_irq_subsystem_setup(void) +{ + sos_irq_nested_level_counter = 0; + return sos_i8259_subsystem_setup(); +} + + +sos_ret_t sos_irq_set_routine(int irq_level, + sos_irq_handler_t routine) +{ + sos_ret_t retval; + sos_ui32_t flags; + + if ((irq_level < 0) || (irq_level >= SOS_IRQ_NUM)) + return -SOS_EINVAL; + + sos_disable_IRQs(flags); + + retval = SOS_OK; + + /* Set the irq routine to be called by the IRQ wrapper */ + sos_irq_handler_array[irq_level] = routine; + + /* If the irq is to be enabled, update the IDT with the IRQ + wrapper */ + if (routine != NULL) + { + retval + = sos_idt_set_handler(SOS_IRQ_BASE + irq_level, + (sos_vaddr_t) sos_irq_wrapper_array[irq_level], + 0 /* CPL0 routine */); + /* A problem occured */ + if (retval != SOS_OK) + sos_irq_handler_array[irq_level] = NULL; + } + else /* Disable this idt entry */ + { + retval + = sos_idt_set_handler(SOS_IRQ_BASE + irq_level, + (sos_vaddr_t)NULL /* Disable IDTE */, + 0 /* Don't care */); + } + + /* Update the PIC only if an IRQ handler has been set */ + if (sos_irq_handler_array[irq_level] != NULL) + sos_i8259_enable_irq_line(irq_level); + else + sos_i8259_disable_irq_line(irq_level); + + sos_restore_IRQs(flags); + return retval; +} + + +sos_irq_handler_t sos_irq_get_routine(int irq_level) +{ + if ((irq_level < 0) || (irq_level >= SOS_IRQ_NUM)) + return NULL; + + /* Expected to be atomic */ + return sos_irq_handler_array[irq_level]; +} + + +sos_ui32_t sos_irq_get_nested_level() +{ + /* No need to disable interrupts here */ + return sos_irq_nested_level_counter; +} diff --git a/hwcore/irq.h b/hwcore/irq.h new file mode 100644 index 0000000..c067cc4 --- /dev/null +++ b/hwcore/irq.h @@ -0,0 +1,97 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_HWINTR_H_ +#define _SOS_HWINTR_H_ + + +/** + * @file irq.c + * + * Hardware interrupts routines management. + */ + + +#include +#include "cpu_context.h" + + +#define sos_save_flags(flags) \ + asm volatile("pushfl ; popl %0":"=g"(flags)::"memory") +#define sos_restore_flags(flags) \ + asm volatile("push %0; popfl"::"g"(flags):"memory") + + +#define sos_disable_IRQs(flags) \ + ({ sos_save_flags(flags); asm("cli\n"); }) +#define sos_restore_IRQs(flags) \ + sos_restore_flags(flags) + + +/* Usual IRQ levels */ +#define SOS_IRQ_TIMER 0 +#define SOS_IRQ_KEYBOARD 1 +#define SOS_IRQ_SLAVE_PIC 2 +#define SOS_IRQ_COM2 3 +#define SOS_IRQ_COM1 4 +#define SOS_IRQ_LPT2 5 +#define SOS_IRQ_FLOPPY 6 +#define SOS_IRQ_LPT1 7 +#define SOS_IRQ_8_NOT_DEFINED 8 +#define SOS_IRQ_RESERVED_1 9 +#define SOS_IRQ_RESERVED_2 10 +#define SOS_IRQ_RESERVED_3 11 +#define SOS_IRQ_RESERVED_4 12 +#define SOS_IRQ_COPROCESSOR 13 +#define SOS_IRQ_HARDDISK 14 +#define SOS_IRQ_RESERVED_5 15 + + +/** Definition of an hardware IRQ handler */ +typedef void (*sos_irq_handler_t)(int irq_level); + + +/** Setup the PIC */ +sos_ret_t sos_irq_subsystem_setup(void); + + +/** + * If the routine is not NULL, the IDT is setup to call an IRQ + * wrapper upon interrupt, which in turn will call the routine, and + * the PIC is programmed to raise an irq.\ If the routine is + * NULL, we disable the irq line. + */ +sos_ret_t sos_irq_set_routine(int irq_level, + sos_irq_handler_t routine); + +sos_irq_handler_t sos_irq_get_routine(int irq_level); + + +/** + * Tell how many nested IRQ handler have been fired + */ +sos_ui32_t sos_irq_get_nested_level(); + + +/** + * Return TRUE when we are currently executing in interrupt context + */ +#define sos_servicing_irq() \ + (sos_irq_get_nested_level() > 0) + + +#endif /* _SOS_HWINTR_H_ */ diff --git a/hwcore/irq_wrappers.S b/hwcore/irq_wrappers.S new file mode 100644 index 0000000..167891b --- /dev/null +++ b/hwcore/irq_wrappers.S @@ -0,0 +1,305 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include "segment.h" + +.file "irq_wrappers.S" + +.text + +/** The address of the table of handlers (defined in irq.c) */ +.extern sos_irq_handler_array + +/** The address of the table of wrappers (defined below, and shared + with irq.c */ +.globl sos_irq_wrapper_array + +/** The variable holding the nested level of the IRQ handlers */ +.extern sos_irq_nested_level_counter + +/** Update the interrupted current thread's CPU context + Its prototype is: + sos_thread_prepare_irq_servicing(struct sos_cpu_state *); +*/ +.extern sos_thread_prepare_irq_servicing + +/** Update the kernel TSS in case we are switching to a thread in user + mode in order to come back into the correct kernel stack */ +.extern sos_cpu_context_update_kernel_tss + +/** Select a thread to set on CPU (this enables user-threads + preemption) and configure the MMU to match that of the destination + thread. + Its prototype is: + struct sos_cpu_state * // Selected CPU context + sos_thread_prepare_irq_switch_back(); +*/ +.extern sos_thread_prepare_irq_switch_back + +/* These pre-handlers are for IRQ (Master PIC) */ +.irp id, 0,1,2,3,4,5,6,7 + + .p2align 2, 0x90 + + sos_irq_wrapper_\id: + .type sos_irq_wrapper_\id,@function + + /* + * Backup the CPU context + */ + + /* Fake error code */ + pushl $0 + + /* Backup the actual context */ + pushl %ebp + movl %esp, %ebp + + pushl %edi + pushl %esi + pushl %edx + pushl %ecx + pushl %ebx + pushl %eax + subl $2,%esp + pushw %ss + pushw %ds + pushw %es + pushw %fs + pushw %gs + + /* Set correct kernel segment descriptors' value */ + movw $SOS_BUILD_SEGMENT_REG_VALUE(0, 0, SOS_SEG_KDATA), %di + pushw %di ; popw %ds + pushw %di ; popw %es + pushw %di ; popw %fs + pushw %di ; popw %gs + + /* + * Increment IRQ nested level + */ + incl sos_irq_nested_level_counter + /* Outermost IRQ only: store the interrupted context + of the current thread */ + cmpl $1, sos_irq_nested_level_counter + jne 1f + pushl %esp + call sos_thread_prepare_irq_servicing + addl $4, %esp + + 1: + + /* Send EOI to PIC. See Intel 8259 datasheet + available on Kos website */ + movb $0x20, %al + outb %al, $0x20 + + /* + * Call the handler with IRQ number as argument + */ + pushl $\id + leal sos_irq_handler_array,%edi + call *\id*4(%edi) + addl $4, %esp + + /* + * Decrement IRQ nested level + */ + cli /* Just in case we messed up everything in the handler */ + subl $1, sos_irq_nested_level_counter + + /* sos_irq_nested_level_counter went below 0 ?! */ + jnc 2f + + 1: /* Yes: Print fatal error message */ + pushl $msg_nested_level_overflow + call sos_display_fatal_error + addl $4, %esp ; jmp 1b + /* Never returns */ + + 2: /* No: all right ! */ + + /* Was this the outermost IRQ handler ? */ + jnz 3f + + /* Yes: reschedule */ + call sos_thread_prepare_irq_switch_back + /* Establish new context: context switch ! */ + movl %eax, %esp + + /* Prepare kernel TSS in case we are switching to a + user thread: we make sure that we will come back + into the kernel at a correct stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + 3: + /* Restore the context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + popl %ebp + + /* Remove fake error code */ + addl $4, %esp + + iret + .endr + + +/* These pre-handlers are for IRQ (Slave PIC) */ +.irp id, 8,9,10,11,12,13,14,15 + + .p2align 2, 0x90 + + sos_irq_wrapper_\id: + .type sos_irq_wrapper_\id,@function + + /* + * Backup the CPU context + */ + + /* Fake error code */ + pushl $0 + + /* Backup the actual context */ + pushl %ebp + movl %esp, %ebp + + pushl %edi + pushl %esi + pushl %edx + pushl %ecx + pushl %ebx + pushl %eax + subl $2,%esp + pushw %ss + pushw %ds + pushw %es + pushw %fs + pushw %gs + + /* Set correct kernel segment descriptors' value */ + movw $SOS_BUILD_SEGMENT_REG_VALUE(0, 0, SOS_SEG_KDATA), %di + pushw %di ; popw %ds + pushw %di ; popw %es + pushw %di ; popw %fs + pushw %di ; popw %gs + + /* + * Increment IRQ nested level + */ + incl sos_irq_nested_level_counter + /* Outermost IRQ only: store the interrupted context + of the current thread */ + cmpl $1, sos_irq_nested_level_counter + jne 1f + pushl %esp + call sos_thread_prepare_irq_servicing + addl $4, %esp + + 1: + + /* Send EOI to PIC. See Intel 8259 datasheet + available on Kos website */ + movb $0x20, %al + outb %al, $0xa0 + outb %al, $0x20 + + /* + * Call the handler with IRQ number as argument + */ + pushl $\id + leal sos_irq_handler_array,%edi + call *\id*4(%edi) + addl $4, %esp + + /* + * Decrement IRQ nested level + */ + cli /* Just in case we messed up everything in the handler */ + subl $1, sos_irq_nested_level_counter + + /* sos_irq_nested_level_counter went below 0 ?! */ + jnc 2f + + 1: /* Yes: Print fatal error message */ + pushl $msg_nested_level_overflow + call sos_display_fatal_error + addl $4, %esp ; jmp 1b + /* Never returns */ + + 2: /* No: all right ! */ + + /* Was this the outermost IRQ handler ? */ + jnz 3f + + /* Yes: reschedule */ + call sos_thread_prepare_irq_switch_back + /* Establish new context: context switch ! */ + movl %eax, %esp + + /* Prepare kernel TSS in case we are switching to a + user thread: we make sure that we will come back + into the kernel at a correct stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + 3: + /* Restore the context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + popl %ebp + + /* Remove fake error code */ + addl $4, %esp + + iret + .endr + +.section ".rodata" +msg_nested_level_overflow: + .string "irq_wrappers.S: IRQ Nested level overflow ! System halted." + +/* Build the sos_irq_wrapper_array, shared with irq.c */ +.p2align 5, 0x0 +sos_irq_wrapper_array: + .irp id, 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 + .long (sos_irq_wrapper_\id) + .endr diff --git a/hwcore/mm_context.c b/hwcore/mm_context.c new file mode 100644 index 0000000..6a25ce6 --- /dev/null +++ b/hwcore/mm_context.c @@ -0,0 +1,297 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include + +#include +#include +#include +#include +#include +#include + +#include "mm_context.h" + + +/** + * Definition of an MMU context. + */ +struct sos_mm_context +{ + /** Physical address of the PD for this MMU context */ + sos_paddr_t paddr_PD; + + /** Virtual address where it is mapped into the Kernel space */ + sos_vaddr_t vaddr_PD; + + /** Reference counter for this mm_context */ + sos_ui32_t ref_cnt; + + /** List of MMU contexts in the system */ + struct sos_mm_context *prev, *next; +}; + + +/** + * The cache of mm_context structures + */ +struct sos_kslab_cache * cache_struct_mm_context; + + +/** + * The current MMU context corresponding to the current configuration + * of the MMU. + */ +static struct sos_mm_context *current_mm_context = NULL; + + +/** + * System-wide list of all the mm_contexts in the system + */ +static struct sos_mm_context *list_mm_context = NULL; +/* The "= NULL" here is FUNDAMENTAL, because paging.c must work + correctly, ie synch_PDE below must behave reasonably (eg do + nothing), until the mm_context subsystem has been initialized. */ + + +sos_ret_t sos_mm_context_subsystem_setup() +{ + struct sos_mm_context * initial_mm_context; + sos_ret_t retval; + + /* Create the new mm_context cache */ + cache_struct_mm_context = sos_kmem_cache_create("struct mm_context", + sizeof(struct sos_mm_context), + 1, 0, + SOS_KSLAB_CREATE_MAP); + if (NULL == cache_struct_mm_context) + return -SOS_ENOMEM; + + /* + * Allocate the initial mm_context structure + */ + initial_mm_context + = (struct sos_mm_context*) sos_kmem_cache_alloc(cache_struct_mm_context, + SOS_KSLAB_ALLOC_ATOMIC); + if (NULL == initial_mm_context) + return -SOS_ENOMEM; + + /* Retrieve the address of the current page where the PD lies */ + initial_mm_context->paddr_PD = sos_paging_get_current_PD_paddr(); + + /* + * Map it somewhere in kernel virtual memory + */ + + /* Allocate 1 page of kernel Virtual memory */ + initial_mm_context->vaddr_PD = sos_kmem_vmm_alloc(1, 0); + if (initial_mm_context->vaddr_PD == 0) + return -SOS_ENOMEM; + + /* Map the PD at this virtual address: it will thus be mapped 2 + times (1 time for the mirroring, 1 time for mm_context) ! */ + retval = sos_paging_map(initial_mm_context->paddr_PD, + initial_mm_context->vaddr_PD, + FALSE, + SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE); + if (SOS_OK != retval) + return retval; + + /* Initialize the initial list of mm_contexts */ + list_singleton(list_mm_context, initial_mm_context); + + /* We just created this mm_context: mark it as "referenced" */ + initial_mm_context->ref_cnt ++; + + /* We are actually already using it ! */ + initial_mm_context->ref_cnt ++; /* ie reference it a 2nd time ! */ + current_mm_context = initial_mm_context; + + return SOS_OK; +} + + +struct sos_mm_context * sos_mm_context_create(void) +{ + sos_ui32_t flags; + struct sos_mm_context *mmctxt; + + /* + * Allocate the initial mm_context structure + */ + mmctxt = (struct sos_mm_context*) sos_kmem_cache_alloc(cache_struct_mm_context, 0); + if (NULL == mmctxt) + return NULL; + + /* Allocate a new page for the new PD and map it into the kernel */ + mmctxt->vaddr_PD = sos_kmem_vmm_alloc(1, SOS_KMEM_VMM_MAP); + if (mmctxt->vaddr_PD == 0) + { + sos_kmem_cache_free((sos_vaddr_t) mmctxt); + return NULL; + } + + /* Retrieve its physical address */ + mmctxt->paddr_PD = sos_paging_get_paddr(mmctxt->vaddr_PD); + if (mmctxt->paddr_PD == 0) + { + sos_kmem_cache_free((sos_vaddr_t) mmctxt); + return NULL; + } + + /* Copy the current hardware MMU address translation tables */ + if (SOS_OK != sos_paging_copy_kernel_space(mmctxt->vaddr_PD, + current_mm_context->vaddr_PD)) + { + sos_kmem_cache_free((sos_vaddr_t) mmctxt); + return NULL; + } + + /* Mark the mm_context as "referenced" */ + mmctxt->ref_cnt = 1; + + /* Add it to the list of MMU contexts */ + sos_disable_IRQs(flags); + list_add_tail(list_mm_context, mmctxt); + sos_restore_IRQs(flags); + + return mmctxt; +} + + +sos_ret_t sos_mm_context_unref(struct sos_mm_context *mmctxt) +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + + /* A valid mmctxt is one which is not yet unreferenced */ + SOS_ASSERT_FATAL(mmctxt->ref_cnt > 0); + + /* Unreference it */ + mmctxt->ref_cnt --; + + /* If somebody is still using it, don't release it now */ + if (mmctxt->ref_cnt > 0) + { + sos_restore_IRQs(flags); + return SOS_OK; + } + + /* If nobody uses it, then it cannot be the current mm_context ! */ + SOS_ASSERT_FATAL(mmctxt != current_mm_context); + + /* Remove it from the list of mm_contexts */ + list_delete(list_mm_context, mmctxt); + + sos_restore_IRQs(flags); + + /* Remove all user mappings (if any) */ + sos_paging_dispose(mmctxt->vaddr_PD); + + /* Unmap the PD from the kernel */ + sos_kmem_vmm_free(mmctxt->vaddr_PD); + + memset(mmctxt, 0x0, sizeof(*mmctxt)); + + return SOS_OK; +} + + +sos_ret_t sos_mm_context_ref(struct sos_mm_context *mmctxt) +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + + /* A valid mmctxt is one which is not yet unreferenced */ + SOS_ASSERT_FATAL(mmctxt->ref_cnt > 0); + + /* Reference it once again */ + mmctxt->ref_cnt ++; + + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +sos_ret_t sos_mm_context_switch_to(struct sos_mm_context *mmctxt) +{ + SOS_ASSERT_FATAL(NULL != mmctxt); + SOS_ASSERT_FATAL(mmctxt->ref_cnt > 0); + SOS_ASSERT_FATAL(current_mm_context->ref_cnt > 0); + if (mmctxt != current_mm_context) + { + sos_ui32_t flags; + struct sos_mm_context * prev_mm_context = current_mm_context; + + /* This is the most dangerous part of the whole thing. If we set + the wrong MMU configuration in mmctxt, this will hang or + reboot the machine... */ + sos_paging_set_current_PD_paddr(mmctxt->paddr_PD); + + /* Exchange the mm_contexts */ + current_mm_context = mmctxt; + + /* Update the reference counts */ + sos_disable_IRQs(flags); + mmctxt->ref_cnt ++; + sos_mm_context_unref(prev_mm_context); + sos_restore_IRQs(flags); + } + + return SOS_OK; +} + + +struct sos_mm_context *get_current_mm_context() +{ + SOS_ASSERT_FATAL(current_mm_context->ref_cnt > 0); + return current_mm_context; +} + + +/* ****************************************************** + * Reserved functions + */ + + +sos_ret_t sos_mm_context_synch_kernel_PDE(unsigned int index_in_pd, + sos_ui32_t pde) +{ + sos_ui32_t flags; + struct sos_mm_context * dest_mm_context; + int nb_mm_contexts; + + sos_disable_IRQs(flags); + list_foreach_forward(list_mm_context, dest_mm_context, nb_mm_contexts) + { + sos_ui32_t * dest_pd; + + SOS_ASSERT_FATAL(dest_mm_context->ref_cnt > 0); + + dest_pd = (sos_ui32_t*) dest_mm_context->vaddr_PD; + dest_pd[index_in_pd] = pde; + } + sos_restore_IRQs(flags); + + return SOS_OK; +} diff --git a/hwcore/mm_context.h b/hwcore/mm_context.h new file mode 100644 index 0000000..16261d2 --- /dev/null +++ b/hwcore/mm_context.h @@ -0,0 +1,101 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_MMCTXT_H_ +#define _SOS_MMCTXT_H_ + + +/** + * @file mm_context.h + * + * Low level API to manage multiple MMU translation tables. The API + * (not its implementation) should be some kind of + * architecture-independent. + * + * The goal of this API is: + * - To provide a simple arch-independent API to change the current + * address space configured in the MMU + * - To make sure that ALL the kernel space mappings are always kept + * IDENTICAL among all the address spaces in the whole system. That + * way, a virtual address in the kernel space refers to EXACTLY the + * same physical memory location for all the address spaces. + */ + +#include +#include + + +/** + * Declaration of an MMU context. Opaque structure defined in + * mm_context.c + */ +struct sos_mm_context; + + +/** + * Setup the MMU context management subsystem + */ +sos_ret_t sos_mm_context_subsystem_setup(); + + +/** + * Public function to allocate a new MMU context. + * + * Allocate a new PD, map it into kernel virtual address space and + * initialize its PDE for the Kernel space so that the Kernel space is + * kept identical between ALL the MMU context in the system. + */ +struct sos_mm_context * sos_mm_context_create(void); + + +/** + * Public function to release the given MMU context (based on + * reference counting). Only the virtual page that maps the PD of the + * MMU context is released. All the other user-space pages are + * expected to be already released by the parent process. + */ +sos_ret_t sos_mm_context_unref(struct sos_mm_context *mmctxt); + + +/** + * Reconfigure the MMU to use a different MMU context. mmctxt MUST + * NOT be NULL. + */ +sos_ret_t sos_mm_context_switch_to(struct sos_mm_context *mmctxt); + + +/* ****************************************************** + * Reserved functions + */ + + +/** + * Reserved function to increase the reference count of the given MMU + * context (based on reference counting). + */ +sos_ret_t sos_mm_context_ref(struct sos_mm_context *mmctxt); + + +/** + * Restricted function reserved to paging.c to synchronize all the PDEs + * accross all the MMU contexts in the system. This is limited to PDEs + * pertaining to the kernel space. + */ +sos_ret_t sos_mm_context_synch_kernel_PDE(unsigned int index_in_pd, + sos_ui32_t pde); + +#endif /* _SOS_MMCTXT_H_ */ diff --git a/hwcore/paging.c b/hwcore/paging.c new file mode 100644 index 0000000..d2d3648 --- /dev/null +++ b/hwcore/paging.c @@ -0,0 +1,789 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include +#include + +#include "mm_context.h" + +#include "paging.h" + + +/* + * Important NOTICE concerning the use of the reference & occupation + * counters of the physical pages by the "paging" subsystem: + * - All the kernel PT are SHARED. This means that as soon as one + * kernel PT belongs to one mm_context, it belongs to ALL the + * mm_contexts. We don't update the real reference count of the PT + * in this respect, because it would require to update the + * reference counts of ALL the kernel PTs as soon as a new + * mm_context is created, or as soon as a mm_context is + * suppressed. This way, the reference count is constant + * independently of the actual number of PD really sharing them. + * - We do NOT maintain the occupation count of the PDs. This would add + * some little overhead that is useless + * - We do maintain the occupation count of ALL the PTs: it represents the + * number of PTE allocated in the PT + */ + + +/** The structure of a page directory entry. See Intel vol 3 section + 3.6.4 */ +struct x86_pde +{ + sos_ui32_t present :1; /* 1=PT mapped */ + sos_ui32_t write :1; /* 0=read-only, 1=read/write */ + sos_ui32_t user :1; /* 0=supervisor, 1=user */ + sos_ui32_t write_through :1; /* 0=write-back, 1=write-through */ + sos_ui32_t cache_disabled :1; /* 1=cache disabled */ + sos_ui32_t accessed :1; /* 1=read/write access since last clear */ + sos_ui32_t zero :1; /* Intel reserved */ + sos_ui32_t page_size :1; /* 0=4kB, 1=4MB or 2MB (depending on PAE) */ + sos_ui32_t global_page :1; /* Ignored (Intel reserved) */ + sos_ui32_t custom :3; /* Do what you want with them */ + sos_ui32_t pt_paddr :20; +} __attribute__ ((packed)); + + +/** Intermediate type to speed up PDE copy */ +typedef union { + struct x86_pde pde; + sos_ui32_t ui32; +} x86_pde_val_t; + + +/** The structure of a page table entry. See Intel vol 3 section + 3.6.4 */ +struct x86_pte +{ + sos_ui32_t present :1; /* 1=PT mapped */ + sos_ui32_t write :1; /* 0=read-only, 1=read/write */ + sos_ui32_t user :1; /* 0=supervisor, 1=user */ + sos_ui32_t write_through :1; /* 0=write-back, 1=write-through */ + sos_ui32_t cache_disabled :1; /* 1=cache disabled */ + sos_ui32_t accessed :1; /* 1=read/write access since last clear */ + sos_ui32_t dirty :1; /* 1=write access since last clear */ + sos_ui32_t zero :1; /* Intel reserved */ + sos_ui32_t global_page :1; /* 1=No TLB invalidation upon cr3 switch + (when PG set in cr4) */ + sos_ui32_t custom :3; /* Do what you want with them */ + sos_ui32_t paddr :20; +} __attribute__ ((packed)); + + +/** Intermediate type to speed up PTE copy */ +typedef union { + struct x86_pte pte; + sos_ui32_t ui32; +} x86_pte_val_t; + + +/** Structure of the x86 CR3 register: the Page Directory Base + Register. See Intel x86 doc Vol 3 section 2.5 */ +struct x86_pdbr +{ + sos_ui32_t zero1 :3; /* Intel reserved */ + sos_ui32_t write_through :1; /* 0=write-back, 1=write-through */ + sos_ui32_t cache_disabled :1; /* 1=cache disabled */ + sos_ui32_t zero2 :7; /* Intel reserved */ + sos_ui32_t pd_paddr :20; +} __attribute__ ((packed)); + + +/** + * Helper macro to control the MMU: invalidate the TLB entry for the + * page located at the given virtual address. See Intel x86 vol 3 + * section 3.7. + */ +#define invlpg(vaddr) \ + do { \ + __asm__ __volatile__("invlpg %0"::"m"(*((unsigned *)(vaddr)))); \ + } while(0) + + +/** + * Helper macro to control the MMU: invalidate the whole TLB. See + * Intel x86 vol 3 section 3.7. + */ +#define flush_tlb() \ + do { \ + unsigned long tmpreg; \ + asm volatile("movl %%cr3,%0\n\tmovl %0,%%cr3" :"=r" \ + (tmpreg) : :"memory"); \ + } while (0) + + +/** + * Helper macro to compute the index in the PD for the given virtual + * address + */ +#define virt_to_pd_index(vaddr) \ + (((unsigned)(vaddr)) >> 22) + + +/** + * Helper macro to compute the index in the PT for the given virtual + * address + */ +#define virt_to_pt_index(vaddr) \ + ( (((unsigned)(vaddr)) >> 12) & 0x3ff ) + + +/** + * Helper macro to compute the offset in the page for the given virtual + * address + */ +#define virt_to_page_offset(vaddr) \ + (((unsigned)(vaddr)) & SOS_PAGE_MASK) + + +/** + * Helper function to map a page in the pd.\ Suppose that the RAM + * is identity mapped to resolve PT actual (CPU) address from the PD + * entry + */ +static sos_ret_t paging_setup_map_helper(struct x86_pde * pd, + sos_paddr_t ppage, + sos_vaddr_t vaddr) +{ + /* Get the page directory entry and table entry index for this + address */ + unsigned index_in_pd = virt_to_pd_index(vaddr); + unsigned index_in_pt = virt_to_pt_index(vaddr); + + /* Make sure the page table was mapped */ + struct x86_pte * pt; + if (pd[index_in_pd].present) + { + pt = (struct x86_pte*) (pd[index_in_pd].pt_paddr << 12); + + /* This test will always be TRUE here, since the setup routine + scans the kernel pages in a strictly increasing order: at + each step, the map will result in the allocation of a new PT + entry. For the sake of clarity, we keep the test here. */ + if (pt[index_in_pt].present) + SOS_ASSERT_FATAL(FALSE); /* indicate a fatal error */ + } + else + { + /* No : allocate a new one */ + pt = (struct x86_pte*) sos_physmem_ref_physpage_new(FALSE); + if (! pt) + return -SOS_ENOMEM; + + memset((void*)pt, 0x0, SOS_PAGE_SIZE); + + pd[index_in_pd].present = TRUE; + pd[index_in_pd].write = 1; /* It would be too complicated to + determine whether it + corresponds to a real R/W area + of the kernel code/data or + read-only */ + pd[index_in_pd].pt_paddr = ((sos_paddr_t)pt) >> 12; + } + + + /* Map the page in the page table */ + pt[index_in_pt].present = 1; + pt[index_in_pt].write = 1; /* It would be too complicated to + determine whether it corresponds to + a real R/W area of the kernel + code/data or R/O only */ + pt[index_in_pt].user = 0; + pt[index_in_pt].paddr = ppage >> 12; + + /* Increase the PT's occupation count because we allocated a new PTE + inside it */ + sos_physmem_inc_physpage_occupation((sos_paddr_t)pt); + + return SOS_OK; +} + + +sos_ret_t sos_paging_subsystem_setup(sos_paddr_t identity_mapping_base, + sos_paddr_t identity_mapping_top) +{ + /* The PDBR we will setup below */ + struct x86_pdbr cr3; + + /* Get the PD for the kernel */ + struct x86_pde * pd + = (struct x86_pde*) sos_physmem_ref_physpage_new(FALSE); + + /* The iterator for scanning the kernel area */ + sos_paddr_t paddr; + + /* Reset the PD. For the moment, there is still an IM for the whole + RAM, so that the paddr are also vaddr */ + memset((void*)pd, + 0x0, + SOS_PAGE_SIZE); + + /* Identity-map the identity_mapping_* area */ + for (paddr = identity_mapping_base ; + paddr < identity_mapping_top ; + paddr += SOS_PAGE_SIZE) + { + if (paging_setup_map_helper(pd, paddr, paddr)) + return -SOS_ENOMEM; + } + + /* Identity-map the PC-specific BIOS/Video area */ + for (paddr = BIOS_N_VIDEO_START ; + paddr < BIOS_N_VIDEO_END ; + paddr += SOS_PAGE_SIZE) + { + if (paging_setup_map_helper(pd, paddr, paddr)) + return -SOS_ENOMEM; + } + + /* Ok, kernel is now identity mapped in the PD. We still have to set + up the mirroring */ + pd[virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)].present = TRUE; + pd[virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)].write = 1; + pd[virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)].user = 0; + pd[virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)].pt_paddr + = ((sos_paddr_t)pd)>>12; + + /* We now just have to configure the MMU to use our PD. See Intel + x86 doc vol 3, section 3.6.3 */ + memset(& cr3, 0x0, sizeof(struct x86_pdbr)); /* Reset the PDBR */ + cr3.pd_paddr = ((sos_paddr_t)pd) >> 12; + + /* Actual loading of the PDBR in the MMU: setup cr3 + bits 31[Paging + Enabled] and 16[Write Protect] of cr0, see Intel x86 doc vol 3, + sections 2.5, 3.6.1 and 4.11.3 + note table 4-2 */ + asm volatile ("movl %0,%%cr3\n\t" + "movl %%cr0,%%eax\n\t" + "orl $0x80010000, %%eax\n\t" /* bit 31 | bit 16 */ + "movl %%eax,%%cr0\n\t" + "jmp 1f\n\t" + "1:\n\t" + "movl $2f, %%eax\n\t" + "jmp *%%eax\n\t" + "2:\n\t" ::"r"(cr3):"memory","eax"); + + /* + * Here, the only memory available is: + * - The BIOS+video area + * - the identity_mapping_base .. identity_mapping_top area + * - the PD mirroring area (4M) + * All accesses to other virtual addresses will generate a #PF + */ + + return SOS_OK; +} + + +/* Suppose that the current address is configured with the mirroring + * enabled to access the PD and PT. */ +sos_ret_t sos_paging_map(sos_paddr_t ppage_paddr, + sos_vaddr_t vpage_vaddr, + sos_bool_t is_user_page, + sos_ui32_t flags) +{ + /* Get the page directory entry and table entry index for this + address */ + unsigned index_in_pd = virt_to_pd_index(vpage_vaddr); + unsigned index_in_pt = virt_to_pt_index(vpage_vaddr); + + /* Get the PD of the current context */ + struct x86_pde *pd = (struct x86_pde*) + (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)); + + /* Address of the PT in the mirroring */ + struct x86_pte * pt = (struct x86_pte*) (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*index_in_pd); + + SOS_ASSERT_FATAL(SOS_IS_PAGE_ALIGNED(ppage_paddr)); + SOS_ASSERT_FATAL(SOS_IS_PAGE_ALIGNED(vpage_vaddr)); + + /* EXEC permission ignored on x86 */ + flags &= ~SOS_VM_MAP_PROT_EXEC; + + /* The mapping of anywhere in the PD mirroring is FORBIDDEN ;) */ + if ((vpage_vaddr >= SOS_PAGING_MIRROR_VADDR) + && (vpage_vaddr < SOS_PAGING_MIRROR_VADDR + SOS_PAGING_MIRROR_SIZE)) + return -SOS_EINVAL; + + /* Map a page for the PT if necessary */ + if (! pd[index_in_pd].present) + { + x86_pde_val_t u; + + /* No : allocate a new one */ + sos_paddr_t pt_ppage + = sos_physmem_ref_physpage_new(! (flags & SOS_VM_MAP_ATOMIC)); + if (! pt_ppage) + { + return -SOS_ENOMEM; + } + + /* Prepare the value of the PDE */ + u.pde = (struct x86_pde){ + .present = TRUE, + .write = 1, + .pt_paddr = ((sos_paddr_t)pt_ppage) >> 12 + }; + + /* Is it a PDE concerning the kernel space */ + if (vpage_vaddr < SOS_PAGING_MIRROR_VADDR) + { + /* Yes: So we need to update the PDE of ALL the mm_contexts + in the system */ + + /* First of all: this is a kernel PT */ + u.pde.user = 0; + + /* Now synchronize all the PD */ + SOS_ASSERT_FATAL(SOS_OK == + sos_mm_context_synch_kernel_PDE(index_in_pd, + u.ui32)); + } + else /* We should have written "else if (vpage_vaddr >= + SOS_PAGING_BASE_USER_ADDRESS)" but this is not needed + because the beginning of the function detects and + rejects mapping requests inside the mirroring */ + { + /* No: The request concerns the user space. So only the + current MMU context is concerned */ + + /* First of all: this is a user PT */ + u.pde.user = 1; + + /* Now update the current PD */ + pd[index_in_pd] = u.pde; + } + + /* + * The PT is now mapped in the PD mirroring + */ + + /* Invalidate TLB for the page we just added */ + invlpg(pt); + + /* Reset this new PT */ + memset((void*)pt, 0x0, SOS_PAGE_SIZE); + } + + /* If we allocate a new entry in the PT, increase its occupation + count. */ + if (! pt[index_in_pt].present) + sos_physmem_inc_physpage_occupation(pd[index_in_pd].pt_paddr << 12); + + /* Otherwise, that means that a physical page is implicitely + unmapped */ + else + sos_physmem_unref_physpage(pt[index_in_pt].paddr << 12); + + /* Map the page in the page table */ + pt[index_in_pt].present = TRUE; + pt[index_in_pt].write = (flags & SOS_VM_MAP_PROT_WRITE)?1:0; + pt[index_in_pt].user = (is_user_page)?1:0; + pt[index_in_pt].paddr = ppage_paddr >> 12; + sos_physmem_ref_physpage_at(ppage_paddr); + + + /* + * The page is now mapped in the current address space + */ + + /* Invalidate TLB for the page we just added */ + invlpg(vpage_vaddr); + + return SOS_OK; +} + + +sos_ret_t sos_paging_unmap(sos_vaddr_t vpage_vaddr) +{ + sos_ret_t pt_dec_occupation_retval; + + /* Get the page directory entry and table entry index for this + address */ + unsigned index_in_pd = virt_to_pd_index(vpage_vaddr); + unsigned index_in_pt = virt_to_pt_index(vpage_vaddr); + + /* Get the PD of the current context */ + struct x86_pde *pd = (struct x86_pde*) + (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)); + + /* Address of the PT in the mirroring */ + struct x86_pte * pt = (struct x86_pte*) (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*index_in_pd); + + SOS_ASSERT_FATAL(SOS_IS_PAGE_ALIGNED(vpage_vaddr)); + + /* No page mapped at this address ? */ + if (! pd[index_in_pd].present) + return -SOS_EINVAL; + if (! pt[index_in_pt].present) + return -SOS_EINVAL; + + /* The unmapping of anywhere in the PD mirroring is FORBIDDEN ;) */ + if ((vpage_vaddr >= SOS_PAGING_MIRROR_VADDR) + && (vpage_vaddr < SOS_PAGING_MIRROR_VADDR + SOS_PAGING_MIRROR_SIZE)) + return -SOS_EINVAL; + + /* Reclaim the physical page */ + sos_physmem_unref_physpage(pt[index_in_pt].paddr << 12); + + /* Unmap the page in the page table */ + memset(pt + index_in_pt, 0x0, sizeof(struct x86_pte)); + + /* Invalidate TLB for the page we just unmapped */ + invlpg(vpage_vaddr); + + /* Reclaim this entry in the PT, which may free the PT */ + pt_dec_occupation_retval + = sos_physmem_dec_physpage_occupation(pd[index_in_pd].pt_paddr << 12); + SOS_ASSERT_FATAL(pt_dec_occupation_retval >= 0); + if (pt_dec_occupation_retval > 0) + /* If the PT is now completely unused... */ + { + x86_pde_val_t u; + + + /* + * The PT is not referenced by this PD anymore + */ + sos_physmem_unref_physpage(pd[index_in_pd].pt_paddr << 12); + + + /* + * Reset the PDE + */ + + /* Mark the PDE as unavailable */ + u.ui32 = 0; + + /* Is it a PDE concerning the kernel space */ + if (vpage_vaddr < SOS_PAGING_MIRROR_VADDR) + { + /* Now synchronize all the PD */ + SOS_ASSERT_FATAL(SOS_OK == + sos_mm_context_synch_kernel_PDE(index_in_pd, + u.ui32)); + } + else /* We should have written "else if (vpage_vaddr >= + SOS_PAGING_BASE_USER_ADDRESS)" but this is not needed + because the beginning of the function detects and + rejects mapping requests inside the mirroring */ + { + /* No: The request concerns the user space. So only the + current MMU context is concerned */ + pd[index_in_pd] = u.pde; + } + + /* Update the TLB */ + invlpg(pt); + } + + return SOS_OK; +} + + +sos_ret_t sos_paging_unmap_interval(sos_vaddr_t vaddr, + sos_size_t size) +{ + sos_ret_t retval = 0; + + if (! SOS_IS_PAGE_ALIGNED(vaddr)) + return -SOS_EINVAL; + if (! SOS_IS_PAGE_ALIGNED(size)) + return -SOS_EINVAL; + + for ( ; + size >= SOS_PAGE_SIZE ; + vaddr += SOS_PAGE_SIZE, size -= SOS_PAGE_SIZE) + if (SOS_OK == sos_paging_unmap(vaddr)) + retval += SOS_PAGE_SIZE; + + return retval; +} + + +sos_ui32_t sos_paging_get_prot(sos_vaddr_t vaddr) +{ + sos_ui32_t retval; + + /* Get the page directory entry and table entry index for this + address */ + unsigned index_in_pd = virt_to_pd_index(vaddr); + unsigned index_in_pt = virt_to_pt_index(vaddr); + + /* Get the PD of the current context */ + struct x86_pde *pd = (struct x86_pde*) + (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)); + + /* Address of the PT in the mirroring */ + struct x86_pte * pt = (struct x86_pte*) (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*index_in_pd); + + /* No page mapped at this address ? */ + if (! pd[index_in_pd].present) + return SOS_VM_MAP_PROT_NONE; + if (! pt[index_in_pt].present) + return SOS_VM_MAP_PROT_NONE; + + /* Default access right of an available page is "read" on x86 */ + retval = SOS_VM_MAP_PROT_READ; + if (pd[index_in_pd].write && pt[index_in_pt].write) + retval |= SOS_VM_MAP_PROT_WRITE; + + return retval; +} + + +sos_ret_t sos_paging_set_prot(sos_vaddr_t vaddr, + sos_ui32_t new_prot) +{ + /* Get the page directory entry and table entry index for this + address */ + unsigned index_in_pd = virt_to_pd_index(vaddr); + unsigned index_in_pt = virt_to_pt_index(vaddr); + + /* Get the PD of the current context */ + struct x86_pde *pd = (struct x86_pde*) + (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)); + + /* Address of the PT in the mirroring */ + struct x86_pte * pt = (struct x86_pte*) (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*index_in_pd); + + /* EXEC permission ignored on x86 */ + new_prot &= ~SOS_VM_MAP_PROT_EXEC; + + /* Check flags */ + if (new_prot & ~(SOS_VM_MAP_PROT_READ | SOS_VM_MAP_PROT_WRITE)) + return -SOS_EINVAL; + if (! (new_prot & SOS_VM_MAP_PROT_READ)) + /* x86 READ flag always set by default */ + return -SOS_ENOSUP; + + /* No page mapped at this address ? */ + if (! pd[index_in_pd].present) + return -SOS_EINVAL; + if (! pt[index_in_pt].present) + return -SOS_EINVAL; + + /* Update access rights */ + pt[index_in_pt].write = ((new_prot & SOS_VM_MAP_PROT_WRITE) != 0); + invlpg(vaddr); + + return SOS_OK; +} + + +sos_ret_t sos_paging_set_prot_of_interval(sos_vaddr_t vaddr, + sos_size_t size, + sos_ui32_t new_prot) +{ + if (! SOS_IS_PAGE_ALIGNED(vaddr)) + return -SOS_EINVAL; + if (! SOS_IS_PAGE_ALIGNED(size)) + return -SOS_EINVAL; + + for ( ; size >= SOS_PAGE_SIZE ; vaddr += SOS_PAGE_SIZE, size -= SOS_PAGE_SIZE) + sos_paging_set_prot(vaddr, new_prot); + + return SOS_OK; +} + + +sos_paddr_t sos_paging_get_paddr(sos_vaddr_t vaddr) +{ + /* Get the page directory entry and table entry index for this + address */ + unsigned index_in_pd = virt_to_pd_index(vaddr); + unsigned index_in_pt = virt_to_pt_index(vaddr); + unsigned offset_in_page = virt_to_page_offset(vaddr); + + /* Get the PD of the current context */ + struct x86_pde *pd = (struct x86_pde*) + (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*virt_to_pd_index(SOS_PAGING_MIRROR_VADDR)); + + /* Address of the PT in the mirroring */ + struct x86_pte * pt = (struct x86_pte*) (SOS_PAGING_MIRROR_VADDR + + SOS_PAGE_SIZE*index_in_pd); + + /* No page mapped at this address ? */ + if (! pd[index_in_pd].present) + return (sos_paddr_t)NULL; + if (! pt[index_in_pt].present) + return (sos_paddr_t)NULL; + + return (pt[index_in_pt].paddr << 12) + offset_in_page; +} + + +/* ************************************************* + * Functions restricted to mm_context module + */ + + +sos_paddr_t sos_paging_get_current_PD_paddr() +{ + struct x86_pdbr pdbr; + asm volatile("movl %%cr3, %0\n": "=r"(pdbr)); + return (pdbr.pd_paddr << 12); +} + + +sos_ret_t sos_paging_set_current_PD_paddr(sos_paddr_t paddr_PD) +{ + struct x86_pdbr pdbr; + + SOS_ASSERT_FATAL(paddr_PD != 0); + SOS_ASSERT_FATAL(SOS_IS_PAGE_ALIGNED(paddr_PD)); + + /* Setup the value of the PDBR */ + memset(& pdbr, 0x0, sizeof(struct x86_pdbr)); /* Reset the PDBR */ + pdbr.pd_paddr = (paddr_PD >> 12); + + /* Configure the MMU according to the PDBR */ + asm volatile ("movl %0,%%cr3\n" ::"r"(pdbr)); + + return SOS_OK; +} + + +sos_ret_t sos_paging_dispose(sos_vaddr_t vaddr_PD) +{ + x86_pde_val_t *pd = (x86_pde_val_t*) vaddr_PD; + x86_pte_val_t *pt; + int index_in_pd; + + /* Allocate 1 page in kernel space to map the PTs in order to + unreference the physical pages they reference */ + pt = (x86_pte_val_t *)sos_kmem_vmm_alloc(1, 0); + if (! pt) + return -SOS_ENOMEM; + + /* (Nothing to do in kernel space) */ + + /* Reset all the PTs in user space */ + for (index_in_pd = (SOS_PAGING_BASE_USER_ADDRESS >> 22) ; + index_in_pd < 1024 ; /* 1 PDE = 1 PT + = 1024 Pages + = 4MB */ + index_in_pd ++) + { + sos_paddr_t paddr_pt = (pd[index_in_pd].pde.pt_paddr << 12); + int index_in_pt; + + /* Nothing to do if there is no PT */ + if (! pd[index_in_pd].pde.present) + { + pd[index_in_pd].ui32 = 0; + continue; + } + + /* Map this PT inside kernel */ + SOS_ASSERT_FATAL(SOS_OK + == sos_paging_map(paddr_pt, + (sos_vaddr_t)pt, FALSE, + SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE)); + + /* Reset all the mappings in this PT */ + for (index_in_pt = 0 ; index_in_pt < 1024 ; index_in_pt ++) + { + /* Ignore unmapped PTE */ + if (! pt[index_in_pt].pte.present) + { + pt[index_in_pt].ui32 = 0; + continue; + } + + /* Unreference the associated page */ + sos_physmem_unref_physpage(pt[index_in_pt].pte.paddr << 12); + + /* Decrease occupation count of the PT */ + sos_physmem_dec_physpage_occupation(paddr_pt); + + /* Reset PTE */ + pt[index_in_pt].ui32 = 0; + } + + /* Unmap PT */ + SOS_ASSERT_FATAL(SOS_OK == sos_paging_unmap((sos_vaddr_t)pt)); + + /* Reset PDE */ + pd[index_in_pd].ui32 = 0; + + /* Unreference PT */ + sos_physmem_unref_physpage(paddr_pt); + } + + /* Unallocate kernel space used for the temporary PT */ + SOS_ASSERT_FATAL(SOS_OK == sos_kmem_vmm_free((sos_vaddr_t)pt)); + + return SOS_OK; +} + + +sos_ret_t sos_paging_copy_kernel_space(sos_vaddr_t dest_vaddr_PD, + sos_vaddr_t src_vaddr_PD) +{ + x86_pde_val_t *src_pd = (x86_pde_val_t*) src_vaddr_PD; + x86_pde_val_t *dest_pd = (x86_pde_val_t*) dest_vaddr_PD; + sos_paddr_t dest_paddr_PD = sos_paging_get_paddr(dest_vaddr_PD); + x86_pde_val_t mirror_pde; + int index_in_pd; + + /* Fill destination PD with zeros */ + memset((void*)dest_vaddr_PD, 0x0, SOS_PAGE_SIZE); + + /* Synchronize it with the master Kernel MMU context. Stop just + before the mirroring ! */ + for (index_in_pd = 0 ; + index_in_pd < (SOS_PAGING_MIRROR_VADDR >> 22) ; /* 1 PDE = 1 PT + = 1024 Pages + = 4MB */ + index_in_pd ++) + { + /* Copy the master's configuration */ + dest_pd[index_in_pd].ui32 = src_pd[index_in_pd].ui32; + + /* We DON'T mark the underlying PT and pages as referenced + because all the PD are equivalent in the kernel space: as + soon as a page is mapped in the kernel, it is mapped by X + address spaces, and as soon as it is unmapped by 1 address + space, it is unmapped in all the others. So that for X + address spaces, the reference counter will be either 0 or X, + and not something else: using the reference counter correctly + won't be of any use and would consume some time in updating it. */ + } + + /* Setup the mirroring for the new address space */ + mirror_pde.ui32 = 0; + mirror_pde.pde.present = TRUE; + mirror_pde.pde.write = 1; + mirror_pde.pde.user = 0; /* This is a KERNEL PDE */ + mirror_pde.pde.pt_paddr = (dest_paddr_PD >> 12); + dest_pd[SOS_PAGING_MIRROR_VADDR >> 22].ui32 = mirror_pde.ui32; + + return SOS_OK; +} + diff --git a/hwcore/paging.h b/hwcore/paging.h new file mode 100644 index 0000000..b0b590f --- /dev/null +++ b/hwcore/paging.h @@ -0,0 +1,194 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_PAGING_H_ +#define _SOS_PAGING_H_ + +/** + * @file paging.h + * + * MMU management routines (arch-dependent). Setup the MMU without + * identity-mapping physical<->virtual addresses over the whole + * physical address space: a single, restricted and known, area is + * identity-mapped, the remaining kernel/user space is not. To access + * and manage the MMU translation tables (PD/PT on x86), we rely on a + * particular configuration, called "mirroring", where the top-level + * translation table (PD on x86) maps itself at a known and fixed (virtual) + * address. The only assumption for this to be possible is that the + * structure of the translation table entries are compatible at the + * different levels of vadddr->paddr translation process (PDE and PTE + * on x86 are Ok). Credits go to Christophe Avoinne for that. + */ + +#include +#include + + +/** + * Basic SOS virtual memory organization + */ +/** Frontier between kernel and user space virtual addresses */ +#define SOS_PAGING_BASE_USER_ADDRESS (0x40000000) /* 1GB (must be 4MB-aligned) */ +#define SOS_PAGING_TOP_USER_ADDRESS (0xFFFFFFFF) /* 4GB - 1B */ +#define SOS_PAGING_USER_SPACE_SIZE (0xc0000000) /* 3GB */ + +/** Length of the space reserved for the mirroring in the kernel + virtual space */ +#define SOS_PAGING_MIRROR_SIZE (1 << 22) /* 1 PD = 1024 Page Tables = 4MB */ + +/** Virtual address where the mirroring takes place */ +#define SOS_PAGING_MIRROR_VADDR \ + (SOS_PAGING_BASE_USER_ADDRESS - SOS_PAGING_MIRROR_SIZE) + + +/** + * sos_paging_map flags + */ +/** Usual virtual memory access rights */ +#define SOS_VM_MAP_PROT_NONE 0 +#define SOS_VM_MAP_PROT_READ (1<<0) +#define SOS_VM_MAP_PROT_WRITE (1<<1) +#define SOS_VM_MAP_PROT_EXEC (1<<2) /* Not supported on IA32 */ + +/** Mapping a page may involve an physical page allocation (for a new + PT), hence may potentially block */ +#define SOS_VM_MAP_ATOMIC (1<<31) + + +/** + * Setup initial page directory structure where the kernel is + * identically-mapped, and the mirroring. This routine also + * identity-maps the BIOS and video areas, to allow some debugging + * text to be printed to the console. Finally, this routine installs + * the whole configuration into the MMU. + */ +sos_ret_t sos_paging_subsystem_setup(sos_paddr_t identity_mapping_base, + sos_paddr_t identity_mapping_top); + +/** + * Map the given physical page at the given virtual address in the + * current address space. + * + * @note *IMPORTANT*: The physical page ppage_paddr *MUST* have been + * referenced by the caller through either a call to + * sos_physmem_ref_physpage_new() or sos_physmem_ref_physpage_at(). It + * would work if this were untrue, but this would be INCORRECT (it is + * expected that one is owning the page before mapping it, or + * otherwise the page could have been stolen by an interrupt or + * another thread). + * + * @param ppage_paddr The address of a physical page (page-aligned) + * @param vpage_vaddr The address of the virtual page (page-aligned) + * @param is_user_page TRUE when the page is available from user space + * @param flags A mask made of SOS_VM_* bits + * + * @note Unless the SOS_VM_MAP_ATOMIC bit is set in the flags, the + * function may potentially block, because a physical page may be + * allocated for a new PT. + */ +sos_ret_t sos_paging_map(sos_paddr_t ppage_paddr, + sos_vaddr_t vpage_vaddr, + sos_bool_t is_user_page, + sos_ui32_t flags); + +/** + * Undo the mapping from vaddr to the underlying physical page (if any) + * @param vpage_vaddr The address of the virtual page (page-aligned) + * + * @return >= 0 when OK (the number of bytes of RAM unmapped), < 0 on error + */ +sos_ret_t sos_paging_unmap(sos_vaddr_t vpage_vaddr); + +/** + * Undo the mapping from [vaddr .. vaddr + size[ to the underlying + * physical pages (if any) + * @param vpage_vaddr The address of the virtual page (page-aligned) + * @param size The size (in bytes) to unmap. MUST be page-aligned + */ +sos_ret_t sos_paging_unmap_interval(sos_vaddr_t base_vpage_vaddr, + sos_size_t size); + +/** + * Return the page protection flags (SOS_VM_MAP_PROT_*) associated + * with the address, or SOS_VM_MAP_PROT_NONE when page is not mapped + */ +sos_ui32_t sos_paging_get_prot(sos_vaddr_t vaddr); + +/** + * Change the page access rights + */ +sos_ret_t sos_paging_set_prot(sos_vaddr_t vaddr, + sos_ui32_t new_prot); + +/** + * Change the access rights of the mapping from [vaddr .. vaddr + + * size[ to the underlying physical pages (if any) + * @param vpage_vaddr The address of the virtual page (page-aligned) + * @param size The size (in bytes) to unmap. MUST be page-aligned + */ +sos_ret_t sos_paging_set_prot_of_interval(sos_vaddr_t vaddr, + sos_size_t size, + sos_ui32_t new_prot); + +/** + * Return the physical address of the given virtual address. Since page + * at physical addr 0 is not mapped, the NULL result means "page not + * mapped". + */ +sos_paddr_t sos_paging_get_paddr(sos_vaddr_t vaddr); + +/** + * Tell whether the address is physically mapped + */ +#define sos_paging_check_present(vaddr) \ + (sos_paging_get_paddr(vaddr) != NULL) + + +/* ************************************************* + * Functions restricted to mm_context module + */ + + +/** + * Release the references to all the referenced pages (and PT on + * x86). On x86, this applies only to the USER pages and PT. + */ +sos_ret_t sos_paging_dispose(sos_vaddr_t vaddr_PD); + + +/** + * Copy the MMU configuration related to the kernel virtual area + */ +sos_ret_t sos_paging_copy_kernel_space(sos_vaddr_t dest_vaddr_PD, + sos_vaddr_t src_vaddr_PD); + + +/** + * Retrieve the current physical address of the PD + */ +sos_paddr_t sos_paging_get_current_PD_paddr(); + + +/** + * Change the current MMU configuration. + * + * @note DANGEROUS. Don't use it unless you know exactly what you're + * doing ! + */ +sos_ret_t sos_paging_set_current_PD_paddr(sos_paddr_t paddr_PD); + +#endif /* _SOS_PAGING_H_ */ diff --git a/hwcore/segment.h b/hwcore/segment.h new file mode 100644 index 0000000..a58b361 --- /dev/null +++ b/hwcore/segment.h @@ -0,0 +1,73 @@ +/* Copyright (C) 2004 The SOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_HWSEGS_H_ +#define _SOS_HWSEGS_H_ + +/** + * @file segments.h + * + * Global and local (GDT/LDT) segment descriptor definition and + * structure. These segments map virtual addresses (ie + * data/instruction addresses, relative to these segment descriptors) + * to linear addresses (ie addresses in the paged-memory space). + * + * @see Intel x86 doc, vol 3 chapter 3. + */ + + +/* + * Global segment selectors (GDT) for SOS/x86. + * + * @see gdt.h + */ +#define SOS_SEG_NULL 0 /* NULL segment, unused by the procesor */ +#define SOS_SEG_KCODE 1 /* Kernel code segment */ +#define SOS_SEG_KDATA 2 /* Kernel data segment */ +#define SOS_SEG_UCODE 3 /* User code segment */ +#define SOS_SEG_UDATA 4 /* User data segment */ +#define SOS_SEG_KERNEL_TSS 5 /* Kernel TSS for CPL3 -> CPL0 privilege change */ + + +#ifndef ASM_SOURCE +/** + * Helper macro that builds a segment register's value + */ +#define SOS_BUILD_SEGMENT_REG_VALUE(desc_privilege,in_ldt,seg_index) \ + ( (((desc_privilege) & 0x3) << 0) \ + | (((in_ldt)?1:0) << 2) \ + | ((seg_index) << 3) ) +#else +/* + * Assembler-compliant version. + * + * Caution: In assembler code, "in_ldt" MUST be either 1 or 0, nothing + * else. + */ +#define SOS_BUILD_SEGMENT_REG_VALUE(desc_privilege,in_ldt,seg_index) \ + ( (((desc_privilege) & 0x3) << 0) \ + | ((in_ldt & 1) << 2) \ + | ((seg_index) << 3) ) +#endif + + +/* + * Local segment selectors (LDT) for SOS/x86 + */ +/* None */ + +#endif /* _SOS_HWSEGS_H_ */ diff --git a/hwcore/swintr.c b/hwcore/swintr.c new file mode 100644 index 0000000..8b02ede --- /dev/null +++ b/hwcore/swintr.c @@ -0,0 +1,50 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include + +#include "idt.h" +#include "irq.h" + +#include "swintr.h" + +/** + * The Assembler low-level wrapper for the SOS syscalls + * + * This wrapper takes care of saving the state of the calling user + * thread before calling the "C" function sos_do_syscall(), passing it + * the correct arguments. + */ +extern void sos_syscall_wrapper(); + + +sos_ret_t sos_swintr_subsystem_setup(void) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + + retval + = sos_idt_set_handler(SOS_SWINTR_SOS_SYSCALL, + (sos_vaddr_t) sos_syscall_wrapper, + 3 /* CPL3 routine */); + + sos_restore_IRQs(flags); + + return retval; +} diff --git a/hwcore/swintr.h b/hwcore/swintr.h new file mode 100644 index 0000000..b775b47 --- /dev/null +++ b/hwcore/swintr.h @@ -0,0 +1,44 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_SWINTR_H_ +#define _SOS_SWINTR_H_ + +/** + * @file swintr.h + * + * SOS handlers for the software interrupts. In SOS, we handle a + * single software interrupt: the syscall interrupt. + */ + + +/** + * The SOS software interrupt number for issueing syscalls + */ +#define SOS_SWINTR_SOS_SYSCALL 0x42 + + +#if defined(KERNEL_SOS) && !defined(ASM_SOURCE) + +#include +#include + +sos_ret_t sos_swintr_subsystem_setup(void); + +#endif /* defined(KERNEL_SOS) && !defined(ASM_SOURCE) */ + +#endif /* _SOS_SWINTR_H_ */ diff --git a/hwcore/swintr_wrappers.S b/hwcore/swintr_wrappers.S new file mode 100644 index 0000000..64c8086 --- /dev/null +++ b/hwcore/swintr_wrappers.S @@ -0,0 +1,116 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "segment.h" + + +/** + * @file swintr_wrappers.S + * + * The SOS low-level handlers for the software interrupts. Currently + * only 1 wrapper: that for the SOS syscalls. + */ +.file "swintr_wrappers.S" + +.text + +/* The address of the real "C" syscall function */ +.extern sos_do_syscall + +/** Update the kernel TSS in case we are switching to a thread in user + mode in order to come back into the correct kernel stack */ +.extern sos_cpu_context_update_kernel_tss + +/* The address of the function to call to set back the user thread's + MMU configuration upon return to user context */ +.extern sos_thread_prepare_syscall_switch_back + +.p2align 2, 0x90 +.globl sos_syscall_wrapper +sos_syscall_wrapper: +.type sos_syscall_wrapper,@function + + /* Fake error code */ + pushl $0 + /* Backup the context */ + pushl %ebp + movl %esp, %ebp + + pushl %edi + pushl %esi + pushl %edx + pushl %ecx + pushl %ebx + pushl %eax + subl $2,%esp + pushw %ss + pushw %ds + pushw %es + pushw %fs + pushw %gs + + /* Set correct kernel segment descriptors' value */ + movw $SOS_BUILD_SEGMENT_REG_VALUE(0, 0, SOS_SEG_KDATA), %di + pushw %di ; popw %ds + pushw %di ; popw %es + pushw %di ; popw %fs + pushw %di ; popw %gs + + /* Prepare the call to do_syscall */ + pushl %esp /* user_ctxt */ + pushl %eax /* syscall ID */ + + call sos_do_syscall + /* Unallocate the stack used by the + do_syscall arguments */ + addl $8, %esp + + /* store the do_syscall return value into interrupted context */ + movl %eax, 12(%esp) + + /* Set the MMU configuration to that of the user thread's process */ + pushl %esp /* user_ctxt */ + call sos_thread_prepare_syscall_switch_back + addl $4, %esp /* Unallocate the stack */ + + /* Prepare kernel TSS because we are switching back to a user + thread: we make sure that we will come back into the kernel at a + correct stack location */ + pushl %esp /* Pass the location of the context we are + restoring to the function */ + call sos_cpu_context_update_kernel_tss + addl $4, %esp + + /* Restore the user context */ + popw %gs + popw %fs + popw %es + popw %ds + popw %ss + addl $2,%esp + popl %eax /* This is the return value of do_syscall (see above) */ + popl %ebx + popl %ecx + popl %edx + popl %esi + popl %edi + + popl %ebp + /* Remove fake error code */ + addl $4, %esp + iret diff --git a/sos/assert.c b/sos/assert.c new file mode 100644 index 0000000..a7b24bf --- /dev/null +++ b/sos/assert.c @@ -0,0 +1,47 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include // backtrace + +#include "assert.h" + +void sos_display_fatal_error(const char *format, /* args */...) +{ + char buff[256]; + va_list ap; + + asm("cli\n"); /* disable interrupts -- x86 only */ \ + + va_start(ap, format); + vsnprintf(buff, sizeof(buff), format, ap); + va_end(ap); + + sos_bochs_putstring(buff); sos_bochs_putstring("\n"); + sos_x86_videomem_putstring(23, 0, + SOS_X86_VIDEO_BG_BLACK + | SOS_X86_VIDEO_FG_LTRED , buff); + + sos_thread_dump_backtrace(TRUE, TRUE); + + /* Infinite loop: processor halted */ + for ( ; ; ) + asm("hlt\n"); +} diff --git a/sos/assert.h b/sos/assert.h new file mode 100644 index 0000000..9fcfec0 --- /dev/null +++ b/sos/assert.h @@ -0,0 +1,45 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_ASSERT_H_ +#define _SOS_ASSERT_H_ + + +void sos_display_fatal_error(const char *format, /* args */...) + __attribute__ ((format (printf, 1, 2), noreturn)); + + +/** + * If the expr is FALSE, print a message and halt the machine + */ +#define SOS_ASSERT_FATAL(expr) \ + ({ \ + int __res=(int)(expr); \ + if (! __res) \ + sos_display_fatal_error("%s@%s:%d Assertion " # expr " failed", \ + __PRETTY_FUNCTION__, __FILE__, __LINE__); \ + }) + + +#define SOS_FATAL_ERROR(fmt,args...) \ + ({ \ + sos_display_fatal_error("%s@%s:%d FATAL: " fmt, \ + __PRETTY_FUNCTION__, __FILE__, __LINE__, \ + ##args); \ + }) + +#endif /* _SOS_ASSERT_H_ */ diff --git a/sos/calcload.c b/sos/calcload.c new file mode 100644 index 0000000..2ec8fc5 --- /dev/null +++ b/sos/calcload.c @@ -0,0 +1,396 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include + + +/** + * Multiplicative factor to display digits after the decimal dot. The + * higher the value, the higher the precision, but the higher the risk + * that the value you get is incorrect (integer overflow). + * + * The CPU ratios will be correctly displayed as long as: + * 2^32 > (900 * HZ * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR) + * The "900" above means 900s because the load is computed over 15mn (900s). + * HZ is the frequency of the timer tick because the load is updated + * at each timer tick. + * The "100" above is the multiplication factor to get the ratio value + * between 0 and 100 (instead of 0-1). + * + * The maximum CPU sustainable load that will be correctly displayed + * is given by the formula: + * (2^32 - 1) / (900 * HZ * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR) + * With HZ=100, these maximum sustainable loads are respectively + * 47.721, 477.21 and 4772.1 with + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR being respectively 1000, 100 + * and 10. + * + * Hence, among these formulaes, the most limitative one is that + * concerning the CPU ratios (because of the "100" factor). Actually, + * for HZ=100, the only correct value is 10. + */ +#define SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR 10 /* 1/10 resolution */ + + +/** + * To compute the load, at each clock tick we store the number of + * threads ready in kernel/user mode, and the kind of the thread that + * is executing (user or kernel mode): this is stored in + * current_load_entry. We then compute the sum of these numbers over 3 + * periods of time: 1 minute, 5 minutes, 15 minutes. This is the role + * of the sliding windows data structures. A "sliding window" is only + * the synthetic sum of these figures, not a real sliding window of + * load_entries. At each timer tick and everytime the load is updated, + * the computations are in O(1). + * + * All the sliding windows share the main "recorded_load" array of + * load_entries for that; its role is to store the last 15mns of load + * data, which encompasses the data for the 1mn, 5mn and 15mn sliding + * windows. + */ + +/* Max number of seconds that we record (ie number of entries in + recorded_loads) */ +#define NB_SECS 900 + + +/* An entry in the longest sliding window */ +struct load_entry +{ + sos_ui32_t nb_ticks; + + sos_ui32_t nb_user_running; + sos_ui32_t nb_kernel_running; + + sos_ui32_t nb_user_ready; + sos_ui32_t nb_kernel_ready; +}; + +struct load_entry current_load_entry; + + +/* The longest sliding window */ +struct recorded_loads +{ + sos_ui32_t most_recent; + sos_ui32_t max_entries; + + struct load_entry *load_entries; +}; + +#define LOAD_GET_ENTRY(loads,age) \ + (&((loads).load_entries[( (loads).max_entries + (loads).most_recent - (age))\ + % ((loads).max_entries)])) + +/* A sliding window, we manage one for each time interval */ +struct sliding_window +{ + sos_ui32_t max_entries; + sos_ui32_t nb_entries; + + sos_ui32_t sigma_nb_ticks; + sos_ui32_t sigma_nb_user_running; + sos_ui32_t sigma_nb_kernel_running; + sos_ui32_t sigma_nb_user_ready; + sos_ui32_t sigma_nb_kernel_ready; +}; + + +/* The main sliding window */ +static struct recorded_loads recorded_loads; + +/* The sliding windows for 3 tims intervals: 1min, 5min, 15min */ +static struct sliding_window load_1mn, load_5mn, load_15mn; + +/* Forward declaration */ +static struct sos_timeout_action calcload_timeout; +static void calcload_routine(struct sos_timeout_action *a); + + +static void _reinit_load_subsystem() +{ + memset(& recorded_loads, 0x0, sizeof(recorded_loads)); + memset(& current_load_entry, 0x0, sizeof(struct load_entry)); + memset(& load_1mn, 0x0, sizeof(load_1mn)); + memset(& load_5mn, 0x0, sizeof(load_5mn)); + memset(& load_15mn, 0x0, sizeof(load_15mn)); +} + + +sos_ret_t sos_load_subsystem_setup(void) +{ + struct sos_time period; + _reinit_load_subsystem(); + + if (recorded_loads.load_entries) + sos_kfree((sos_vaddr_t) recorded_loads.load_entries); + _reinit_load_subsystem(); + + /* Allocate 900 entries to store 15mn of data (because 15minutes = + 900s) */ + recorded_loads.max_entries = NB_SECS; + recorded_loads.load_entries + = (struct load_entry*) sos_kmalloc(NB_SECS * sizeof(struct load_entry), + 0); + if (! recorded_loads.load_entries) + { + return -SOS_ENOMEM; + } + + /* Compute the number of entries in each sliding window */ + load_1mn.max_entries = 60; + load_5mn.max_entries = 300; + load_15mn.max_entries = 900; + + /* Program the load computation action */ + sos_time_init_action(& calcload_timeout); + period.sec = 1; period.nanosec = 0; + return sos_time_register_action_relative(& calcload_timeout, + & period, + calcload_routine, + NULL); +} + + +/* Shift the given sliding window to record the current_load_entry */ +static void update_sliding_window(struct sliding_window *w) +{ + /* + * Compute the value of the sum over the sliding window + */ + + /* Take the new value into account */ + w->sigma_nb_ticks += current_load_entry.nb_ticks; + w->sigma_nb_user_running += current_load_entry.nb_user_running; + w->sigma_nb_kernel_running += current_load_entry.nb_kernel_running; + w->sigma_nb_user_ready += current_load_entry.nb_user_ready; + w->sigma_nb_kernel_ready += current_load_entry.nb_kernel_ready; + + /* Remove the oldest entry, if it is going to be popped out of the + sliding window */ + if (w->nb_entries < w->max_entries) + { + w->nb_entries ++; + } + else + { + struct load_entry * oldest_entry; + oldest_entry = LOAD_GET_ENTRY(recorded_loads, w->nb_entries - 1); + w->sigma_nb_ticks -= oldest_entry->nb_ticks; + w->sigma_nb_user_running -= oldest_entry->nb_user_running; + w->sigma_nb_kernel_running -= oldest_entry->nb_kernel_running; + w->sigma_nb_user_ready -= oldest_entry->nb_user_ready; + w->sigma_nb_kernel_ready -= oldest_entry->nb_kernel_ready; + } +} + + +/* The timeout action responsible for computing the CPU load */ +static void calcload_routine(struct sos_timeout_action *a) +{ + struct load_entry * new_head; + struct sos_time delay; + + if (! recorded_loads.load_entries) + return; + + /* Update the sliding windows */ + update_sliding_window(& load_1mn); + update_sliding_window(& load_5mn); + update_sliding_window(& load_15mn); + + /* Move the head of the list forward */ + recorded_loads.most_recent + = (recorded_loads.most_recent + 1) % recorded_loads.max_entries; + + /* Update the new head */ + new_head = & recorded_loads.load_entries[recorded_loads.most_recent]; + memcpy(new_head, & current_load_entry, sizeof(current_load_entry)); + + /* Reset the current load entry */ + memset(& current_load_entry, 0x0, sizeof(current_load_entry)); + + /* Program next occurence of the action */ + delay.sec = 1; + delay.nanosec = 0; + sos_time_register_action_relative(a, & delay, calcload_routine, NULL); +} + + +sos_ret_t sos_load_do_timer_tick(sos_bool_t cur_is_user, + sos_ui32_t nb_user_ready, + sos_ui32_t nb_kernel_ready) +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + current_load_entry.nb_ticks ++; + current_load_entry.nb_user_ready += nb_user_ready; + current_load_entry.nb_kernel_ready += nb_kernel_ready; + if (cur_is_user) + current_load_entry.nb_user_running ++; + else + current_load_entry.nb_kernel_running ++; + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +void sos_load_to_string(char dest[11], sos_ui32_t load_value) +{ + sos_bool_t print0 = FALSE; + sos_ui32_t d; + +#define PUTCH(c) ({ *dest = (c); dest ++; }) + + for (d = 1000000000UL ; d > 0 ; d /= 10) + { + sos_ui32_t digit = (load_value / d) % 10; + + if (digit > 0) + { + PUTCH(digit + '0'); + print0 = TRUE; + } + else if (print0) + PUTCH('0'); + + if (d == SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR) + { + if (! print0) + PUTCH('0'); + + PUTCH('.'); + print0 = TRUE; + } + } + *dest = '\0'; +} + + +void sos_load_get_uload(sos_ui32_t * _load_1mn, + sos_ui32_t * _load_5mn, + sos_ui32_t * _load_15mn) +{ + sos_ui32_t flags; + + if (load_1mn.sigma_nb_ticks < 1) + return; + + sos_disable_IRQs(flags); + *_load_1mn = ( load_1mn.sigma_nb_user_ready + + load_1mn.sigma_nb_user_running) + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_1mn.sigma_nb_ticks; + *_load_5mn = ( load_5mn.sigma_nb_user_ready + + load_5mn.sigma_nb_user_running) + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_5mn.sigma_nb_ticks; + *_load_15mn = ( load_15mn.sigma_nb_user_ready + + load_15mn.sigma_nb_user_running) + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_15mn.sigma_nb_ticks; + sos_restore_IRQs(flags); +} + + +void sos_load_get_sload(sos_ui32_t * _load_1mn, + sos_ui32_t * _load_5mn, + sos_ui32_t * _load_15mn) +{ + sos_ui32_t flags; + + if (load_1mn.sigma_nb_ticks < 1) + return; + + /* The "IDLE" thread is always either ready or running by definition */ + SOS_ASSERT_FATAL(load_1mn.sigma_nb_kernel_ready + + load_1mn.sigma_nb_kernel_running + >= load_1mn.sigma_nb_ticks); + + /* Remove the IDLE thread from the load calculation */ + sos_disable_IRQs(flags); + *_load_1mn = ( load_1mn.sigma_nb_kernel_ready + + load_1mn.sigma_nb_kernel_running + - load_1mn.sigma_nb_ticks) + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_1mn.sigma_nb_ticks; + *_load_5mn = ( load_5mn.sigma_nb_kernel_ready + + load_5mn.sigma_nb_kernel_running + - load_5mn.sigma_nb_ticks) + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_5mn.sigma_nb_ticks; + *_load_15mn = ( load_15mn.sigma_nb_kernel_ready + + load_15mn.sigma_nb_kernel_running + - load_15mn.sigma_nb_ticks) + * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_15mn.sigma_nb_ticks; + sos_restore_IRQs(flags); +} + + +void sos_load_get_uratio(sos_ui32_t * _load_1mn, + sos_ui32_t * _load_5mn, + sos_ui32_t * _load_15mn) +{ + sos_ui32_t flags; + + if (load_1mn.sigma_nb_ticks < 1) + return; + + sos_disable_IRQs(flags); + *_load_1mn = load_1mn.sigma_nb_user_running + * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_1mn.sigma_nb_ticks; + *_load_5mn = load_5mn.sigma_nb_user_running + * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_5mn.sigma_nb_ticks; + *_load_15mn = load_15mn.sigma_nb_user_running + * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_15mn.sigma_nb_ticks; + sos_restore_IRQs(flags); +} + + +void sos_load_get_sratio(sos_ui32_t * _load_1mn, + sos_ui32_t * _load_5mn, + sos_ui32_t * _load_15mn) +{ + sos_ui32_t flags; + + if (load_1mn.sigma_nb_ticks < 1) + return; + + /* Don't remove the CPU occupation ration of the IDLE thread + here... */ + sos_disable_IRQs(flags); + *_load_1mn = load_1mn.sigma_nb_kernel_running + * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_1mn.sigma_nb_ticks; + *_load_5mn = load_5mn.sigma_nb_kernel_running + * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_5mn.sigma_nb_ticks; + *_load_15mn = load_15mn.sigma_nb_kernel_running + * 100 * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + / load_15mn.sigma_nb_ticks; + sos_restore_IRQs(flags); +} diff --git a/sos/calcload.h b/sos/calcload.h new file mode 100644 index 0000000..7d63f7d --- /dev/null +++ b/sos/calcload.h @@ -0,0 +1,117 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_CPULOAD_H_ +#define _SOS_CPULOAD_H_ + +#include +#include +#include + + +/** + * @file calcload.h + * + * Management of the CPU load in the system. For three intervals + * (1min, 5min, 15min), we maintain the user/kernel loads (ie number + * of threads in user/kernel mode ready or running) and the + * user/kernel CPU occupation ratio. + */ + + +/** + * Reinitialize the calcload subsystem. Must be called after the time + * subsystem has been initialized + */ +sos_ret_t sos_load_subsystem_setup(void); + + +/** + * Get the current USER load for each of the intervals. Definition: + * the USER load is the mean number of threads in USER mode which are + * ready or running over the period. + * + * @return the current USER load * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + */ +void sos_load_get_uload(sos_ui32_t * load_1mn, + sos_ui32_t * load_5mn, + sos_ui32_t * load_15mn); + + +/** + * Get the current KERNEL load for each of the intervals. Definition: + * the KERNEL load is the mean number of threads in KERNEL mode which are + * ready or running over the period. + * + * @note The load of the IDLE thread is removed from this computation ! + * + * @return the current KERNEL load * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + */ +void sos_load_get_sload(sos_ui32_t * load_1mn, + sos_ui32_t * load_5mn, + sos_ui32_t * load_15mn); + + +/** + * Get the current User CPU occupation ratio + * + * @return the current User/Kernel CPU occupation ratio + * * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + */ +void sos_load_get_uratio(sos_ui32_t * load_1mn, + sos_ui32_t * load_5mn, + sos_ui32_t * load_15mn); + + +/** + * Get the current Kernel CPU occupation ratio + * + * @note The load of the IDLE thread is NOT removed from this computation ! + * + * @return the current User/Kernel CPU occupation ratio + * * SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR + */ +void sos_load_get_sratio(sos_ui32_t * load_1mn, + sos_ui32_t * load_5mn, + sos_ui32_t * load_15mn); + + +/** + * Generate the "dest" string with the string corresponding to + * load_value / SOS_LOAD_DISPLAY_MULTIPLICATION_FACTOR with decimal + * digits + */ +void sos_load_to_string(char dest[11], sos_ui32_t load_value); + + +/* ****************************************************** + * Restricted function. Used only by sched.c/time.c + */ + + +/** + * Restricted callback called from the scheduler subsystem to update + * the load parameters. + * + * @note This is RESTRICTED function to be used by time.c + */ +sos_ret_t sos_load_do_timer_tick(sos_bool_t cur_is_user, + sos_ui32_t nb_user_ready, + sos_ui32_t nb_kernel_ready); + + +#endif /* _SOS_CPULOAD_H_ */ diff --git a/sos/errno.h b/sos/errno.h new file mode 100644 index 0000000..116d15f --- /dev/null +++ b/sos/errno.h @@ -0,0 +1,43 @@ +/* Copyright (C) 2004 The SOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_ERRNO_H_ +#define _SOS_ERRNO_H_ + +/** + * @file errno.h + * + * SOS return value codes and errors. + */ + +/* Positive values of the error codes */ +#define SOS_OK 0 /* No error */ +#define SOS_EINVAL 1 /* Invalid argument */ +#define SOS_ENOSUP 2 /* Operation not supported */ +#define SOS_ENOMEM 3 /* No available memory */ +#define SOS_EBUSY 4 /* Object or device still in use */ +#define SOS_EINTR 5 /* Wait/Sleep has been interrupted */ +#define SOS_EPERM 6 /* Mutex/files ownership error */ +#define SOS_EFAULT 7 /* Unresolved virtual memory fault */ +#define SOS_EFATAL 255 /* Internal fatal error */ + +/* A negative value means that an error occured. For + * example -SOS_EINVAL means that the error was "invalid + * argument" */ +typedef int sos_ret_t; + +#endif /* _SOS_ERRNO_H_ */ diff --git a/sos/klibc.c b/sos/klibc.c new file mode 100644 index 0000000..969a9b5 --- /dev/null +++ b/sos/klibc.c @@ -0,0 +1,398 @@ +/* Copyright (C) 2004 David Decotigny (with INSA Rennes for vsnprintf) + Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "klibc.h" + +/* For an optimized version, see BSD sources ;) */ +void *memcpy(void *dst0, const void *src0, register unsigned int size) +{ + char *dst; + const char *src; + for (dst = (char*)dst0, src = (const char*)src0 ; + size > 0 ; + dst++, src++, size--) + *dst = *src; + return dst0; +} + +/* ditto */ +void *memset(void *dst0, register int c, register unsigned int length) +{ + char *dst; + for (dst = (char*) dst0 ; + length > 0 ; + dst++, length --) + *dst = (char)c; + return dst0; +} + +int memcmp(const void *s1, const void *s2, sos_size_t len) +{ + const unsigned char *c1, *c2; + unsigned int i; + + for (i = 0, c1 = s1, c2 = s2; i < len; i++, c1++, c2++) + { + if(*c1 != *c2) + return *c1 - *c2; + } + + return 0; +} + + +unsigned int strlen(register const char *str) +{ + unsigned int retval = 0; + + while (*str++) + retval++; + + return retval; +} + + +unsigned int strnlen(const char * s, sos_size_t count) +{ + const char *sc; + + for (sc = s; count-- && *sc != '\0'; ++sc) + /* nothing */continue; + + return sc - s; +} + + +char *strzcpy(register char *dst, register const char *src, register int len) +{ + int i; + + if (len <= 0) + return dst; + + for (i = 0; i < len; i++) + { + dst[i] = src[i]; + if(src[i] == '\0') + return dst; + } + + dst[len-1] = '\0'; + return dst; +} + + +char *strzcat (char *dest, const char *src, sos_size_t n) +{ + char *res = dest; + + for ( ; *dest ; dest++); + + for ( ; *src ; src++, dest++) { + *dest = *src; + n--; + if (n <= 0) + break; + } + + *dest = '\0'; + return res; +} + +int strcmp(register const char *s1, register const char *s2) +{ + while (*s1 == *s2++) + if (*s1++ == 0) + return (0); + + return (*(const unsigned char *)s1 - *(const unsigned char *)(s2 - 1)); +} + + +int strncmp(register const char *s1, register const char *s2, register int len) +{ + char c1 = '\0', c2 = '\0'; + + while (len > 0) + { + c1 = (unsigned char) *s1++; + c2 = (unsigned char) *s2++; + if (c1 == '\0' || c1 != c2) + return c1 - c2; + len--; + } + + return c1 - c2; +} + + +static unsigned long int _random_seed = 93186752; + +/** + * The following code is borrowed from Glenn Rhoads. + * http://remus.rutgers.edu/~rhoads/Code/code.html + * License to be defined... + */ +unsigned long int random (void) +{ +/* The following parameters are recommended settings based on research + uncomment the one you want. */ + +/* For RAND_MAX == 4294967291 */ + static unsigned int a = 1588635695, q = 2, r = 1117695901; +/* static unsigned int a = 1223106847, m = 4294967291U, q = 3, r = 625646750;*/ +/* static unsigned int a = 279470273, m = 4294967291U, q = 15, r = 102913196;*/ + +/* For RAND_MAX == 2147483647 */ +/* static unsigned int a = 1583458089, m = 2147483647, q = 1, r = 564025558; */ +/* static unsigned int a = 784588716, m = 2147483647, q = 2, r = 578306215; */ +/* static unsigned int a = 16807, m = 2147483647, q = 127773, r = 2836; */ +/* static unsigned int a = 950706376, m = 2147483647, q = 2, r = 246070895; */ + + _random_seed = a*(_random_seed % q) - r*(_random_seed / q); + return _random_seed; +} + + +void srandom (unsigned long int seed) +{ + _random_seed = seed; +} + + +/* I (d2) borrowed and rewrote this for Nachos/INSA Rennes. Thanks to + them for having kindly allowed me to do so. */ +int vsnprintf(char *buff, sos_size_t len, const char * format, va_list ap) +{ + sos_size_t i, result; + sos_bool_t fmt_modifiers = FALSE; + sos_bool_t prefix_long = FALSE; + sos_bool_t prefix_long_long = FALSE; + + if (!buff || !format || (len < 0)) + return -1; + +#define PUTCHAR(thechar) \ + do { \ + if (result < len-1) \ + *buff++ = (thechar); \ + result++; \ + } while (0) + + result = 0; + for(i=0 ; format[i] != '\0' ; i++) + { + if (!fmt_modifiers && (format[i] != '%')) + { + PUTCHAR(format[i]); + continue; + } + + switch (format[i]) + { + case '%': + if (fmt_modifiers) + { + PUTCHAR('%'); + fmt_modifiers = FALSE; + break; + } + + fmt_modifiers = TRUE; + prefix_long = FALSE; + prefix_long_long = FALSE; + break; + + case 'l': + if (prefix_long) + prefix_long_long = TRUE; + else + prefix_long = TRUE; + break; + + case 'u': + { + if (! prefix_long_long) + { + unsigned int integer = va_arg(ap,unsigned int); + int cpt2 = 0; + char buff_int[16]; + + do { + int m10 = integer%10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + else + { + unsigned long long int integer + = va_arg(ap,unsigned long long int); + int cpt2 = 0; + char buff_int[32]; + + do { + int m10 = integer%10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + } + fmt_modifiers = FALSE; + break; + + case 'i': + case 'd': + { + if (! prefix_long_long) + { + int integer = va_arg(ap,int); + int cpt2 = 0; + char buff_int[16]; + + if (integer<0) + PUTCHAR('-'); + /* Ne fait pas integer = -integer ici parce que INT_MIN + n'a pas d'equivalent positif (int = [-2^31, 2^31-1]) */ + + do { + int m10 = integer%10; + m10 = (m10 < 0)? -m10:m10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + else + { + long long int integer = va_arg(ap,long long int); + int cpt2 = 0; + char buff_int[32]; + + if (integer<0) + PUTCHAR('-'); + /* Ne fait pas integer = -integer ici parce que INT_MIN + n'a pas d'equivalent positif (int = [-2^63, 2^63-1]) */ + + do { + int m10 = integer%10; + m10 = (m10 < 0)? -m10:m10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + } + fmt_modifiers = FALSE; + break; + + case 'c': + { + int value = va_arg(ap,int); + PUTCHAR((char)value); + fmt_modifiers = FALSE; + break; + } + + case 's': + { + char *string = va_arg(ap,char *); + if (! string) + string = "(null)"; + for( ; *string != '\0' ; string++) + PUTCHAR(*string); + fmt_modifiers = FALSE; + break; + } + + case 'p': + PUTCHAR('0'); + PUTCHAR('x'); + case 'x': + { + unsigned long long int hexa; + unsigned long long int nb; + int i, had_nonzero = 0; + + if (prefix_long_long) + hexa = va_arg(ap,unsigned long long int); + else + hexa = va_arg(ap,unsigned int); + + for(i=0 ; i < 16 ; i++) + { + nb = (unsigned long long int)(hexa << (i*4)); + nb = (nb >> 60) & 0xf; + // Skip the leading zeros + if (nb == 0) + { + if (had_nonzero) + PUTCHAR('0'); + } + else + { + had_nonzero = 1; + if (nb < 10) + PUTCHAR('0'+nb); + else + PUTCHAR('a'+(nb-10)); + } + } + if (! had_nonzero) + PUTCHAR('0'); + } + fmt_modifiers = FALSE; + break; + + default: + PUTCHAR('%'); + if (prefix_long) + PUTCHAR('l'); + if (prefix_long_long) + PUTCHAR('l'); + PUTCHAR(format[i]); + fmt_modifiers = FALSE; + } + } + + *buff = '\0'; + return result; +} + + +int snprintf(char * buff, sos_size_t len, const char *format, ...) +{ + va_list ap; + + va_start(ap, format); + len = vsnprintf(buff, len, format, ap); + va_end(ap); + + return len; +} diff --git a/sos/klibc.h b/sos/klibc.h new file mode 100644 index 0000000..7002778 --- /dev/null +++ b/sos/klibc.h @@ -0,0 +1,103 @@ +/* Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_KLIBC_H_ +#define _SOS_KLIBC_H_ + +/** + * @file klibc.h + * + * Basic libc-style support for common useful functions (string.h, + * stdarg.h), some with slight non-standard behavior (see comments). + * + * Most of the prototypes of these functions are borrowed from + * FreeBSD, but their implementation (in klibc.c) come either from Kos + * (GPL v2) or from David Decotigny (SOS). + */ + +#include + +/* string.h functions */ + +void *memcpy(void *dst, const void *src, register unsigned int size ) ; +void *memset(void *dst, register int c, register unsigned int length ) ; +int memcmp(const void *s1, const void *s2, sos_size_t n); + +unsigned int strlen( register const char *str) ; +unsigned int strnlen(const char * s, sos_size_t maxlen); + +/** + * @note Same as strncpy(), with a slightly different semantic. + * Actually, strncpy(3C) says " The result will not be null-terminated + * if the length of 'from' is n or more.". Here, 'dst' is ALWAYS + * null-terminated. And its total len will ALWAYS be <= len, with + * null-terminating-char included. + */ +char *strzcpy( register char *dst, register const char *src, + register int len ) ; + +/** + * @note Same as strncat(), with the same semantic : 'dst' is ALWAYS + * null-terminated. And its total len will ALWAYS be <= len, with + * null-terminating-char included. + */ +char *strzcat (char *dest, const char *src, + const sos_size_t len); + +int strcmp(register const char *s1, register const char *s2 ); +int strncmp(register const char *s1, register const char *s2, + register int len ); + +/* Basic stdarg.h macros. Taken from gcc support files */ +#define __GNUC_VA_LIST +typedef void *__gnuc_va_list; +typedef __gnuc_va_list va_list; +#define __va_rounded_size(TYPE) \ + (((sizeof (TYPE) + sizeof (int) - 1) / sizeof (int)) * sizeof (int)) +#define va_start(AP, LASTARG) \ + (AP = ((__gnuc_va_list) __builtin_next_arg (LASTARG))) +#define va_end(AP) \ + ((void)0) +#define va_arg(AP, TYPE) \ + (AP = (__gnuc_va_list) ((char *) (AP) + __va_rounded_size (TYPE)), \ + *((TYPE *) (void *) ((char *) (AP) - __va_rounded_size (TYPE)))) +#define __va_copy(dest, src) \ + (dest) = (src) + +/* stdarg.h functions. There might be a non-standard behavior: there + will always be a trailing '\0' in the resulting string */ +int vsnprintf(char *, sos_size_t, const char *, va_list); +int snprintf(char *, sos_size_t, const char *, /*args*/ ...) + __attribute__ ((format (printf, 3, 4))); + + +/* + * Pseudo-random generation functions. Useful to do some coverage + * tests. + */ + +/* Amplitude of the random number generation */ +#define RAND_MAX 4294967291U + +/* Pseudo-random number generation (MT unsafe) */ +unsigned long int random (void); + +/* Set random seed (MT unsafe) */ +void srandom (unsigned long int seed); + +#endif /* _SOS_KLIBC_H_ */ diff --git a/sos/kmalloc.c b/sos/kmalloc.c new file mode 100644 index 0000000..62d948d --- /dev/null +++ b/sos/kmalloc.c @@ -0,0 +1,113 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include + +#include "physmem.h" +#include "kmem_vmm.h" +#include "kmem_slab.h" + +#include "kmalloc.h" + +/* The cache structures for these caches, the object size, their + names, and some number of pages that contain them. They might not + necessarily be powers of 2s. */ +static struct { + const char *name; + sos_size_t object_size; + sos_count_t pages_per_slab; + struct sos_kslab_cache *cache; +} kmalloc_cache[] = + { + { "kmalloc 8B objects", 8, 1 }, + { "kmalloc 16B objects", 16, 1 }, + { "kmalloc 32B objects", 32, 1 }, + { "kmalloc 64B objects", 64, 1 }, + { "kmalloc 128B objects", 128, 1 }, + { "kmalloc 256B objects", 256, 2 }, + { "kmalloc 1024B objects", 1024, 2 }, + { "kmalloc 2048B objects", 2048, 3 }, + { "kmalloc 4096B objects", 4096, 4 }, + { "kmalloc 8192B objects", 8192, 8 }, + { "kmalloc 16384B objects", 16384, 12 }, + { NULL, 0, 0, NULL } + }; + + +sos_ret_t sos_kmalloc_subsystem_setup() +{ + int i; + for (i = 0 ; kmalloc_cache[i].object_size != 0 ; i ++) + { + struct sos_kslab_cache *new_cache; + new_cache = sos_kmem_cache_create(kmalloc_cache[i].name, + kmalloc_cache[i].object_size, + kmalloc_cache[i].pages_per_slab, + 0, + SOS_KSLAB_CREATE_MAP + ); + SOS_ASSERT_FATAL(new_cache != NULL); + kmalloc_cache[i].cache = new_cache; + } + return SOS_OK; +} + + +sos_vaddr_t sos_kmalloc(sos_size_t size, sos_ui32_t flags) +{ + /* Look for a suitable pre-allocated kmalloc cache */ + int i; + for (i = 0 ; kmalloc_cache[i].object_size != 0 ; i ++) + { + if (kmalloc_cache[i].object_size >= size) + return sos_kmem_cache_alloc(kmalloc_cache[i].cache, + (flags + & SOS_KMALLOC_ATOMIC)? + SOS_KSLAB_ALLOC_ATOMIC:0); + } + + /* none found yet => we directly use the kmem_vmm subsystem to + allocate whole pages */ + return sos_kmem_vmm_alloc(SOS_PAGE_ALIGN_SUP(size) / SOS_PAGE_SIZE, + ( (flags + & SOS_KMALLOC_ATOMIC)? + SOS_KMEM_VMM_ATOMIC:0) + | SOS_KMEM_VMM_MAP + ); +} + + +sos_ret_t sos_kfree(sos_vaddr_t vaddr) +{ + /* The trouble here is that we aren't sure whether this object is a + slab object in a pre-allocated kmalloc cache, or an object + directly allocated as a kmem_vmm region. */ + + /* We first pretend this object is allocated in a pre-allocated + kmalloc cache */ + if (! sos_kmem_cache_free(vaddr)) + return SOS_OK; /* Great ! We guessed right ! */ + + /* Here we're wrong: it appears not to be an object in a + pre-allocated kmalloc cache. So we try to pretend this is a + kmem_vmm area */ + return sos_kmem_vmm_free(vaddr); +} + + diff --git a/sos/kmalloc.h b/sos/kmalloc.h new file mode 100644 index 0000000..3f35b9d --- /dev/null +++ b/sos/kmalloc.h @@ -0,0 +1,63 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_KMALLOC_H_ +#define _SOS_KMALLOC_H_ + +/** + * @file kmalloc.h + * + * Simple malloc-style wrapper to kmem_vmm.h and kmem_slab.h for + * "anonymous" objects (ie not associated to any precise slab cache). + */ + +#include +#include + + +/** + * Iniatilize the kmalloc subsystem, ie pre-allocate a series of caches. + */ +sos_ret_t sos_kmalloc_subsystem_setup(void); + +/* + * sos_kmalloc flags + */ +/** sos_kmalloc() should succeed without blocking, or return NULL */ +#define SOS_KMALLOC_ATOMIC 1 + +/** + * Allocate a kernel object of the given size in the most suited slab + * cache if size can be handled by one of the pre-allocated caches, or + * using directly the range allocator otherwise. The object will + * allways be mapped in physical memory (ie implies + * SOS_KSLAB_CREATE_MAP and SOS_KMEM_VMM_MAP). + * + * @param size The size of the object + * @param flags The allocation flags (SOS_KMALLOC_* flags) + */ +sos_vaddr_t sos_kmalloc(sos_size_t size, sos_ui32_t flags); + +/** + * @note you are perfectly allowed to give the address of the + * kernel image, or the address of the bios area here, it will work: + * the kernel/bios WILL be "deallocated". But if you really want to do + * this, well..., do expect some "surprises" ;) + */ +sos_ret_t sos_kfree(sos_vaddr_t vaddr); + +#endif /* _SOS_KMALLOC_H_ */ diff --git a/sos/kmem_slab.c b/sos/kmem_slab.c new file mode 100644 index 0000000..49a1527 --- /dev/null +++ b/sos/kmem_slab.c @@ -0,0 +1,812 @@ +/* Copyright (C) 2000 Thomas Petazzoni + Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include +#include +#include +#include +#include +#include + +#include "kmem_slab.h" + +/* Dimensioning constants */ +#define NB_PAGES_IN_SLAB_OF_CACHES 1 +#define NB_PAGES_IN_SLAB_OF_RANGES 1 + +/** The structure of a slab cache */ +struct sos_kslab_cache +{ + char *name; + + /* non mutable characteristics of this slab */ + sos_size_t original_obj_size; /* asked object size */ + sos_size_t alloc_obj_size; /* actual object size, taking the + alignment constraints into account */ + sos_count_t nb_objects_per_slab; + sos_count_t nb_pages_per_slab; + sos_count_t min_free_objects; + +/* slab cache flags */ +// #define SOS_KSLAB_CREATE_MAP (1<<0) /* See kmem_slab.h */ +// #define SOS_KSLAB_CREATE_ZERO (1<<1) /* " " " " " " " " */ +#define ON_SLAB (1<<31) /* struct sos_kslab is included inside the slab */ + sos_ui32_t flags; + + /* Supervision data (updated at run-time) */ + sos_count_t nb_free_objects; + + /* The lists of slabs owned by this cache */ + struct sos_kslab *slab_list; /* head = non full, tail = full */ + + /* The caches are linked together on the kslab_cache_list */ + struct sos_kslab_cache *prev, *next; +}; + + +/** The structure of a slab */ +struct sos_kslab +{ + /** Number of free objects on this slab */ + sos_count_t nb_free; + + /** The list of these free objects */ + struct sos_kslab_free_object *free; + + /** The address of the associated range structure */ + struct sos_kmem_range *range; + + /** Virtual start address of this range */ + sos_vaddr_t first_object; + + /** Slab cache owning this slab */ + struct sos_kslab_cache *cache; + + /** Links to the other slabs managed by the same cache */ + struct sos_kslab *prev, *next; +}; + + +/** The structure of the free objects in the slab */ +struct sos_kslab_free_object +{ + struct sos_kslab_free_object *prev, *next; +}; + +/** The cache of slab caches */ +static struct sos_kslab_cache *cache_of_struct_kslab_cache; + +/** The cache of slab structures for non-ON_SLAB caches */ +static struct sos_kslab_cache *cache_of_struct_kslab; + +/** The list of slab caches */ +static struct sos_kslab_cache *kslab_cache_list; + +/* Helper function to initialize a cache structure */ +static sos_ret_t +cache_initialize(/*out*/struct sos_kslab_cache *the_cache, + const char* name, + sos_size_t obj_size, + sos_count_t pages_per_slab, + sos_count_t min_free_objs, + sos_ui32_t cache_flags) +{ + unsigned int space_left; + sos_size_t alloc_obj_size; + + if (obj_size <= 0) + return -SOS_EINVAL; + + /* Default allocation size is the requested one */ + alloc_obj_size = obj_size; + + /* Make sure the requested size is large enough to store a + free_object structure */ + if (alloc_obj_size < sizeof(struct sos_kslab_free_object)) + alloc_obj_size = sizeof(struct sos_kslab_free_object); + + /* Align obj_size on 4 bytes */ + alloc_obj_size = SOS_ALIGN_SUP(alloc_obj_size, sizeof(int)); + + /* Make sure supplied number of pages per slab is consistent with + actual allocated object size */ + if (alloc_obj_size > pages_per_slab*SOS_PAGE_SIZE) + return -SOS_EINVAL; + + /* Refuse too large slabs */ + if (pages_per_slab > MAX_PAGES_PER_SLAB) + return -SOS_ENOMEM; + + /* Fills in the cache structure */ + memset(the_cache, 0x0, sizeof(struct sos_kslab_cache)); + the_cache->name = (char*)name; + the_cache->flags = cache_flags; + the_cache->original_obj_size = obj_size; + the_cache->alloc_obj_size = alloc_obj_size; + the_cache->min_free_objects = min_free_objs; + the_cache->nb_pages_per_slab = pages_per_slab; + + /* Small size objets => the slab structure is allocated directly in + the slab */ + if(alloc_obj_size <= sizeof(struct sos_kslab)) + the_cache->flags |= ON_SLAB; + + /* + * Compute the space left once the maximum number of objects + * have been allocated in the slab + */ + space_left = the_cache->nb_pages_per_slab*SOS_PAGE_SIZE; + if(the_cache->flags & ON_SLAB) + space_left -= sizeof(struct sos_kslab); + the_cache->nb_objects_per_slab = space_left / alloc_obj_size; + space_left -= the_cache->nb_objects_per_slab*alloc_obj_size; + + /* Make sure a single slab is large enough to contain the minimum + number of objects requested */ + if (the_cache->nb_objects_per_slab < min_free_objs) + return -SOS_EINVAL; + + /* If there is now enough place for both the objects and the slab + structure, then make the slab structure ON_SLAB */ + if (space_left >= sizeof(struct sos_kslab)) + the_cache->flags |= ON_SLAB; + + return SOS_OK; +} + + +/** Helper function to add a new slab for the given cache. */ +static sos_ret_t +cache_add_slab(struct sos_kslab_cache *kslab_cache, + sos_vaddr_t vaddr_slab, + struct sos_kslab *slab) +{ + int i; + + /* Setup the slab structure */ + memset(slab, 0x0, sizeof(struct sos_kslab)); + slab->cache = kslab_cache; + + /* Establish the address of the first free object */ + slab->first_object = vaddr_slab; + + /* Account for this new slab in the cache */ + slab->nb_free = kslab_cache->nb_objects_per_slab; + kslab_cache->nb_free_objects += slab->nb_free; + + /* Build the list of free objects */ + for (i = 0 ; i < kslab_cache->nb_objects_per_slab ; i++) + { + sos_vaddr_t obj_vaddr; + + /* Set object's address */ + obj_vaddr = slab->first_object + i*kslab_cache->alloc_obj_size; + + /* Add it to the list of free objects */ + list_add_tail(slab->free, + (struct sos_kslab_free_object *)obj_vaddr); + } + + /* Add the slab to the cache's slab list: add the head of the list + since this slab is non full */ + list_add_head(kslab_cache->slab_list, slab); + + return SOS_OK; +} + + +/** Helper function to allocate a new slab for the given kslab_cache */ +static sos_ret_t +cache_grow(struct sos_kslab_cache *kslab_cache, + sos_ui32_t alloc_flags) +{ + sos_ui32_t range_alloc_flags; + + struct sos_kmem_range *new_range; + sos_vaddr_t new_range_start; + + struct sos_kslab *new_slab; + + /* + * Setup the flags for the range allocation + */ + range_alloc_flags = 0; + + /* Atomic ? */ + if (alloc_flags & SOS_KSLAB_ALLOC_ATOMIC) + range_alloc_flags |= SOS_KMEM_VMM_ATOMIC; + + /* Need physical mapping NOW ? */ + if (kslab_cache->flags & (SOS_KSLAB_CREATE_MAP + | SOS_KSLAB_CREATE_ZERO)) + range_alloc_flags |= SOS_KMEM_VMM_MAP; + + /* Allocate the range */ + new_range = sos_kmem_vmm_new_range(kslab_cache->nb_pages_per_slab, + range_alloc_flags, + & new_range_start); + if (! new_range) + return -SOS_ENOMEM; + + /* Allocate the slab structure */ + if (kslab_cache->flags & ON_SLAB) + { + /* Slab structure is ON the slab: simply set its address to the + end of the range */ + sos_vaddr_t slab_vaddr + = new_range_start + kslab_cache->nb_pages_per_slab*SOS_PAGE_SIZE + - sizeof(struct sos_kslab); + new_slab = (struct sos_kslab*)slab_vaddr; + } + else + { + /* Slab structure is OFF the slab: allocate it from the cache of + slab structures */ + sos_vaddr_t slab_vaddr + = sos_kmem_cache_alloc(cache_of_struct_kslab, + alloc_flags); + if (! slab_vaddr) + { + sos_kmem_vmm_del_range(new_range); + return -SOS_ENOMEM; + } + new_slab = (struct sos_kslab*)slab_vaddr; + } + + cache_add_slab(kslab_cache, new_range_start, new_slab); + new_slab->range = new_range; + + /* Set the backlink from range to this slab */ + sos_kmem_vmm_set_slab(new_range, new_slab); + + return SOS_OK; +} + + +/** + * Helper function to release a slab + * + * The corresponding range is always deleted, except when the @param + * must_del_range_now is not set. This happens only when the function + * gets called from sos_kmem_cache_release_struct_range(), to avoid + * large recursions. + */ +static sos_ret_t +cache_release_slab(struct sos_kslab *slab, + sos_bool_t must_del_range_now) +{ + struct sos_kslab_cache *kslab_cache = slab->cache; + struct sos_kmem_range *range = slab->range; + + SOS_ASSERT_FATAL(kslab_cache != NULL); + SOS_ASSERT_FATAL(range != NULL); + SOS_ASSERT_FATAL(slab->nb_free == slab->cache->nb_objects_per_slab); + + /* First, remove the slab from the slabs' list of the cache */ + list_delete(kslab_cache->slab_list, slab); + slab->cache->nb_free_objects -= slab->nb_free; + + /* Release the slab structure if it is OFF slab */ + if (! (slab->cache->flags & ON_SLAB)) + sos_kmem_cache_free((sos_vaddr_t)slab); + + /* Ok, the range is not bound to any slab anymore */ + sos_kmem_vmm_set_slab(range, NULL); + + /* Always delete the range now, unless we are told not to do so (see + sos_kmem_cache_release_struct_range() below) */ + if (must_del_range_now) + return sos_kmem_vmm_del_range(range); + + return SOS_OK; +} + + +/** + * Helper function to create the initial cache of caches, with a very + * first slab in it, so that new cache structures can be simply allocated. + * @return the cache structure for the cache of caches + */ +static struct sos_kslab_cache * +create_cache_of_caches(sos_vaddr_t vaddr_first_slab_of_caches, + int nb_pages) +{ + /* The preliminary cache structure we need in order to allocate the + first slab in the cache of caches (allocated on the stack !) */ + struct sos_kslab_cache fake_cache_of_caches; + + /* The real cache structure for the cache of caches */ + struct sos_kslab_cache *real_cache_of_caches; + + /* The kslab structure for this very first slab */ + struct sos_kslab *slab_of_caches; + + /* Init the cache structure for the cache of caches */ + if (cache_initialize(& fake_cache_of_caches, + "Caches", sizeof(struct sos_kslab_cache), + nb_pages, 0, SOS_KSLAB_CREATE_MAP | ON_SLAB)) + /* Something wrong with the parameters */ + return NULL; + + memset((void*)vaddr_first_slab_of_caches, 0x0, nb_pages*SOS_PAGE_SIZE); + + /* Add the pages for the 1st slab of caches */ + slab_of_caches = (struct sos_kslab*)(vaddr_first_slab_of_caches + + nb_pages*SOS_PAGE_SIZE + - sizeof(struct sos_kslab)); + + /* Add the abovementioned 1st slab to the cache of caches */ + cache_add_slab(& fake_cache_of_caches, + vaddr_first_slab_of_caches, + slab_of_caches); + + /* Now we allocate a cache structure, which will be the real cache + of caches, ie a cache structure allocated INSIDE the cache of + caches, not inside the stack */ + real_cache_of_caches + = (struct sos_kslab_cache*) sos_kmem_cache_alloc(& fake_cache_of_caches, + 0); + /* We initialize it */ + memcpy(real_cache_of_caches, & fake_cache_of_caches, + sizeof(struct sos_kslab_cache)); + /* We need to update the slab's 'cache' field */ + slab_of_caches->cache = real_cache_of_caches; + + /* Add the cache to the list of slab caches */ + list_add_tail(kslab_cache_list, real_cache_of_caches); + + return real_cache_of_caches; +} + + +/** + * Helper function to create the initial cache of ranges, with a very + * first slab in it, so that new kmem_range structures can be simply + * allocated. + * @return the cache of kmem_range + */ +static struct sos_kslab_cache * +create_cache_of_ranges(sos_vaddr_t vaddr_first_slab_of_ranges, + sos_size_t sizeof_struct_range, + int nb_pages) +{ + /* The cache structure for the cache of kmem_range */ + struct sos_kslab_cache *cache_of_ranges; + + /* The kslab structure for the very first slab of ranges */ + struct sos_kslab *slab_of_ranges; + + cache_of_ranges = (struct sos_kslab_cache*) + sos_kmem_cache_alloc(cache_of_struct_kslab_cache, + 0); + if (! cache_of_ranges) + return NULL; + + /* Init the cache structure for the cache of ranges with min objects + per slab = 2 !!! */ + if (cache_initialize(cache_of_ranges, + "struct kmem_range", + sizeof_struct_range, + nb_pages, 2, SOS_KSLAB_CREATE_MAP | ON_SLAB)) + /* Something wrong with the parameters */ + return NULL; + + /* Add the cache to the list of slab caches */ + list_add_tail(kslab_cache_list, cache_of_ranges); + + /* + * Add the first slab for this cache + */ + memset((void*)vaddr_first_slab_of_ranges, 0x0, nb_pages*SOS_PAGE_SIZE); + + /* Add the pages for the 1st slab of ranges */ + slab_of_ranges = (struct sos_kslab*)(vaddr_first_slab_of_ranges + + nb_pages*SOS_PAGE_SIZE + - sizeof(struct sos_kslab)); + + cache_add_slab(cache_of_ranges, + vaddr_first_slab_of_ranges, + slab_of_ranges); + + return cache_of_ranges; +} + + +struct sos_kslab_cache * +sos_kmem_cache_subsystem_setup_prepare(sos_vaddr_t kernel_core_base, + sos_vaddr_t kernel_core_top, + sos_size_t sizeof_struct_range, + /* results */ + struct sos_kslab **first_struct_slab_of_caches, + sos_vaddr_t *first_slab_of_caches_base, + sos_count_t *first_slab_of_caches_nb_pages, + struct sos_kslab **first_struct_slab_of_ranges, + sos_vaddr_t *first_slab_of_ranges_base, + sos_count_t *first_slab_of_ranges_nb_pages) +{ + int i; + sos_ret_t retval; + sos_vaddr_t vaddr; + + /* The cache of ranges we are about to allocate */ + struct sos_kslab_cache *cache_of_ranges; + + /* In the begining, there isn't any cache */ + kslab_cache_list = NULL; + cache_of_struct_kslab = NULL; + cache_of_struct_kslab_cache = NULL; + + /* + * Create the cache of caches, initialised with 1 allocated slab + */ + + /* Allocate the pages needed for the 1st slab of caches, and map them + in kernel space, right after the kernel */ + *first_slab_of_caches_base = SOS_PAGE_ALIGN_SUP(kernel_core_top); + for (i = 0, vaddr = *first_slab_of_caches_base ; + i < NB_PAGES_IN_SLAB_OF_CACHES ; + i++, vaddr += SOS_PAGE_SIZE) + { + sos_paddr_t ppage_paddr; + + ppage_paddr + = sos_physmem_ref_physpage_new(FALSE); + SOS_ASSERT_FATAL(ppage_paddr != (sos_paddr_t)NULL); + + retval = sos_paging_map(ppage_paddr, vaddr, + FALSE, + SOS_VM_MAP_ATOMIC + | SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE); + SOS_ASSERT_FATAL(retval == SOS_OK); + + retval = sos_physmem_unref_physpage(ppage_paddr); + SOS_ASSERT_FATAL(retval == FALSE); + } + + /* Create the cache of caches */ + *first_slab_of_caches_nb_pages = NB_PAGES_IN_SLAB_OF_CACHES; + cache_of_struct_kslab_cache + = create_cache_of_caches(*first_slab_of_caches_base, + NB_PAGES_IN_SLAB_OF_CACHES); + SOS_ASSERT_FATAL(cache_of_struct_kslab_cache != NULL); + + /* Retrieve the slab that should have been allocated */ + *first_struct_slab_of_caches + = list_get_head(cache_of_struct_kslab_cache->slab_list); + + + /* + * Create the cache of ranges, initialised with 1 allocated slab + */ + *first_slab_of_ranges_base = vaddr; + /* Allocate the 1st slab */ + for (i = 0, vaddr = *first_slab_of_ranges_base ; + i < NB_PAGES_IN_SLAB_OF_RANGES ; + i++, vaddr += SOS_PAGE_SIZE) + { + sos_paddr_t ppage_paddr; + + ppage_paddr + = sos_physmem_ref_physpage_new(FALSE); + SOS_ASSERT_FATAL(ppage_paddr != (sos_paddr_t)NULL); + + retval = sos_paging_map(ppage_paddr, vaddr, + FALSE, + SOS_VM_MAP_ATOMIC + | SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE); + SOS_ASSERT_FATAL(retval == SOS_OK); + + retval = sos_physmem_unref_physpage(ppage_paddr); + SOS_ASSERT_FATAL(retval == FALSE); + } + + /* Create the cache of ranges */ + *first_slab_of_ranges_nb_pages = NB_PAGES_IN_SLAB_OF_RANGES; + cache_of_ranges = create_cache_of_ranges(*first_slab_of_ranges_base, + sizeof_struct_range, + NB_PAGES_IN_SLAB_OF_RANGES); + SOS_ASSERT_FATAL(cache_of_ranges != NULL); + + /* Retrieve the slab that should have been allocated */ + *first_struct_slab_of_ranges + = list_get_head(cache_of_ranges->slab_list); + + /* + * Create the cache of slabs, without any allocated slab yet + */ + cache_of_struct_kslab + = sos_kmem_cache_create("off-slab slab structures", + sizeof(struct sos_kslab), + 1, + 0, + SOS_KSLAB_CREATE_MAP); + SOS_ASSERT_FATAL(cache_of_struct_kslab != NULL); + + return cache_of_ranges; +} + + +sos_ret_t +sos_kmem_cache_subsystem_setup_commit(struct sos_kslab *first_struct_slab_of_caches, + struct sos_kmem_range *first_range_of_caches, + struct sos_kslab *first_struct_slab_of_ranges, + struct sos_kmem_range *first_range_of_ranges) +{ + first_struct_slab_of_caches->range = first_range_of_caches; + first_struct_slab_of_ranges->range = first_range_of_ranges; + return SOS_OK; +} + + +struct sos_kslab_cache * +sos_kmem_cache_create(const char* name, + sos_size_t obj_size, + sos_count_t pages_per_slab, + sos_count_t min_free_objs, + sos_ui32_t cache_flags) +{ + struct sos_kslab_cache *new_cache; + + /* Allocate the new cache */ + new_cache = (struct sos_kslab_cache*) + sos_kmem_cache_alloc(cache_of_struct_kslab_cache, + 0/* NOT ATOMIC */); + if (! new_cache) + return NULL; + + if (cache_initialize(new_cache, name, obj_size, + pages_per_slab, min_free_objs, + cache_flags)) + { + /* Something was wrong */ + sos_kmem_cache_free((sos_vaddr_t)new_cache); + return NULL; + } + + /* Add the cache to the list of slab caches */ + list_add_tail(kslab_cache_list, new_cache); + + /* if the min_free_objs is set, pre-allocate a slab */ + if (min_free_objs) + { + if (cache_grow(new_cache, 0 /* Not atomic */) != SOS_OK) + { + sos_kmem_cache_destroy(new_cache); + return NULL; /* Not enough memory */ + } + } + + return new_cache; +} + + +sos_ret_t sos_kmem_cache_destroy(struct sos_kslab_cache *kslab_cache) +{ + int nb_slabs; + struct sos_kslab *slab; + + if (! kslab_cache) + return -SOS_EINVAL; + + /* Refuse to destroy the cache if there are any objects still + allocated */ + list_foreach(kslab_cache->slab_list, slab, nb_slabs) + { + if (slab->nb_free != kslab_cache->nb_objects_per_slab) + return -SOS_EBUSY; + } + + /* Remove all the slabs */ + while ((slab = list_get_head(kslab_cache->slab_list)) != NULL) + { + cache_release_slab(slab, TRUE); + } + + /* Remove the cache */ + return sos_kmem_cache_free((sos_vaddr_t)kslab_cache); +} + + +sos_vaddr_t sos_kmem_cache_alloc(struct sos_kslab_cache *kslab_cache, + sos_ui32_t alloc_flags) +{ + sos_vaddr_t obj_vaddr; + struct sos_kslab * slab_head; +#define ALLOC_RET return + + /* If the slab at the head of the slabs' list has no free object, + then the other slabs don't either => need to allocate a new + slab */ + if ((! kslab_cache->slab_list) + || (! list_get_head(kslab_cache->slab_list)->free)) + { + if (cache_grow(kslab_cache, alloc_flags) != SOS_OK) + /* Not enough memory or blocking alloc */ + ALLOC_RET( (sos_vaddr_t)NULL); + } + + /* Here: we are sure that list_get_head(kslab_cache->slab_list) + exists *AND* that list_get_head(kslab_cache->slab_list)->free is + NOT NULL */ + slab_head = list_get_head(kslab_cache->slab_list); + SOS_ASSERT_FATAL(slab_head != NULL); + + /* Allocate the object at the head of the slab at the head of the + slabs' list */ + obj_vaddr = (sos_vaddr_t)list_pop_head(slab_head->free); + slab_head->nb_free --; + kslab_cache->nb_free_objects --; + + /* If needed, reset object's contents */ + if (kslab_cache->flags & SOS_KSLAB_CREATE_ZERO) + memset((void*)obj_vaddr, 0x0, kslab_cache->alloc_obj_size); + + /* Slab is now full ? */ + if (slab_head->free == NULL) + { + /* Transfer it at the tail of the slabs' list */ + struct sos_kslab *slab; + slab = list_pop_head(kslab_cache->slab_list); + list_add_tail(kslab_cache->slab_list, slab); + } + + /* + * For caches that require a minimum amount of free objects left, + * allocate a slab if needed. + * + * Notice the "== min_objects - 1": we did not write " < + * min_objects" because for the cache of kmem structure, this would + * lead to an chicken-and-egg problem, since cache_grow below would + * call cache_alloc again for the kmem_vmm cache, so we return here + * with the same cache. If the test were " < min_objects", then we + * would call cache_grow again for the kmem_vmm cache again and + * again... until we reach the bottom of our stack (infinite + * recursion). By telling precisely "==", then the cache_grow would + * only be called the first time. + */ + if ((kslab_cache->min_free_objects > 0) + && (kslab_cache->nb_free_objects == (kslab_cache->min_free_objects - 1))) + { + /* No: allocate a new slab now */ + if (cache_grow(kslab_cache, alloc_flags) != SOS_OK) + { + /* Not enough free memory or blocking alloc => undo the + allocation */ + sos_kmem_cache_free(obj_vaddr); + ALLOC_RET( (sos_vaddr_t)NULL); + } + } + + ALLOC_RET(obj_vaddr); +} + + +/** + * Helper function to free the object located at the given address. + * + * @param empty_slab is the address of the slab to release, if removing + * the object causes the slab to become empty. + */ +inline static +sos_ret_t +free_object(sos_vaddr_t vaddr, + struct sos_kslab ** empty_slab) +{ + struct sos_kslab_cache *kslab_cache; + + /* Lookup the slab containing the object in the slabs' list */ + struct sos_kslab *slab = sos_kmem_vmm_resolve_slab(vaddr); + + /* By default, consider that the slab will not become empty */ + *empty_slab = NULL; + + /* Did not find the slab */ + if (! slab) + return -SOS_EINVAL; + + SOS_ASSERT_FATAL(slab->cache); + kslab_cache = slab->cache; + + /* + * Check whether the address really could mark the start of an actual + * allocated object + */ + /* Address multiple of an object's size ? */ + if (( (vaddr - slab->first_object) + % kslab_cache->alloc_obj_size) != 0) + return -SOS_EINVAL; + /* Address not too large ? */ + if (( (vaddr - slab->first_object) + / kslab_cache->alloc_obj_size) >= kslab_cache->nb_objects_per_slab) + return -SOS_EINVAL; + + /* + * Ok: we now release the object + */ + + /* Did find a full slab => will not be full any more => move it + to the head of the slabs' list */ + if (! slab->free) + { + list_delete(kslab_cache->slab_list, slab); + list_add_head(kslab_cache->slab_list, slab); + } + + /* Release the object */ + list_add_head(slab->free, (struct sos_kslab_free_object*)vaddr); + slab->nb_free++; + kslab_cache->nb_free_objects++; + SOS_ASSERT_FATAL(slab->nb_free <= slab->cache->nb_objects_per_slab); + + /* Cause the slab to be released if it becomes empty, and if we are + allowed to do it */ + if ((slab->nb_free >= kslab_cache->nb_objects_per_slab) + && (kslab_cache->nb_free_objects - slab->nb_free + >= kslab_cache->min_free_objects)) + { + *empty_slab = slab; + } + + return SOS_OK; +} + + +sos_ret_t sos_kmem_cache_free(sos_vaddr_t vaddr) +{ + sos_ret_t retval; + struct sos_kslab *empty_slab; + + /* Remove the object from the slab */ + retval = free_object(vaddr, & empty_slab); + if (retval != SOS_OK) + return retval; + + /* Remove the slab and the underlying range if needed */ + if (empty_slab != NULL) + return cache_release_slab(empty_slab, TRUE); + + return SOS_OK; +} + + +struct sos_kmem_range * +sos_kmem_cache_release_struct_range(struct sos_kmem_range *the_range) +{ + sos_ret_t retval; + struct sos_kslab *empty_slab; + + /* Remove the object from the slab */ + retval = free_object((sos_vaddr_t)the_range, & empty_slab); + if (retval != SOS_OK) + return NULL; + + /* Remove the slab BUT NOT the underlying range if needed */ + if (empty_slab != NULL) + { + struct sos_kmem_range *empty_range = empty_slab->range; + SOS_ASSERT_FATAL(cache_release_slab(empty_slab, FALSE) == SOS_OK); + SOS_ASSERT_FATAL(empty_range != NULL); + return empty_range; + } + + return NULL; +} + diff --git a/sos/kmem_slab.h b/sos/kmem_slab.h new file mode 100644 index 0000000..50a0d03 --- /dev/null +++ b/sos/kmem_slab.h @@ -0,0 +1,206 @@ +/* Copyright (C) 2000 Thomas Petazzoni + Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_KMEM_SLAB_H_ +#define _SOS_KMEM_SLAB_H_ + +/** + * @file kmem_slab.h + * + * Kernel Memory Allocator based on Bonwick's slab llocator (Solaris + * 2.4, Linux 2.4). This allocator achieves good memory utilization + * ratio (memory effectively used / memory requested) ie limited + * fragmentation, while elegantly handling cache-effect considerations + * (TLB locality through the notion of "cache" of slabs, and the + * dcache utilization through the notion of cache colouring to + * decrease the conflicts in the dcache for accesses to different data + * in the same cache). + * + * This allocator relies on the range allocator (kmem_vmm.h) to + * allocate the slabs, which itself relies on the slab allocator to + * allocate its "range" data structures, thus leading to a + * chicken-and-egg problem. We solve this problem by introducing the + * notion of "min_free_objs" for the slab caches, in order for the cache + * of ranges to always have enough ranges in reserve to complete the + * range allocation before being urged to allocate a new slab of + * ranges, which would require the allocation of a new range. + * + * Compared to Bonwick's recommendations, we don't handle ctor/dtor + * routines on the objects, so that we can alter the objects once they + * are set free. Thus, the list of free object is stored in the free + * objects themselves, not alongside the objects (this also implies that + * the SOS_KSLAB_CREATE_MAP flag below is meaningless). We also don't + * implement the cache colouring (trivial to add, but we omit it for + * readability reasons), and the only alignment constraint we respect + * is that allocated objects are aligned on a 4B boundary: for other + * alignment constraints, the user must integrate them in the + * "object_size" parameter to "sos_kmem_cache_create()". + * + * References : + * - J. Bonwick's paper, "The slab allocator: An object-caching kernel + * memory allocator", In USENIX Summer 1994 Technical Conference + * - The bible, aka "Unix internals : the new frontiers" (section + * 12.10), Uresh Vahalia, Prentice Hall 1996, ISBN 0131019082 + * - "The Linux slab allocator", B. Fitzgibbons, + * http://www.cc.gatech.edu/people/home/bradf/cs7001/proj2/ + * - The Kos, http://kos.enix.org/ + */ +#include +#include + +/** Opaque data structure that defines a Cache of slabs */ +struct sos_kslab_cache; + +/** Opaque data structure that defines a slab. Exported only to + kmem_vmm.h */ +struct sos_kslab; + +#include "kmem_vmm.h" + + +/** The maximum allowed pages for each slab */ +#define MAX_PAGES_PER_SLAB 32 /* 128 kB */ + + +/** + * Initialize the slab cache of slab caches, and prepare the cache of + * kmem_range for kmem_vmm. + * + * @param kernel_core_base The virtual address of the first byte used + * by the kernel code/data + * + * @param kernel_core_top The virtual address of the first byte after + * the kernel code/data. + * + * @param sizeof_struct_range the size of the objects (aka "struct + * sos_kmem_vmm_ranges") to be allocated in the cache of ranges + * + * @param first_struct_slab_of_caches (output value) the virtual + * address of the first slab structure that gets allocated for the + * cache of caches. The function actually manually allocate the first + * slab of the cache of caches because of a chicken-and-egg thing. The + * address of the slab is used by the kmem_vmm_setup routine to + * finalize the allocation of the slab, in order for it to behave like + * a real slab afterwards. + * + * @param first_slab_of_caches_base (output value) the virtual address + * of the slab associated to the slab structure. + * + * @param first_slab_of_caches_nb_pages (output value) the number of + * (virtual) pages used by the first slab of the cache of caches. + * + * @param first_struct_slab_of_ranges (output value) the virtual address + * of the first slab that gets allocated for the cache of ranges. Same + * explanation as above. + * + * @param first_slab_of_ranges_base (output value) the virtual address + * of the slab associated to the slab structure. + * + * @param first_slab_of_ranges_nb_pages (output value) the number of + * (virtual) pages used by the first slab of the cache of ranges. + * + * @return the cache of kmem_range immediatly usable + */ +struct sos_kslab_cache * +sos_kmem_cache_subsystem_setup_prepare(sos_vaddr_t kernel_core_base, + sos_vaddr_t kernel_core_top, + sos_size_t sizeof_struct_range, + /* results */ + struct sos_kslab **first_struct_slab_of_caches, + sos_vaddr_t *first_slab_of_caches_base, + sos_count_t *first_slab_of_caches_nb_pages, + struct sos_kslab **first_struct_slab_of_ranges, + sos_vaddr_t *first_slab_of_ranges_base, + sos_count_t *first_slab_of_ranges_nb_pages); + +/** + * Update the configuration of the cache subsystem once the vmm + * subsystem has been fully initialized + */ +sos_ret_t +sos_kmem_cache_subsystem_setup_commit(struct sos_kslab *first_struct_slab_of_caches, + struct sos_kmem_range *first_range_of_caches, + struct sos_kslab *first_struct_slab_of_ranges, + struct sos_kmem_range *first_range_of_ranges); + + +/* + * Flags for sos_kmem_cache_create() + */ +/** The slabs should be initially mapped in physical memory */ +#define SOS_KSLAB_CREATE_MAP (1<<0) +/** The object should always be set to zero at allocation (implies + SOS_KSLAB_CREATE_MAP) */ +#define SOS_KSLAB_CREATE_ZERO (1<<1) + +/** + * @note this function MAY block (involved allocations are not atomic) + * @param name must remain valid during the whole cache's life + * (shallow copy) ! + * @param cache_flags An or-ed combination of the SOS_KSLAB_CREATE_* flags + */ +struct sos_kslab_cache * +sos_kmem_cache_create(const char* name, + sos_size_t object_size, + sos_count_t pages_per_slab, + sos_count_t min_free_objects, + sos_ui32_t cache_flags); + +sos_ret_t sos_kmem_cache_destroy(struct sos_kslab_cache *kslab_cache); + + +/* + * Flags for sos_kmem_cache_alloc() + */ +/** Allocation should either succeed or fail, without blocking */ +#define SOS_KSLAB_ALLOC_ATOMIC (1<<0) + +/** + * Allocate an object from the given cache. + * + * @param alloc_flags An or-ed combination of the SOS_KSLAB_ALLOC_* flags + */ +sos_vaddr_t sos_kmem_cache_alloc(struct sos_kslab_cache *kslab_cache, + sos_ui32_t alloc_flags); + + +/** + * Free an object (assumed to be already allocated and not already + * free) at the given virtual address. + */ +sos_ret_t sos_kmem_cache_free(sos_vaddr_t vaddr); + + +/* + * Function reserved to kmem_vmm.c. Does almost everything + * sos_kmem_cache_free() does, except it does not call + * sos_kmem_vmm_del_range() if it needs to. This is aimed at avoiding + * large recursion when a range is freed with + * sos_kmem_vmm_del_range(). + * + * @param the_range The range structure to free + * + * @return NULL when the range containing 'the_range' still contains + * other ranges, or the address of the range which owned 'the_range' + * if it becomes empty. + */ +struct sos_kmem_range * +sos_kmem_cache_release_struct_range(struct sos_kmem_range *the_range); + + +#endif /* _SOS_KMEM_SLAB_H_ */ diff --git a/sos/kmem_vmm.c b/sos/kmem_vmm.c new file mode 100644 index 0000000..ea2fdf1 --- /dev/null +++ b/sos/kmem_vmm.c @@ -0,0 +1,606 @@ +/* Copyright (C) 2000 Thomas Petazzoni + Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include + +#include "kmem_vmm.h" + +/** The structure of a range of kernel-space virtual addresses */ +struct sos_kmem_range +{ + sos_vaddr_t base_vaddr; + sos_count_t nb_pages; + + /* The slab owning this range, or NULL */ + struct sos_kslab *slab; + + struct sos_kmem_range *prev, *next; +}; +const int sizeof_struct_sos_kmem_range = sizeof(struct sos_kmem_range); + +/** The ranges are SORTED in (strictly) ascending base addresses */ +static struct sos_kmem_range *kmem_free_range_list, *kmem_used_range_list; + +/** The slab cache for the kmem ranges */ +static struct sos_kslab_cache *kmem_range_cache; + + + +/** Helper function to get the closest preceding or containing + range for the given virtual address */ +static struct sos_kmem_range * +get_closest_preceding_kmem_range(struct sos_kmem_range *the_list, + sos_vaddr_t vaddr) +{ + int nb_elements; + struct sos_kmem_range *a_range, *ret_range; + + /* kmem_range list is kept SORTED, so we exit as soon as vaddr >= a + range base address */ + ret_range = NULL; + list_foreach(the_list, a_range, nb_elements) + { + if (vaddr < a_range->base_vaddr) + return ret_range; + ret_range = a_range; + } + + /* This will always be the LAST range in the kmem area */ + return ret_range; +} + + +/** + * Helper function to lookup a free range large enough to hold nb_pages + * pages (first fit) + */ +static struct sos_kmem_range *find_suitable_free_range(sos_count_t nb_pages) +{ + int nb_elements; + struct sos_kmem_range *r; + + list_foreach(kmem_free_range_list, r, nb_elements) + { + if (r->nb_pages >= nb_pages) + return r; + } + + return NULL; +} + + +/** + * Helper function to add a_range in the_list, in strictly ascending order. + * + * @return The (possibly) new head of the_list + */ +static struct sos_kmem_range *insert_range(struct sos_kmem_range *the_list, + struct sos_kmem_range *a_range) +{ + struct sos_kmem_range *prec_used; + + /** Look for any preceding range */ + prec_used = get_closest_preceding_kmem_range(the_list, + a_range->base_vaddr); + /** insert a_range /after/ this prec_used */ + if (prec_used != NULL) + list_insert_after(the_list, prec_used, a_range); + else /* Insert at the beginning of the list */ + list_add_head(the_list, a_range); + + return the_list; +} + + +/** + * Helper function to retrieve the range owning the given vaddr, by + * scanning the physical memory first if vaddr is mapped in RAM + */ +static struct sos_kmem_range *lookup_range(sos_vaddr_t vaddr) +{ + struct sos_kmem_range *range; + + /* First: try to retrieve the physical page mapped at this address */ + sos_paddr_t ppage_paddr = SOS_PAGE_ALIGN_INF(sos_paging_get_paddr(vaddr)); + + if (ppage_paddr) + { + range = sos_physmem_get_kmem_range(ppage_paddr); + + /* If a page is mapped at this address, it is EXPECTED that it + is really associated with a range */ + SOS_ASSERT_FATAL(range != NULL); + } + + /* Otherwise scan the list of used ranges, looking for the range + owning the address */ + else + { + range = get_closest_preceding_kmem_range(kmem_used_range_list, + vaddr); + /* Not found */ + if (! range) + return NULL; + + /* vaddr not covered by this range */ + if ( (vaddr < range->base_vaddr) + || (vaddr >= (range->base_vaddr + range->nb_pages*SOS_PAGE_SIZE)) ) + return NULL; + } + + return range; +} + + +/** + * Helper function for sos_kmem_vmm_setup() to initialize a new range + * that maps a given area as free or as already used. + * This function either succeeds or halts the whole system. + */ +static struct sos_kmem_range * +create_range(sos_bool_t is_free, + sos_vaddr_t base_vaddr, + sos_vaddr_t top_vaddr, + struct sos_kslab *associated_slab) +{ + struct sos_kmem_range *range; + + SOS_ASSERT_FATAL(SOS_IS_PAGE_ALIGNED(base_vaddr)); + SOS_ASSERT_FATAL(SOS_IS_PAGE_ALIGNED(top_vaddr)); + + if ((top_vaddr - base_vaddr) < SOS_PAGE_SIZE) + return NULL; + + range = (struct sos_kmem_range*)sos_kmem_cache_alloc(kmem_range_cache, + SOS_KSLAB_ALLOC_ATOMIC); + SOS_ASSERT_FATAL(range != NULL); + + range->base_vaddr = base_vaddr; + range->nb_pages = (top_vaddr - base_vaddr) / SOS_PAGE_SIZE; + + if (is_free) + { + list_add_tail(kmem_free_range_list, + range); + } + else + { + sos_vaddr_t vaddr; + range->slab = associated_slab; + list_add_tail(kmem_used_range_list, + range); + + /* Ok, set the range owner for the pages in this page */ + for (vaddr = base_vaddr ; + vaddr < top_vaddr ; + vaddr += SOS_PAGE_SIZE) + { + sos_paddr_t ppage_paddr = sos_paging_get_paddr(vaddr); + SOS_ASSERT_FATAL((void*)ppage_paddr != NULL); + sos_physmem_set_kmem_range(ppage_paddr, range); + } + } + + return range; +} + + +sos_ret_t +sos_kmem_vmm_subsystem_setup(sos_vaddr_t kernel_core_base, + sos_vaddr_t kernel_core_top, + sos_vaddr_t bootstrap_stack_bottom_vaddr, + sos_vaddr_t bootstrap_stack_top_vaddr) +{ + struct sos_kslab *first_struct_slab_of_caches, + *first_struct_slab_of_ranges; + sos_vaddr_t first_slab_of_caches_base, + first_slab_of_caches_nb_pages, + first_slab_of_ranges_base, + first_slab_of_ranges_nb_pages; + struct sos_kmem_range *first_range_of_caches, + *first_range_of_ranges; + + list_init(kmem_free_range_list); + list_init(kmem_used_range_list); + + kmem_range_cache + = sos_kmem_cache_subsystem_setup_prepare(kernel_core_base, + kernel_core_top, + sizeof(struct sos_kmem_range), + & first_struct_slab_of_caches, + & first_slab_of_caches_base, + & first_slab_of_caches_nb_pages, + & first_struct_slab_of_ranges, + & first_slab_of_ranges_base, + & first_slab_of_ranges_nb_pages); + SOS_ASSERT_FATAL(kmem_range_cache != NULL); + + /* Mark virtual addresses 16kB - Video as FREE */ + create_range(TRUE, + SOS_KMEM_VMM_BASE, + SOS_PAGE_ALIGN_INF(BIOS_N_VIDEO_START), + NULL); + + /* Mark virtual addresses in Video hardware mapping as NOT FREE */ + create_range(FALSE, + SOS_PAGE_ALIGN_INF(BIOS_N_VIDEO_START), + SOS_PAGE_ALIGN_SUP(BIOS_N_VIDEO_END), + NULL); + + /* Mark virtual addresses Video - Kernel as FREE */ + create_range(TRUE, + SOS_PAGE_ALIGN_SUP(BIOS_N_VIDEO_END), + SOS_PAGE_ALIGN_INF(kernel_core_base), + NULL); + + /* Mark virtual addresses in Kernel code/data up to the bootstrap stack + as NOT FREE */ + create_range(FALSE, + SOS_PAGE_ALIGN_INF(kernel_core_base), + bootstrap_stack_bottom_vaddr, + NULL); + + /* Mark virtual addresses in the bootstrap stack as NOT FREE too, + but in another vmm region in order to be un-allocated later */ + create_range(FALSE, + bootstrap_stack_bottom_vaddr, + bootstrap_stack_top_vaddr, + NULL); + + /* Mark the remaining virtual addresses in Kernel code/data after + the bootstrap stack as NOT FREE */ + create_range(FALSE, + bootstrap_stack_top_vaddr, + SOS_PAGE_ALIGN_SUP(kernel_core_top), + NULL); + + /* Mark virtual addresses in the first slab of the cache of caches + as NOT FREE */ + SOS_ASSERT_FATAL(SOS_PAGE_ALIGN_SUP(kernel_core_top) + == first_slab_of_caches_base); + SOS_ASSERT_FATAL(first_struct_slab_of_caches != NULL); + first_range_of_caches + = create_range(FALSE, + first_slab_of_caches_base, + first_slab_of_caches_base + + first_slab_of_caches_nb_pages*SOS_PAGE_SIZE, + first_struct_slab_of_caches); + + /* Mark virtual addresses in the first slab of the cache of ranges + as NOT FREE */ + SOS_ASSERT_FATAL((first_slab_of_caches_base + + first_slab_of_caches_nb_pages*SOS_PAGE_SIZE) + == first_slab_of_ranges_base); + SOS_ASSERT_FATAL(first_struct_slab_of_ranges != NULL); + first_range_of_ranges + = create_range(FALSE, + first_slab_of_ranges_base, + first_slab_of_ranges_base + + first_slab_of_ranges_nb_pages*SOS_PAGE_SIZE, + first_struct_slab_of_ranges); + + /* Mark virtual addresses after these slabs as FREE */ + create_range(TRUE, + first_slab_of_ranges_base + + first_slab_of_ranges_nb_pages*SOS_PAGE_SIZE, + SOS_KMEM_VMM_TOP, + NULL); + + /* Update the cache subsystem so that the artificially-created + caches of caches and ranges really behave like *normal* caches (ie + those allocated by the normal slab API) */ + sos_kmem_cache_subsystem_setup_commit(first_struct_slab_of_caches, + first_range_of_caches, + first_struct_slab_of_ranges, + first_range_of_ranges); + + return SOS_OK; +} + + +/** + * Allocate a new kernel area spanning one or multiple pages. + * + * @eturn a new range structure + */ +struct sos_kmem_range *sos_kmem_vmm_new_range(sos_count_t nb_pages, + sos_ui32_t flags, + sos_vaddr_t * range_start) +{ + struct sos_kmem_range *free_range, *new_range; + + if (nb_pages <= 0) + return NULL; + + /* Find a suitable free range to hold the size-sized object */ + free_range = find_suitable_free_range(nb_pages); + if (free_range == NULL) + return NULL; + + /* If range has exactly the requested size, just move it to the + "used" list */ + if(free_range->nb_pages == nb_pages) + { + list_delete(kmem_free_range_list, free_range); + kmem_used_range_list = insert_range(kmem_used_range_list, + free_range); + /* The new_range is exactly the free_range */ + new_range = free_range; + } + + /* Otherwise the range is bigger than the requested size, split it. + This involves reducing its size, and allocate a new range, which + is going to be added to the "used" list */ + else + { + /* free_range split in { new_range | free_range } */ + new_range = (struct sos_kmem_range*) + sos_kmem_cache_alloc(kmem_range_cache, + (flags & SOS_KMEM_VMM_ATOMIC)? + SOS_KSLAB_ALLOC_ATOMIC:0); + if (! new_range) + return NULL; + + new_range->base_vaddr = free_range->base_vaddr; + new_range->nb_pages = nb_pages; + free_range->base_vaddr += nb_pages*SOS_PAGE_SIZE; + free_range->nb_pages -= nb_pages; + + /* free_range is still at the same place in the list */ + /* insert new_range in the used list */ + kmem_used_range_list = insert_range(kmem_used_range_list, + new_range); + } + + /* By default, the range is not associated with any slab */ + new_range->slab = NULL; + + /* If mapping of physical pages is needed, map them now */ + if (flags & SOS_KMEM_VMM_MAP) + { + int i; + for (i = 0 ; i < nb_pages ; i ++) + { + /* Get a new physical page */ + sos_paddr_t ppage_paddr + = sos_physmem_ref_physpage_new(! (flags & SOS_KMEM_VMM_ATOMIC)); + + /* Map the page in kernel space */ + if (ppage_paddr) + { + if (sos_paging_map(ppage_paddr, + new_range->base_vaddr + + i * SOS_PAGE_SIZE, + FALSE /* Not a user page */, + ((flags & SOS_KMEM_VMM_ATOMIC)? + SOS_VM_MAP_ATOMIC:0) + | SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE)) + { + /* Failed => force unallocation, see below */ + sos_physmem_unref_physpage(ppage_paddr); + ppage_paddr = (sos_paddr_t)NULL; + } + else + { + /* Success : page can be unreferenced since it is + now mapped */ + sos_physmem_unref_physpage(ppage_paddr); + } + } + + /* Undo the allocation if failed to allocate or map a new page */ + if (! ppage_paddr) + { + sos_kmem_vmm_del_range(new_range); + return NULL; + } + + /* Ok, set the range owner for this page */ + sos_physmem_set_kmem_range(ppage_paddr, new_range); + } + } + /* ... Otherwise: Demand Paging will do the job */ + + if (range_start) + *range_start = new_range->base_vaddr; + + return new_range; +} + + +sos_ret_t sos_kmem_vmm_del_range(struct sos_kmem_range *range) +{ + int i; + struct sos_kmem_range *ranges_to_free; + list_init(ranges_to_free); + + SOS_ASSERT_FATAL(range != NULL); + SOS_ASSERT_FATAL(range->slab == NULL); + + /* Remove the range from the 'USED' list now */ + list_delete(kmem_used_range_list, range); + + /* + * The following do..while() loop is here to avoid an indirect + * recursion: if we call directly kmem_cache_free() from inside the + * current function, we take the risk to re-enter the current function + * (sos_kmem_vmm_del_range()) again, which may cause problem if it + * in turn calls kmem_slab again and sos_kmem_vmm_del_range again, + * and again and again. This may happen while freeing ranges of + * struct sos_kslab... + * + * To avoid this,we choose to call a special function of kmem_slab + * doing almost the same as sos_kmem_cache_free(), but which does + * NOT call us (ie sos_kmem_vmm_del_range()): instead WE add the + * range that is to be freed to a list, and the do..while() loop is + * here to process this list ! The recursion is replaced by + * classical iterations. + */ + do + { + /* Ok, we got the range. Now, insert this range in the free list */ + kmem_free_range_list = insert_range(kmem_free_range_list, range); + + /* Unmap the physical pages */ + for (i = 0 ; i < range->nb_pages ; i ++) + { + /* This will work even if no page is mapped at this address */ + sos_paging_unmap(range->base_vaddr + i*SOS_PAGE_SIZE); + } + + /* Eventually coalesce it with prev/next free ranges (there is + always a valid prev/next link since the list is circular). Note: + the tests below will lead to correct behaviour even if the list + is limited to the 'range' singleton, at least as long as the + range is not zero-sized */ + /* Merge with preceding one ? */ + if (range->prev->base_vaddr + range->prev->nb_pages*SOS_PAGE_SIZE + == range->base_vaddr) + { + struct sos_kmem_range *empty_range_of_ranges = NULL; + struct sos_kmem_range *prec_free = range->prev; + + /* Merge them */ + prec_free->nb_pages += range->nb_pages; + list_delete(kmem_free_range_list, range); + + /* Mark the range as free. This may cause the slab owning + the range to become empty */ + empty_range_of_ranges = + sos_kmem_cache_release_struct_range(range); + + /* If this causes the slab owning the range to become empty, + add the range corresponding to the slab at the end of the + list of the ranges to be freed: it will be actually freed + in one of the next iterations of the do{} loop. */ + if (empty_range_of_ranges != NULL) + { + list_delete(kmem_used_range_list, empty_range_of_ranges); + list_add_tail(ranges_to_free, empty_range_of_ranges); + } + + /* Set range to the beginning of this coelescion */ + range = prec_free; + } + + /* Merge with next one ? [NO 'else' since range may be the result of + the merge above] */ + if (range->base_vaddr + range->nb_pages*SOS_PAGE_SIZE + == range->next->base_vaddr) + { + struct sos_kmem_range *empty_range_of_ranges = NULL; + struct sos_kmem_range *next_range = range->next; + + /* Merge them */ + range->nb_pages += next_range->nb_pages; + list_delete(kmem_free_range_list, next_range); + + /* Mark the next_range as free. This may cause the slab + owning the next_range to become empty */ + empty_range_of_ranges = + sos_kmem_cache_release_struct_range(next_range); + + /* If this causes the slab owning the next_range to become + empty, add the range corresponding to the slab at the end + of the list of the ranges to be freed: it will be + actually freed in one of the next iterations of the + do{} loop. */ + if (empty_range_of_ranges != NULL) + { + list_delete(kmem_used_range_list, empty_range_of_ranges); + list_add_tail(ranges_to_free, empty_range_of_ranges); + } + } + + + /* If deleting the range(s) caused one or more range(s) to be + freed, get the next one to free */ + if (list_is_empty(ranges_to_free)) + range = NULL; /* No range left to free */ + else + range = list_pop_head(ranges_to_free); + + } + /* Stop when there is no range left to be freed for now */ + while (range != NULL); + + return SOS_OK; +} + + +sos_vaddr_t sos_kmem_vmm_alloc(sos_count_t nb_pages, + sos_ui32_t flags) +{ + struct sos_kmem_range *range + = sos_kmem_vmm_new_range(nb_pages, + flags, + NULL); + if (! range) + return (sos_vaddr_t)NULL; + + return range->base_vaddr; +} + + +sos_ret_t sos_kmem_vmm_free(sos_vaddr_t vaddr) +{ + struct sos_kmem_range *range = lookup_range(vaddr); + + /* We expect that the given address is the base address of the + range */ + if (!range || (range->base_vaddr != vaddr)) + return -SOS_EINVAL; + + /* We expect that this range is not held by any cache */ + if (range->slab != NULL) + return -SOS_EBUSY; + + return sos_kmem_vmm_del_range(range); +} + + +sos_ret_t sos_kmem_vmm_set_slab(struct sos_kmem_range *range, + struct sos_kslab *slab) +{ + if (! range) + return -SOS_EINVAL; + + range->slab = slab; + return SOS_OK; +} + +struct sos_kslab * sos_kmem_vmm_resolve_slab(sos_vaddr_t vaddr) +{ + struct sos_kmem_range *range = lookup_range(vaddr); + if (! range) + return NULL; + + return range->slab; +} + + +sos_bool_t sos_kmem_vmm_is_valid_vaddr(sos_vaddr_t vaddr) +{ + struct sos_kmem_range *range = lookup_range(vaddr); + return (range != NULL); +} diff --git a/sos/kmem_vmm.h b/sos/kmem_vmm.h new file mode 100644 index 0000000..49b262d --- /dev/null +++ b/sos/kmem_vmm.h @@ -0,0 +1,113 @@ +/* Copyright (C) 2000 Thomas Petazzoni + Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_KMEM_VMM_H_ +#define _SOS_KMEM_VMM_H_ + +/** + * @file kmem_vmm.h + * + * Kernel Memory Allocator for multiple-page-sized objects residing in + * the kernel (virtual memory) space. Relies on the slab cache + * allocator to allocate its (internal) "range" data structure. + */ + +#include + +/* The base and top virtual addresses covered by the kernel allocator */ +#define SOS_KMEM_VMM_BASE 0x4000 /* 16kB */ +#define SOS_KMEM_VMM_TOP SOS_PAGING_MIRROR_VADDR /* 1GB - 4MB */ + +/** Opaque structure used internally and declared here for physmem.h */ +struct sos_kmem_range; + +#include + +/** + * Mark the areas belonging to SOS_KMEM_VMM_BASE and SOS_KMEM_VMM_TOP + * are either used or free. Those that are already mapped are marked + * as "used", and the 0..SOS_KMEM_VMM_BASE virtual addresses as marked + * as "used" too (to detect incorrect pointer dereferences). + */ +sos_ret_t +sos_kmem_vmm_subsystem_setup(sos_vaddr_t kernel_core_base_vaddr, + sos_vaddr_t kernel_core_top_vaddr, + sos_vaddr_t bootstrap_stack_bottom_vaddr, + sos_vaddr_t bootstrap_stack_top_vaddr); + + +/* + * Flags for kmem_vmm_new_range and kmem_vmm_alloc + */ +/** Physical pages should be immediately mapped */ +#define SOS_KMEM_VMM_MAP (1<<0) +/** Allocation should either success or fail, without blocking */ +#define SOS_KMEM_VMM_ATOMIC (1<<1) + +/** + * Allocate a new kernel area spanning one or multiple pages. + * + * @param range_base_vaddr If not NULL, the start address of the range + * is stored in this location + * @eturn a new range structure + */ +struct sos_kmem_range *sos_kmem_vmm_new_range(sos_size_t nb_pages, + sos_ui32_t flags, + sos_vaddr_t *range_base_vaddr); +sos_ret_t sos_kmem_vmm_del_range(struct sos_kmem_range *range); + + +/** + * Straighforward variant of sos_kmem_vmm_new_range() returning the + * range's start address instead of the range structure + */ +sos_vaddr_t sos_kmem_vmm_alloc(sos_size_t nb_pages, + sos_ui32_t flags); + +/** + * @note you are perfectly allowed to give the address of the + * kernel image, or the address of the bios area here, it will work: + * the kernel/bios WILL be "deallocated". But if you really want to do + * this, well..., do expect some "surprises" ;) + */ +sos_ret_t sos_kmem_vmm_free(sos_vaddr_t vaddr); + + +/** + * @return TRUE when vaddr is covered by any (used) kernel range + */ +sos_bool_t sos_kmem_vmm_is_valid_vaddr(sos_vaddr_t vaddr); + + +/* ***************************** + * Reserved to kmem_slab.c ONLY. + */ +/** + * Associate the range with the given slab. + */ +sos_ret_t sos_kmem_vmm_set_slab(struct sos_kmem_range *range, + struct sos_kslab *slab); + +/** + * Retrieve the (used) slab associated with the range covering vaddr. + * + * @return NULL if the range is not associated with a KMEM range + */ +struct sos_kslab *sos_kmem_vmm_resolve_slab(sos_vaddr_t vaddr); + +#endif /* _SOS_KMEM_VMM_H_ */ diff --git a/sos/ksynch.c b/sos/ksynch.c new file mode 100644 index 0000000..edbd800 --- /dev/null +++ b/sos/ksynch.c @@ -0,0 +1,235 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + + +#include + + +#include "ksynch.h" + + +sos_ret_t sos_ksema_init(struct sos_ksema *sema, const char *name, + int initial_value, + sos_kwaitq_ordering_t ordering) +{ + sema->value = initial_value; + return sos_kwaitq_init(& sema->kwaitq, name, ordering); +} + + +sos_ret_t sos_ksema_dispose(struct sos_ksema *sema) +{ + return sos_kwaitq_dispose(& sema->kwaitq); +} + + +sos_ret_t sos_ksema_down(struct sos_ksema *sema, + struct sos_time *timeout) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = SOS_OK; + + sema->value --; + if (sema->value < 0) + { + /* Wait for somebody to wake us */ + retval = sos_kwaitq_wait(& sema->kwaitq, timeout); + + /* Something wrong happened (timeout, external wakeup, ...) ? */ + if (SOS_OK != retval) + { + /* Yes: pretend we did not ask for the semaphore */ + sema->value ++; + } + } + + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_ksema_trydown(struct sos_ksema *sema) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + + /* Can we take the semaphore without blocking ? */ + if (sema->value >= 1) + { + /* Yes: we take it now */ + sema->value --; + retval = SOS_OK; + } + else + { + /* No: we signal it */ + retval = -SOS_EBUSY; + } + + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_ksema_up(struct sos_ksema *sema) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + + sema->value ++; + retval = sos_kwaitq_wakeup(& sema->kwaitq, 1, SOS_OK); + + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_kmutex_init(struct sos_kmutex *mutex, const char *name, + sos_kwaitq_ordering_t ordering) +{ + mutex->owner = NULL; + return sos_kwaitq_init(& mutex->kwaitq, name, ordering); +} + + +sos_ret_t sos_kmutex_dispose(struct sos_kmutex *mutex) +{ + return sos_kwaitq_dispose(& mutex->kwaitq); +} + + +/* + * Implementation based on ownership transfer (ie no while() + * loop). The only assumption is that the thread awoken by + * kmutex_unlock is not suppressed before effectively waking up: in + * that case the mutex will be forever locked AND unlockable (by + * nobody other than the owner, but this is not natural since this + * owner already issued an unlock()...). The same problem happens with + * the semaphores, but in a less obvious manner. + */ +sos_ret_t sos_kmutex_lock(struct sos_kmutex *mutex, + struct sos_time *timeout) +{ + __label__ exit_kmutex_lock; + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = SOS_OK; + + /* Mutex already owned ? */ + if (NULL != mutex->owner) + { + /* Owned by us or by someone else ? */ + if (sos_thread_get_current() == mutex->owner) + { + /* Owned by us: do nothing */ + retval = -SOS_EBUSY; + goto exit_kmutex_lock; + } + + /* Wait for somebody to wake us */ + retval = sos_kwaitq_wait(& mutex->kwaitq, timeout); + + /* Something wrong happened ? */ + if (SOS_OK != retval) + { + goto exit_kmutex_lock; + } + } + + /* Ok, the mutex is available to us: take it */ + mutex->owner = sos_thread_get_current(); + + exit_kmutex_lock: + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_kmutex_trylock(struct sos_kmutex *mutex) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + + /* Mutex available to us ? */ + if (NULL == mutex->owner) + { + /* Great ! Take it now */ + mutex->owner = sos_thread_get_current(); + + retval = SOS_OK; + } + else + { + /* No: signal it */ + retval = -SOS_EBUSY; + } + + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_kmutex_unlock(struct sos_kmutex *mutex) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + + if (sos_thread_get_current() != mutex->owner) + retval = -SOS_EPERM; + + else if (sos_kwaitq_is_empty(& mutex->kwaitq)) + { + /* + * There is NOT ANY thread waiting => we really mark the mutex + * as FREE + */ + mutex->owner = NULL; + retval = SOS_OK; + } + else + { + /* + * There is at least 1 thread waiting => we DO NOT mark the + * mutex as free ! + * Actually, we should have written: + * mutex->owner = thread_that_is_woken_up; + * But the real Id of the next thread owning the mutex is not + * that important. What is important here is that mutex->owner + * IS NOT NULL. Otherwise there will be a possibility for the + * thread woken up here to have the mutex stolen by a thread + * locking the mutex in the meantime. + */ + retval = sos_kwaitq_wakeup(& mutex->kwaitq, 1, SOS_OK); + } + + sos_restore_IRQs(flags); + return retval; +} diff --git a/sos/ksynch.h b/sos/ksynch.h new file mode 100644 index 0000000..47d8675 --- /dev/null +++ b/sos/ksynch.h @@ -0,0 +1,172 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_KSYNCH_H_ +#define _SOS_KSYNCH_H_ + + +/** + * @file synch.h + * + * Common kernel synchronisation primitives. + */ + + +#include +#include + + +/* ==================================================================== + * Kernel semaphores, NON-recursive + */ + + +/** + * The structure of a (NON-RECURSIVE) kernel Semaphore + */ +struct sos_ksema +{ + int value; + struct sos_kwaitq kwaitq; +}; + + +/* + * Initialize a kernel semaphore structure with the given name + * + * @param name Name of the semaphore (for debugging purpose only; safe + * [deep copied]) + * + * @param initial_value The value of the semaphore before any up/down + */ +sos_ret_t sos_ksema_init(struct sos_ksema *sema, const char *name, + int initial_value, + sos_kwaitq_ordering_t ordering); + + +/* + * De-initialize a kernel semaphore + * + * @return -SOS_EBUSY when semaphore could not be de-initialized + * because at least a thread is in the waitq. + */ +sos_ret_t sos_ksema_dispose(struct sos_ksema *sema); + + +/* + * Enters the semaphore + * + * @param timeout Maximum time to wait for the semaphore. Or NULL for + * "no limit". Updated on return to reflect the time remaining (0 when + * timeout has been triggered) + * + * @return -SOS_EINTR when timeout was triggered or when another waitq + * woke us up. + * + * @note This is a BLOCKING FUNCTION + */ +sos_ret_t sos_ksema_down(struct sos_ksema *sema, + struct sos_time *timeout); + + +/* + * Try to enter the semaphore without blocking. + * + * @return -SOS_EBUSY when locking the semaphore would block + */ +sos_ret_t sos_ksema_trydown(struct sos_ksema *sema); + + +/** + * Increments the semaphore's value, eventually waking up a thread + */ +sos_ret_t sos_ksema_up(struct sos_ksema *sema); + + + +/* ==================================================================== + * Kernel mutex (ie binary semaphore with strong ownership), + * NON-recursive ! + */ + + +/** + * The structure of a (NON-RECURSIVE) kernel Mutex + */ +struct sos_kmutex +{ + struct sos_thread *owner; + struct sos_kwaitq kwaitq; +}; + + +/* + * Initialize a kernel mutex structure with the given name + * + * @param name Name of the mutex (for debugging purpose only; safe + * [deep copied]) + * + * @param initial_value The value of the mutex before any up/down + */ +sos_ret_t sos_kmutex_init(struct sos_kmutex *mutex, const char *name, + sos_kwaitq_ordering_t ordering); + + +/* + * De-initialize a kernel mutex + * + * @return -SOS_EBUSY when mutex could not be de-initialized + * because at least a thread is in the waitq. + */ +sos_ret_t sos_kmutex_dispose(struct sos_kmutex *mutex); + + +/* + * Lock the mutex. If the same thread multiply locks the same mutex, + * it won't hurt (no deadlock, return value = -SOS_EBUSY). + * + * @param timeout Maximum time to wait for the mutex. Or NULL for "no + * limit". Updated on return to reflect the time remaining (0 when + * timeout has been triggered) + * + * @return -SOS_EINTR when timeout was triggered or when another waitq + * woke us up, -SOS_EBUSY when the thread already owns the mutex. + * + * @note This is a BLOCKING FUNCTION + */ +sos_ret_t sos_kmutex_lock(struct sos_kmutex *mutex, + struct sos_time *timeout); + + +/* + * Try to lock the mutex without blocking. + * + * @return -SOS_EBUSY when locking the mutex would block + */ +sos_ret_t sos_kmutex_trylock(struct sos_kmutex *mutex); + + +/** + * Unlock the mutex, eventually waking up a thread + * + * @return -SOS_EPERM when the calling thread is NOT the owner of the + * mutex + */ +sos_ret_t sos_kmutex_unlock(struct sos_kmutex *mutex); + + +#endif /* _SOS_KSYNCH_H_ */ diff --git a/sos/kwaitq.c b/sos/kwaitq.c new file mode 100644 index 0000000..2b49a04 --- /dev/null +++ b/sos/kwaitq.c @@ -0,0 +1,321 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include + +#include "kwaitq.h" + + +sos_ret_t sos_kwaitq_init(struct sos_kwaitq *kwq, + const char *name, + sos_kwaitq_ordering_t ordering) +{ + memset(kwq, 0x0, sizeof(struct sos_kwaitq)); + +#ifdef SOS_KWQ_DEBUG + if (! name) + name = ""; + strzcpy(kwq->name, name, SOS_KWQ_DEBUG_MAX_NAMELEN); +#endif + kwq->ordering = ordering; + list_init_named(kwq->waiting_list, + prev_entry_in_kwaitq, next_entry_in_kwaitq); + + return SOS_OK; +} + + +sos_ret_t sos_kwaitq_dispose(struct sos_kwaitq *kwq) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + if (list_is_empty_named(kwq->waiting_list, + prev_entry_in_kwaitq, next_entry_in_kwaitq)) + retval = SOS_OK; + else + retval = -SOS_EBUSY; + + sos_restore_IRQs(flags); + return retval; +} + + +sos_bool_t sos_kwaitq_is_empty(const struct sos_kwaitq *kwq) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = list_is_empty_named(kwq->waiting_list, + prev_entry_in_kwaitq, next_entry_in_kwaitq); + + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_kwaitq_init_entry(struct sos_kwaitq_entry *kwq_entry) +{ + memset(kwq_entry, 0x0, sizeof(struct sos_kwaitq_entry)); + kwq_entry->thread = sos_thread_get_current(); + return SOS_OK; +} + + +/** Internal helper function equivalent to sos_kwaitq_add_entry(), but + without interrupt protection scheme */ +inline static sos_ret_t +_kwaitq_add_entry(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry, + sos_sched_priority_t prio) +{ + struct sos_kwaitq_entry *next_entry = NULL, *entry; + int nb_entries; + + /* This entry is already added in the kwaitq ! */ + SOS_ASSERT_FATAL(NULL == kwq_entry->kwaitq); + + /* sos_kwaitq_init_entry() has not been called ?! */ + SOS_ASSERT_FATAL(NULL != kwq_entry->thread); + + /* (Re-)Initialize wakeup status of the entry */ + kwq_entry->wakeup_triggered = FALSE; + kwq_entry->wakeup_status = SOS_OK; + + /* Insert this entry in the kwaitq waiting list */ + switch (kwq->ordering) + { + case SOS_KWQ_ORDER_FIFO: + /* Insertion in the list in FIFO order */ + { + /* Add the thread in the list */ + list_add_tail_named(kwq->waiting_list, kwq_entry, + prev_entry_in_kwaitq, next_entry_in_kwaitq); + } + break; + + case SOS_KWQ_ORDER_PRIO: + /* Priority-driven insertion in the list */ + { + /* Look for the place where to insert the thread in the queue (we + want to order them in order of increasing priorities) */ + list_foreach_forward_named(kwq->waiting_list, entry, nb_entries, + prev_entry_in_kwaitq, next_entry_in_kwaitq) + { + /* Does the thread we want to insert have higher priority than + the given thread in the queue ? */ + if (SOS_SCHED_PRIO_CMP(prio, + sos_thread_get_priority(entry->thread)) + > 0) + { + /* Yes: we insert before this given thread */ + next_entry = entry; + break; + } + } + + /* Actually insert the entry in the list */ + if (next_entry != NULL) + { + list_insert_before_named(kwq->waiting_list, kwq_entry, next_entry, + prev_entry_in_kwaitq, + next_entry_in_kwaitq); + } + else + { + /* The thread we want to insert has less priority than any + other in the list */ + list_add_tail_named(kwq->waiting_list, kwq_entry, + prev_entry_in_kwaitq, next_entry_in_kwaitq); + } + } + break; + + default: + SOS_FATAL_ERROR("Invalid kwq ordering %d !\n", kwq->ordering); + break; + } + + /* Update the list of waitqueues for the thread */ + list_add_tail_named(kwq_entry->thread->kwaitq_list, kwq_entry, + prev_entry_for_thread, next_entry_for_thread); + + kwq_entry->kwaitq = kwq; + + return SOS_OK; +} + + +sos_ret_t sos_kwaitq_add_entry(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = _kwaitq_add_entry(kwq, kwq_entry, + sos_thread_get_priority(kwq_entry->thread)); + sos_restore_IRQs(flags); + + return retval; +} + + +/** Internal helper function equivalent to sos_kwaitq_remove_entry(), + but without interrupt protection scheme */ +inline static sos_ret_t +_kwaitq_remove_entry(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry) +{ + SOS_ASSERT_FATAL(kwq_entry->kwaitq == kwq); + + list_delete_named(kwq->waiting_list, kwq_entry, + prev_entry_in_kwaitq, next_entry_in_kwaitq); + + list_delete_named(kwq_entry->thread->kwaitq_list, kwq_entry, + prev_entry_for_thread, next_entry_for_thread); + + kwq_entry->kwaitq = NULL; + return SOS_OK; +} + + +sos_ret_t sos_kwaitq_remove_entry(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = _kwaitq_remove_entry(kwq, kwq_entry); + sos_restore_IRQs(flags); + + return retval; +} + + +sos_ret_t sos_kwaitq_wait(struct sos_kwaitq *kwq, + struct sos_time *timeout) +{ + sos_ui32_t flags; + sos_ret_t retval; + struct sos_kwaitq_entry kwq_entry; + + sos_kwaitq_init_entry(& kwq_entry); + + sos_disable_IRQs(flags); + + retval = _kwaitq_add_entry(kwq, & kwq_entry, + sos_thread_get_priority(kwq_entry.thread)); + + /* Wait for wakeup or timeout */ + sos_thread_sleep(timeout); + /* Woken up ! */ + + /* Sleep delay elapsed ? */ + if (! kwq_entry.wakeup_triggered) + { + /* Yes (timeout occured, or wakeup on another waitqueue): remove + the waitq entry by ourselves */ + _kwaitq_remove_entry(kwq, & kwq_entry); + retval = -SOS_EINTR; + } + else + { + retval = kwq_entry.wakeup_status; + } + + sos_restore_IRQs(flags); + + /* We were correctly awoken: position return status */ + return retval; +} + + +sos_ret_t sos_kwaitq_wakeup(struct sos_kwaitq *kwq, + unsigned int nb_threads, + sos_ret_t wakeup_status) +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + + /* Wake up as much threads waiting in waitqueue as possible (up to + nb_threads), scanning the list in FIFO/decreasing priority order + (depends on the kwaitq ordering) */ + while (! list_is_empty_named(kwq->waiting_list, + prev_entry_in_kwaitq, next_entry_in_kwaitq)) + { + struct sos_kwaitq_entry *kwq_entry + = list_get_head_named(kwq->waiting_list, + prev_entry_in_kwaitq, next_entry_in_kwaitq); + + /* Enough threads woken up ? */ + if (nb_threads <= 0) + break; + + /* + * Ok: wake up the thread for this entry + */ + + /* Thread already woken up ? */ + if (SOS_THR_RUNNING == sos_thread_get_state(kwq_entry->thread)) + { + /* Yes => Do nothing because WE are that woken-up thread. In + particular: don't call set_ready() here because this + would result in an inconsistent configuration (currently + running thread marked as "waiting for CPU"...). */ + continue; + } + else + { + /* No => wake it up now. */ + sos_sched_set_ready(kwq_entry->thread); + } + + /* Remove this waitq entry */ + _kwaitq_remove_entry(kwq, kwq_entry); + kwq_entry->wakeup_triggered = TRUE; + kwq_entry->wakeup_status = wakeup_status; + + /* Next iteration... */ + nb_threads --; + } + + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +/* Internal function (callback for thread subsystem) */ +sos_ret_t sos_kwaitq_change_priority(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry, + sos_sched_priority_t priority) +{ + /* Reorder the waiting list */ + _kwaitq_remove_entry(kwq, kwq_entry); + _kwaitq_add_entry(kwq, kwq_entry, priority); + + return SOS_OK; +} diff --git a/sos/kwaitq.h b/sos/kwaitq.h new file mode 100644 index 0000000..9bc6c39 --- /dev/null +++ b/sos/kwaitq.h @@ -0,0 +1,216 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_KWAITQ_H_ +#define _SOS_KWAITQ_H_ + +#include +#include +#include + + +/** + * @kwaitq.h + * + * Low-level functions to manage queues of threads waiting for a + * resource. These functions are public, except + * sos_kwaitq_change_priority() that is a callback for the thread + * subsystem. However, for higher-level synchronization primitives + * such as mutex, semaphores, conditions, ... prefer to look at the + * corresponding libraries. + */ + + +/** + * Define this if you want to know the names of the kwaitq + */ +// #define SOS_KWQ_DEBUG + + +/* Forward declaration */ +struct sos_kwaitq_entry; + + +/** + * The threads in the kwaitqs can be ordered in FIFO or in decreasing + * priority order. + */ +typedef enum { SOS_KWQ_ORDER_FIFO, SOS_KWQ_ORDER_PRIO } sos_kwaitq_ordering_t; + + +#include + + +/** + * Definition of a waitqueue. In a kwaitq, the threads can be ordererd + * either in FIFO order (SOS_KWQ_ORDER_FIFO) or in decreasing priority + * order (SOS_KWQ_ORDER_PRIO ; with FIFO ordering for same-prio + * threads). + * + * A more efficient method to store the threads ordered by their + * priority would have been to use 1 list for each priority level. But + * we have to be careful to the size of a kwaitq structure here: + * potentially there are thousands of kwaitq in a running system + * (basically: 1 per opened file !). The algorithm we use to order the + * threads in the kwaitq in this case is highly under-optimal (naive + * linear insertion): as an exercise, one can implement a more + * efficient algorithm (think of a heap). + */ +struct sos_kwaitq +{ +#ifdef SOS_KWQ_DEBUG +# define SOS_KWQ_DEBUG_MAX_NAMELEN 32 + char name[SOS_KWQ_DEBUG_MAX_NAMELEN]; +#endif + sos_kwaitq_ordering_t ordering; + struct sos_kwaitq_entry *waiting_list; +}; + + +/** + * Definition of an entry for a thread waiting in the waitqueue + */ +struct sos_kwaitq_entry +{ + /** The thread associted with this entry */ + struct sos_thread *thread; + + /** The kwaitqueue this entry belongs to */ + struct sos_kwaitq *kwaitq; + + /** TRUE when somebody woke up this entry */ + sos_bool_t wakeup_triggered; + + /** The status of wakeup for this entry. @see wakeup_status argument + of sos_kwaitq_wakeup() */ + sos_ret_t wakeup_status; + + /** Other entries in this kwaitqueue */ + struct sos_kwaitq_entry *prev_entry_in_kwaitq, *next_entry_in_kwaitq; + + /** Other entries for the thread */ + struct sos_kwaitq_entry *prev_entry_for_thread, *next_entry_for_thread; +}; + + +/** + * Initialize an empty waitqueue. + * + * @param name Used only if SOS_KWQ_DEBUG is defined (safe [deep + * copied]) + */ +sos_ret_t sos_kwaitq_init(struct sos_kwaitq *kwq, + const char *name, + sos_kwaitq_ordering_t ordering); + + +/** + * Release a waitqueue, making sure that no thread is in it. + * + * @return -SOS_EBUSY in case a thread is still in the waitqueue. + */ +sos_ret_t sos_kwaitq_dispose(struct sos_kwaitq *kwq); + + +/** + * Return whether there are no threads in the waitq + */ +sos_bool_t sos_kwaitq_is_empty(const struct sos_kwaitq *kwq); + + +/** + * Initialize a waitqueue entry. Mainly consists in updating the + * "thread" field of the entry (set to current running thread), and + * initializing the remaining of the entry as to indicate it does not + * belong to any waitq. + */ +sos_ret_t sos_kwaitq_init_entry(struct sos_kwaitq_entry *kwq_entry); + + +/** + * Add an entry (previously initialized with sos_kwaitq_init_entry()) + * in the given waitqueue. + * + * @note: No state change/context switch can occur here ! Among other + * things: the current executing thread is not preempted. + */ +sos_ret_t sos_kwaitq_add_entry(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry); + + +/** + * Remove the given kwaitq_entry from the kwaitq. + * + * @note: No state change/context switch can occur here ! Among other + * things: the thread associated with the entry is not necessarilly + * the same as the one currently running, and does not preempt the + * current running thread if they are different. + */ +sos_ret_t sos_kwaitq_remove_entry(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry); + + +/** + * Helper function to make the current running thread block in the + * given kwaitq, waiting to be woken up by somedy else or by the given + * timeout. It calls the sos_kwaitq_add_entry() and + * sos_kwaitq_remove_entry(). + * + * @param timeout The desired timeout (can be NULL => wait for + * ever). It is updated by the function to reflect the remaining + * timeout in case the thread has been woken-up prior to its + * expiration. + * + * @return -SOS_EINTR when the thread is resumed while it has not be + * explicitely woken up by someone calling sos_kwaitq_wakeup() upon + * the same waitqueue... This can only happen 1/ if the timeout + * expired, or 2/ if the current thread is also in another kwaitq + * different to "kwq". Otherwise return the value set by + * sos_kwaitq_wakeup(). The timeout remaining is updated in timeout. + * + * @note This is a BLOCKING FUNCTION + */ +sos_ret_t sos_kwaitq_wait(struct sos_kwaitq *kwq, + struct sos_time *timeout); + + +/** + * Wake up as much as nb_thread threads (SOS_KWQ_WAKEUP_ALL to wake + * up all threads) in the kwaitq kwq, in FIFO or decreasing priority + * order (depends on the ordering scheme selected at kwaitq + * initialization time). + * + * @param wakeup_status The value returned by sos_kwaitq_wait() when + * the thread will effectively woken up due to this wakeup. + */ +sos_ret_t sos_kwaitq_wakeup(struct sos_kwaitq *kwq, + unsigned int nb_threads, + sos_ret_t wakeup_status); +#define SOS_KWQ_WAKEUP_ALL (~((unsigned int)0)) + + +/** + * @note INTERNAL function (in particular: interrupts not disabled) ! + * + * @note: The use of this function is RESERVED (to thread.c). Do not + * call it directly: use sos_thread_set_priority() for that ! + */ +sos_ret_t sos_kwaitq_change_priority(struct sos_kwaitq *kwq, + struct sos_kwaitq_entry *kwq_entry, + sos_sched_priority_t priority); + +#endif /* _SOS_KWAITQ_H_ */ diff --git a/sos/list.h b/sos/list.h new file mode 100644 index 0000000..1f4b4d1 --- /dev/null +++ b/sos/list.h @@ -0,0 +1,194 @@ +/* Copyright (C) 2001 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_LIST_H_ +#define _SOS_LIST_H_ + +/** + * @file list.h + * + * Circular doubly-linked lists implementation entirely based on C + * macros + */ + + +/* *_named are used when next and prev links are not exactly next + and prev. For instance when we have next_in_team, prev_in_team, + prev_global and next_global */ + +#define list_init_named(list,prev,next) \ + ((list) = NULL) + +#define list_singleton_named(list,item,prev,next) ({ \ + (item)->next = (item)->prev = (item); \ + (list) = (item); \ +}) + +#define list_is_empty_named(list,prev,next) \ + ((list) == NULL) + +#define list_is_singleton_named(list,prev,next) \ + ( ((list) != NULL) && ((list)->prev == (list)->next) && ((list) == (list)->next) ) + +#define list_get_head_named(list,prev,next) \ + (list) + +#define list_get_tail_named(list,prev,next) \ + ((list)?((list)->prev):NULL) + +/* Internal macro : insert before the head == insert at tail */ +#define __list_insert_atleft_named(before_this,item,prev,next) ({ \ + (before_this)->prev->next = (item); \ + (item)->prev = (before_this)->prev; \ + (before_this)->prev = (item); \ + (item)->next = (before_this); \ +}) + +/* @note Before_this and item are expected to be valid ! */ +#define list_insert_before_named(list,before_this,item,prev,next) ({ \ + __list_insert_atleft_named(before_this,item,prev,next); \ + if ((list) == (before_this)) (list) = (item); \ +}) + +/** @note After_this and item are expected to be valid ! */ +#define list_insert_after_named(list,after_this,item,prev,next) ({ \ + (after_this)->next->prev = (item); \ + (item)->next = (after_this)->next; \ + (after_this)->next = (item); \ + (item)->prev = (after_this); \ +}) + +#define list_add_head_named(list,item,prev,next) ({ \ + if (list) \ + list_insert_before_named(list,list,item,prev,next); \ + else \ + list_singleton_named(list,item,prev,next); \ + (list) = (item); \ +}) + +#define list_add_tail_named(list,item,prev,next) ({ \ + if (list) \ + __list_insert_atleft_named(list,item,prev,next); \ + else \ + list_singleton_named(list,item,prev,next); \ +}) + +/** @note NO check whether item really is in list ! */ +#define list_delete_named(list,item,prev,next) ({ \ + if ( ((item)->next == (item)) && ((item)->prev == (item)) ) \ + (item)->next = (item)->prev = (list) = NULL; \ + else { \ + (item)->prev->next = (item)->next; \ + (item)->next->prev = (item)->prev; \ + if ((item) == (list)) (list) = (item)->next; \ + (item)->prev = (item)->next = NULL; \ + } \ +}) + +#define list_pop_head_named(list,prev,next) ({ \ + typeof(list) __ret_elt = (list); \ + list_delete_named(list,__ret_elt,prev,next); \ + __ret_elt; }) + +/** Loop statement that iterates through all of its elements, from + head to tail */ +#define list_foreach_forward_named(list,iterator,nb_elements,prev,next) \ + for (nb_elements=0, (iterator) = (list) ; \ + (iterator) && (!nb_elements || ((iterator) != (list))) ; \ + nb_elements++, (iterator) = (iterator)->next ) + +/** Loop statement that iterates through all of its elements, from + tail back to head */ +#define list_foreach_backward_named(list,iterator,nb_elements,prev,next) \ + for (nb_elements=0, (iterator) = list_get_tail_named(list,prev,next) ; \ + (iterator) && (!nb_elements || \ + ((iterator) != list_get_tail_named(list,prev,next))) ; \ + nb_elements++, (iterator) = (iterator)->prev ) + +#define list_foreach_named list_foreach_forward_named + +/** True when we exitted early from the foreach loop (ie break) */ +#define list_foreach_early_break(list,iterator,nb_elements) \ + ((list) && ( \ + ((list) != (iterator)) || \ + ( ((list) == (iterator)) && (nb_elements == 0)) )) + +/** Loop statement that also removes the item at each iteration. The + body of the loop is allowed to delete the iterator element from + memory. */ +#define list_collapse_named(list,iterator,prev,next) \ + for ( ; ({ ((iterator) = (list)) ; \ + if (list) list_delete_named(list,iterator,prev,next) ; \ + (iterator); }) ; ) + + +/* + * the same macros : assume that the prev and next fields are really + * named "prev" and "next" + */ + +#define list_init(list) \ + list_init_named(list,prev,next) + +#define list_singleton(list,item) \ + list_singleton_named(list,item,prev,next) + +#define list_is_empty(list) \ + list_is_empty_named(list,prev,next) + +#define list_is_singleton(list) \ + list_is_singleton_named(list,prev,next) + +#define list_get_head(list) \ + list_get_head_named(list,prev,next) \ + +#define list_get_tail(list) \ + list_get_tail_named(list,prev,next) \ + +/* @note Before_this and item are expected to be valid ! */ +#define list_insert_after(list,after_this,item) \ + list_insert_after_named(list,after_this,item,prev,next) + +/* @note After_this and item are expected to be valid ! */ +#define list_insert_before(list,before_this,item) \ + list_insert_before_named(list,before_this,item,prev,next) + +#define list_add_head(list,item) \ + list_add_head_named(list,item,prev,next) + +#define list_add_tail(list,item) \ + list_add_tail_named(list,item,prev,next) + +/* @note NO check whether item really is in list ! */ +#define list_delete(list,item) \ + list_delete_named(list,item,prev,next) + +#define list_pop_head(list) \ + list_pop_head_named(list,prev,next) + +#define list_foreach_forward(list,iterator,nb_elements) \ + list_foreach_forward_named(list,iterator,nb_elements,prev,next) + +#define list_foreach_backward(list,iterator,nb_elements) \ + list_foreach_backward_named(list,iterator,nb_elements,prev,next) + +#define list_foreach list_foreach_forward + +#define list_collapse(list,iterator) \ + list_collapse_named(list,iterator,prev,next) + +#endif /* _SOS_LIST_H_ */ diff --git a/sos/macros.h b/sos/macros.h new file mode 100644 index 0000000..29a8848 --- /dev/null +++ b/sos/macros.h @@ -0,0 +1,47 @@ +/* Copyright (C) 2004 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_MACROS_H_ +#define _SOS_MACROS_H_ + +/** Align on a boundary (MUST be a power of 2), so that return value <= val */ +#define SOS_ALIGN_INF(val,boundary) \ + (((unsigned)(val)) & (~((boundary)-1))) + +/** Align on a boundary (MUST be a power of 2), so that return value >= val */ +#define SOS_ALIGN_SUP(val,boundary) \ + ({ unsigned int __bnd=(boundary); \ + (((((unsigned)(val))-1) & (~(__bnd - 1))) + __bnd); }) + +/** Check whether val is aligned on a boundary (MUST be a power of 2) */ +#define SOS_IS_ALIGNED(val,boundary) \ + ( 0 == (((unsigned)(val)) & ((boundary)-1)) ) + +/** + * @return TRUE if val is a power of 2. + * @note val is evaluated multiple times + */ +#define SOS_IS_POWER_OF_2(val) \ + ((((val) - 1) & (val)) == 0) + +/** + * Standard macro to get the offset of the given field in a structure + */ +#define offsetof(type,field) \ + ((unsigned) &(((type *)0)->field)) + +#endif /* _SOS_MACROS_H_ */ diff --git a/sos/main.c b/sos/main.c new file mode 100644 index 0000000..d063a6d --- /dev/null +++ b/sos/main.c @@ -0,0 +1,514 @@ +/* Copyright (C) 2004 The SOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +/* Include definitions of the multiboot standard */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +/* Helper function to display each bits of a 32bits integer on the + screen as dark or light carrets */ +void display_bits(unsigned char row, unsigned char col, + unsigned char attribute, + sos_ui32_t integer) +{ + int i; + /* Scan each bit of the integer, MSb first */ + for (i = 31 ; i >= 0 ; i--) + { + /* Test if bit i of 'integer' is set */ + int bit_i = (integer & (1 << i)); + /* Ascii 219 => dark carret, Ascii 177 => light carret */ + unsigned char ascii_code = bit_i?219:177; + sos_x86_videomem_putchar(row, col++, + attribute, + ascii_code); + } +} + + +/* Clock IRQ handler */ +static void clk_it(int intid) +{ + static sos_ui32_t clock_count = 0; + + display_bits(0, 48, + SOS_X86_VIDEO_FG_LTGREEN | SOS_X86_VIDEO_BG_BLUE, + clock_count); + clock_count++; + + /* Execute the expired timeout actions (if any) */ + sos_time_do_tick(); + + /* Update scheduler statistics and status */ + sos_sched_do_timer_tick(); +} + + +/* ====================================================================== + * Page fault exception handling + */ + + +/* Page fault exception handler with demand paging for the kernel */ +static void pgflt_ex(int intid, struct sos_cpu_state *ctxt) +{ + static sos_ui32_t demand_paging_count = 0; + sos_vaddr_t faulting_vaddr = sos_cpu_context_get_EX_faulting_vaddr(ctxt); + sos_paddr_t ppage_paddr; + + if (sos_cpu_context_is_in_user_mode(ctxt)) + { + /* User-mode page faults are considered unresolved for the + moment */ + sos_bochs_printf("Unresolved USER page Fault at instruction 0x%x on access to address 0x%x (info=%x)!\n", + sos_cpu_context_get_PC(ctxt), + (unsigned)faulting_vaddr, + (unsigned)sos_cpu_context_get_EX_info(ctxt)); + sos_bochs_printf("Terminating User thread\n"); + sos_thread_exit(); + } + + /* Check if address is covered by any VMM range */ + if (! sos_kmem_vmm_is_valid_vaddr(faulting_vaddr)) + { + /* No: The page fault is out of any kernel virtual region. For + the moment, we don't handle this. */ + sos_display_fatal_error("Unresolved page Fault at instruction 0x%x on access to address 0x%x (info=%x)!", + sos_cpu_context_get_PC(ctxt), + (unsigned)faulting_vaddr, + (unsigned)sos_cpu_context_get_EX_info(ctxt)); + SOS_ASSERT_FATAL(! "Got page fault (note: demand paging is disabled)"); + } + + + /* + * Demand paging in kernel space + */ + + /* Update the number of demand paging requests handled */ + demand_paging_count ++; + display_bits(0, 0, + SOS_X86_VIDEO_FG_LTRED | SOS_X86_VIDEO_BG_BLUE, + demand_paging_count); + + /* Allocate a new page for the virtual address */ + ppage_paddr = sos_physmem_ref_physpage_new(FALSE); + if (! ppage_paddr) + SOS_ASSERT_FATAL(! "TODO: implement swap. (Out of mem in demand paging because no swap for kernel yet !)"); + SOS_ASSERT_FATAL(SOS_OK == sos_paging_map(ppage_paddr, + SOS_PAGE_ALIGN_INF(faulting_vaddr), + FALSE, + SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE + | SOS_VM_MAP_ATOMIC)); + sos_physmem_unref_physpage(ppage_paddr); + + /* Ok, we can now return to interrupted context */ +} + + +/* ====================================================================== + * Demonstrate the use of SOS kernel threads + * - Kernel Threads are created with various priorities and their + * state is printed on both the console and the bochs' 0xe9 port + * - For tests regarding threads' synchronization, see mouse_sim.c + */ + +struct thr_arg +{ + char character; + int color; + + int col; + int row; +}; + + +static void demo_thread(void *arg) +{ + struct thr_arg *thr_arg = (struct thr_arg*)arg; + int progress = 0; + + sos_bochs_printf("start %c", thr_arg->character); + while (1) + { + progress ++; + display_bits(thr_arg->row, thr_arg->col+1, thr_arg->color, progress); + + sos_bochs_putchar(thr_arg->character); + + /* Yield the CPU to another thread sometimes... */ + if ((random() % 100) == 0) + { + sos_bochs_printf("yield(%c)\n", thr_arg->character); + sos_x86_videomem_putchar(thr_arg->row, thr_arg->col, 0x1e, 'Y'); + SOS_ASSERT_FATAL(SOS_OK == sos_thread_yield()); + sos_x86_videomem_putchar(thr_arg->row, thr_arg->col, 0x1e, 'R'); + } + + /* Go to sleep some other times... */ + else if ((random() % 200) == 0) + { + struct sos_time t = (struct sos_time){ .sec=0, .nanosec=50000000 }; + sos_bochs_printf("sleep1(%c)\n", thr_arg->character); + sos_x86_videomem_putchar(thr_arg->row, thr_arg->col, 0x1e, 's'); + SOS_ASSERT_FATAL(SOS_OK == sos_thread_sleep(& t)); + SOS_ASSERT_FATAL(sos_time_is_zero(& t)); + sos_x86_videomem_putchar(thr_arg->row, thr_arg->col, 0x1e, 'R'); + } + + /* Go to sleep for a longer time some other times... */ + else if ((random() % 300) == 0) + { + struct sos_time t = (struct sos_time){ .sec=0, .nanosec=300000000 }; + sos_bochs_printf("sleep2(%c)\n", thr_arg->character); + sos_x86_videomem_putchar(thr_arg->row, thr_arg->col, 0x1e, 'S'); + SOS_ASSERT_FATAL(SOS_OK == sos_thread_sleep(& t)); + SOS_ASSERT_FATAL(sos_time_is_zero(& t)); + sos_x86_videomem_putchar(thr_arg->row, thr_arg->col, 0x1e, 'R'); + } + + /* Infinite loop otherwise */ + } +} + + +static void test_thread() +{ + /* "static" variables because we want them to remain even when the + function returns */ + static struct thr_arg arg_b, arg_c, arg_d, arg_e, arg_R, arg_S; + sos_ui32_t flags; + + sos_disable_IRQs(flags); + + arg_b = (struct thr_arg) { .character='b', .col=0, .row=21, .color=0x14 }; + sos_create_kernel_thread("YO[b]", demo_thread, (void*)&arg_b, SOS_SCHED_PRIO_TS_LOWEST); + + arg_c = (struct thr_arg) { .character='c', .col=46, .row=21, .color=0x14 }; + sos_create_kernel_thread("YO[c]", demo_thread, (void*)&arg_c, SOS_SCHED_PRIO_TS_LOWEST); + + arg_d = (struct thr_arg) { .character='d', .col=0, .row=20, .color=0x14 }; + sos_create_kernel_thread("YO[d]", demo_thread, (void*)&arg_d, SOS_SCHED_PRIO_TS_LOWEST-1); + + arg_e = (struct thr_arg) { .character='e', .col=0, .row=19, .color=0x14 }; + sos_create_kernel_thread("YO[e]", demo_thread, (void*)&arg_e, SOS_SCHED_PRIO_TS_LOWEST-2); + + arg_R = (struct thr_arg) { .character='R', .col=0, .row=17, .color=0x1c }; + sos_create_kernel_thread("YO[R]", demo_thread, (void*)&arg_R, SOS_SCHED_PRIO_RT_LOWEST); + + arg_S = (struct thr_arg) { .character='S', .col=0, .row=16, .color=0x1c }; + sos_create_kernel_thread("YO[S]", demo_thread, (void*)&arg_S, SOS_SCHED_PRIO_RT_LOWEST-1); + + sos_restore_IRQs(flags); +} + + +/* ====================================================================== + * An operating system MUST always have a ready thread ! Otherwise: + * what would the CPU have to execute ?! + */ +static void idle_thread() +{ + sos_ui32_t idle_twiddle = 0; + + while (1) + { + /* Remove this instruction if you get an "Invalid opcode" CPU + exception (old 80386 CPU) */ + asm("hlt\n"); + + idle_twiddle ++; + display_bits(0, 0, SOS_X86_VIDEO_FG_GREEN | SOS_X86_VIDEO_BG_BLUE, + idle_twiddle); + + /* Lend the CPU to some other thread */ + sos_thread_yield(); + } +} + + +/* ====================================================================== + * Kernel thread showing some CPU usage statistics on the console every 1s + */ +static void stat_thread() +{ + while (1) + { + sos_ui32_t flags; + sos_ui32_t load1, load5, load15; + char str1[11], str5[11], str15[11]; + struct sos_time t; + t.sec = 1; + t.nanosec = 0; + + sos_thread_sleep(& t); + + sos_disable_IRQs(flags); + + /* The IDLE task is EXcluded in the following computation */ + sos_load_get_sload(&load1, &load5, &load15); + sos_load_to_string(str1, load1); + sos_load_to_string(str5, load5); + sos_load_to_string(str15, load15); + sos_x86_videomem_printf(16, 34, + SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "Kernel (- Idle): %s %s %s ", + str1, str5, str15); + + sos_load_get_uload(&load1, &load5, &load15); + sos_load_to_string(str1, load1); + sos_load_to_string(str5, load5); + sos_load_to_string(str15, load15); + sos_x86_videomem_printf(17, 34, + SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "User: %s %s %s ", + str1, str5, str15); + + sos_load_get_uratio(&load1, &load5, &load15); + sos_load_to_string(str1, load1); + sos_load_to_string(str5, load5); + sos_load_to_string(str15, load15); + sos_x86_videomem_printf(18, 34, + SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "User CPU %%: %s %s %s ", + str1, str5, str15); + + /* The IDLE task is INcluded in the following computation */ + sos_load_get_sratio(&load1, &load5, &load15); + sos_load_to_string(str1, load1); + sos_load_to_string(str5, load5); + sos_load_to_string(str15, load15); + sos_x86_videomem_printf(19, 34, + SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "Kernel CPU %% (+ Idle): %s %s %s ", + str1, str5, str15); + sos_restore_IRQs(flags); + } +} + + +/* ====================================================================== + * The C entry point of our operating system + */ +void sos_main(unsigned long magic, unsigned long addr) +{ + unsigned i; + sos_paddr_t sos_kernel_core_base_paddr, sos_kernel_core_top_paddr; + struct sos_time tick_resolution; + + /* Grub sends us a structure, called multiboot_info_t with a lot of + precious informations about the system, see the multiboot + documentation for more information. */ + multiboot_info_t *mbi; + mbi = (multiboot_info_t *) addr; + + /* Setup bochs and console, and clear the console */ + sos_bochs_setup(); + + sos_x86_videomem_setup(); + sos_x86_videomem_cls(SOS_X86_VIDEO_BG_BLUE); + + /* Greetings from SOS */ + if (magic == MULTIBOOT_BOOTLOADER_MAGIC) + /* Loaded with Grub */ + sos_x86_videomem_printf(1, 0, + SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "Welcome From GRUB to %s%c RAM is %dMB (upper mem = 0x%x kB)", + "SOS article 7", ',', + (unsigned)(mbi->mem_upper >> 10) + 1, + (unsigned)mbi->mem_upper); + else + /* Not loaded with grub */ + sos_x86_videomem_printf(1, 0, + SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "Welcome to SOS article 7"); + + sos_bochs_putstring("Message in a bochs: This is SOS article 7.\n"); + + /* Setup CPU segmentation and IRQ subsystem */ + sos_gdt_subsystem_setup(); + sos_idt_subsystem_setup(); + + /* Setup SOS IRQs and exceptions subsystem */ + sos_exception_subsystem_setup(); + sos_irq_subsystem_setup(); + + /* Configure the timer so as to raise the IRQ0 at a 100Hz rate */ + sos_i8254_set_frequency(100); + + /* Setup the kernel time subsystem to get prepared to take the timer + ticks into account */ + tick_resolution = (struct sos_time) { .sec=0, .nanosec=10000000UL }; + sos_time_subsysem_setup(& tick_resolution); + + /* We need a multiboot-compliant boot loader to get the size of the RAM */ + if (magic != MULTIBOOT_BOOTLOADER_MAGIC) + { + sos_x86_videomem_putstring(20, 0, + SOS_X86_VIDEO_FG_LTRED + | SOS_X86_VIDEO_BG_BLUE + | SOS_X86_VIDEO_FG_BLINKING, + "I'm not loaded with Grub !"); + /* STOP ! */ + for (;;) + continue; + } + + /* + * Some interrupt handlers + */ + + /* Binding some HW interrupts and exceptions to software routines */ + sos_irq_set_routine(SOS_IRQ_TIMER, + clk_it); + + /* + * Setup physical memory management + */ + + /* Multiboot says: "The value returned for upper memory is maximally + the address of the first upper memory hole minus 1 megabyte.". It + also adds: "It is not guaranteed to be this value." aka "YMMV" ;) */ + sos_physmem_subsystem_setup((mbi->mem_upper<<10) + (1<<20), + & sos_kernel_core_base_paddr, + & sos_kernel_core_top_paddr); + + /* + * Switch to paged-memory mode + */ + + /* Disabling interrupts should seem more correct, but it's not really + necessary at this stage */ + SOS_ASSERT_FATAL(SOS_OK == + sos_paging_subsystem_setup(sos_kernel_core_base_paddr, + sos_kernel_core_top_paddr)); + + /* Bind the page fault exception */ + sos_exception_set_routine(SOS_EXCEPT_PAGE_FAULT, + pgflt_ex); + + /* + * Setup kernel virtual memory allocator + */ + + if (sos_kmem_vmm_subsystem_setup(sos_kernel_core_base_paddr, + sos_kernel_core_top_paddr, + bootstrap_stack_bottom, + bootstrap_stack_bottom + + bootstrap_stack_size)) + sos_bochs_printf("Could not setup the Kernel virtual space allocator\n"); + + if (sos_kmalloc_subsystem_setup()) + sos_bochs_printf("Could not setup the Kmalloc subsystem\n"); + + /* + * Initialize the MMU context subsystem + */ + sos_mm_context_subsystem_setup(); + + /* + * Initialize the CPU context subsystem + */ + sos_cpu_context_subsystem_setup(); + + /* + * Bind the syscall handler to its software interrupt handler + */ + sos_swintr_subsystem_setup(); + + + /* + * Initialize the Kernel thread and scheduler subsystems + */ + + /* Initialize kernel thread subsystem */ + sos_thread_subsystem_setup(bootstrap_stack_bottom, + bootstrap_stack_size); + + /* Initialize the scheduler */ + sos_sched_subsystem_setup(); + + /* Declare the IDLE thread */ + SOS_ASSERT_FATAL(sos_create_kernel_thread("idle", idle_thread, NULL, + SOS_SCHED_PRIO_TS_LOWEST) != NULL); + + /* Prepare the stats subsystem */ + sos_load_subsystem_setup(); + + /* Declare a thread that prints some stats */ + SOS_ASSERT_FATAL(sos_create_kernel_thread("stat_thread", stat_thread, + NULL, + SOS_SCHED_PRIO_TS_LOWEST) != NULL); + + + /* + * Initialize process stuff + */ + sos_process_subsystem_setup(); + + + /* Enabling the HW interrupts here, this will make the timer HW + interrupt call the scheduler */ + asm volatile ("sti\n"); + + /* Run some tests involving USER processes and threads */ + extern void test_art7(); + test_art7(); + + /* Now run some Kernel threads just for fun ! */ + extern void MouseSim(); + MouseSim(); + test_thread(); + + /* + * We can safely exit from this function now, for there is already + * an idle Kernel thread ready to make the CPU busy working... + * + * However, we must EXPLICITELY call sos_thread_exit() because a + * simple "return" will return nowhere ! Actually this first thread + * was initialized by the Grub bootstrap stage, at a time when the + * word "thread" did not exist. This means that the stack was not + * setup in order for a return here to call sos_thread_exit() + * automagically. Hence we must call it manually. This is the ONLY + * kernel thread where we must do this manually. + */ + sos_bochs_printf("Bye from primary thread !\n"); + sos_thread_exit(); + SOS_FATAL_ERROR("No trespassing !"); +} diff --git a/sos/mouse_sim.c b/sos/mouse_sim.c new file mode 100644 index 0000000..736effe --- /dev/null +++ b/sos/mouse_sim.c @@ -0,0 +1,804 @@ +/*************************************************************************** + * Copyright (C) 2004 by cyril dupuit * + * cyrildupuit@hotmail.com * + * http://perso.wanadoo.fr/koalys/ * + * (Adaptation for SOS by d2 -- 2004/12/20) * + * * + * This program is free software; you can redistribute it and/or modify * + * it under the terms of the GNU General Public License as published by * + * the Free Software Foundation; either version 2 of the License, or * + * (at your option) any later version. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + ***************************************************************************/ + +//***************************************************************************** +// Nom du module : MouseSim.c +// Description : Creation et destruction de souris mangeuse de fromages +//***************************************************************************** + +#include +#include +#include +#include +#include +#include + +// Historique : +// 20/12/04 : Suppr DestroyMap et suppr handler kbd dans version LM (d2) +// 26/11/04 : Bug trouve et resolu dans la fonction DestroyMap +// 21/11/04 : Creation du module V1.0 + +//***************************************************************************** +// Definition des equivalences : +//***************************************************************************** +#define MAP_X 76 +#define MAP_Y 12 +#define MAP_SIZE MAP_X * MAP_Y + +#define MOUSE 0x01 +#define CHEESE 0x02 +#define OBSTACLE 0x04 +#define INPUT 0x08 +#define OUTPUT 0x10 + +#define OBSTACLE_COUNT 100 +#define CHEESE_COUNT 650 + +#define MOUSE_FULL 0x01 +#define MOUSE_EMPTY 0x02 +#define CHEESE_FOUND 0x04 +#define MOUSE_EXITED 0x08 + +#define MOUSE_SPEED_MAX 1000 +#define MOUSE_SPEED_MIN 4 + +typedef unsigned int Color_t; + +struct Point{ + int X; + int Y; + }; + +typedef struct Point Point_t; + +#define Set(Reg, Flag) Reg = (Reg | Flag) +#define Reset(Reg, Flag) Reg = (Reg &(~Flag)) +#define IsSet(Reg, Flag) (Reg & Flag) + + +//***************************************************************************** +// Structure de gestion d'un element +//***************************************************************************** +struct Element{ + sos_ui32_t Type;//Type d'element + sos_ui32_t Status; + Color_t Color;//Couleur de l'element + Point_t P;//Coordonnees de l'element + struct sos_thread * ThreadID;//Thread associe a la souris + int Way;//Direction de la souris + }; + +typedef struct Element Element_t; + +//***************************************************************************** +// Prototypes des fonctions/procedures : +//***************************************************************************** +static void DrawMap(void); +static sos_ret_t CreateMap(void); +static sos_ret_t InitMapInput(Element_t * * pMap); +static sos_ret_t InitMapOutput(Element_t * * pMap); +static sos_ret_t ElementInit(Element_t * * pMap, unsigned int Type); +static void Mouse(unsigned long Param); +static void MouseMove(Point_t * P); +static Point_t ChoosePosition(Element_t * pMouse, int Positions[], int Count); +static int EvaluatePositions(Point_t Org, int Positions[], Point_t * Cheese); +static sos_bool_t IsCollision(Point_t Org, Point_t p, Point_t *Cheese); +static sos_bool_t AffectMovement(Point_t Org, Point_t p); +static void MouseCreator(void); +static sos_ret_t CreateMouse(void); + +//***************************************************************************** +// Variables globales de ce module : +//***************************************************************************** + +static Element_t * * pMap; +static struct sos_ksema SemMap; +static struct sos_ksema SemMouse; +static int MouseCount = 0; +static int CheeseCount = 0; +static int ObstacleCount = 0; +static int MouseSpeed = 100; + +//***************************************************************************** +// Koalys Glue +//***************************************************************************** +void DrawPixel(int x, int y, Color_t color) +{ + sos_x86_videomem_putchar(y+3, x+2, color, 219); +} + + + +//***************************************************************************** +// Point d'entre de la 'simulation' +//***************************************************************************** +void MouseSim(void) +{ + //Creation du semaphore de protection de la carte + SOS_ASSERT_FATAL(SOS_OK == sos_ksema_init(& SemMap, "SemMap", 1, + SOS_KWQ_ORDER_FIFO)); + + //Creation du semaphore de creation de souris + SOS_ASSERT_FATAL(SOS_OK == sos_ksema_init(& SemMouse, "SemMouse", 2, + SOS_KWQ_ORDER_FIFO)); + + //Creation de la carte + SOS_ASSERT_FATAL(SOS_OK == CreateMap()); + + //Creation du thread createur de souris + SOS_ASSERT_FATAL(sos_create_kernel_thread("MouseCreator", + (sos_kernel_thread_start_routine_t)MouseCreator, + 0, SOS_SCHED_PRIO_TS_LOWEST-1) != NULL); + +} + + +//***************************************************************************** +// But de la fonction : Creer et initialiser la carte +// Entree : Aucune +// Parametre retourne : ERROR si la memoire est insuffisante, TRUE sinon +//***************************************************************************** +static sos_ret_t CreateMap(void) +{ + pMap = (Element_t * *)sos_kmalloc(MAP_SIZE * sizeof(Element_t *), 0); + if(pMap == NULL) return -SOS_ENOMEM; + + //Mettre la carte a 0 + memset(pMap, 0, MAP_SIZE * sizeof(Element_t *)); + + //Initialisation de l'entree de la carte + if(SOS_OK != InitMapInput(pMap)) + {//Memoire insuffisante + return -SOS_EFATAL; + } + + //Initialisation de la sortie de la carte + if(InitMapOutput(pMap) != SOS_OK) + {//Memoire insuffisante + return -SOS_EFATAL; + } + + //Initialisation du fromage + if(ElementInit(pMap, CHEESE) != SOS_OK) + {//Memoire insuffisante + return -SOS_EFATAL; + } + + //Initialisation des obstacles + if(ElementInit(pMap, OBSTACLE) != SOS_OK) + {//Memoire insuffisante + return -SOS_EFATAL; + } + + DrawMap();//Afficher la carte creee + + return SOS_OK; +} + +//***************************************************************************** +// But de la procedure : Dessiner la carte a l'ecran +// Entree : Aucune +// Sortie : Aucune +//***************************************************************************** +static void DrawMap(void) +{ + unsigned int I; + + for(I = 0; I < MAP_SIZE; I++) + { + if(pMap[I] != NULL) + { + DrawPixel(I % MAP_X, I/MAP_X, pMap[I]->Color); + } + else DrawPixel(I % MAP_X, I/MAP_X, SOS_X86_VIDEO_FG_BLACK); + } + sos_x86_videomem_printf(23, 0, SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "Souris = %d; Fromages = %d; Obstacles = %d ", + MouseCount, CheeseCount, ObstacleCount); +} + +//***************************************************************************** +// But de la fonction : Initialiser l'entree de la carte +// Entree : +// pMap : Pointeur sur la carte +// Parametre retourne : ERROR si memoire insuffisante, TRUE sinon +//***************************************************************************** +static sos_ret_t InitMapInput(Element_t * * pMap) +{ + Element_t * pElement; + + //Definir le point d'entree + pElement = (Element_t *)sos_kmalloc(sizeof(Element_t), 0); + if(pElement == NULL) return -SOS_ENOMEM; + + //Initialiser l'entree + pElement->Type = INPUT; + pElement->Status = 0; + pElement->Color = SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE; + pElement->P.X = 0; + pElement->P.Y = MAP_Y / 2; + pElement->ThreadID = 0; + + pMap[(pElement->P.Y * MAP_X) + pElement->P.X] = pElement; + + return SOS_OK; +} + +//***************************************************************************** +// But de la fonction : Initialiser la sortie de la carte +// Entree : +// pMap : Pointeur sur la carte +// Parametre retourne : ERROR si memoire insuffisante, TRUE sinon +//***************************************************************************** +static sos_ret_t InitMapOutput(Element_t * * pMap) +{ + Element_t * pElement; + + //Definir le point de sortie + pElement = (Element_t *)sos_kmalloc(sizeof(Element_t), 0); + if(pElement == NULL) return -SOS_ENOMEM; + + //Initialiser l'entree + pElement->Type = OUTPUT; + pElement->Status = 0; + pElement->Color = SOS_X86_VIDEO_FG_LTBLUE; + pElement->P.X = MAP_X - 1; + pElement->P.Y = MAP_Y / 2; + pElement->ThreadID = 0; + + pMap[(pElement->P.Y * MAP_X) + pElement->P.X] = pElement; + + return SOS_OK; +} + +//***************************************************************************** +// But de la fonction : Initialiser un type d'objet sur la carte +// Entree : +// pMap : Pointeur sur la carte +// Type : Type d'objet a initialiser +// Parametre retourne : ERROR si memoire insuffisante, TRUE sinon +//***************************************************************************** +static sos_ret_t ElementInit(Element_t * * pMap, unsigned int Type) +{ + unsigned int I, J; + unsigned int Max; + Color_t Color; + + if(Type == CHEESE) + {//Type d'element = fromage + Max = CHEESE_COUNT; + Color = SOS_X86_VIDEO_FG_YELLOW; + } + else if(Type == OBSTACLE) + {//Type d'element = Obstacle + Max = OBSTACLE_COUNT; + Color = SOS_X86_VIDEO_FG_GREEN; + } + else + {//Aucune autre type reconnu + return -SOS_EINVAL; + } + + for(I = 0; I < Max; I++) + {//Tirer les fromages + J = random(); + J += random(); + J %= MAP_SIZE; + if(pMap[J] == NULL) + {//Si l'emplacement est libre + pMap[J] = (Element_t *)sos_kmalloc(sizeof(Element_t), + 0); + if(pMap[J] == NULL) return -SOS_ENOMEM; + + pMap[J]->Type = Type; + //Initialiser l'element + if(Type == CHEESE) + {//Type d'element = fromage + CheeseCount++; + } + else if(Type == OBSTACLE) + {//Type d'element = Obstacle + ObstacleCount++; + } + + pMap[J]->Color = Color; + pMap[J]->Status = 0; + pMap[J]->Color = Color; + pMap[J]->P.X = J % MAP_X; + pMap[J]->P.Y = J / MAP_X; + pMap[J]->ThreadID = 0; + } + } + + return SOS_OK; +} + + +//***************************************************************************** +// But du thread : Deplacer la souris sur la carte selon les regles etablies. +// Regles : +// - La souris doit se placer devant l'entree puis commence a recolter du +// fromage. +// - Des que la souris a ramasse un morceau de fromage, elle doit aller en +// entree de la carte afin de deposer sa recolte. +// - Si une souris a prouve sa recolte, une autre souris est creee. +// - Si une souris prend la sortie, elle est eliminee. +//***************************************************************************** +static void Mouse(unsigned long Param) +{ + Element_t * pMouse = (Element_t *)Param; + Point_t P; + + SOS_ASSERT_FATAL(pMouse != NULL); + + //Position de depart de la souris + P = pMouse->P; + P = pMouse->P; + + while(1) + { + int delay_ms; + struct sos_time delay; + + //La souris doit se deplacer + sos_ksema_down(& SemMap, NULL); + + MouseMove(&P); + + sos_ksema_up(& SemMap); + + // Est-ce que la souris est sortie ? + if (IsSet(pMouse->Status, MOUSE_EXITED)) + // Oui => on sort + break; + + // Delai entre MOUSE_SPEED_MIN et MouseSpeed - 1 + delay_ms = MOUSE_SPEED_MIN + (random() % MouseSpeed); + delay.sec = delay_ms / 1000; + delay.nanosec = (delay_ms % 1000) * 1000000; + sos_thread_sleep(& delay); + } + + // Libere la structure associee + sos_kfree((sos_vaddr_t)pMouse); +} + +//***************************************************************************** +// But de la procedure : Deplacer la souris de maniere aleatoire sur la carte +// Entrees : +// P : Position courante de la souris +// Sorties : +// P : Position suivante de la souris +//***************************************************************************** +static void MouseMove(Point_t * P) +{ + Point_t Org; + Point_t p; + Point_t Cheese; + int Positions[8]; + int Count = 0; + Element_t * pMouse; + + Org = *P; + + pMouse = pMap[Org.X + (Org.Y * MAP_X)]; + + Count = EvaluatePositions(Org, Positions, &Cheese); + + if(Count == 0) return; + + p = Org; + + if(IsSet(pMouse->Status, CHEESE_FOUND)) + {//Prendre le fromage + Reset(pMouse->Status, CHEESE_FOUND); + p = Cheese; + } + else + {//Choisir une position au hasard + p = ChoosePosition(pMouse, Positions, Count); + } + if(AffectMovement(Org, p) == FALSE) return; + //Deplacer la souris + pMap[Org.X + (Org.Y * MAP_X)] = NULL; + pMap[p.X + (p.Y * MAP_X)] = pMouse; + pMouse->P = p; + //Mettre a jour l'affichage + DrawPixel(Org.X, Org.Y, SOS_X86_VIDEO_FG_BLACK); + DrawPixel(p.X, p.Y, pMouse->Color); + sos_x86_videomem_printf( 23,0, SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, "Souris = %d; Fromages = %d; Obstacles = %d ", MouseCount, CheeseCount, ObstacleCount); + //Mettre a jour les coordonnees + *P = p; +} + +//***************************************************************************** +// But de la fonction : Choisir un mouvement +// Entree : +// pMouse : Pointeur sur la souris +// Positions : Tableau de position possible +// Count :Nombre de positions valides +// Sortie : Aucune +// Parametre retourne : Position choisie +//***************************************************************************** +static Point_t ChoosePosition(Element_t * pMouse, int Positions[], int Count) +{ + int I, J; + Point_t p; + + for(J = 0; J < Count; J++) + {//Chercher dans le tableau si cette position est disponible + I = Positions[J]; + if(I == pMouse->Way) + {//Poursuivre ce sens d'avance + p = pMouse->P; + switch(I) + { + case 0: + p.Y++; + break; + case 1: + p.X++; + p.Y++; + break; + case 2: + p.X++; + break; + case 3: + p.Y--; + p.X++; + break; + case 4: + p.Y--; + break; + case 5: + p.Y--; + p.X--; + break; + case 6: + p.X--; + break; + case 7: + p.X--; + p.Y++; + break; + } + return p; + } + } + + J = random() % Count; + I = Positions[J]; + if(((I + 4) % 8) == pMouse->Way) + {//Eviter le sens inverse + J = (J + 1) % Count; + I = Positions[J]; + } + + p = pMouse->P; + switch(I) + {//Repere le deplacement + case 0: + p.Y++; + break; + case 1: + p.X++; + p.Y++; + break; + case 2: + p.X++; + break; + case 3: + p.Y--; + p.X++; + break; + case 4: + p.Y--; + break; + case 5: + p.Y--; + p.X--; + break; + case 6: + p.X--; + break; + case 7: + p.X--; + p.Y++; + break; + } + + pMouse->Way = I;//Memoriser la direction selectionnee + + return p; +} + +//***************************************************************************** +// But de la fonction : Evaluer les positions possibles et les memoriser dans +// un tableau de positions si aucun fromage n'a ete detecte. Si du fromage a +// ete detecte, il sera selectionne en premier. La presence d'un fromage est +// indiquee par le drapeau CHEESE_FOUND +// Entree : +// Org : Position de la souris +// Sorties : +// Positions : Tableau de positions valides +// Cheese : Position du fromage +// Parametre retourne : Nombre de positions valides +//***************************************************************************** +static int EvaluatePositions(Point_t Org, int Positions[], Point_t * Cheese) +{ + int I; + int Count = 0; + Point_t p; + Point_t CheesePos; + + for(I = 0; I < 8; I++) + {//Explorer toute les directions + p = Org; + switch(I) + {//Repere le deplacement + case 0: + p.Y++; + break; + case 1: + p.X++; + p.Y++; + break; + case 2: + p.X++; + break; + case 3: + p.Y--; + p.X++; + break; + case 4: + p.Y--; + break; + case 5: + p.Y--; + p.X--; + break; + case 6: + p.X--; + break; + case 7: + p.X--; + p.Y++; + break; + } + //Tester la collision + if(IsCollision(Org, p, &CheesePos) == FALSE) + {//La souris n'a rencontre aucun obstacle + Positions[Count] = I; + Count++; + } + } + + *Cheese = CheesePos; + + return Count; +} + +//***************************************************************************** +// But de la fonction : Affecter un mouvement a la souris +// Entrees : +// Org : Coordonnees de la souris +// p : Coordonnees voulu par la souris +// Parametre retourne : TRUE si le mouvement a eu lieu, FALSE sinon +//***************************************************************************** +static sos_bool_t AffectMovement(Point_t Org, Point_t p) +{ + Element_t * pMouse = pMap[Org.X + (Org.Y * MAP_X)]; + Element_t * pElement; + + pElement = pMap[p.X + (p.Y * MAP_X)]; + + //La place est libre + if(pElement == NULL) return TRUE;//Autoriser le mouvement + + switch(pElement->Type) + { + case CHEESE: + // Liberer l'emplacement memoire du fromage + sos_kfree((sos_vaddr_t)pElement); + pMap[p.X + (p.Y * MAP_X)] = NULL; + + //Donner le fromage a la souris + Set(pMouse->Status, MOUSE_FULL); + Reset(pMouse->Status, MOUSE_EMPTY); + pMouse->Color = SOS_X86_VIDEO_FG_MAGENTA; + CheeseCount--; + return TRUE; + case OUTPUT: + //Supprimer la souris + pMap[Org.X + (Org.Y * MAP_X)] = NULL; + MouseCount--; + DrawPixel(Org.X, Org.Y, SOS_X86_VIDEO_FG_BLACK); + sos_x86_videomem_printf( 23,0, SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, + "Souris = %d; Fromages = %d; Obstacles = %d ", + MouseCount, CheeseCount, + ObstacleCount); + Set(pMouse->Status, MOUSE_EXITED); + return FALSE; + default : + return FALSE; + } + + return FALSE; +} + +//***************************************************************************** +// But de la fonction : Tester si une collision a eu lieu avec un obstacle +// Entrees : +// Org : Coordonnees de la souris +// p : coordonnees desirees par la souris +// Sortie : +// Cheese : Coordonnees du fromage +// Parametre retourne : TRUE si une collision a eu lieu, FALSE sinon +//***************************************************************************** +static sos_bool_t IsCollision(Point_t Org, Point_t p, Point_t *Cheese) +{ + Element_t * pMouse = pMap[Org.X + (Org.Y * MAP_X)]; + Element_t * pElement; + + //Tester les bordures de la map + if((p.X < 0)||(p.Y < 0)) return TRUE; + + if((p.Y >= MAP_Y)||(p.X >= MAP_X)) return TRUE; + + pElement = pMap[p.X + (p.Y * MAP_X)]; + + //L'element est vide + if(pElement == NULL) return FALSE; + + //Si du fromage a ete trouve, stopper la recherche + if(IsSet(pMouse->Status, CHEESE_FOUND)) return FALSE; + + switch(pElement->Type) + { + case CHEESE: + if(IsSet(pMouse->Status, MOUSE_FULL)) return TRUE; + //Indiquer que du fromage a ete trouve + Set(pMouse->Status, CHEESE_FOUND); + //Retenir la position du fromage + (*Cheese).X = p.X; + (*Cheese).Y = p.Y; + break; + case INPUT: + if(IsSet(pMouse->Status, MOUSE_EMPTY)) return TRUE; + //Remplir les reserves de fromage + Set(pMouse->Status, MOUSE_EMPTY); + Reset(pMouse->Status, MOUSE_FULL); + pMouse->Color = SOS_X86_VIDEO_FG_LTRED; + //Autoriser la creation d'une autre souris + sos_ksema_up(& SemMouse); + return TRUE; + case OUTPUT: + break; + default : + return TRUE; + } + + return FALSE;//Aucune collision +} + +//***************************************************************************** +// But du thread : Creer une souris et la placer autour de l'entree +//***************************************************************************** +static void MouseCreator(void) +{ + while(1) + { + sos_ksema_down(& SemMouse, NULL); + sos_ksema_down(& SemMap, NULL); + CreateMouse(); + sos_ksema_up(& SemMap); + } +} + +//***************************************************************************** +// But de la fonction : Creer une souris et l'inserer dans la carte +// Entree : Aucune +// Parametre retourne : ERROR si memoire insuffisante, FALSE si souris non +// cree, TRUE sinon +//***************************************************************************** +static sos_ret_t CreateMouse(void) +{ + Element_t * pElement; + unsigned int I; + + Point_t p; + + for(I = 0; I < 8; I++) + {//Explorer tous les emplacements + p.X = 0; + p.Y = MAP_Y / 2; + switch(I) + {//Repere le deplacement + case 0: + p.Y++; + break; + case 1: + p.X++; + p.Y++; + break; + case 2: + p.X++; + break; + case 3: + p.Y--; + p.X++; + break; + case 4: + p.Y--; + break; + case 5: + p.Y--; + p.X--; + break; + case 6: + p.X--; + break; + case 7: + p.X--; + p.Y++; + break; + } + if((p.X >= 0)&&(p.Y >= 0)&&(p.X < MAP_X)&&(p.Y < MAP_Y)) + {//L'emplacement est valide + pElement = pMap[p.X + (p.Y * MAP_X)]; + if(pElement == NULL) + {//Creer la souris + pElement = (Element_t *)sos_kmalloc(sizeof(Element_t), 0); + if(pElement != NULL) + {//Initialiser l'entree + pElement->Type = MOUSE; + Set(pElement->Status, MOUSE_EMPTY); + pElement->Color = SOS_X86_VIDEO_FG_LTRED; + pElement->P = p; + pElement->Way = 0; + pElement->ThreadID + = sos_create_kernel_thread("Mouse", + (sos_kernel_thread_start_routine_t)Mouse, + pElement, SOS_SCHED_PRIO_TS_LOWEST-1); + if(pElement->ThreadID == 0) + { + sos_kfree((sos_vaddr_t)pElement); + pElement = NULL; + return -SOS_ENOMEM; + } + pMap[p.X + (p.Y * MAP_X)] = pElement; + MouseCount++; + + DrawPixel(p.X, p.Y, pElement->Color); + sos_x86_videomem_printf(23, 0, SOS_X86_VIDEO_FG_YELLOW | SOS_X86_VIDEO_BG_BLUE, "Souris = %d; Fromages = %d; Obstacles = %d ", MouseCount, CheeseCount, ObstacleCount); + + return SOS_OK; + } + } + } + } + return -SOS_EBUSY; +} + +//***************************************************************************** +// C'est fini !!!! +//***************************************************************************** diff --git a/sos/physmem.c b/sos/physmem.c new file mode 100644 index 0000000..4d6fa0b --- /dev/null +++ b/sos/physmem.c @@ -0,0 +1,385 @@ +/* Copyright (C) 2004 David Decotigny + Copyright (C) 2000 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include +#include +#include + +#include "physmem.h" + +/** A descriptor for a physical page in SOS */ +struct physical_page_descr +{ + /** The physical base address for the page */ + sos_paddr_t paddr; + + /** The reference count for this physical page. > 0 means that the + page is in the nonfree list. */ + sos_count_t ref_cnt; + + /** + * An additional counter for user-defined use. The management of this + * counter is up to the user, however a simple set of rules applies: + * - it can only be incremented/decremented if the page is referenced + * - when it reaches 0, no automatic action is taken + * The first rule means in particular that a page whose reference + * count reaches 0 (=> will be freed) cannot have a custom_count + * value > 0 ! The system will be HALTED if this ever happens + */ + sos_count_t occupation_cnt; + + + /** Some data associated with the page when it is mapped in kernel space */ + struct sos_kmem_range *kernel_range; + + /** The other pages on the list (nonfree, free) */ + struct physical_page_descr *prev, *next; +}; + +/** These are some markers present in the executable file (see sos.lds) */ +extern char __b_kernel, __e_kernel; + +/** The array of ppage descriptors will be located at this address */ +#define PAGE_DESCR_ARRAY_ADDR \ + SOS_PAGE_ALIGN_SUP((sos_paddr_t) (& __e_kernel)) +static struct physical_page_descr * physical_page_descr_array; + +/** The list of physical pages currently available */ +static struct physical_page_descr *free_ppage; + +/** The list of physical pages currently allocated */ +static struct physical_page_descr *nonfree_ppage; + +/** We will store here the interval of valid physical addresses */ +static sos_paddr_t physmem_base, physmem_top; + +/** We store the number of pages nonfree/free */ +static sos_count_t physmem_total_pages, physmem_nonfree_pages; + +sos_ret_t sos_physmem_subsystem_setup(sos_size_t ram_size, + /* out */sos_paddr_t *kernel_core_base, + /* out */sos_paddr_t *kernel_core_top) +{ + /* The iterator over the page descriptors */ + struct physical_page_descr *ppage_descr; + + /* The iterator over the physical addresses */ + sos_paddr_t ppage_addr; + + /* Make sure ram size is aligned on a page boundary */ + ram_size = SOS_PAGE_ALIGN_INF(ram_size);/* Yes, we may lose at most a page */ + + /* Reset the nonfree/free page lists before building them */ + free_ppage = nonfree_ppage = NULL; + physmem_total_pages = physmem_nonfree_pages = 0; + + /* Make sure that there is enough memory to store the array of page + descriptors */ + *kernel_core_base = SOS_PAGE_ALIGN_INF((sos_paddr_t)(& __b_kernel)); + *kernel_core_top + = PAGE_DESCR_ARRAY_ADDR + + SOS_PAGE_ALIGN_SUP( (ram_size >> SOS_PAGE_SHIFT) + * sizeof(struct physical_page_descr)); + if (*kernel_core_top > ram_size) + return -SOS_ENOMEM; + + /* Page 0-4kB is not available in order to return address 0 as a + means to signal "no page available" */ + physmem_base = SOS_PAGE_SIZE; + physmem_top = ram_size; + + /* Setup the page descriptor arrray */ + physical_page_descr_array + = (struct physical_page_descr*)PAGE_DESCR_ARRAY_ADDR; + + /* Scan the list of physical pages */ + for (ppage_addr = 0, + ppage_descr = physical_page_descr_array ; + ppage_addr < physmem_top ; + ppage_addr += SOS_PAGE_SIZE, + ppage_descr ++) + { + enum { PPAGE_MARK_RESERVED, PPAGE_MARK_FREE, + PPAGE_MARK_KERNEL, PPAGE_MARK_HWMAP } todo; + + memset(ppage_descr, 0x0, sizeof(struct physical_page_descr)); + + /* Init the page descriptor for this page */ + ppage_descr->paddr = ppage_addr; + + /* Reserved : 0 ... base */ + if (ppage_addr < physmem_base) + todo = PPAGE_MARK_RESERVED; + + /* Free : base ... BIOS */ + else if ((ppage_addr >= physmem_base) + && (ppage_addr < BIOS_N_VIDEO_START)) + todo = PPAGE_MARK_FREE; + + /* Used : BIOS */ + else if ((ppage_addr >= BIOS_N_VIDEO_START) + && (ppage_addr < BIOS_N_VIDEO_END)) + todo = PPAGE_MARK_HWMAP; + + /* Free : BIOS ... kernel */ + else if ((ppage_addr >= BIOS_N_VIDEO_END) + && (ppage_addr < (sos_paddr_t) (& __b_kernel))) + todo = PPAGE_MARK_FREE; + + /* Used : Kernel code/data/bss + physcal page descr array */ + else if ((ppage_addr >= *kernel_core_base) + && (ppage_addr < *kernel_core_top)) + todo = PPAGE_MARK_KERNEL; + + /* Free : first page of descr ... end of RAM */ + else + todo = PPAGE_MARK_FREE; + + /* Actually does the insertion in the nonfree/free page lists */ + physmem_total_pages ++; + switch (todo) + { + case PPAGE_MARK_FREE: + ppage_descr->ref_cnt = 0; + list_add_head(free_ppage, ppage_descr); + break; + + case PPAGE_MARK_KERNEL: + case PPAGE_MARK_HWMAP: + ppage_descr->ref_cnt = 1; + list_add_head(nonfree_ppage, ppage_descr); + physmem_nonfree_pages ++; + break; + + default: + /* Reserved page: nop */ + break; + } + } + + return SOS_OK; +} + + +sos_paddr_t sos_physmem_ref_physpage_new(sos_bool_t can_block) +{ + struct physical_page_descr *ppage_descr; + + if (! free_ppage) + return (sos_paddr_t)NULL; + + /* Retrieve a page in the free list */ + ppage_descr = list_pop_head(free_ppage); + + /* The page is assumed not to be already in the nonfree list */ + SOS_ASSERT_FATAL(ppage_descr->ref_cnt == 0); + + /* Mark the page as nonfree (this of course sets the ref count to 1) */ + ppage_descr->ref_cnt ++; + + /* The page descriptor should be unmodified since previous + deallocation. Otherwise this means that something unauthorized + overwrote the page descriptor table contents ! */ + SOS_ASSERT_FATAL(ppage_descr->occupation_cnt == 0); + SOS_ASSERT_FATAL(ppage_descr->kernel_range == NULL); + + /* Put the page in the nonfree list */ + list_add_tail(nonfree_ppage, ppage_descr); + physmem_nonfree_pages ++; + + return ppage_descr->paddr; +} + + +/** + * Helper function to get the physical page descriptor for the given + * physical page address. + * + * @return NULL when out-of-bounds or non-page-aligned + */ +inline static struct physical_page_descr * +get_page_descr_at_paddr(sos_paddr_t ppage_paddr) +{ + /* Don't handle non-page-aligned addresses */ + if (ppage_paddr & SOS_PAGE_MASK) + return NULL; + + /* Don't support out-of-bounds requests */ + if ((ppage_paddr < physmem_base) || (ppage_paddr >= physmem_top)) + return NULL; + + return physical_page_descr_array + (ppage_paddr >> SOS_PAGE_SHIFT); +} + + +sos_ret_t sos_physmem_ref_physpage_at(sos_paddr_t ppage_paddr) +{ + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return -SOS_EINVAL; + + /* Increment the reference count for the page */ + ppage_descr->ref_cnt ++; + + /* If the page is newly referenced (ie we are the only owners of the + page => ref cnt == 1), transfer it in the nonfree pages list */ + if (ppage_descr->ref_cnt == 1) + { + /* The page descriptor should be unmodified since previous + deallocation. Otherwise this means that something unauthorized + overwrote the page descriptor table contents ! */ + SOS_ASSERT_FATAL(ppage_descr->occupation_cnt == 0); + SOS_ASSERT_FATAL(ppage_descr->kernel_range == NULL); + + list_delete(free_ppage, ppage_descr); + list_add_tail(nonfree_ppage, ppage_descr); + physmem_nonfree_pages ++; + + /* The page is newly referenced */ + return FALSE; + } + + /* The page was already referenced by someone */ + return TRUE; +} + + +sos_ret_t +sos_physmem_unref_physpage(sos_paddr_t ppage_paddr) +{ + /* By default the return value indicates that the page is still + used */ + sos_ret_t retval = FALSE; + + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return -SOS_EINVAL; + + /* Don't do anything if the page is not in the nonfree list */ + if (ppage_descr->ref_cnt <= 0) + return -SOS_EINVAL; + + /* Unreference the page, and, when no mapping is active anymore, put + the page in the free list */ + ppage_descr->ref_cnt--; + if (ppage_descr->ref_cnt == 0) + { + /* Make sure that the occupation counter is set to 0 */ + SOS_ASSERT_FATAL(ppage_descr->occupation_cnt == 0); + + /* Reset associated kernel range */ + ppage_descr->kernel_range = NULL; + + /* Transfer the page, considered NON-FREE, to the free list */ + list_delete(nonfree_ppage, ppage_descr); + physmem_nonfree_pages --; + list_add_head(free_ppage, ppage_descr); + + /* Indicate that the page is now unreferenced */ + retval = TRUE; + } + + /* The page was already referenced by someone */ + return retval; +} + + +sos_ret_t sos_physmem_get_physpage_refcount(sos_paddr_t ppage_paddr) +{ + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return -SOS_EINVAL; + + return ppage_descr->ref_cnt; +} + + +sos_ret_t sos_physmem_inc_physpage_occupation(sos_paddr_t ppage_paddr) +{ + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return -SOS_EINVAL; + + /* Don't do anything if the page is not in the nonfree list */ + SOS_ASSERT_FATAL(ppage_descr->ref_cnt > 0); + + ppage_descr->occupation_cnt ++; + return (ppage_descr->occupation_cnt > 1); +} + + +sos_ret_t sos_physmem_dec_physpage_occupation(sos_paddr_t ppage_paddr) +{ + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return -SOS_EINVAL; + + /* Don't do anything if the page is not in the nonfree list */ + SOS_ASSERT_FATAL(ppage_descr->ref_cnt > 0); + SOS_ASSERT_FATAL(ppage_descr->occupation_cnt > 0); + + ppage_descr->occupation_cnt --; + return (ppage_descr->occupation_cnt == 0); +} + + +struct sos_kmem_range* sos_physmem_get_kmem_range(sos_paddr_t ppage_paddr) +{ + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return NULL; + + return ppage_descr->kernel_range; +} + + +sos_ret_t sos_physmem_set_kmem_range(sos_paddr_t ppage_paddr, + struct sos_kmem_range *range) +{ + struct physical_page_descr *ppage_descr + = get_page_descr_at_paddr(ppage_paddr); + + if (! ppage_descr) + return -SOS_EINVAL; + + ppage_descr->kernel_range = range; + return SOS_OK; +} + +sos_ret_t sos_physmem_get_state(/* out */sos_count_t *total_ppages, + /* out */sos_count_t *nonfree_ppages) +{ + if (total_ppages) + *total_ppages = physmem_total_pages; + if (nonfree_ppages) + *nonfree_ppages = physmem_nonfree_pages; + return SOS_OK; +} diff --git a/sos/physmem.h b/sos/physmem.h new file mode 100644 index 0000000..b3ba269 --- /dev/null +++ b/sos/physmem.h @@ -0,0 +1,202 @@ +/* Copyright (C) 2004 David Decotigny + Copyright (C) 2000 The KOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_PHYSMEM_H_ +#define _SOS_PHYSMEM_H_ + +/** + * @file physmem.h + * + * Physical pages of memory + */ + +#include +#include +#include + +/** The size of a physical page (arch-dependent) */ +#define SOS_PAGE_SIZE (4*1024) + +/** The corresponding shift */ +#define SOS_PAGE_SHIFT 12 /* 4 kB = 2^12 B */ + +/** The corresponding mask */ +#define SOS_PAGE_MASK ((1<<12) - 1) + +#define SOS_PAGE_ALIGN_INF(val) \ + SOS_ALIGN_INF((val), SOS_PAGE_SIZE) +#define SOS_PAGE_ALIGN_SUP(val) \ + SOS_ALIGN_SUP((val), SOS_PAGE_SIZE) +#define SOS_IS_PAGE_ALIGNED(val) \ + SOS_IS_ALIGNED((val), SOS_PAGE_SIZE) + +/** + * This is the reserved physical interval for the x86 video memory and + * BIOS area. In physmem.c, we have to mark this area as "nonfree" in + * order to prevent from allocating it. And in paging.c, we'd better + * map it in virtual space if we really want to be able to print to + * the screen (for debugging purpose, at least): for this, the + * simplest is to identity-map this area in virtual space (note + * however that this mapping could also be non-identical). + */ +#define BIOS_N_VIDEO_START 0xa0000 +#define BIOS_N_VIDEO_END 0x100000 + + +/** + * Initialize the physical memory subsystem, for the physical area [0, + * ram_size). This routine takes into account the BIOS and video + * areas, to prevent them from future allocations. + * + * @param ram_size The size of the RAM that will be managed by this subsystem + * + * @param kernel_core_base The lowest address for which the kernel + * assumes identity mapping (ie virtual address == physical address) + * will be stored here + * + * @param kernel_core_top The top address for which the kernel + * assumes identity mapping (ie virtual address == physical address) + * will be stored here + */ +sos_ret_t sos_physmem_subsystem_setup(sos_size_t ram_size, + /* out */sos_paddr_t *kernel_core_base, + /* out */sos_paddr_t *kernel_core_top); + +/** + * Retrieve the total number of pages, and the number of free pages + */ +sos_ret_t sos_physmem_get_state(/* out */sos_count_t *total_ppages, + /* out */sos_count_t *nonfree_ppages); + + +/** + * Get a free page. + * + * @return The (physical) address of the (physical) page allocated, or + * NULL when none currently available. + * + * @param can_block TRUE if the function is allowed to block + * @note The page returned has a reference count equal to 1. + */ +sos_paddr_t sos_physmem_ref_physpage_new(sos_bool_t can_block); + + +/** + * Increment the reference count of a given physical page. Useful for + * VM code which tries to map a precise physical address. + * + * @param ppage_paddr Physical address of the page (MUST be page-aligned) + * + * @return TRUE when the page was previously referenced, FALSE when + * the page was previously unreferenced, <0 when the page address is + * invalid. + */ +sos_ret_t sos_physmem_ref_physpage_at(sos_paddr_t ppage_paddr); + + +/** + * Decrement the reference count of the given physical page. When the + * reference count of the page reaches 0, the page is marked free, ie + * is available for future sos_physmem_ref_physpage_new() + * + * @param ppage_paddr Physical address of the page (MUST be page-aligned) + * + * @return FALSE when the page is still referenced, TRUE when the page + * is now unreferenced, <0 when the page address is invalid + */ +sos_ret_t sos_physmem_unref_physpage(sos_paddr_t ppage_paddr); + + +/** + * Return the reference count of the given page + * + * @return >= 0 (the referebce count of the page) if the physical + * address is valid, or an error status + */ +sos_ret_t sos_physmem_get_physpage_refcount(sos_paddr_t ppage_paddr); + + + +/* + * In some cases (Page Tables on x86 for example), the physical pages + * might contain a set of slots available for "allocation" (x86 + * example: a PT contains a set of PTE). We provide here a set of + * functions to manage a per-page additional counter that holds this + * number of slots currently in use in the page. + * + * A newly allocated physical page has a occupation count of 0. + * + * The management of this counter is up to the subsystem that manages + * the page (mainly: paging), however a simple set of rules applies: + * - it can only be incremented/decremented if the page is referenced + * - when it reaches 0, no automatic action is undertaken + * The first rule means in particular that a page whose reference + * count reaches 0 (=> being freed) cannot have a occupation_cnt + * value > 0 ! The system will be HALTED if this ever happens + */ + + +/** + * Increment the occupation count of the given physical page. + * + * @param ppage_paddr Physical address of the page (MUST be page-aligned) + * + * @return TRUE when the occupation count was previously NON-ZERO, FALSE + * when this occupation count was 0, <0 when the page address is invalid. + * + * @note the page MUST be marked as REFERENCED by somebody ! + */ +sos_ret_t sos_physmem_inc_physpage_occupation(sos_paddr_t ppage_paddr); + + +/** + * Decrement the occupation count of the given physical page. + * + * @param ppage_paddr Physical address of the page (MUST be page-aligned) + * + * @return FALSE when the occupation count is still NON-ZERO, TRUE when the + * page now is ZERO, <0 when the page address is invalid + * + * @note the page MUST be marked as REFERENCED by somebody ! + */ +sos_ret_t sos_physmem_dec_physpage_occupation(sos_paddr_t ppage_paddr); + + +#include + +/** + * Return the kernel memory allocation range associated with the given + * physical page, or NULL when page has no associated range + * + * @param ppage_paddr Physical address of the page (MUST be page-aligned) + */ +struct sos_kmem_range* sos_physmem_get_kmem_range(sos_paddr_t ppage_paddr); + + +/** + * Set the kernel memory allocation range associated to the given + * physical page. + * + * @param ppage_paddr Physical address of the page (MUST be page-aligned) + * + * @return error if page is invalid + */ +sos_ret_t sos_physmem_set_kmem_range(sos_paddr_t ppage_paddr, + struct sos_kmem_range *range); + +#endif /* _SOS_PHYSMEM_H_ */ diff --git a/sos/process.c b/sos/process.c new file mode 100644 index 0000000..9b1c855 --- /dev/null +++ b/sos/process.c @@ -0,0 +1,280 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include +#include + +#include + +#include "process.h" + + +#define SOS_PROCESS_MAX_NAMELEN 32 + + +/** + * Definition of a process in SOS. A process is basically the + * collection of all the resources requested by a user program. The + * threads are one of these resources, the mm_context is one other + * example of such resources. + */ +struct sos_process +{ + char name[SOS_PROCESS_MAX_NAMELEN]; + + /** First important resource: the MMU translation tables' + configuration */ + struct sos_mm_context *mm_context; + + /** Second important resource: the CPU execution contexts, aka the + threads executing in the context of this process. */ + struct sos_thread *thread_list; + sos_count_t nb_threads; + + /** Reference counter, including threads */ + sos_count_t ref_cnt; + + struct sos_process *prev, *next; +}; + + +/** The list of processes in the system */ +static struct sos_process *process_list = NULL; + + +/** The cache for the sos_process structures */ +struct sos_kslab_cache *cache_struct_process; + + +/** + * Helper function for debugging purposes + */ +void sos_process_dumplist() +{ + struct sos_thread * cur_thr = sos_thread_get_current(); + struct sos_process * proc; + int nb_procs; + + sos_bochs_printf("\n"); + list_foreach(process_list, proc, nb_procs) + { + struct sos_thread * thr; + int nb_thrs; + + sos_bochs_printf(" proc@%p: '%s', %d threads, %d refs\n", + proc, proc->name?proc->name:"(none)", + proc->nb_threads, proc->ref_cnt); + + list_foreach_forward_named(proc->thread_list, thr, nb_thrs, + prev_in_process, next_in_process) + { + if (thr == cur_thr) + sos_bochs_printf(" thr@%p: [CURRENT]\n", thr); + else + sos_bochs_printf(" thr@%p: %cstate=%d eip=%p\n", + thr, + sos_cpu_context_is_in_user_mode(thr->cpu_state)?'u':'k', + thr->state, + (void*)sos_cpu_context_get_PC(thr->cpu_state)); + } + } + sos_bochs_printf(" ======= %d processes =======\n", nb_procs); + sos_bochs_printf("\n"); +} + + +sos_ret_t sos_process_subsystem_setup() +{ + /* Create the cache for the process structures */ + cache_struct_process = sos_kmem_cache_create("struct_process", + sizeof(struct sos_process), + 3, + 0, + SOS_KSLAB_CREATE_MAP + | SOS_KSLAB_CREATE_ZERO); + if (! cache_struct_process) + return -SOS_ENOMEM; + + return SOS_OK; +} + + +struct sos_process *sos_process_create_empty(const char *name) +{ + sos_ui32_t flags; + struct sos_process *proc; + + proc = (struct sos_process*) sos_kmem_cache_alloc(cache_struct_process, 0); + if (! proc) + return NULL; + + /* proc is already filled with 0 (cache has SOS_KSLAB_CREATE_ZERO + flag) */ + + /* Initialize a new mm_context */ + proc->mm_context = sos_mm_context_create(); + if (NULL == proc->mm_context) + { + /* Error */ + sos_kmem_cache_free((sos_vaddr_t)proc); + return NULL; + } + + if (!name) + { + name = "[UNNAMED]"; + } + + strzcpy(proc->name, name, SOS_PROCESS_MAX_NAMELEN); + + /* Add it to the global list of processes */ + sos_disable_IRQs(flags); + list_add_tail(process_list, proc); + sos_restore_IRQs(flags); + + /* Mark the process as referenced */ + proc->ref_cnt = 1; + return proc; +} + + +inline +sos_ret_t sos_process_ref(struct sos_process *proc) +{ + sos_ui32_t flags; + sos_disable_IRQs(flags); + proc->ref_cnt ++; + sos_restore_IRQs(flags); + return SOS_OK; +} + + +sos_count_t sos_process_get_nb_threads(const struct sos_process *proc) +{ + sos_count_t retval; + sos_ui32_t flags; + sos_disable_IRQs(flags); + retval = proc->nb_threads; + sos_restore_IRQs(flags); + return retval; +} + + +struct sos_mm_context * +sos_process_get_mm_context(const struct sos_process *proc) +{ + return proc->mm_context; +} + + +/* *************************************************** + * Restricted functions + */ + + +sos_ret_t sos_process_register_thread(struct sos_process *in_proc, + struct sos_thread *thr) +{ + sos_ui32_t flags; + + /* The process is assumed to be referenced by somebody */ + SOS_ASSERT_FATAL(in_proc->ref_cnt > 0); + + /* Only threads that are being created are allowed to be attached to + a process */ + SOS_ASSERT_FATAL(thr->state == SOS_THR_CREATED); + + /* Update the list of the threads in the process */ + thr->process = in_proc; + + /* Increment the reference count for the process */ + sos_process_ref(in_proc); + + /* Add the thread to the process thread's list */ + sos_disable_IRQs(flags); + list_add_tail_named(in_proc->thread_list, thr, + prev_in_process, next_in_process); + in_proc->nb_threads ++; + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +/** The function responsible for releasing the resources held by the + process. */ +sos_ret_t sos_process_unref(struct sos_process *proc) +{ + sos_ui32_t flags; + sos_ret_t retval; + + SOS_ASSERT_FATAL(proc->ref_cnt > 0); + + sos_disable_IRQs(flags); + proc->ref_cnt --; + if (proc->ref_cnt > 0) + { + sos_restore_IRQs(flags); + return -SOS_EBUSY; + } + list_delete(process_list, proc); + sos_restore_IRQs(flags); + + /* First: release the mm_context */ + retval = sos_mm_context_unref(proc->mm_context); + SOS_ASSERT_FATAL(SOS_OK == retval); + + /* Free the process structure */ + sos_kmem_cache_free((sos_vaddr_t)proc); + + return SOS_OK; +} + + +sos_ret_t sos_process_unregister_thread(struct sos_thread *thr) +{ + sos_ui32_t flags; + struct sos_process * in_proc = thr->process; + + SOS_ASSERT_FATAL(thr->state == SOS_THR_ZOMBIE); + + /* Update the list of the threads in the process */ + thr->process = NULL; + sos_disable_IRQs(flags); + list_delete_named(in_proc->thread_list, thr, + prev_in_process, next_in_process); + SOS_ASSERT_FATAL(in_proc->nb_threads > 0); + in_proc->nb_threads --; + sos_restore_IRQs(flags); + + /* Unreference the process */ + sos_process_unref(in_proc); + + return SOS_OK; +} + + +sos_ret_t sos_process_set_name(struct sos_process * proc, + const char * new_name) +{ + strzcpy(proc->name, new_name, SOS_PROCESS_MAX_NAMELEN); + return SOS_OK; +} diff --git a/sos/process.h b/sos/process.h new file mode 100644 index 0000000..f409c6c --- /dev/null +++ b/sos/process.h @@ -0,0 +1,138 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_PROCESS_H_ +#define _SOS_PROCESS_H_ + +/** + * @file process.h + * + * SOS Definition of a process and associated management API. A + * process is basically the collection of all the resources requested + * by a user program. The threads are one of these resources, the + * mm_context is one other example of such resources. In SOS, a + * "process" is mainly a resource manager, a container. It does not + * provide much advanced functionality apart from a reference counter. + * + * Only the user threads belong to a process. The kernel + * threads don't because the resources they hold are held by the whole + * kernel, thus by ALL the threads (kernel AND user): the notion of + * "process" doesn't have any meaning for them because they don't own + * any proper resource (apart from their stack). + */ + +#include + + +/** + * The definition of an SOS process is opaque. @see process.c + */ +struct sos_process; + +#include + + +/** + * Default size of a user stack (8 MB) + */ +#define SOS_DEFAULT_USER_STACK_SIZE (8 << 20) + + +/** + * Initialization of the process subsystem + */ +sos_ret_t sos_process_subsystem_setup(); + + +/** + * Initialize a new (empty) process and return a reference to it. This + * means that: + * - A new mm_context has been initialized + * - No threads belong to this process yet + * - Nothing is mapped in user space + * - No other resource is used + * + * @return NULL on error (not enough memory) + */ +struct sos_process *sos_process_create_empty(const char *name); + + +/** + * Signal we're using another reference to a process. + */ +sos_ret_t sos_process_ref(struct sos_process *proc); + + +/** + * Release the reference to a process. If nobody holds a reference to + * it and if the process does not have any thread anymore, the process + * is destroyed. + * + * @return -SOS_EBUSY when the process is still referenced afterwards + */ +sos_ret_t sos_process_unref(struct sos_process *proc); + + +/** + * Return the number of threads currently registered in the process + */ +sos_count_t sos_process_get_nb_threads(const struct sos_process *proc); + + +/** + * Retrieve the address of the MMU configuration description + * + * @return NULL on error + */ +struct sos_mm_context * +sos_process_get_mm_context(const struct sos_process *proc); + + +/* *************************************************** + * Restricted functions + */ + + +/** + * Change the name of the process + */ +sos_ret_t sos_process_set_name(struct sos_process * proc, + const char * new_name); + + +/** + * Attach the given thread to the process + * + * @note This function is called internally by thread.c . The thread + * is assumed to be in the "CREATED" state, ie one cannot attach a + * thread to some other process once it has been created. + */ +sos_ret_t sos_process_register_thread(struct sos_process *in_proc, + struct sos_thread *thr); + + +/** + * Remove the given thread from the given process threads' list. When + * the process becomes empty (ie does not contain any thread anymore + * and is not referenced by anybody), all its resources are released. + * + * @note This function is called internally by thread.c . The thread + * is assumed to be in the "ZOMBIE" state. + */ +sos_ret_t sos_process_unregister_thread(struct sos_thread *thr); + +#endif /* _SOS_PROCESS_H_ */ diff --git a/sos/sched.c b/sos/sched.c new file mode 100644 index 0000000..e9e4c29 --- /dev/null +++ b/sos/sched.c @@ -0,0 +1,338 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include +#include + +#include "sched.h" + + +/** + * The definition of the scheduler queue. We could have used a normal + * kwaitq here, it would have had the same properties (regarding + * priority ordering mainly). But we don't bother with size + * considerations here (in kwaitq, we had better make the kwaitq + * structure as small as possible because there are a lot of kwaitq in + * the system: at least 1 per opened file), so that we can implement a + * much faster way of handling the prioritized jobs. + */ +struct sos_sched_queue +{ + unsigned int nr_threads; + struct sos_thread *thread_list[SOS_SCHED_NUM_PRIO]; +}; + + +/** + * We manage 2 queues: a queue being scanned for ready threads + * (active_queue) and a queue to store the threads the threads having + * expired their time quantuum. + */ +static struct sos_sched_queue *active_queue, *expired_queue; + + +/** + * The instances for the active/expired queues + */ +static struct sos_sched_queue sched_queue[2]; + + +/** + * The array giving the timeslice corresponding to each priority level + */ +struct sos_time time_slice[SOS_SCHED_NUM_PRIO]; + + +sos_ret_t sos_sched_subsystem_setup() +{ + sos_sched_priority_t prio; + + memset(sched_queue, 0x0, sizeof(sched_queue)); + active_queue = & sched_queue[0]; + expired_queue = & sched_queue[1]; + + /* pre-compute time slices */ + for (prio = SOS_SCHED_PRIO_TS_HIGHEST ; + prio <= SOS_SCHED_PRIO_TS_LOWEST ; + prio ++) + { + unsigned int ms; + ms = SOS_TIME_SLICE_MIN + + (SOS_TIME_SLICE_MAX - SOS_TIME_SLICE_MIN) + * (prio - SOS_SCHED_PRIO_TS_HIGHEST) + / (SOS_SCHED_PRIO_TS_LOWEST - SOS_SCHED_PRIO_TS_HIGHEST); + time_slice[prio].sec = ms / 1000; + time_slice[prio].nanosec = 1000000UL * (ms % 1000); + } + + return SOS_OK; +} + + +/** + * Helper function to add a thread in a ready queue AND to change the + * state of the given thread to "READY". + * + * @param insert_at_tail TRUE to tell to add the thread at the end of + * the ready list. Otherwise it is added at the head of it. + */ +static sos_ret_t add_in_ready_queue(struct sos_sched_queue *q, + struct sos_thread *thr, + sos_bool_t insert_at_tail) +{ + sos_sched_priority_t prio; + + SOS_ASSERT_FATAL( (SOS_THR_CREATED == thr->state) + || (SOS_THR_RUNNING == thr->state) /* Yield */ + || (SOS_THR_BLOCKED == thr->state) ); + + /* Add the thread to the CPU queue */ + prio = sos_thread_get_priority(thr); + if (insert_at_tail) + list_add_tail_named(q->thread_list[prio], thr, + ready.rdy_prev, ready.rdy_next); + else + list_add_head_named(q->thread_list[prio], thr, + ready.rdy_prev, ready.rdy_next); + thr->ready.rdy_queue = q; + q->nr_threads ++; + + /* Ok, thread is now really ready to be (re)started */ + thr->state = SOS_THR_READY; + + return SOS_OK; +} + + +sos_ret_t sos_sched_set_ready(struct sos_thread *thr) +{ + sos_ret_t retval; + + /* Don't do anything for already ready threads */ + if (SOS_THR_READY == thr->state) + return SOS_OK; + + /* Reset the CPU time used in the quantuum */ + memset(& thr->running.user_time_spent_in_slice, 0x0, sizeof(struct sos_time)); + + if (SOS_SCHED_PRIO_IS_RT(sos_thread_get_priority(thr))) + { + /* Real-time thread: schedule it for the present turn */ + retval = add_in_ready_queue(active_queue, thr, TRUE); + } + else + { + /* Non real-time thread: schedule it for next turn */ + retval = add_in_ready_queue(expired_queue, thr, TRUE); + } + + return retval; +} + + +sos_ret_t sos_sched_change_priority(struct sos_thread *thr, + sos_sched_priority_t priority) +{ + struct sos_thread *thread_list; + SOS_ASSERT_FATAL(SOS_THR_READY == thr->state); + + /* Temp variable */ + thread_list + = thr->ready.rdy_queue->thread_list[sos_thread_get_priority(thr)]; + + list_delete_named(thread_list, thr, ready.rdy_prev, ready.rdy_next); + + /* Update lists */ + thread_list = thr->ready.rdy_queue->thread_list[priority]; + list_add_tail_named(thread_list, thr, ready.rdy_prev, ready.rdy_next); + thr->ready.rdy_queue->thread_list[priority] = thread_list; + + return SOS_OK; +} + + +/** + * Helper function to determine whether the current thread expired its + * time quantuum + */ +static sos_bool_t +thread_expired_its_quantuum(struct sos_thread *thr) +{ + sos_sched_priority_t prio = sos_thread_get_priority(thr); + + /* No timesharing/round-robin for "real-time" threads */ + if (SOS_SCHED_PRIO_IS_RT(prio)) + return FALSE; + + /* Current (user) thread expired its time quantuum ? A kernel + thread never expires because sos_sched_do_timer_tick() below + won't update its user_time_spent_in_slice */ + if (sos_time_cmp(& thr->running.user_time_spent_in_slice, + & time_slice[prio]) >= 0) + return TRUE; + + return FALSE; +} + + +struct sos_thread * sos_reschedule(struct sos_thread *current_thread, + sos_bool_t do_yield) +{ + sos_sched_priority_t prio; + + /* Force the current thread to release the CPU if it expired its + quantuum */ + if (thread_expired_its_quantuum(current_thread)) + { + /* Reset the CPU time used in the quantuum */ + memset(& current_thread->running.user_time_spent_in_slice, + 0x0, sizeof(struct sos_time)); + + do_yield = TRUE; + } + + if (SOS_THR_ZOMBIE == current_thread->state) + { + /* Don't think of returning to this thread since it is + terminated */ + /* Nop */ + } + else if (SOS_THR_BLOCKED != current_thread->state) + { + /* Take into account the current executing thread unless it is + marked blocked */ + if (do_yield) + { + /* Ok, reserve it for next turn */ + if (SOS_SCHED_PRIO_IS_RT(sos_thread_get_priority(current_thread))) + add_in_ready_queue(active_queue, current_thread, TRUE); + else + add_in_ready_queue(expired_queue, current_thread, TRUE); + } + else + { + /* Put it at the head of the active list */ + add_in_ready_queue(active_queue, current_thread, FALSE); + } + } + + + /* Active queue is empty ? */ + if (active_queue->nr_threads <= 0) + { + /* Yes: Exchange it with the expired queue */ + struct sos_sched_queue *q; + q = active_queue; + active_queue = expired_queue; + expired_queue = q; + } + + /* Now loop over the priorities in the active queue, looking for a + non-empty queue */ + for (prio = SOS_SCHED_PRIO_HIGHEST ; prio <= SOS_SCHED_PRIO_LOWEST ; prio ++) + { + struct sos_thread *next_thr; + + if (list_is_empty_named(active_queue->thread_list[prio], + ready.rdy_prev, ready.rdy_next)) + continue; + + /* Queue is not empty: take the thread at its head */ + next_thr = list_pop_head_named(active_queue->thread_list[prio], + ready.rdy_prev, ready.rdy_next); + active_queue->nr_threads --; + + return next_thr; + } + + + SOS_FATAL_ERROR("No kernel thread ready ?!"); + return NULL; +} + + +sos_ret_t sos_sched_do_timer_tick() +{ + struct sos_thread *interrupted_thread = sos_thread_get_current(); + struct sos_time tick_duration; + sos_bool_t cur_is_user; + sos_ui32_t nb_user_ready = 0; + sos_ui32_t nb_kernel_ready = 0; + int prio; + + sos_time_get_tick_resolution(& tick_duration); + + /* Update the timing statistics */ + if (sos_cpu_context_is_in_user_mode(interrupted_thread->cpu_state)) + { + cur_is_user = TRUE; + + /* User time */ + sos_time_inc(& interrupted_thread->rusage.ru_utime, + & tick_duration); + + /* Update time spent is current timeslice ONLY for a user thread */ + sos_time_inc(& interrupted_thread->running.user_time_spent_in_slice, + & tick_duration); + } + else + { + cur_is_user = FALSE; + + /* System time */ + sos_time_inc(& interrupted_thread->rusage.ru_stime, + & tick_duration); + } + + + /* Update load stats */ + for (prio = SOS_SCHED_PRIO_HIGHEST ; prio <= SOS_SCHED_PRIO_LOWEST ; prio ++) + { + struct sos_thread *thr; + int nb_thrs; + + list_foreach_forward_named(active_queue->thread_list[prio], + thr, nb_thrs, + ready.rdy_prev, ready.rdy_next) + { + if (sos_cpu_context_is_in_user_mode(thr->cpu_state)) + nb_user_ready ++; + else + nb_kernel_ready ++; + } + + list_foreach_forward_named(expired_queue->thread_list[prio], + thr, nb_thrs, + ready.rdy_prev, ready.rdy_next) + { + if (sos_cpu_context_is_in_user_mode(thr->cpu_state)) + nb_user_ready ++; + else + nb_kernel_ready ++; + } + } + + sos_load_do_timer_tick(cur_is_user, + nb_user_ready, + nb_kernel_ready); + + return SOS_OK; +} diff --git a/sos/sched.h b/sos/sched.h new file mode 100644 index 0000000..a6f10e3 --- /dev/null +++ b/sos/sched.h @@ -0,0 +1,158 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_SCHED_H_ +#define _SOS_SCHED_H_ + + +/** + * @file sched.h + * + * A basic scheduler inspired from the O(1) Linux scheduler. Supports + * 2 classes of thread priorities: + * - so-called 'real-time' threads scheduled according to a simple + * traditional static priority real-time scheduler. "Real-time" round + * robin scheduling is not supported. + * - "fair" time-sharing scheduling for non real-time threads. "fair" + * because no starvation among the non real-time threads is + * possible. Contrary to the original O(1) Linux scheduler, the + * on-line adjustment of the scheduling priorities to cope with + * interactive/non interactive threads discrimination is not + * supported: threads keep having the same priority as long as the + * user does not change it. + * + * The functions below manage CPU queues, and are NEVER responsible + * for context switches (see thread.h for that) or synchronizations + * (see kwaitq.h or the higher levels primitives [mutex, semaphore, + * ...] for that). + * + * @note IMPORTANT: all the functions below are meant to be called + * ONLY by the thread/timer/kwaitq subsystems. DO NOT use them + * directly from anywhere else: use ONLY the thread/kwaitq functions! + * If you still want to call them directly despite this disclaimer, + * simply disable interrupts before clling them. + */ + +#include +#include + + +/** + * The definition of a priority + */ +typedef unsigned char sos_sched_priority_t; + + +#include + + +/** + * Valid priority interval ("real-time" and non real-time threads altogether) + */ +#define SOS_SCHED_PRIO_HIGHEST 0 +#define SOS_SCHED_PRIO_LOWEST 63 +#define SOS_SCHED_NUM_PRIO 64 + + +/** + * Class-specific priorities + */ +#define SOS_SCHED_PRIO_RT_HIGHEST 0 /**< Highest 'real-time' static prio. */ +#define SOS_SCHED_PRIO_RT_LOWEST 15 /**< Lowest 'real-time' static priority */ +#define SOS_SCHED_PRIO_TS_HIGHEST 16 /**< Highest time-sharing priority */ +#define SOS_SCHED_PRIO_TS_LOWEST 63 /**< Lowest time-sharing priority */ + +#define SOS_SCHED_PRIO_DEFAULT 40 /**< Default priority */ + + +/** + * Helper macros (Yes, priorities ordered in decreasing numerical value) + * + * @note: The use of this function is RESERVED + */ +#define SOS_SCHED_PRIO_CMP(prio1,prio2) ((prio1) - (prio2)) + +#define SOS_SCHED_PRIO_IS_VALID(prio) \ + ({ int __prio = (int)(prio); \ + ((__prio) <= SOS_SCHED_PRIO_LOWEST) \ + && \ + ((__prio) >= SOS_SCHED_PRIO_HIGHEST); }) + +#define SOS_SCHED_PRIO_IS_RT(prio) \ + ({ int __prio = (int)(prio); \ + ((__prio) <= SOS_SCHED_PRIO_RT_LOWEST) \ + && \ + ((__prio) >= SOS_SCHED_PRIO_RT_HIGHEST); }) + + +/** + * The time slices for 'time-sharing' user threads, in ms + */ +#define SOS_TIME_SLICE_MIN 10 /* for SOS_SCHED_PRIO_TS_HIGHEST */ +#define SOS_TIME_SLICE_MAX 200 /* for SOS_SCHED_PRIO_TS_LOWEST */ + + +/** + * Initialize the scheduler + * + * @note: The use of this function is RESERVED + */ +sos_ret_t sos_sched_subsystem_setup(); + + +/** + * Mark the given thread as ready + * + * @note: The use of this function is RESERVED + */ +sos_ret_t sos_sched_set_ready(struct sos_thread * thr); + + +/** + * Return the identifier of the next thread to run. Also removes it + * from the ready list, but does NOT set is as current_thread ! + * + * @param current_thread TCB of the thread calling the function + * + * @param do_yield When TRUE, put the current executing thread at the + * end of the ready list. Otherwise it is kept at the head of it. + * + * @note: The use of this function is RESERVED + */ +struct sos_thread * sos_reschedule(struct sos_thread * current_thread, + sos_bool_t do_yield); + +/** + * Called by thread subsystem each time a READY thread's priority is + * changed + * + * @note: The use of this function is RESERVED (to thread.c) + */ +sos_ret_t sos_sched_change_priority(struct sos_thread * thr, + sos_sched_priority_t priority); + + +/** + * Account for the execution of a time tick. Should be called + * immediately before the timer ISR calls sos_reschedule() before + * returning to thread context. + * + * @note The use of this function is RESERVED (to timer IRQ) + */ +sos_ret_t sos_sched_do_timer_tick(); + +#endif /* _SOS_WAITQUEUE_H_ */ diff --git a/sos/syscall.c b/sos/syscall.c new file mode 100644 index 0000000..623ff44 --- /dev/null +++ b/sos/syscall.c @@ -0,0 +1,142 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include +#include +#include + +#include +#include +#include "syscall.h" + + +/** + * THE syscall entry point + */ +sos_ret_t sos_do_syscall(int syscall_id, + const struct sos_cpu_state *user_ctxt) +{ + sos_ret_t retval; + + switch(syscall_id) + { + case SOS_SYSCALL_ID_EXIT: + { + unsigned int status; + retval = sos_syscall_get1arg(user_ctxt, & status); + if (SOS_OK != retval) + break; + sos_thread_exit(); + retval = -SOS_EFATAL; /* Not reached */ + } + break; + case SOS_SYSCALL_ID_BOCHS_WRITE: + { + sos_uaddr_t user_str; + sos_size_t len; + char * str; + retval = sos_syscall_get2args(user_ctxt, & user_str, & len); + if (SOS_OK != retval) + break; + + str = (char*)sos_kmalloc(len + 1, 0); + if (str) + { + retval = sos_strzcpy_from_user(str, user_str, len+1); + str[len] = '\0'; + if (SOS_OK == retval) + { + sos_bochs_printf("THR 0x%x: ", + (unsigned)sos_thread_get_current()); + retval = sos_bochs_putstring(str); + retval = len; + } + sos_kfree((sos_vaddr_t)str); + } + else + retval = -SOS_ENOMEM; + } + break; + + + /* *********************************************** + * Debug syscalls (will be removed in the future) + */ + + + /** + * Syscall 4012: hexdump of a user-space memory region + * args: addr_start size, retval=ignored + */ + case 4012: + { + sos_uaddr_t user_str; + unsigned int len; + unsigned char * str; + + retval = sos_syscall_get2args(user_ctxt, & user_str, & len); + if (SOS_OK != retval) + break; + + str = (char*)sos_kmalloc(len + 1, 0); + if (str) + { + int i; + sos_bochs_printf("Hexdump(0x%x, %d):\n", user_str, len); + retval = sos_memcpy_from_user((sos_vaddr_t) str, user_str, len); + sos_bochs_printf(" (Successfully copied %d out of %d)\n", + retval, len); + + for (i = 0 ; i < retval ; i++) + { + if ((i % 32) == 0) + sos_bochs_printf("%x:", i); + sos_bochs_printf(" %x", str[i]); + if (((i+1) % 32) == 0) + sos_bochs_printf("\n"); + } + if (i % 32) + sos_bochs_printf("\n"); + + sos_kfree((sos_vaddr_t)str); + } + else + retval = -SOS_ENOMEM; + } + break; + + + /** + * Syscall 4008: dump the list of processes in the system + * args: none, retval=ignored + */ + case 4008: + { + extern void sos_process_dumplist(void); + sos_process_dumplist(); + retval = SOS_OK; + } + break; + + default: + sos_bochs_printf("Syscall: UNKNOWN[%d]\n", syscall_id); + retval = -SOS_ENOSUP; + } + + return retval; +} diff --git a/sos/syscall.h b/sos/syscall.h new file mode 100644 index 0000000..1832083 --- /dev/null +++ b/sos/syscall.h @@ -0,0 +1,53 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_SYSCALL_H_ +#define _SOS_SYSCALL_H_ + +/** + * @file syscall.h + * + * SOS Syscalls identifiers and handler. The handler is called by the + * underlying assembler routine (see hwcore/syscall.h) + */ + + +/** + * The user services offered by the SOS kernel + */ +#define SOS_SYSCALL_ID_EXIT 256 /**< Args: retval, retval=NONE */ + +#define SOS_SYSCALL_ID_BOCHS_WRITE 43 /**< Args: string, retval=num_printed */ + + +#if defined(KERNEL_SOS) && !defined(ASM_SOURCE) + +#include +#include + +/** + * "The" SOS syscall handler + * + * @param syscall_id The identifier of the syscall service + * @param user_ctxt The user context making the syscall + */ +sos_ret_t sos_do_syscall(int syscall_id, + const struct sos_cpu_state *user_ctxt); + +#endif /* defined(KERNEL_SOS) && !defined(ASM_SOURCE) */ + +#endif /* _SOS_SYSCALL_H_ */ diff --git a/sos/test-art7.c b/sos/test-art7.c new file mode 100644 index 0000000..af2cb3a --- /dev/null +++ b/sos/test-art7.c @@ -0,0 +1,427 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 1995 TIS Committee (ELF typedefs, constants and macros) + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include +#include + +#include +#include + + +/** + * @file test-art7.c + * + * Basic tests for the user thread/process management API + */ + + +/** + * The "C" structure of a user program image in the kernel. Structures + * like this are created by the Makefile in the userland/ directory + */ +struct userprog_entry +{ + const char *name; + sos_vaddr_t bottom_vaddr; + sos_vaddr_t top_vaddr; +}; + + +/** + * Symbol marking the start of the userprogs table, as setup by the + * ld script in the userland/ directory + */ +extern char _userprogs_table; + + +/* + * Local functions + */ + + +/** + * Function to locate the given user program image in the kernel memory + */ +static struct userprog_entry * lookup_userprog(const char *name); + + +/** + * Function to create a new process containing the given USER program + * image. This function automatically locates the destination addresses + * of the program by examinating its ELF header + * + * @return The address of the first instruction of the program, as + * given by its ELF header, or 0 when the program is not a correct ELF + * image. + */ +static sos_uaddr_t load_elf_prog(const struct userprog_entry *prog); + + +/** + * Function that locates a USER program in the kernel image, creates a + * new USER process for it, and creates the given nb_uthreads USER + * threads inside it. + */ +static sos_ret_t spawn_program(const char *progname, + unsigned nb_uthreads); + + +/** + * The main function for our tests + */ +void test_art7() +{ + spawn_program("myprog5", 5); + spawn_program("myprog1", 10); + spawn_program("myprog5", 1); + spawn_program("myprog6", 12); + spawn_program("myprog2", 10); + spawn_program("myprog5", 1); + spawn_program("myprog3", 10); + spawn_program("myprog5", 1); + spawn_program("myprog1", 10); + spawn_program("myprog6", 12); + spawn_program("myprog5", 1); + spawn_program("myprog4", 10); + spawn_program("myprog5", 1); + spawn_program("myprog2", 10); + spawn_program("myprog6", 12); + spawn_program("myprog5", 1); +} + + +static sos_ret_t spawn_program(const char *progname, + unsigned nb_uthreads) +{ + int i; + + sos_uaddr_t prog_entry, stack_top_uaddr; + struct userprog_entry *prog; + struct sos_process *new_proc; + + prog = lookup_userprog(progname); + if (! prog) + return -SOS_EINVAL; + + new_proc = sos_process_create_empty(progname); + if (! new_proc) + return -SOS_ENOMEM; + + /* Squat this new process to map the user program into it */ + SOS_ASSERT_FATAL(SOS_OK + == sos_thread_change_current_mm_context(sos_process_get_mm_context(new_proc))); + + /* Load the user program image */ + prog_entry = load_elf_prog(prog); + if (! prog_entry) + { + sos_process_unref(new_proc); + return -SOS_ENOMEM; + } + + /* Map the user stacks into it and create the user threads */ + /* By default, the first user stack will be located at the end of + the user address space (ie 4GB), the stacks of the other threads + will be located (12 pages) below. Each stack is USTACK_NPAGES + pages long */ +#define USTACK_NPAGES 8 + for (i = 0, stack_top_uaddr = 0xfffffffc ; + i < nb_uthreads ; + i++, stack_top_uaddr -= (USTACK_NPAGES + 4)*SOS_PAGE_SIZE) + { + int p; + char thrname[16]; + sos_uaddr_t stack_base = SOS_PAGE_ALIGN_INF(stack_top_uaddr); + + /* Allocate USTACK_NPAGES pages for the stack and map them */ + for (p = 0 ; p < USTACK_NPAGES ; p++, stack_base -= SOS_PAGE_SIZE) + { + sos_ret_t retval; + sos_paddr_t ppage; + + ppage = sos_physmem_ref_physpage_new(FALSE); + SOS_ASSERT_FATAL(ppage != 0); + + /* Map it in the process space. Might fail is there is not + enough RAM (we don't support swap-out for the moment) */ + retval = sos_paging_map(ppage, stack_base, TRUE, + SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE); + SOS_ASSERT_FATAL(retval == SOS_OK); + + retval = sos_physmem_unref_physpage(ppage); + SOS_ASSERT_FATAL(retval == 0); + + /* Poison the stack to detect the use of uninitialized + variables */ + memset((void*)stack_base, 0xa5, SOS_PAGE_SIZE); + } + + /* Create the user thread */ + snprintf(thrname, sizeof(thrname), "%s:%d", progname, i); + sos_bochs_printf("Spawning %s\n", thrname); + sos_create_user_thread(thrname, + new_proc, + prog_entry, + 0, 0, + stack_top_uaddr, + SOS_SCHED_PRIO_TS_LOWEST); + + sos_thread_yield(); + } + + /* Don't need the reference to the process anymore */ + sos_process_unref(new_proc); + + /* Revert to normal kernel thread's address space */ + SOS_ASSERT_FATAL(SOS_OK + == sos_thread_change_current_mm_context(NULL)); + + return SOS_OK; +} + + +/** + * Lookup a user program located inside the kernel's image + */ +static struct userprog_entry * lookup_userprog(const char *name) +{ + struct userprog_entry *prog; + + if (! name) + return NULL; + + /* Walk through the table of user program description structures to + find the user program with the given name */ + for (prog = (struct userprog_entry*) & _userprogs_table ; + prog && (prog->name != NULL) ; + prog++) + { + if (0 == strcmp(name, prog->name)) + /* Found it ! */ + return prog; + } + + return NULL; +} + + +/** + * Make sure the program is in a valid ELF format, map it into memory, + * and return the address of its entry point (ie _start function) + * + * @return 0 when the program is not a valid ELF + */ +static sos_uaddr_t load_elf_prog(const struct userprog_entry *prog) +{ + int i; + + /** + * Typedefs, constants and structure definitions as given by the ELF + * standard specifications. + */ + typedef unsigned long Elf32_Addr; + typedef unsigned long Elf32_Word; + typedef unsigned short Elf32_Half; + typedef unsigned long Elf32_Off; + typedef signed long Elf32_Sword; + + /* Elf identification */ + +#define EI_NIDENT 16 + typedef struct { + unsigned char e_ident[EI_NIDENT]; + Elf32_Half e_type; + Elf32_Half e_machine; + Elf32_Word e_version; + Elf32_Addr e_entry; + Elf32_Off e_phoff; + Elf32_Off e_shoff; + Elf32_Word e_flags; + Elf32_Half e_ehsize; + Elf32_Half e_phentsize; + Elf32_Half e_phnum; + Elf32_Half e_shentsize; + Elf32_Half e_shnum; + Elf32_Half e_shstrndx; + } __attribute__((packed)) Elf32_Ehdr_t; + +/* e_ident value */ +#define ELFMAG0 0x7f +#define ELFMAG1 'E' +#define ELFMAG2 'L' +#define ELFMAG3 'F' + +/* e_ident offsets */ +#define EI_MAG0 0 +#define EI_MAG1 1 +#define EI_MAG2 2 +#define EI_MAG3 3 +#define EI_CLASS 4 +#define EI_DATA 5 +#define EI_VERSION 6 +#define EI_PAD 7 + +/* e_ident[EI_CLASS] */ +#define ELFCLASSNONE 0 +#define ELFCLASS32 1 +#define ELFCLASS64 2 + +/* e_ident[EI_DATA] */ +#define ELFDATANONE 0 +#define ELFDATA2LSB 1 +#define ELFDATA2MSB 2 + +/* e_type */ +#define ET_NONE 0 /* No file type */ +#define ET_REL 1 /* Relocatable file */ +#define ET_EXEC 2 /* Executable file */ +#define ET_DYN 3 /* Shared object file */ +#define ET_CORE 4 /* Core file */ +#define ET_LOPROC 0xff00 /* Processor-specific */ +#define ET_HIPROC 0xffff /* Processor-specific */ + +/* e_machine */ +#define EM_NONE 0 /* No machine */ +#define EM_M32 1 /* AT&T WE 32100 */ +#define EM_SPARC 2 /* SPARC */ +#define EM_386 3 /* Intel 80386 */ +#define EM_68K 4 /* Motorola 68000 */ +#define EM_88K 5 /* Motorola 88000 */ +#define EM_860 7 /* Intel 80860 */ +#define EM_MIPS 8 /* MIPS RS3000 */ + +/* e_version */ +#define EV_NONE 0 /* invalid version */ +#define EV_CURRENT 1 /* current version */ + + typedef struct { + Elf32_Word p_type; + Elf32_Off p_offset; + Elf32_Addr p_vaddr; + Elf32_Addr p_paddr; + Elf32_Word p_filesz; + Elf32_Word p_memsz; + Elf32_Word p_flags; + Elf32_Word p_align; + } __attribute__((packed)) Elf32_Phdr_t; + +/* Reserved segment types p_type */ +#define PT_NULL 0 +#define PT_LOAD 1 +#define PT_DYNAMIC 2 +#define PT_INTERP 3 +#define PT_NOTE 4 +#define PT_SHLIB 5 +#define PT_PHDR 6 +#define PT_LOPROC 0x70000000 +#define PT_HIPROC 0x7fffffff + +/* p_flags */ +#define PF_X 1 +#define PF_W 2 +#define PF_R 4 + + + Elf32_Ehdr_t *elf_hdr = (Elf32_Ehdr_t*) prog->bottom_vaddr; + Elf32_Phdr_t *elf_phdrs; + + /* Make sure the image is large enough to contain at least the ELF + header */ + if (prog->bottom_vaddr + sizeof(Elf32_Ehdr_t) > prog->top_vaddr) + { + sos_bochs_printf("ELF prog %s: incorrect header\n", prog->name); + return 0; + } + + /* Macro to check expected values for some fields in the ELF header */ +#define ELF_CHECK(hdr,field,expected_value) \ + ({ if ((hdr)->field != (expected_value)) \ + { \ + sos_bochs_printf("ELF prog %s: for %s, expected %x, got %x\n", \ + prog->name, \ + #field, \ + (unsigned)(expected_value), \ + (unsigned)(hdr)->field); \ + return 0; \ + } \ + }) + + ELF_CHECK(elf_hdr, e_ident[EI_MAG0], ELFMAG0); + ELF_CHECK(elf_hdr, e_ident[EI_MAG1], ELFMAG1); + ELF_CHECK(elf_hdr, e_ident[EI_MAG2], ELFMAG2); + ELF_CHECK(elf_hdr, e_ident[EI_MAG3], ELFMAG3); + ELF_CHECK(elf_hdr, e_ident[EI_CLASS], ELFCLASS32); + ELF_CHECK(elf_hdr, e_ident[EI_DATA], ELFDATA2LSB); + ELF_CHECK(elf_hdr, e_type, ET_EXEC); + ELF_CHECK(elf_hdr, e_version, EV_CURRENT); + + /* Get the begining of the program header table */ + elf_phdrs = (Elf32_Phdr_t*) (prog->bottom_vaddr + elf_hdr->e_phoff); + + /* Map the program segment in R/W mode. To make things clean, we + should iterate over the sections, not the program header */ + for (i = 0 ; i < elf_hdr->e_phnum ; i++) + { + sos_uaddr_t uaddr; + + /* Ignore the empty program headers that are not marked "LOAD" */ + if (elf_phdrs[i].p_type != PT_LOAD) + { + if (elf_phdrs[i].p_memsz != 0) + { + SOS_FATAL_ERROR("ELF: non-empty non-LOAD segments not supported yet"); + } + continue; + } + + if (elf_phdrs[i].p_vaddr < SOS_PAGING_BASE_USER_ADDRESS) + { + SOS_FATAL_ERROR("User program has an incorrect address"); + } + + /* Map pages of physical memory into user space */ + for (uaddr = SOS_PAGE_ALIGN_INF(elf_phdrs[i].p_vaddr) ; + uaddr < elf_phdrs[i].p_vaddr + elf_phdrs[i].p_memsz ; + uaddr += SOS_PAGE_SIZE) + { + sos_ret_t retval; + sos_paddr_t ppage; + ppage = sos_physmem_ref_physpage_new(TRUE); + + retval = sos_paging_map(ppage, uaddr, TRUE, + SOS_VM_MAP_PROT_READ + | SOS_VM_MAP_PROT_WRITE); + SOS_ASSERT_FATAL(retval == SOS_OK); + + retval = sos_physmem_unref_physpage(ppage); + SOS_ASSERT_FATAL(retval == 0); + } + + /* Copy segment into memory */ + memcpy((void*) elf_phdrs[i].p_vaddr, + (void*) (prog->bottom_vaddr + elf_phdrs[i].p_offset), + elf_phdrs[i].p_filesz); + } + + return elf_hdr->e_entry; +} diff --git a/sos/thread.c b/sos/thread.c new file mode 100644 index 0000000..00450ee --- /dev/null +++ b/sos/thread.c @@ -0,0 +1,821 @@ +/* Copyright (C) 2004,2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include + +#include "thread.h" + + +/** + * The size of the stack of a kernel thread + */ +#define SOS_THREAD_KERNEL_STACK_SIZE (1*SOS_PAGE_SIZE) + + +/** + * The identifier of the thread currently running on CPU. + * + * We only support a SINGLE processor, ie a SINGLE thread + * running at any time in the system. This greatly simplifies the + * implementation of the system, since we don't have to complicate + * things in order to retrieve the identifier of the threads running + * on the CPU. On multiprocessor systems the current_thread below is + * an array indexed by the id of the CPU, so that the challenge is to + * retrieve the identifier of the CPU. This is usually done based on + * the stack address (Linux implementation) or on some form of TLS + * ("Thread Local Storage": can be implemented by way of LDTs for the + * processes, accessed through the fs or gs registers). + */ +static volatile struct sos_thread *current_thread = NULL; + + +/* + * The list of threads currently in the system. + * + * @note We could have used current_thread for that... + */ +static struct sos_thread *thread_list = NULL; + + +/** + * The Cache of thread structures + */ +static struct sos_kslab_cache *cache_thread; + + +struct sos_thread *sos_thread_get_current() +{ + SOS_ASSERT_FATAL(current_thread->state == SOS_THR_RUNNING); + return (struct sos_thread*)current_thread; +} + + +inline static sos_ret_t _set_current(struct sos_thread *thr) +{ + SOS_ASSERT_FATAL(thr->state == SOS_THR_READY); + current_thread = thr; + current_thread->state = SOS_THR_RUNNING; + return SOS_OK; +} + + +sos_ret_t sos_thread_subsystem_setup(sos_vaddr_t init_thread_stack_base_addr, + sos_size_t init_thread_stack_size) +{ + struct sos_thread *myself; + + /* Allocate the cache of threads */ + cache_thread = sos_kmem_cache_create("thread", + sizeof(struct sos_thread), + 2, + 0, + SOS_KSLAB_CREATE_MAP + | SOS_KSLAB_CREATE_ZERO); + if (! cache_thread) + return -SOS_ENOMEM; + + /* Allocate a new thread structure for the current running thread */ + myself = (struct sos_thread*) sos_kmem_cache_alloc(cache_thread, + SOS_KSLAB_ALLOC_ATOMIC); + if (! myself) + return -SOS_ENOMEM; + + /* Initialize the thread attributes */ + strzcpy(myself->name, "[kinit]", SOS_THR_MAX_NAMELEN); + myself->state = SOS_THR_CREATED; + myself->priority = SOS_SCHED_PRIO_LOWEST; + myself->kernel_stack_base_addr = init_thread_stack_base_addr; + myself->kernel_stack_size = init_thread_stack_size; + + /* Do some stack poisoning on the bottom of the stack, if needed */ + sos_cpu_state_prepare_detect_kernel_stack_overflow(myself->cpu_state, + myself->kernel_stack_base_addr, + myself->kernel_stack_size); + + /* Add the thread in the global list */ + list_singleton_named(thread_list, myself, gbl_prev, gbl_next); + + /* Ok, now pretend that the running thread is ourselves */ + myself->state = SOS_THR_READY; + _set_current(myself); + + return SOS_OK; +} + + +struct sos_thread * +sos_create_kernel_thread(const char *name, + sos_kernel_thread_start_routine_t start_func, + void *start_arg, + sos_sched_priority_t priority) +{ + __label__ undo_creation; + sos_ui32_t flags; + struct sos_thread *new_thread; + + if (! start_func) + return NULL; + if (! SOS_SCHED_PRIO_IS_VALID(priority)) + return NULL; + + /* Allocate a new thread structure for the current running thread */ + new_thread + = (struct sos_thread*) sos_kmem_cache_alloc(cache_thread, + SOS_KSLAB_ALLOC_ATOMIC); + if (! new_thread) + return NULL; + + /* Initialize the thread attributes */ + strzcpy(new_thread->name, ((name)?name:"[NONAME]"), SOS_THR_MAX_NAMELEN); + new_thread->state = SOS_THR_CREATED; + new_thread->priority = priority; + + /* Allocate the stack for the new thread */ + new_thread->kernel_stack_base_addr = sos_kmalloc(SOS_THREAD_KERNEL_STACK_SIZE, 0); + new_thread->kernel_stack_size = SOS_THREAD_KERNEL_STACK_SIZE; + if (! new_thread->kernel_stack_base_addr) + goto undo_creation; + + /* Initialize the CPU context of the new thread */ + if (SOS_OK + != sos_cpu_kstate_init(& new_thread->cpu_state, + (sos_cpu_kstate_function_arg1_t*) start_func, + (sos_ui32_t) start_arg, + new_thread->kernel_stack_base_addr, + new_thread->kernel_stack_size, + (sos_cpu_kstate_function_arg1_t*) sos_thread_exit, + (sos_ui32_t) NULL)) + goto undo_creation; + + /* Add the thread in the global list */ + sos_disable_IRQs(flags); + list_add_tail_named(thread_list, new_thread, gbl_prev, gbl_next); + sos_restore_IRQs(flags); + + /* Mark the thread ready */ + if (SOS_OK != sos_sched_set_ready(new_thread)) + goto undo_creation; + + /* Normal non-erroneous end of function */ + return new_thread; + + undo_creation: + if (new_thread->kernel_stack_base_addr) + sos_kfree((sos_vaddr_t) new_thread->kernel_stack_base_addr); + sos_kmem_cache_free((sos_vaddr_t) new_thread); + return NULL; +} + + +struct sos_thread * +sos_create_user_thread(const char *name, + struct sos_process *process, + sos_uaddr_t user_initial_PC, + sos_ui32_t user_start_arg1, + sos_ui32_t user_start_arg2, + sos_uaddr_t user_initial_SP, + sos_sched_priority_t priority) +{ + __label__ undo_creation; + sos_ui32_t flags; + struct sos_thread *new_thread; + + if (! SOS_SCHED_PRIO_IS_VALID(priority)) + return NULL; + + /* For a user thread, the process must be given */ + if (! process) + return NULL; + + /* Allocate a new thread structure for the current running thread */ + new_thread + = (struct sos_thread*) sos_kmem_cache_alloc(cache_thread, + SOS_KSLAB_ALLOC_ATOMIC); + if (! new_thread) + return NULL; + + /* Initialize the thread attributes */ + strzcpy(new_thread->name, ((name)?name:"[NONAME]"), SOS_THR_MAX_NAMELEN); + new_thread->state = SOS_THR_CREATED; + new_thread->priority = priority; + + /* Allocate the stack for the new thread */ + new_thread->kernel_stack_base_addr = sos_kmalloc(SOS_THREAD_KERNEL_STACK_SIZE, 0); + new_thread->kernel_stack_size = SOS_THREAD_KERNEL_STACK_SIZE; + if (! new_thread->kernel_stack_base_addr) + goto undo_creation; + + if (SOS_OK + != sos_cpu_ustate_init(& new_thread->cpu_state, + user_initial_PC, + user_start_arg1, + user_start_arg2, + user_initial_SP, + new_thread->kernel_stack_base_addr, + new_thread->kernel_stack_size)) + goto undo_creation; + + /* Attach the new thread to the process */ + if (SOS_OK != sos_process_register_thread(process, new_thread)) + goto undo_creation; + + /* Add the thread in the global list */ + sos_disable_IRQs(flags); + list_add_tail_named(thread_list, new_thread, gbl_prev, gbl_next); + sos_restore_IRQs(flags); + + /* Mark the thread ready */ + if (SOS_OK != sos_sched_set_ready(new_thread)) + goto undo_creation; + + /* Normal non-erroneous end of function */ + return new_thread; + + undo_creation: + if (new_thread->kernel_stack_base_addr) + sos_kfree((sos_vaddr_t) new_thread->kernel_stack_base_addr); + sos_kmem_cache_free((sos_vaddr_t) new_thread); + return NULL; +} + + +/** + * Helper function to switch to the correct MMU configuration to suit + * the_thread's needs. + * - When switching to a user-mode thread, force the reconfiguration + * of the MMU + * - When switching to a kernel-mode thread, only change the MMU + * configuration if the thread was squatting someone else's space + */ +static void _prepare_mm_context(struct sos_thread *the_thread) +{ + /* Going to restore a thread in user mode ? */ + if (sos_cpu_context_is_in_user_mode(the_thread->cpu_state) + == TRUE) + { + /* Yes: force the MMU to be correctly setup with the correct + user's address space */ + + /* The thread should be a user thread */ + SOS_ASSERT_FATAL(the_thread->process != NULL); + + /* It should not squat any other's address space */ + SOS_ASSERT_FATAL(the_thread->squatted_mm_context == NULL); + + /* Perform an MMU context switch if needed */ + sos_mm_context_switch_to(sos_process_get_mm_context(the_thread->process)); + } + + /* the_thread is a kernel thread squatting a precise address + space ? */ + else if (the_thread->squatted_mm_context != NULL) + sos_mm_context_switch_to(the_thread->squatted_mm_context); +} + + +/** Function called after thr has terminated. Called from inside the context + of another thread, interrupts disabled */ +static void delete_thread(struct sos_thread *thr) +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + list_delete_named(thread_list, thr, gbl_prev, gbl_next); + sos_restore_IRQs(flags); + + sos_kfree((sos_vaddr_t) thr->kernel_stack_base_addr); + + /* If the thread squats an address space, release it */ + if (thr->squatted_mm_context) + SOS_ASSERT_FATAL(SOS_OK == sos_thread_change_current_mm_context(NULL)); + + /* For a user thread: remove the thread from the process threads' list */ + if (thr->process) + SOS_ASSERT_FATAL(SOS_OK == sos_process_unregister_thread(thr)); + + memset(thr, 0x0, sizeof(struct sos_thread)); + sos_kmem_cache_free((sos_vaddr_t) thr); +} + + +void sos_thread_exit() +{ + sos_ui32_t flags; + struct sos_thread *myself, *next_thread; + + /* Interrupt handlers are NOT allowed to exit the current thread ! */ + SOS_ASSERT_FATAL(! sos_servicing_irq()); + + myself = sos_thread_get_current(); + + /* Refuse to end the current executing thread if it still holds a + resource ! */ + SOS_ASSERT_FATAL(list_is_empty_named(myself->kwaitq_list, + prev_entry_for_thread, + next_entry_for_thread)); + + /* Prepare to run the next thread */ + sos_disable_IRQs(flags); + myself->state = SOS_THR_ZOMBIE; + next_thread = sos_reschedule(myself, FALSE); + + /* Make sure that the next_thread is valid */ + sos_cpu_state_detect_kernel_stack_overflow(next_thread->cpu_state, + next_thread->kernel_stack_base_addr, + next_thread->kernel_stack_size); + + /* + * Perform an MMU context switch if needed + */ + _prepare_mm_context(next_thread); + + /* No need for sos_restore_IRQs() here because the IRQ flag will be + restored to that of the next thread upon context switch */ + + /* Immediate switch to next thread */ + _set_current(next_thread); + sos_cpu_context_exit_to(next_thread->cpu_state, + (sos_cpu_kstate_function_arg1_t*) delete_thread, + (sos_ui32_t) myself); +} + + +sos_sched_priority_t sos_thread_get_priority(struct sos_thread *thr) +{ + if (! thr) + thr = (struct sos_thread*)current_thread; + + return thr->priority; +} + + +sos_thread_state_t sos_thread_get_state(struct sos_thread *thr) +{ + if (! thr) + thr = (struct sos_thread*)current_thread; + + return thr->state; +} + + +typedef enum { YIELD_MYSELF, BLOCK_MYSELF } switch_type_t; +/** + * Helper function to initiate a context switch in case the current + * thread becomes blocked, waiting for a timeout, or calls yield. + */ +static sos_ret_t _switch_to_next_thread(switch_type_t operation) +{ + struct sos_thread *myself, *next_thread; + + SOS_ASSERT_FATAL(current_thread->state == SOS_THR_RUNNING); + + /* Interrupt handlers are NOT allowed to block ! */ + SOS_ASSERT_FATAL(! sos_servicing_irq()); + + myself = (struct sos_thread*)current_thread; + + /* Make sure that if we are to be marked "BLOCKED", we have any + reason of effectively being blocked */ + if (BLOCK_MYSELF == operation) + { + myself->state = SOS_THR_BLOCKED; + } + + /* Identify the next thread */ + next_thread = sos_reschedule(myself, YIELD_MYSELF == operation); + + /* Avoid context switch if the context does not change */ + if (myself != next_thread) + { + /* Sanity checks for the next thread */ + sos_cpu_state_detect_kernel_stack_overflow(next_thread->cpu_state, + next_thread->kernel_stack_base_addr, + next_thread->kernel_stack_size); + + /* + * Perform an MMU context switch if needed + */ + _prepare_mm_context(next_thread); + + /* + * Actual CPU context switch + */ + _set_current(next_thread); + sos_cpu_context_switch(& myself->cpu_state, next_thread->cpu_state); + + /* Back here ! */ + SOS_ASSERT_FATAL(current_thread == myself); + SOS_ASSERT_FATAL(current_thread->state == SOS_THR_RUNNING); + } + else + { + /* No context switch but still update ID of current thread */ + _set_current(next_thread); + } + + return SOS_OK; +} + + +/** + * Helper function to change the thread's priority in all the + * waitqueues associated with the thread. + */ +static sos_ret_t _change_waitq_priorities(struct sos_thread *thr, + sos_sched_priority_t priority) +{ + struct sos_kwaitq_entry *kwq_entry; + int nb_waitqs; + + list_foreach_forward_named(thr->kwaitq_list, kwq_entry, nb_waitqs, + prev_entry_for_thread, next_entry_for_thread) + { + SOS_ASSERT_FATAL(SOS_OK == sos_kwaitq_change_priority(kwq_entry->kwaitq, + kwq_entry, + priority)); + } + + return SOS_OK; +} + + +sos_ret_t sos_thread_set_priority(struct sos_thread *thr, + sos_sched_priority_t priority) +{ + __label__ exit_set_prio; + sos_ui32_t flags; + sos_ret_t retval; + + + if (! SOS_SCHED_PRIO_IS_VALID(priority)) + return -SOS_EINVAL; + + if (! thr) + thr = (struct sos_thread*)current_thread; + + sos_disable_IRQs(flags); + + /* Signal kwaitq subsystem that the priority of the thread in all + the waitq it is waiting in should be updated */ + retval = _change_waitq_priorities(thr, priority); + if (SOS_OK != retval) + goto exit_set_prio; + + /* Signal scheduler that the thread, currently in a waiting list, + should take into account the change of priority */ + if (SOS_THR_READY == thr->state) + retval = sos_sched_change_priority(thr, priority); + + /* Update priority */ + thr->priority = priority; + + exit_set_prio: + sos_restore_IRQs(flags); + return retval; +} + + +sos_ret_t sos_thread_yield() +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + + retval = _switch_to_next_thread(YIELD_MYSELF); + + sos_restore_IRQs(flags); + return retval; +} + + +/** + * Internal sleep timeout management + */ +struct sleep_timeout_params +{ + struct sos_thread *thread_to_wakeup; + sos_bool_t timeout_triggered; +}; + + +/** + * Callback called when a timeout happened + */ +static void sleep_timeout(struct sos_timeout_action *act) +{ + struct sleep_timeout_params *sleep_timeout_params + = (struct sleep_timeout_params*) act->routine_data; + + /* Signal that we have been woken up by the timeout */ + sleep_timeout_params->timeout_triggered = TRUE; + + /* Mark the thread ready */ + SOS_ASSERT_FATAL(SOS_OK == + sos_thread_force_unblock(sleep_timeout_params + ->thread_to_wakeup)); +} + + +sos_ret_t sos_thread_sleep(struct sos_time *timeout) +{ + sos_ui32_t flags; + struct sleep_timeout_params sleep_timeout_params; + struct sos_timeout_action timeout_action; + sos_ret_t retval; + + /* Block forever if no timeout is given */ + if (NULL == timeout) + { + sos_disable_IRQs(flags); + retval = _switch_to_next_thread(BLOCK_MYSELF); + sos_restore_IRQs(flags); + + return retval; + } + + /* Initialize the timeout action */ + sos_time_init_action(& timeout_action); + + /* Prepare parameters used by the sleep timeout callback */ + sleep_timeout_params.thread_to_wakeup + = (struct sos_thread*)current_thread; + sleep_timeout_params.timeout_triggered = FALSE; + + sos_disable_IRQs(flags); + + /* Now program the timeout ! */ + SOS_ASSERT_FATAL(SOS_OK == + sos_time_register_action_relative(& timeout_action, + timeout, + sleep_timeout, + & sleep_timeout_params)); + + /* Prepare to block: wait for sleep_timeout() to wakeup us in the + timeout kwaitq, or for someone to wake us up in any other + waitq */ + retval = _switch_to_next_thread(BLOCK_MYSELF); + /* Unblocked by something ! */ + + /* Unblocked by timeout ? */ + if (sleep_timeout_params.timeout_triggered) + { + /* Yes */ + SOS_ASSERT_FATAL(sos_time_is_zero(& timeout_action.timeout)); + retval = SOS_OK; + } + else + { + /* No: We have probably been woken up while in some other + kwaitq */ + SOS_ASSERT_FATAL(SOS_OK == sos_time_unregister_action(& timeout_action)); + retval = -SOS_EINTR; + } + + sos_restore_IRQs(flags); + + /* Update the remaining timeout */ + memcpy(timeout, & timeout_action.timeout, sizeof(struct sos_time)); + + return retval; +} + + +sos_ret_t sos_thread_force_unblock(struct sos_thread *thread) +{ + sos_ret_t retval; + sos_ui32_t flags; + + if (! thread) + return -SOS_EINVAL; + + sos_disable_IRQs(flags); + + /* Thread already woken up ? */ + retval = SOS_OK; + switch(sos_thread_get_state(thread)) + { + case SOS_THR_RUNNING: + case SOS_THR_READY: + /* Do nothing */ + break; + + case SOS_THR_ZOMBIE: + retval = -SOS_EFATAL; + break; + + default: + retval = sos_sched_set_ready(thread); + break; + } + + sos_restore_IRQs(flags); + + return retval; +} + + +void sos_thread_dump_backtrace(sos_bool_t on_console, + sos_bool_t on_bochs) +{ + sos_vaddr_t stack_bottom = current_thread->kernel_stack_base_addr; + sos_size_t stack_size = current_thread->kernel_stack_size; + + static void backtracer(sos_vaddr_t PC, + sos_vaddr_t params, + sos_ui32_t depth, + void *custom_arg) + { + sos_ui32_t invalid = 0xffffffff, *arg1, *arg2, *arg3, *arg4; + + /* Get the address of the first 3 arguments from the + frame. Among these arguments, 0, 1, 2, 3 arguments might be + meaningful (depending on how many arguments the function may + take). */ + arg1 = (sos_ui32_t*)params; + arg2 = (sos_ui32_t*)(params+4); + arg3 = (sos_ui32_t*)(params+8); + arg4 = (sos_ui32_t*)(params+12); + + /* Make sure the addresses of these arguments fit inside the + stack boundaries */ +#define INTERVAL_OK(b,v,u) ( ((b) <= (sos_vaddr_t)(v)) \ + && ((sos_vaddr_t)(v) < (u)) ) + if (!INTERVAL_OK(stack_bottom, arg1, stack_bottom + stack_size)) + arg1 = &invalid; + if (!INTERVAL_OK(stack_bottom, arg2, stack_bottom + stack_size)) + arg2 = &invalid; + if (!INTERVAL_OK(stack_bottom, arg3, stack_bottom + stack_size)) + arg3 = &invalid; + if (!INTERVAL_OK(stack_bottom, arg4, stack_bottom + stack_size)) + arg4 = &invalid; + + /* Print the function context for this frame */ + if (on_bochs) + sos_bochs_printf("[%d] PC=0x%x arg1=0x%x arg2=0x%x arg3=0x%x\n", + (unsigned)depth, (unsigned)PC, + (unsigned)*arg1, (unsigned)*arg2, + (unsigned)*arg3); + + if (on_console) + sos_x86_videomem_printf(23-depth, 3, + SOS_X86_VIDEO_BG_BLUE + | SOS_X86_VIDEO_FG_LTGREEN, + "[%d] PC=0x%x arg1=0x%x arg2=0x%x arg3=0x%x arg4=0x%x", + (unsigned)depth, PC, + (unsigned)*arg1, (unsigned)*arg2, + (unsigned)*arg3, (unsigned)*arg4); + + } + + sos_backtrace(NULL, 15, stack_bottom, stack_size, + backtracer, NULL); +} + + + +/* ********************************************** + * Restricted functions + */ + + +sos_ret_t +sos_thread_change_current_mm_context(struct sos_mm_context *mm_ctxt) +{ + sos_ui32_t flags; + + /* Retrieve the previous mm context */ + struct sos_mm_context * prev_mm_ctxt + = current_thread->squatted_mm_context; + + /* We should either select a new squatted_mm_context or revert to + the default */ + if (mm_ctxt != NULL) + SOS_ASSERT_FATAL(prev_mm_ctxt == NULL); + else + SOS_ASSERT_FATAL(prev_mm_ctxt != NULL); + + sos_disable_IRQs(flags); + + /* Update current thread's squatted mm context */ + current_thread->squatted_mm_context = mm_ctxt; + + /* Update the reference counts and switch the MMU configuration if + needed */ + if (mm_ctxt != NULL) + { + sos_mm_context_ref(mm_ctxt); /* Because it is now referenced as + the squatted_mm_context field of + the thread */ + sos_mm_context_switch_to(mm_ctxt); + } + else + sos_mm_context_unref(prev_mm_ctxt); /* Because it is not referenced as + the squatted_mm_context field of + the thread any more */ + + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +void sos_thread_prepare_syscall_switch_back(struct sos_cpu_state *cpu_state) +{ + /* Don't preempt the current thread */ + + /* + * Save the state of the interrupted context to make sure that: + * - The list of threads correctly reflects that the thread is back + * in user mode + * - _prepare_mm_context() deals with the correct mm_context + */ + current_thread->cpu_state = cpu_state; + + /* Perform an MMU context switch if needed */ + _prepare_mm_context((struct sos_thread*) current_thread); +} + + +void sos_thread_prepare_exception_switch_back(struct sos_cpu_state *cpu_state) +{ + /* Don't preempt the current thread */ + + /* + * Save the state of the interrupted context to make sure that: + * - The list of threads correctly reflects that the thread is + * running in user or kernel mode + * - _prepare_mm_context() deals with the correct mm_context + */ + current_thread->cpu_state = cpu_state; + + /* Perform an MMU context switch if needed */ + _prepare_mm_context((struct sos_thread*) current_thread); +} + + +void +sos_thread_prepare_irq_servicing(struct sos_cpu_state *interrupted_state) +{ + current_thread->cpu_state = interrupted_state; +} + + +struct sos_cpu_state * +sos_thread_prepare_irq_switch_back(void) +{ + struct sos_thread *myself, *next_thread; + + /* In SOS, threads in kernel mode are NEVER preempted from the + interrupt handlers ! */ + if (! sos_cpu_context_is_in_user_mode(current_thread->cpu_state)) + return current_thread->cpu_state; + + /* + * Here we are dealing only with possible preemption of user threads + * in user context ! + */ + + /* Make sure the thread actually is a user thread */ + SOS_ASSERT_FATAL(current_thread->process != NULL); + + /* Save the state of the interrupted context */ + myself = (struct sos_thread*)current_thread; + + /* Select the next thread to run */ + next_thread = sos_reschedule(myself, FALSE); + + /* Perform an MMU context switch if needed */ + _prepare_mm_context(next_thread); + + /* Setup the next_thread's context into the CPU */ + _set_current(next_thread); + return next_thread->cpu_state; +} diff --git a/sos/thread.h b/sos/thread.h new file mode 100644 index 0000000..0fbd044 --- /dev/null +++ b/sos/thread.h @@ -0,0 +1,389 @@ +/* Copyright (C) 2004,2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_THREAD_H_ +#define _SOS_THREAD_H_ + +/** + * @file thread.h + * + * SOS Thread management API + */ + +#include + +/* Forward declaration */ +struct sos_thread; + +#include +#include +#include +#include +#include + +/** + * The possible states of a valid thread + */ +typedef enum { SOS_THR_CREATED, /**< Thread created, not fully initialized */ + SOS_THR_READY, /**< Thread fully initialized or + waiting for CPU after having been + blocked or preempted */ + SOS_THR_RUNNING, /**< Thread currently running on CPU */ + SOS_THR_BLOCKED, /**< Thread waiting for I/O (+ in at LEAST + one kwaitq) and/or sleeping (+ in NO + kwaitq) */ + SOS_THR_ZOMBIE, /**< Thread terminated execution, waiting to + be deleted by kernel */ + } sos_thread_state_t; + + +/** + * TCB (Thread Control Block): structure describing a thread. Don't + * access these fields directly: prefer using the accessor functions + * below. + */ +struct sos_thread +{ +#define SOS_THR_MAX_NAMELEN 32 + char name[SOS_THR_MAX_NAMELEN]; + + sos_thread_state_t state; + sos_sched_priority_t priority; + + /** + * The hardware context of the thread. + * + * It will reflect the CPU state of the thread: + * - From an interrupt handler: the state of the thread at the time + * of the OUTERMOST irq. An IRQ is not allowed to make context + * switches, so this context will remain valid from the begining of + * the outermost IRQ handler to the end of it, no matter if there + * are other IRQ handlers nesting in one another. You may safely + * use it from IRQ handlers to query the state of the interrupted + * thread, no matter if there has been other IRQ handlers + * executing meanwhile. + * - From normal kernel code, exceptions and syscall: the state of + * the thread the last time there was a context switch from this + * thread to another one. Thus this field WON'T reflect the + * current's thread cpu_state in these cases. So, in these cases, + * simply DO NOT USE IT outside thread.c ! Note: for syscall and + * exception handlers, the VALID state of the interrupted thread is + * passed as an argument to the handlers. + */ + struct sos_cpu_state *cpu_state; + + /* Kernel stack parameters */ + sos_vaddr_t kernel_stack_base_addr; + sos_size_t kernel_stack_size; + + /* Process this thread belongs to. Always NULL for a kernel + thread */ + struct sos_process *process; + + /** + * Address space currently "squatted" by the thread, or used to be + * active when the thread was interrupted/preempted. This is the MMU + * configuration expected before the cpu_state of the thread is + * restored on CPU. + * - For kernel threads: should normally be NULL, meaning that the + * thread will squat the current mm_context currently set in the + * MMU. Might be NON NULL when a kernel thread squats a given + * process to manipulate its address space. + * - For user threads: should normally be NULL. More precisely: + * - in user mode: the thread->process.mm_context is ALWAYS + * set on MMU. squatted_mm_context is ALWAYS NULL in this + * situation, meaning that the thread in user mode uses its + * process-space as expected + * - in kernel mode: NULL means that we keep on using the + * mm_context currently set on MMU, which might be the + * mm_context of another process. This is natural since a + * thread in kernel mode normally only uses data in kernel + * space. BTW, this limits the number of TLB flushes. However, + * there are exceptions where this squatted_mm_context will + * NOT be NULL. One is the copy_from/to_user API, which can + * force the effective mm_context so that the MMU will be + * (re)configured upon every context to the thread to match + * the squatted_mm_context. Another exception is when a parent + * thread creates the address space of a child process, in + * which case the parent thread might temporarilly decide to + * switch to the child's process space. + * + * This is the SOS implementation of the Linux "Lazy TLB" and + * address-space loaning. + */ + struct sos_mm_context *squatted_mm_context; + + /* Data specific to each state */ + union + { + struct + { + struct sos_sched_queue *rdy_queue; + struct sos_thread *rdy_prev, *rdy_next; + } ready; + + struct + { + struct sos_time user_time_spent_in_slice; + } running; + }; /* Anonymous union (gcc extenion) */ + + + /* + * Data used by the kwaitq subsystem: list of kwaitqueues the thread + * is waiting for. + * + * @note: a RUNNING or READY thread might be in one or more + * waitqueues ! The only property we have is that, among these + * waitqueues (if any), _at least_ one has woken the thread. + */ + struct sos_kwaitq_entry *kwaitq_list; + + + /** + * Some statistics + */ + struct rusage + { + /* Updated by sched.c */ + struct sos_time ru_utime; /* Time spent in user mode */ + struct sos_time ru_stime; /* Time spent in kernel mode */ + } rusage; + + + /** + * Chaining pointers for the list of threads in the parent process + */ + struct sos_thread *prev_in_process, *next_in_process; + + + /** + * Chaining pointers for global ("gbl") list of threads (debug) + */ + struct sos_thread *gbl_prev, *gbl_next; +}; + + +/** + * Definition of the function executed by a kernel thread + */ +typedef void (*sos_kernel_thread_start_routine_t)(void *arg); + + +/** + * Initialize the subsystem responsible for thread management + * + * Initialize the primary kernel thread so that it can be handled the + * same way as an ordinary thread created by sos_thread_create(). + */ +sos_ret_t sos_thread_subsystem_setup(sos_vaddr_t init_thread_stack_base_addr, + sos_size_t init_thread_stack_size); + + +/** + * Create a new kernel thread + */ +struct sos_thread * +sos_create_kernel_thread(const char *name, + sos_kernel_thread_start_routine_t start_func, + void *start_arg, + sos_sched_priority_t priority); + + +/** + * Create a new user thread + */ +struct sos_thread * +sos_create_user_thread(const char *name, + struct sos_process *process, + sos_uaddr_t user_initial_PC, + sos_ui32_t user_start_arg1, + sos_ui32_t user_start_arg2, + sos_uaddr_t user_initial_SP, + sos_sched_priority_t priority); + + +/** + * Terminate the execution of the current thread. For kernel threads, + * it is called by default when the start routine returns. + */ +void sos_thread_exit() __attribute__((noreturn)); + + +/** + * Get the identifier of the thread currently running on CPU. Trivial + * function. + */ +struct sos_thread *sos_thread_get_current(); + + +/** + * If thr == NULL, set the priority of the current thread. Trivial + * function. + * + * @note NOT protected against interrupts + */ +sos_sched_priority_t sos_thread_get_priority(struct sos_thread *thr); + + +/** + * If thr == NULL, get the state of the current thread. Trivial + * function. + * + * @note NOT protected against interrupts + */ +sos_thread_state_t sos_thread_get_state(struct sos_thread *thr); + + +/** + * If thr == NULL, set the priority of the current thread + * + * @note NO context-switch ever occurs in this function ! + */ +sos_ret_t sos_thread_set_priority(struct sos_thread *thr, + sos_sched_priority_t priority); + + +/** + * Yield CPU to another ready thread. + * + * @note This is a BLOCKING FUNCTION + */ +sos_ret_t sos_thread_yield(); + + +/** + * Release the CPU for (at least) the given delay. + * + * @param delay The delay to wait for. If delay == NULL then wait + * forever that any event occurs. + * + * @return SOS_OK when delay expired (and delay is reset to zero), + * -SOS_EINTR otherwise (and delay contains the amount of time + * remaining). + * + * @note This is a BLOCKING FUNCTION + */ +sos_ret_t sos_thread_sleep(/* in/out */struct sos_time *delay); + + +/** + * Mark the given thread as READY (if not already ready) even if it is + * blocked in a kwaitq or in a sleep ! As a result, the interrupted + * kwaitq/sleep function call of the thread will return with + * -SOS_EINTR. + * + * @return -SOS_EINVAL if thread does not exist, or -SOS_EFATAL if + * marked ZOMBIE. + * + * @note As a result, the semaphore/mutex/conditions/... functions + * return values SHOULD ALWAYS be checked ! If they are != SOS_OK, + * then the caller should consider that the resource is not aquired + * because somebody woke the thread by some way. + */ +sos_ret_t sos_thread_force_unblock(struct sos_thread *thread); + +/** + * Dump the backtrace of the current thread to console and/or bochs + */ +void sos_thread_dump_backtrace(sos_bool_t on_console, + sos_bool_t on_bochs); + + +/* ********************************************** + * Restricted functions + */ + + +/** + * Restricted function to change the current mm_context AND the + * squatted_mm_context of the current thread in order to access the data + * in this context + * + * @param mm_ctxt The mm_ctxt to restore. Might be NULL, meaning that: + * - for a Kernel thread: the current MMU configuration is never + * modified. The address space to use is limited to the kernel + * space, user space might change due to preemptions to other + * processes + * - for a User thread in kernel mode: same as for kernel threads + * - when a User thread will go back in user context: the MMU will + * be reconfigured to match the mm_context of the thread's + * process + * + * @note A non NULL parameter is allowed only if the + * squatted_mm_context is not already set. A NULL parameter is allowed + * only if the squatted_mm_context was already set. + * + * @note The use of this function is RESERVED to the syscall handler + * and the copy_from/to_user functions + */ +sos_ret_t +sos_thread_change_current_mm_context(struct sos_mm_context *mm_ctxt); + + +/** + * Restricted callback called when a syscall goes back in user mode, + * to reconfigure the MMU to match that of the current thread's + * process MMU context. + * + * @note The use of this function is RESERVED to the syscall wrapper + */ +void sos_thread_prepare_syscall_switch_back(struct sos_cpu_state *cpu_state); + + +/** + * Restricted callback called when an exception handler goes back to + * the interrupted thread to reconfigure the MMU to match that of the + * current thread's process MMU context. + * + * @note The use of this function is RESERVED to the exception wrappers + */ +void sos_thread_prepare_exception_switch_back(struct sos_cpu_state *cpu_state); + + +/** + * Restricted callback called when an IRQ is entered while the CPU was + * NOT already servicing any other IRQ (ie the outermost IRQ handler + * is entered). This callback simply updates the "cpu_state" field so + * that IRQ handlers always know the state of the interrupted thread, + * even if they are imbricated in other IRQ handlers. + * + * @note The use of this function is RESERVED to the irq wrappers + */ +void +sos_thread_prepare_irq_servicing(struct sos_cpu_state *interrupted_state); + + +/** + * Restricted callback called when the outermost IRQ handler returns, + * to select the thread to return to. This callbacks implements: + * - preemption of user threads in user mode (time sharing / FIFO) + * - non-preemption of user threads in kernel mode (interrupted thread + * is restored on CPU "as is") + * - non-preemption of kernel threads (same remark) + * The MMU is reconfigured correctly to match the address space of the + * selected thread. + * + * @return The CPU context of the thread to return to + * + * @note The use of this function is RESERVED to the irq wrappers + */ +struct sos_cpu_state * +sos_thread_prepare_irq_switch_back(void); + + +#endif /* _SOS_THREAD_H_ */ diff --git a/sos/time.c b/sos/time.c new file mode 100644 index 0000000..5181959 --- /dev/null +++ b/sos/time.c @@ -0,0 +1,355 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include + +#include "time.h" + + +/** + * Number of nanoseconds in 1 second + */ +#define NS_IN_SEC 1000000000UL + + +/** + * The list of timeout actions waiting for a timeout. The timeout + * actions are stored in the list in increasing initial timeout + * order. Actually, the "timeout" field won't reflect this initial + * timeout: for each element in the list, it stores the timeout + * _difference_ between the timeout action and the previous in the + * list. + */ +static struct sos_timeout_action *timeout_action_list; + + +/** + * Current resolution of a time tick + */ +static struct sos_time tick_resolution; + + +/** + * Time elapsed between boot and last timer tick + * + * @note No 'volatile' here because the tick value is NEVER modified + * while in any of the functions below: it is modified only out of + * these functions by the IRQ timer handler because these functions + * are protected against timer IRQ and are "one shot" (no busy waiting + * for a change in the tick's value). + */ +static struct sos_time last_tick_time; + + +sos_ret_t sos_time_inc(struct sos_time *dest, + const struct sos_time *to_add) +{ + /* nanosec is always < 1e9 so that their sum is always < 2e9, which + is smaller than 2^32-1 */ + sos_ui32_t sigma_ns = dest->nanosec + to_add->nanosec; + + dest->sec += to_add->sec; + dest->sec += sigma_ns / NS_IN_SEC; + dest->nanosec = sigma_ns % NS_IN_SEC; + return SOS_OK; +} + + +sos_ret_t sos_time_dec(struct sos_time *dest, + const struct sos_time *to_dec) +{ + /* nanosec is always < 1e9 so that their difference is always in + (-1e9, 1e9), which is compatible with the (-2^31, 2^31 - 1) + cpacity of a signed dword */ + sos_si32_t diff_ns = ((sos_si32_t)dest->nanosec) + - ((sos_si32_t)to_dec->nanosec); + + /* Make sure substraction is possible */ + SOS_ASSERT_FATAL(dest->sec >= to_dec->sec); + if (dest->sec == to_dec->sec) + SOS_ASSERT_FATAL(dest->nanosec >= to_dec->nanosec); + + dest->sec -= to_dec->sec; + if (diff_ns > 0) + dest->sec += diff_ns / NS_IN_SEC; + else + dest->sec -= ((-diff_ns) / NS_IN_SEC); + dest->nanosec = (NS_IN_SEC + diff_ns) % NS_IN_SEC; + if (diff_ns < 0) + dest->sec --; + return SOS_OK; +} + + +int sos_time_cmp(const struct sos_time *t1, + const struct sos_time *t2) +{ + /* Compare seconds */ + if (t1->sec < t2->sec) + return -1; + else if (t1->sec > t2->sec) + return 1; + + /* seconds are equal => compare nanoseconds */ + else if (t1->nanosec < t2->nanosec) + return -1; + else if (t1->nanosec > t2->nanosec) + return 1; + + /* else: sec and nanosecs are equal */ + return 0; +} + + +sos_bool_t sos_time_is_zero(const struct sos_time *tm) +{ + return ( (0 == tm->sec) && (0 == tm->nanosec) ); +} + + +sos_ret_t sos_time_subsysem_setup(const struct sos_time *initial_resolution) +{ + timeout_action_list = NULL; + last_tick_time = (struct sos_time) { .sec = 0, .nanosec = 0 }; + memcpy(& tick_resolution, initial_resolution, sizeof(struct sos_time)); + + return SOS_OK; +} + + +sos_ret_t sos_time_get_tick_resolution(struct sos_time *resolution) +{ + sos_ui32_t flags; + sos_disable_IRQs(flags); + + memcpy(resolution, & tick_resolution, sizeof(struct sos_time)); + + sos_restore_IRQs(flags); + return SOS_OK; +} + + +sos_ret_t sos_time_set_tick_resolution(const struct sos_time *resolution) +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + memcpy(& tick_resolution, resolution, sizeof(struct sos_time)); + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +sos_ret_t sos_time_get_now(struct sos_time *now) +{ + sos_ui32_t flags; + sos_disable_IRQs(flags); + + memcpy(now, & last_tick_time, sizeof(struct sos_time)); + + sos_restore_IRQs(flags); + return SOS_OK; +} + + +/** + * Helper routine to add the action in the list. MUST be called with + * interrupts disabled ! + */ +static sos_ret_t _add_action(struct sos_timeout_action *act, + const struct sos_time *due_date, + sos_bool_t is_relative_due_date, + sos_timeout_routine_t *routine, + void *routine_data) +{ + struct sos_timeout_action *other, *insert_before; + int nb_act; + + /* Delay must be specified */ + if (due_date == NULL) + return -SOS_EINVAL; + + /* Action container MUST be specified */ + if (act == NULL) + return -SOS_EINVAL; + + /* Refuse to add an empty action */ + if (NULL == routine) + return -SOS_EINVAL; + + /* Refuse to add the action if it is already added */ + if (NULL != act->tmo_next) + return -SOS_EBUSY; + + /* Compute action absolute due date */ + if (is_relative_due_date) + { + /* The provided due_date is relative to the current time */ + memcpy(& act->timeout, & last_tick_time, sizeof(struct sos_time)); + sos_time_inc(& act->timeout, due_date); + } + else + { + /* The provided due_date is absolute (ie relative to the system + boot instant) */ + + if (sos_time_cmp(due_date, & last_tick_time) < 0) + /* Refuse to add a past action ! */ + return -SOS_EINVAL; + + memcpy(& act->timeout, due_date, sizeof(struct sos_time)); + } + + /* Prepare the action data structure */ + act->routine = routine; + act->routine_data = routine_data; + + /* Find the right place in the list of the timeout action. */ + insert_before = NULL; + list_foreach_forward_named(timeout_action_list, + other, nb_act, + tmo_prev, tmo_next) + { + if (sos_time_cmp(& act->timeout, & other->timeout) < 0) + { + insert_before = other; + break; + } + + /* Loop over to next timeout */ + } + + /* Now insert the action in the list */ + if (insert_before != NULL) + list_insert_before_named(timeout_action_list, insert_before, act, + tmo_prev, tmo_next); + else + list_add_tail_named(timeout_action_list, act, + tmo_prev, tmo_next); + + return SOS_OK; +} + + +sos_ret_t +sos_time_register_action_relative(struct sos_timeout_action *act, + const struct sos_time *delay, + sos_timeout_routine_t *routine, + void *routine_data) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = _add_action(act, delay, TRUE, routine, routine_data); + sos_restore_IRQs(flags); + + return retval; +} + + +sos_ret_t +sos_time_register_action_absolute(struct sos_timeout_action *act, + const struct sos_time *date, + sos_timeout_routine_t *routine, + void *routine_data) +{ + sos_ui32_t flags; + sos_ret_t retval; + + sos_disable_IRQs(flags); + retval = _add_action(act, date, FALSE, routine, routine_data); + sos_restore_IRQs(flags); + + return retval; +} + + +/** + * Helper routine to remove the action from the list. MUST be called + * with interrupts disabled ! + */ +static sos_ret_t _remove_action(struct sos_timeout_action *act) +{ + /* Don't do anything if action is not in timeout list */ + if (NULL == act->tmo_next) + return -SOS_EINVAL; + + /* Update the action's remaining timeout */ + if (sos_time_cmp(& act->timeout, & last_tick_time) <= 0) + act->timeout = (struct sos_time){ .sec=0, .nanosec=0 }; + else + sos_time_dec(& act->timeout, & last_tick_time); + + /* Actually remove the action from the list */ + list_delete_named(timeout_action_list, act, + tmo_prev, tmo_next); + act->tmo_prev = act->tmo_next = NULL; + + return SOS_OK; +} + + +sos_ret_t sos_time_unregister_action(struct sos_timeout_action *act) +{ + sos_ret_t retval; + sos_ui32_t flags; + + sos_disable_IRQs(flags); + retval = _remove_action(act); + sos_restore_IRQs(flags); + + return SOS_OK; +} + + +sos_ret_t sos_time_do_tick() +{ + sos_ui32_t flags; + + sos_disable_IRQs(flags); + + /* Update kernel time */ + sos_time_inc(& last_tick_time, & tick_resolution); + + while (! list_is_empty_named(timeout_action_list, tmo_prev, tmo_next)) + { + struct sos_timeout_action *act; + act = list_get_head_named(timeout_action_list, tmo_prev, tmo_next); + + /* Did we go too far in the actions' list ? */ + if (sos_time_cmp(& last_tick_time, & act->timeout) < 0) + { + /* Yes: No need to look further. */ + break; + } + + /* Remove the action from the list */ + _remove_action(act); + + /* Call the action's routine */ + act->routine(act); + } + + sos_restore_IRQs(flags); + return SOS_OK; +} diff --git a/sos/time.h b/sos/time.h new file mode 100644 index 0000000..7d3a90b --- /dev/null +++ b/sos/time.h @@ -0,0 +1,222 @@ +/* Copyright (C) 2004 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_TIME_H_ +#define _SOS_TIME_H_ + +/** + * @file time.h + * + * Primitives and callbacks related to kernel time management (timer + * IRQ) + */ + +#include +#include +#include + + +/* ======================================================================= + * Library of time manipulation functions + */ +struct sos_time +{ + sos_ui32_t sec; + sos_ui32_t nanosec; +}; + +sos_ret_t sos_time_inc(struct sos_time *dest, + const struct sos_time *to_add); + +sos_ret_t sos_time_dec(struct sos_time *dest, + const struct sos_time *to_dec); + +int sos_time_cmp(const struct sos_time *t1, + const struct sos_time *t2); + +sos_bool_t sos_time_is_zero(const struct sos_time *tm); + + + +/* ======================================================================= + * Kernel time management. This is not the same as the "system-time", + * ie it does not not take into account the system-time adjustments + * (NTP, daylight saving times, etc...): this is the job of a + * system-time subsystem. + */ + + +/** + * Initialize kernel time subsystem. + * + * @param initial_resolution The initial time resolution. MUST be + * consistent with that of the hardware timer + */ +sos_ret_t sos_time_subsysem_setup(const struct sos_time *initial_resolution); + + +/** + * Value of the interval between 2 time ticks. Should be consistent + * with the configuration of the hardware timer. + */ +sos_ret_t sos_time_get_tick_resolution(struct sos_time *resolution); + + +/** + * Change the value of the interval between 2 time ticks. Must be + * called each time the hardware timer is reconfigured. + * + * @note MUST be consistent with that of the hardware timer + */ +sos_ret_t sos_time_set_tick_resolution(const struct sos_time *resolution); + + +/** + * Get the time elapsed since system boot. Does not take into account + * the system-time adjustment (NTP, daylight saving times, etc...): + * this is the job of a system-time subsystem. + */ +sos_ret_t sos_time_get_now(struct sos_time *now); + + + +/* ======================================================================= + * Routines to schedule future execution of routines: "timeout" actions + */ + +/* Forward declaration */ +struct sos_timeout_action; + +/** + * Prototype of a timeout routine. Called with IRQ disabled ! + */ +typedef void (sos_timeout_routine_t)(struct sos_timeout_action *); + + +/** + * The structure of a timeout action. This structure should have been + * opaque to the other parts of the kernel. We keep it public here so + * that struct sos_timeout_action can be allocated on the stack from + * other source files in the kernel. However, all the fields should be + * considered read-only for modules others than time.{ch}. + * + * @note After an action has been allocated (on the stack or kmalloc), + * it MUST be initialized with sos_time_init_action below ! + */ +struct sos_timeout_action +{ + /** PUBLIC: Address of the timeout routine */ + sos_timeout_routine_t *routine; + + /** PUBLIC: (Custom) data available for this routine */ + void *routine_data; + + /** PUBLIC: 2 meanings: + * - before and while in the timeout list: absolute due date of the + * timeout action + * - once removed from timeout list: the time remaining in the + * initial timeout (might be 0 if timeout expired) at removal + * time + */ + struct sos_time timeout; + + /** PRIVATE: To chain the timeout actions */ + struct sos_timeout_action *tmo_prev, *tmo_next; +}; + + +/** + * Initialize a timeout action. MUST be called immediately after + * (stack or kmalloc) allocation of the action. + * + * @param ptr_act Pointer to the action to initialize. + */ +#define sos_time_init_action(ptr_act) \ + ({ (ptr_act)->tmo_prev = (ptr_act)->tmo_next = NULL; /* return */ SOS_OK; }) + + +/** + * Add the given action in the timeout list, so that it will be + * triggered after the specified delay RELATIVE to the time when the + * function gets called. The action is always inserted in the list. + * + * @param act The action to be initialized by the function upon + * insertion in the timeout list. + * + * @param delay Delay until the action is fired. If 0, then it is + * fired at next timer IRQ. The action will be fired in X ticks, with + * X integer and >= delay. + * + * @param routine The timeout routine to call when the timeout will be + * triggered. + * + * @param routine_data The data available to the routine when it will + * be called. + * + * @note 'act' MUST remain valid until it is either fired or removed + * (with sos_time_remove_action) + */ +sos_ret_t +sos_time_register_action_relative(struct sos_timeout_action *act, + const struct sos_time *delay, + sos_timeout_routine_t *routine, + void *routine_data); + + +/** + * Add the given action in the timeout list, so that it will be + * triggered after the specified ABSOLUTE date (relative to system + * boot time). The action is always inserted in the list. + * + * @param act The action to be initialized by the function upon + * insertion in the timeout list. + * + * @param date Absolute date (relative to system boot time) when the + * action will be triggered. + * + * @param routine The timeout routine to call when the timeout will be + * triggered. + * + * @param routine_data The data available to the routine when it will + * be called. + * + * @note 'act' MUST remain valid until it is either fired or removed + * (with sos_time_remove_action) + */ +sos_ret_t +sos_time_register_action_absolute(struct sos_timeout_action *act, + const struct sos_time *date, + sos_timeout_routine_t *routine, + void *routine_data); + + +/** + * The action is removed and its timeout is updated to reflect the + * time remaining. + */ +sos_ret_t sos_time_unregister_action(struct sos_timeout_action *act); + + +/** + * Timer IRQ callback. Call and remove expired actions from the list. + * + * @note The use of this function is RESERVED (to timer IRQ) + */ +sos_ret_t sos_time_do_tick(); + + +#endif /* _SOS_TIME_H_ */ diff --git a/sos/types.h b/sos/types.h new file mode 100644 index 0000000..1272e05 --- /dev/null +++ b/sos/types.h @@ -0,0 +1,67 @@ +/* Copyright (C) 2004 The SOS Team + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_TYPES_H_ +#define _SOS_TYPES_H_ + +/** + * @file types.h + * + * SOS basic types definition + */ + +/** Physical address */ +typedef unsigned int sos_paddr_t; + +/** Kernel virtual address */ +typedef unsigned int sos_vaddr_t; + +/** User virtual address */ +typedef unsigned int sos_uaddr_t; + +/** Memory size of an object (positive) */ +typedef unsigned int sos_size_t; +/** Generic positive offset into objects */ +typedef unsigned int sos_uoffset_t; +/** Generic signed offset into objects */ +typedef signed int sos_soffset_t; +/** Generic positive LONG (64 bits) offset into objects */ +typedef unsigned long long int sos_luoffset_t; +/** Generic signed LONG (64 bits) offset into objects */ +typedef signed long long int sos_lsoffset_t; + +/** Generic count of objects */ +typedef unsigned int sos_count_t; + +/* Low-level sizes */ +typedef unsigned long long int sos_ui64_t; /**< 32b unsigned */ +typedef unsigned long int sos_ui32_t; /**< 32b unsigned */ +typedef unsigned short int sos_ui16_t; /**< 16b unsigned */ +typedef unsigned char sos_ui8_t; /**< 8b unsigned */ + +typedef signed long long int sos_si64_t; /**< 64b signed */ +typedef signed long int sos_si32_t; /**< 32b signed */ +typedef signed short int sos_si16_t; /**< 16b signed */ +typedef signed char sos_si8_t; /**< 8b signed */ + +typedef enum { FALSE=0, TRUE } sos_bool_t; + +/** Not a proper type, but highly useful with basic type + manipulations */ +#define NULL ((void*)0) + +#endif /* _SOS_TYPES_H_ */ diff --git a/sos/uaccess.c b/sos/uaccess.c new file mode 100644 index 0000000..75384dd --- /dev/null +++ b/sos/uaccess.c @@ -0,0 +1,200 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include +#include +#include +#include + +#include "uaccess.h" + + +/** + * Helper function to force the MMU to switch to the address space of + * the process + */ +static sos_ret_t bindto_user_mm_context() +{ + struct sos_thread * current_thread; + struct sos_mm_context * process_mm_ctxt; + + current_thread = sos_thread_get_current(); + SOS_ASSERT_FATAL(NULL != current_thread->process); + + /* Switch to the user's address space */ + process_mm_ctxt + = sos_process_get_mm_context(current_thread->process); + return sos_thread_change_current_mm_context(process_mm_ctxt); +} + + +/** + * Helper macro to restore the MMU configuration prior to + * bindto_user_mm_context() + */ +#define unbindto_user_mm_context() \ + sos_thread_change_current_mm_context(NULL) + + +static sos_ret_t nocheck_user_memcpy(sos_vaddr_t dest, + sos_vaddr_t src, + sos_size_t size, + sos_bool_t transfer_from_user) +{ + sos_ret_t retval; + + retval = bindto_user_mm_context(); + if (SOS_OK != retval) + return retval; + + memcpy((void*) dest, (void*) src, size); + + retval = unbindto_user_mm_context(); + if (SOS_OK != retval) + return retval; + + return size; +} + + +sos_ret_t sos_memcpy_from_user(sos_vaddr_t kernel_to, + sos_uaddr_t user_from, + sos_size_t size) +{ + /* Make sure user is trying to access user space */ + if (user_from < SOS_PAGING_BASE_USER_ADDRESS) + return -SOS_EPERM; + + if (user_from > SOS_PAGING_TOP_USER_ADDRESS - size) + return -SOS_EPERM; + + return nocheck_user_memcpy(kernel_to, user_from, size, TRUE); +} + + +sos_ret_t sos_memcpy_to_user(sos_uaddr_t user_to, + sos_vaddr_t kernel_from, + sos_size_t size) +{ + /* Make sure user is trying to access user space */ + if (user_to < SOS_PAGING_BASE_USER_ADDRESS) + return -SOS_EPERM; + + if (user_to > SOS_PAGING_TOP_USER_ADDRESS - size) + return -SOS_EPERM; + + return nocheck_user_memcpy(user_to, kernel_from, size, FALSE); +} + + +sos_ret_t sos_strnlen_from_user(sos_uaddr_t user_str, sos_size_t max_len) +{ + sos_ret_t retval, len; + + /* Make sure user is trying to access user space */ + if (user_str < SOS_PAGING_BASE_USER_ADDRESS) + return -SOS_EPERM; + + /* Don't allow invalid max_len */ + if ( (max_len < 1) || (max_len > SOS_PAGING_USER_SPACE_SIZE) ) + return -SOS_EINVAL; + + retval = bindto_user_mm_context(); + if (SOS_OK != retval) + return retval; + + len = strnlen((const char*)user_str, max_len); + + retval = unbindto_user_mm_context(); + if (SOS_OK != retval) + return retval; + + return len; +} + + +static sos_ret_t nocheck_user_strzcpy(char *dst, const char *src, + sos_size_t len) +{ + sos_ret_t retval; + + retval = bindto_user_mm_context(); + if (SOS_OK != retval) + return retval; + + strzcpy(dst, src, len); + + retval = unbindto_user_mm_context(); + if (SOS_OK != retval) + return retval; + + return SOS_OK; +} + + +sos_ret_t sos_strzcpy_from_user(char *kernel_to, sos_uaddr_t user_from, + sos_size_t max_len) +{ + /* Make sure user is trying to access user space */ + if ((sos_uaddr_t)user_from < SOS_PAGING_BASE_USER_ADDRESS) + return -SOS_EPERM; + + /* Don't allow invalid max_len */ + if ( (max_len < 1) || (max_len > SOS_PAGING_USER_SPACE_SIZE) ) + return -SOS_EINVAL; + + return nocheck_user_strzcpy(kernel_to, (const char*)user_from, max_len); +} + + +sos_ret_t sos_strzcpy_to_user(sos_uaddr_t user_to, const char *kernel_from, + sos_size_t max_len) +{ + /* Make sure user is trying to access user space */ + if ((sos_uaddr_t)user_to < SOS_PAGING_BASE_USER_ADDRESS) + return -SOS_EPERM; + + /* Don't allow invalid max_len */ + if ( (max_len < 1) || (max_len > SOS_PAGING_USER_SPACE_SIZE) ) + return -SOS_EINVAL; + + return nocheck_user_strzcpy((char*)user_to, kernel_from, max_len); +} + + +sos_ret_t sos_strndup_from_user(char ** kernel_to, sos_uaddr_t from_user, + sos_size_t max_len, + sos_ui32_t kmalloc_flags) +{ + sos_ret_t retval = sos_strnlen_from_user(from_user, max_len); + if (retval < 0) + return retval; + + *kernel_to = (char*)sos_kmalloc(retval + 1, kmalloc_flags); + if (NULL == *kernel_to) + return -SOS_ENOMEM; + + retval = sos_strzcpy_from_user(*kernel_to, from_user, retval + 1); + if (SOS_OK != retval) + { + sos_kfree((sos_vaddr_t)*kernel_to); + *kernel_to = NULL; + } + + return retval; +} diff --git a/sos/uaccess.h b/sos/uaccess.h new file mode 100644 index 0000000..b375fbc --- /dev/null +++ b/sos/uaccess.h @@ -0,0 +1,96 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_UACCESS_H_ +#define _SOS_UACCESS_H_ + + +/** + * @file uaccess.h + * + * Routines to access user-space data from inside the kernel space. + */ + +#include +#include + + +/** + * Retrieve a bunch of data from the user space of the + * current_thread->process + * + * @return <0 on error ! Return the number of bytes successfully copied + * otherwise. + */ +sos_ret_t sos_memcpy_from_user(sos_vaddr_t kernel_to, + sos_uaddr_t user_from, + sos_size_t size); + + +/** + * Transfer a bunch of data to the user space of the + * current_thread->process + * + * @return <0 n error ! Return the number of bytes successfully copied + * otherwise. + */ +sos_ret_t sos_memcpy_to_user(sos_uaddr_t user_to, + sos_vaddr_t kernel_from, + sos_size_t size); + + +/** + * @return the length of the given user space string user_str + * (excluding the trailing \0), up to max_len bytes. <0 on error + * (unresolved page fault, etc.) + */ +sos_ret_t sos_strnlen_from_user(sos_uaddr_t user_str, sos_size_t max_len); + + +/** + * Copy the given user space string to kernel space, up to max_len + * bytes (including trailing \0) + * + * @return SOS_OK on success, <0 otherwise (unresolved page fault, etc.) + */ +sos_ret_t sos_strzcpy_from_user(char *kernel_to, sos_uaddr_t user_from, + sos_size_t max_len); + + +/** + * Copy the given kernel string to user space, up to max_len bytes + * (including trailing \0) + * + * @return SOS_OK on success, <0 otherwise (unresolved page fault, etc.) + */ +sos_ret_t sos_strzcpy_to_user(sos_uaddr_t user_to, const char *kernel_from, + sos_size_t max_len); + + +/** + * Copy the given user space string into a new allocated kernel space + * area of the correct size, up to max_len bytes (including trailing + * \0) + * + * @return SOS_OK on success + *kernel_to is set to the freshly + * allocated kernel string, <0 otherwise (unresolved page fault, etc.) + */ +sos_ret_t sos_strndup_from_user(char ** kernel_to, sos_uaddr_t from_user, + sos_size_t max_len, + sos_ui32_t kmalloc_flags); + +#endif /* _SOS_UACCESS_H_ */ diff --git a/support/build_image.sh b/support/build_image.sh new file mode 100755 index 0000000..43929cd --- /dev/null +++ b/support/build_image.sh @@ -0,0 +1,215 @@ +#!/bin/sh +# Copyright (C) 2003, David Decotigny + +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, +# USA. + +# 1) What does it do ? +# +# 1) Check where Grub is installed (lookup_grub) +# 2) Assign some local variables using the shell script arguments. +# a) Argument 1 : the destination (either a file or a drive, like a:) +# b) Argument 2 : the loader (i.e kernel) +# c) Argument 3 : options passed to the loader +# d) Argument 4 : the modules (that can be loaded optionally by Grub) +# 3) Test whether destination is a drive or a file +# 4) Create the directory structure inside the drive +# 5) Copy the loader in the drive +# 6) Generate the 'menu.txt' file used by Grub to generate the boot menu +# 7) Copy all modules +# 8) Copy the menu.txt file +# +# 2) Why is it so complex ? +# Because it must support various Grub/mtools installations and versions +# +# In fact, this shell script is used in the KOS (kos.enix.org) +# project. This operating system consists in a loader and many many +# modules that are linked together at boot time. It is much more +# complex that a simple monolithic kernel. +# +# For your simple monolithic kernel, you only need to give argument 1 +# and 2. + +print_usage () { + echo "Usage: $0 [X:|image] path/to/loader option path/to/modules..." + echo " where X: is a valid floppy drive on your computer" + echo " where image is any file name" + exit 1 +} + +grub_dirs_common="/usr/local/share/grub/i386-freebsd /usr/local/share/grub/i386-pc /usr/share/grub/i386-pc /usr/lib/grub/i386-pc /usr/local/grub /usr/share/grub/i386-redhat /usr/local/src/grub-0.5.94 $HOME/share/grub/i386-pc/" +sbin_grub_path="/usr/local/sbin /usr/sbin /sbin $HOME/sbin" + +PATH=$PATH:/sbin:/usr/sbin:/usr/local/sbin +export PATH + +MTOOLSRC=mtoolsrc +export MTOOLSRC + +# Redefined variables +FLOPPY_DRIVE=A: +IMG_FNAME=fd.img + +## +## Format disk image +## +init_image () { + echo "Initialize disk image $IMG_FILE..." + if [ ! -f $IMG_FNAME ] ; then + dd if=/dev/zero of=$IMG_FNAME bs=18k count=80 1>/dev/null 2>&1 + fi + + rm -f $MTOOLSRC + echo "drive u: file=\"$IMG_FNAME\" 1.44M filter" > $MTOOLSRC + + if mformat U: ; then : ; else + rm -f $MTOOLSRC + echo "drive u: file=\"$IMG_FNAME\" 1.44M" > $MTOOLSRC + if mformat U: ; then : ; else + rm -f $MTOOLSRC + echo "drive u: file=\"$IMG_FNAME\"" > $MTOOLSRC + mformat U: + fi + fi +} + + +## +## Format (real) floppy disk +## +init_floppy () { + echo "Formatting floppy..." + mformat $FLOPPY_DRIVE || exit 1 +} + + +lookup_grub () { + # Look for a correct GRUBDIR + for d in $grub_dirs_common ; do + if [ -d $d ] ; then + GRUBDIR=$d + break + fi + done + + # Try to guess with locate + if [ ! -d "$GRUBDIR" ] ; then + GRUBDIR=`locate stage2 | head -1 | xargs dirname 2>/dev/null` + fi + + # Look for a correct sbin/grub + for d in $sbin_grub_path ; do + if [ -x $d/grub ] ; then + SBIN_GRUB=$d/grub + break + fi + done + + if [ -d "$GRUBDIR" -a -x "$SBIN_GRUB" ] ; then + echo "Found correct grub installation in $GRUBDIR" + echo "Found correct /sbin/grub at $SBIN_GRUB" + else + echo "Couldn't find a correct grub installation." + exit 1 + fi +} + +## +## setup_disk [drive] +## => setup disk directory structure / copy files +## +setup_disk () { + echo "Setup destination disk..." + + mmd $1/boot + mmd $1/boot/grub + + if [ -d $GRUBDIR/stage1 ] ; then + mcopy $GRUBDIR/stage1/stage1 $1/boot/grub/ + mcopy $GRUBDIR/stage2/stage2 $1/boot/grub/ + else + mcopy $GRUBDIR/stage1 $1/boot/grub/ + mcopy $GRUBDIR/stage2 $1/boot/grub/ + fi + mmd $1/system + mmd $1/modules + + $SBIN_GRUB --batch </dev/null 2>/dev/null || exit 1 +device (fd0) $IMG_FNAME +install (fd0)/boot/grub/stage1 (fd0) (fd0)/boot/grub/stage2 p (fd0)/boot/grub/menu.txt +quit +EOT +} + + + +################################################# +## Real start +## +#[ "$#" -lt 3 ] && print_usage + +lookup_grub + +dest="$1" ; shift +loader_fname="$1" ; shift +options="$1" ; shift +modules="$*" + +# Init destination disk +case x$dest in + x*:) + drive=$dest + IMG_FNAME=$dest + FLOPPY_DRIVE=$dest + init_floppy + ;; + x*) + drive=U: + IMG_FNAME=$dest + init_image + ;; +esac + +# Create directory structure +setup_disk $drive + +# Copy the loader +mcopy -bo $loader_fname $drive/system/`basename $loader_fname` + +# Generate the menu.txt file +rm -f menu.txt +cat < menu.txt +timeout 0 +default 0 +title Simple OS +root (fd0) +kernel /system/`basename $loader_fname` $options +EOF + +# Copy the modules +for f in $modules ; do + if [ ! -f $f ] ; then + echo "ERROR: module $f not correctly compiled in." + exit 1 + fi + if ! mcopy -bo $f $drive/modules/`basename $f` ; then + echo "ERROR: module $f could not be transferred to floppy." + exit 1 + fi + echo module /modules/`basename $f` >> menu.txt +done + +# Transfers the menu.txt file to floppy +mcopy -bo menu.txt $drive/boot/grub/ diff --git a/support/sos.lds b/support/sos.lds new file mode 100644 index 0000000..dff0127 --- /dev/null +++ b/support/sos.lds @@ -0,0 +1,125 @@ +/* Copyright (C) 2003, Thomas Petazzoni + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +/* We generate binary in the ELF format */ +OUTPUT_FORMAT("elf32-i386","elf32-i386","elf32-i386"); + +/* The entry point is _start (defined in boot.S) */ +ENTRY(_start) + +/* The architecture is i386 */ +OUTPUT_ARCH("i386") + +SECTIONS +{ + /* our kernel is loaded at 0x200000 */ + . = 0x200000; + __b_load = .; + + /* the multiboot header MUST come early enough in the output + object file */ + .multiboot : + { + /* The multiboot section (containing the multiboot header) + goes here */ + *(.multiboot); + + /* + * With the following line, we force this section to be + * allocated in the output file as soon as possible, no matter + * when the file containing the multiboot header (multiboot.S) + * is compiled. This is to conform to the multiboot spec, which + * says "The Multiboot header must be contained completely + * within the first 8192 bytes of the OS image, and must be + * longword (32-bit) aligned." + */ + LONG(0); + } + + /* Defines a symbol '__b_kernel to mark the start of the kernel + code/data */ + . = ALIGN(4096); + __b_kernel = .; + + /* Beginning of the text section */ + .text ALIGN(4096) : + { + /* This section includes the code */ + *(.text*) + /* Defines the 'etext' and '_etext' at the end */ + PROVIDE(etext = .); + PROVIDE(_etext = .); + } + + /* Beginning of the data section */ + .data . : + { *(.data*) + PROVIDE(edata = .); + PROVIDE(_edata = .); + } + + /* Beginning of the read-only data section */ + .rodata . : + { *(.rodata*) + *(.eh_frame*) + + /* For articles 7.5 and later, it is better if the program + "files" are located on a 4kB boundary: this allows + binfmt_elf32 to share program pages between kernel and + user, alleviating the need to allocate new pages to copy the + user code */ + . = ALIGN(4096); + *(.userprogs) + + PROVIDE(erodata = .); + PROVIDE(_erodata = .); + } + + /* We take note of the end of the data to load */ + __e_load = .; + + /* Beginning of the BSS section (global uninitialized data) */ + .bss SIZEOF(.rodata) + ADDR(.rodata) : + { *(.bss) + *(COMMON) + + /* We put the stack of the bootstrap thread on a page + boundary, because it can be un-allocated later */ + . = ALIGN(4096); + *(.init_stack) + + PROVIDE(ebss = .); + PROVIDE(_ebss = .); + } + + /* We take note of the end of the kernel: this is where the GPFM + will begin */ + __e_kernel = .; + + /* We don't care of the note, indent, comment, etc.. sections + generated by gcc */ + /DISCARD/ :{ + *(.note*) + *(.indent) + *(.comment) + *(.stab) + *(.stabstr) + } + +} + diff --git a/userland/Makefile b/userland/Makefile new file mode 100644 index 0000000..05f365b --- /dev/null +++ b/userland/Makefile @@ -0,0 +1,89 @@ +## Copyright (C) 2005 David Decotigny +## +## This program is free software; you can redistribute it and/or +## modify it under the terms of the GNU General Public License +## as published by the Free Software Foundation; either version 2 +## of the License, or (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, +## USA. + +CC=gcc +AR=ar +OBJCOPY=objcopy +CFLAGS = -Wall -nostdinc -ffreestanding -I. -I.. +LIBGCC := $(shell $(CC) -print-libgcc-file-name) # To benefit from FP/64bits artihm. +LDFLAGS = -Wl,--warn-common -nostdlib -Wl,-Tldscript.lds + +# Main target +all: userprogs.kimg + +-include .mkvars + +PROGS := myprog1 myprog2 myprog3 myprog4 myprog5 myprog6 + +# Build dependencies of the programs +$(PROGS) : % : %.o crt.o libc.a + +PWD := $(shell pwd) + +# Programs generation +$(PROGS): + $(CC) -static $(LDFLAGS) -o $@ $^ $(LIBGCC) + +# Generation of the libC +libc.a: libc.o string.o stdarg.o debug.o + +# Create a program image to be integrated into the Kernel +userprogs.kimg: $(PROGS) + @echo "# Generating ELF images for inclusion into the kernel image: $@" + @echo "SECTIONS { .userprogs . : { " > .userprogs.lds + @i=0 ; \ + for f in $^ ; do \ + i=`expr $$i + 1` ; \ + echo "extern char _begin_userprog$$i, _end_userprog$$i;" \ + > .userprog$$i.c ; \ + echo "char *_userprog"$$i"_entry[]" >> .userprog$$i.c ; \ + echo " __attribute__((section(\".userprogs_table\")))" \ + >> .userprog$$i.c ; \ + echo " = { \"$$f\", &_begin_userprog$$i, &_end_userprog$$i };" \ + >> .userprog$$i.c ; \ + $(CC) $(CFLAGS) -c .userprog$$i.c -o .userprog$$i.o ; \ + $(OBJCOPY) --add-section .userprog$$i=$$f .userprog$$i.o \ + .userprog$$i.kimg ; \ + echo " . = ALIGN(4096);" >> .userprogs.lds ; \ + echo " _begin_userprog$$i = .;" >> .userprogs.lds ; \ + echo " .userprog$$i.kimg(.userprog$$i);" >> .userprogs.lds ; \ + echo " _end_userprog$$i = .;" >> .userprogs.lds ; \ + echo " .userprog$$i.kimg(.rodata); .userprog$$i.kimg(.data);" \ + >> .userprogs.lds ; \ + done + @echo " _userprogs_table = .; *(.userprogs_table) ; LONG(0);" \ + >> .userprogs.lds + @echo "} /DISCARD/ : { *(.text) *(.data) *(.bss) } }" \ + >> .userprogs.lds + @$(LD) -r -o $@ -T.userprogs.lds + +# Create libraries from object files +%.a: + $(AR) rcv $@ $^ + +# Create objects from C source code +%.o: %.c + $(CC) -I$(PWD) -c $< $(CFLAGS) -o $@ + +# Create objects from assembler (.S) source code +%.o: %.S + $(CC) -I$(PWD) -c $< $(CFLAGS) -DASM_SOURCE=1 -o $@ + +# Clean directory +clean: + $(RM) *.o *.a *~ $(PROGS) *.kimg + $(RM) .userprog* diff --git a/userland/crt.c b/userland/crt.c new file mode 100644 index 0000000..eff1b8f --- /dev/null +++ b/userland/crt.c @@ -0,0 +1,183 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2003 Thomas Petazzoni + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + + +/** + * @file crt.c + * + * The C RunTime environment for the basic support of SOS C user + * programs + */ + +#include +#include +#include "crt.h" + +/** + * Starter function ! + */ +void _start() __attribute__((noreturn)); +void _start() +{ + /* This starter function expects a main() function somewhere */ + extern int main(); + + /* Reset the bss section */ + extern char _bbss, _ebss; + memset(& _bbss, 0x0, (& _ebss) - (& _bbss)); + + _sos_exit(main()); +} + + +/* + * By convention, the USER SOS programs always pass 4 arguments to the + * kernel syscall handler: in eax/../edx. For less arguments, the + * unused registers are filled with 0s. For more arguments, the 4th + * syscall parameter gives the address of the array containing the + * remaining arguments. In any case, eax corresponds to the syscall + * IDentifier. + */ + + +inline +int _sos_syscall3(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3) +{ + int ret; + + asm volatile("movl %1,%%eax \n" + "movl %2,%%ebx \n" + "movl %3,%%ecx \n" + "movl %4,%%edx \n" + "int %5\n" + "movl %%eax, %0" + :"=g"(ret) + :"g"(id),"g"(arg1),"g"(arg2),"g"(arg3) + ,"i"(SOS_SWINTR_SOS_SYSCALL) + :"eax","ebx","ecx","edx"); + + return ret; +} + + +int _sos_syscall0(int id) +{ + return _sos_syscall3(id, 0, 0, 0); +} + + +int _sos_syscall1(int id, + unsigned int arg1) +{ + return _sos_syscall3(id, arg1, 0, 0); +} + + +int _sos_syscall2(int id, + unsigned int arg1, + unsigned int arg2) +{ + return _sos_syscall3(id, arg1, arg2, 0); +} + + +int _sos_syscall4(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4) +{ + unsigned int args[] = { arg3, arg4 }; + return _sos_syscall3(id, arg1, arg2, (unsigned)args); +} + + +int _sos_syscall5(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5) +{ + unsigned int args[] = { arg3, arg4, arg5 }; + return _sos_syscall3(id, arg1, arg2, (unsigned)args); +} + + +int _sos_syscall6(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5, + unsigned int arg6) +{ + unsigned int args[] = { arg3, arg4, arg5, arg6 }; + return _sos_syscall3(id, arg1, arg2, (unsigned)args); +} + + +int _sos_syscall7(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5, + unsigned int arg6, + unsigned int arg7) +{ + unsigned int args[] = { arg3, arg4, arg5, arg6, arg7 }; + return _sos_syscall3(id, arg1, arg2, (unsigned)args); +} + + +int _sos_syscall8(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5, + unsigned int arg6, + unsigned int arg7, + unsigned int arg8) +{ + unsigned int args[] = { arg3, arg4, arg5, arg6, arg7, arg8 }; + return _sos_syscall3(id, arg1, arg2, (unsigned)args); +} + + +void _sos_exit(int status) +{ + _sos_syscall1(SOS_SYSCALL_ID_EXIT, (unsigned)status); + + /* Never reached ! */ + for ( ; ; ) + ; +} + + +int _sos_bochs_write(const char * str, unsigned length) +{ + return _sos_syscall2(SOS_SYSCALL_ID_BOCHS_WRITE, + (unsigned)str, + length); +} diff --git a/userland/crt.h b/userland/crt.h new file mode 100644 index 0000000..c9805f3 --- /dev/null +++ b/userland/crt.h @@ -0,0 +1,107 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2003 Thomas Petazzoni + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_USER_CRT_H_ +#define _SOS_USER_CRT_H_ + + +/** + * @file crt.h + * + * C runtime environment for the user side of the kernel/user + * interface + */ + +#include + +/** + * We include the syscall.h file from the kernel to retrieve the list + * of available syscall ID + */ +#include + + +/** + * The syscall wrappers hiding the details of the implementation + */ +int _sos_syscall0(int id); + +int _sos_syscall1(int id, + unsigned int arg1); + +int _sos_syscall2(int id, + unsigned int arg1, + unsigned int arg2); + +int _sos_syscall3(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3); + +int _sos_syscall4(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4); + +int _sos_syscall5(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5); + +int _sos_syscall6(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5, + unsigned int arg6); + +int _sos_syscall7(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5, + unsigned int arg6, + unsigned int arg7); + +int _sos_syscall8(int id, + unsigned int arg1, + unsigned int arg2, + unsigned int arg3, + unsigned int arg4, + unsigned int arg5, + unsigned int arg6, + unsigned int arg7, + unsigned int arg8); + + +/** + * The most important function of a C program ! ;) + */ +void _sos_exit (int status) __attribute__((noreturn)); + + +/** + * Non standard function to print something on bochs + */ +int _sos_bochs_write(const char *str, unsigned length); +#endif /* _SOS_USER_CRT_H_ */ diff --git a/userland/debug.c b/userland/debug.c new file mode 100644 index 0000000..6442dd2 --- /dev/null +++ b/userland/debug.c @@ -0,0 +1,39 @@ +/* Copyright (C) 2004 David Decotigny (with INSA Rennes for vsnprintf) + Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include +#include + +#include "debug.h" + +int bochs_printf(const char *format, /* args */...) +{ + char buff[4096]; + int len; + va_list ap; + + va_start(ap, format); + len = vsnprintf(buff, sizeof(buff), format, ap); + va_end(ap); + + if (len < 0) + return len; + + return _sos_bochs_write(buff, len); +} diff --git a/userland/debug.h b/userland/debug.h new file mode 100644 index 0000000..7515e30 --- /dev/null +++ b/userland/debug.h @@ -0,0 +1,34 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2003 Thomas Petazzoni + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_LIBC_DEBUG_H_ +#define _SOS_LIBC_DEBUG_H_ + +/** + * @file debug.h + * + * Non standard debugging features + */ + +/** + * Non standard function to print something on bochs + */ +int bochs_printf(const char *format, /* args */...) + __attribute__ ((format (printf, 1, 2))); + +#endif /* _SOS_USER_LIBC_H_ */ diff --git a/userland/ldscript.lds b/userland/ldscript.lds new file mode 100644 index 0000000..c446354 --- /dev/null +++ b/userland/ldscript.lds @@ -0,0 +1,67 @@ +/* Copyright (C) 2005, David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +/* We generate binary in the ELF format */ +OUTPUT_FORMAT("elf32-i386","elf32-i386","elf32-i386"); + +/* The entry point of the program is _start (defined in crt.c) */ +ENTRY(_start) + +/* The architecture is i386 */ +OUTPUT_ARCH("i386") + +SECTIONS +{ + /* our program is loaded at 2G */ + . = 0x80000000; + + /* Beginning of the text section */ + .text : + { + /* This section includes the code */ + *(.text*) + /* Defines the 'etext' and '_etext' at the end */ + PROVIDE(etext = .); + PROVIDE(_etext = .); + } + + /* Beginning of the data section */ + .data . : + { *(.data*) + PROVIDE(edata = .); + PROVIDE(_edata = .); + } + + /* Beginning of the read-only data section */ + .rodata . : + { *(.rodata*) + *(.eh_frame*) + PROVIDE(erodata = .); + PROVIDE(_erodata = .); + } + + /* Beginning of the BSS section (global uninitialized data) */ + .bss SIZEOF(.rodata) + ADDR(.rodata) : + { PROVIDE(bbss = .); + PROVIDE(_bbss = .); + *(.bss) + *(COMMON) + PROVIDE(ebss = .); + PROVIDE(_ebss = .); + } +} diff --git a/userland/libc.c b/userland/libc.c new file mode 100644 index 0000000..a75fcb4 --- /dev/null +++ b/userland/libc.c @@ -0,0 +1,17 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ diff --git a/userland/libc.h b/userland/libc.h new file mode 100644 index 0000000..2b8d47b --- /dev/null +++ b/userland/libc.h @@ -0,0 +1,35 @@ +/* Copyright (C) 2005 David Decotigny + Copyright (C) 2003 Thomas Petazzoni + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_USER_LIBC_H_ +#define _SOS_USER_LIBC_H_ + +#include + +/** + * @file libc.h + * + * The basic user C library for user programs + */ + +/** + * The most important function of a C program ! ;) + */ +void exit (int status) __attribute__((noreturn, alias("_sos_exit"))); + +#endif /* _SOS_USER_LIBC_H_ */ diff --git a/userland/myprog1.c b/userland/myprog1.c new file mode 100644 index 0000000..dd1ed60 --- /dev/null +++ b/userland/myprog1.c @@ -0,0 +1,37 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include + +/** + * @file myprog1.c + * Basic print/exit test + */ + +int main() +{ + int retval; + + bochs_printf("Prog1: Hello world 1 !\n"); + bochs_printf("Prog1: Hello world 2 !\n"); + bochs_printf("Prog1: Hello world 3 !\n"); + bochs_printf("Prog1: Hello world 4 !\n"); + retval = bochs_printf("Prog1: Hello world 5 !\n"); + + return retval; +} diff --git a/userland/myprog2.c b/userland/myprog2.c new file mode 100644 index 0000000..24f9fb8 --- /dev/null +++ b/userland/myprog2.c @@ -0,0 +1,35 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include + +/** + * @file myprog2.c + * Basic print/pause/exit test + */ + +int main() +{ + int i; + bochs_printf("Prog2: Hello world A !\n"); + for (i = 0 ; i < 10000000 ; i++) + continue; + bochs_printf("Prog2: Hello world B !\n"); + + return 0; +} diff --git a/userland/myprog3.c b/userland/myprog3.c new file mode 100644 index 0000000..166199c --- /dev/null +++ b/userland/myprog3.c @@ -0,0 +1,46 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include + +/** + * @file myprog3.c + * Test unresolved page fault (write to kernel space) + */ + +int main() +{ + char *c; + int i; + bochs_printf("Prog3: Hello world A !\n"); + for (i = 0 ; i < 100000 ; i++) + continue; + bochs_printf("Prog3: Hello world B !\n"); + + /* Force a page fault */ + c = (char*) 0x201000; + /* Try to read somewhere in the kernel space */ + i = *c; + + bochs_printf("Prog3: Hello world C !\n"); + for ( ; i> 0 ; i--) + continue; + bochs_printf("Prog3: Hello world D !\n"); + + return 0; +} diff --git a/userland/myprog4.c b/userland/myprog4.c new file mode 100644 index 0000000..db5c841 --- /dev/null +++ b/userland/myprog4.c @@ -0,0 +1,46 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include + +/** + * @file myprog4.c + * Test unresolved page fault (write to unmapped page in user space) + */ + +int main() +{ + char *c; + int i; + bochs_printf("Prog4: Hello world A !\n"); + for (i = 0 ; i < 100000 ; i++) + continue; + bochs_printf("Prog4: Hello world B !\n"); + + /* Force a page fault */ + c = (char*) 0x60000000; + /* Try to read somewhere in user space where nothing is mapped */ + i = *c; + + bochs_printf("Prog4: Hello world C !\n"); + for ( ; i> 0 ; i--) + continue; + bochs_printf("Prog4: Hello world D !\n"); + + return 0; +} diff --git a/userland/myprog5.c b/userland/myprog5.c new file mode 100644 index 0000000..3d5e390 --- /dev/null +++ b/userland/myprog5.c @@ -0,0 +1,36 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include + +/** + * @file myprog5.c + * Test inifite loop (preemptive scheduling of threads in user mode) + */ + +int main() +{ + int retval; + + bochs_printf("Prog5: Hello world 1 !\n"); + for (;;) + ; + bochs_printf("Prog5: Hello world 2 !\n"); + + return retval; +} diff --git a/userland/myprog6.c b/userland/myprog6.c new file mode 100644 index 0000000..0076345 --- /dev/null +++ b/userland/myprog6.c @@ -0,0 +1,39 @@ +/* Copyright (C) 2005 David Decotigny + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ + +#include + +/** + * @file myprog6.c + * Test execution of (forbiden) supervisor instructions + */ + +int main() +{ + int i; + int retval = 0; + + bochs_printf("Prog6: Hello world 1 !\n"); + for (i = 0 ; i < 10000000 ; i++) + ; + bochs_printf("Prog6: Hello world 2 !\n"); + asm("cli\n"); /* Protection volation ! */ + bochs_printf("Prog6: Hello world 3 !\n"); + + return retval; +} diff --git a/userland/stdarg.c b/userland/stdarg.c new file mode 100644 index 0000000..a122586 --- /dev/null +++ b/userland/stdarg.c @@ -0,0 +1,244 @@ +/* Copyright (C) 2004 David Decotigny (with INSA Rennes for vsnprintf) + Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include + +#include "stdarg.h" + + +/* I (d2) borrowed and rewrote this for Nachos/INSA Rennes. Thanks to + them for having kindly allowed me to do so. */ +int vsnprintf(char *buff, size_t len, const char * format, va_list ap) +{ + int i, result; + int fmt_modifiers = 0; + int prefix_long = 0; + int prefix_long_long = 0; + + if (!buff || !format || (len < 0)) + return -1; + +#define PUTCHAR(thechar) \ + do { \ + if (result < len-1) \ + *buff++ = (thechar); \ + result++; \ + } while (0) + + result = 0; + for(i=0 ; format[i] != '\0' ; i++) + { + if (!fmt_modifiers && (format[i] != '%')) + { + PUTCHAR(format[i]); + continue; + } + + switch (format[i]) + { + case '%': + if (fmt_modifiers) + { + PUTCHAR('%'); + fmt_modifiers = 0; + break; + } + + fmt_modifiers = 1; + prefix_long = 0; + prefix_long_long = 0; + break; + + case 'l': + if (prefix_long) + prefix_long_long = 1; + else + prefix_long = 1; + break; + + case 'u': + { + if (! prefix_long_long) + { + unsigned int integer = va_arg(ap,unsigned int); + int cpt2 = 0; + char buff_int[16]; + + do { + int m10 = integer%10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + else + { + unsigned long long int integer + = va_arg(ap,unsigned long long int); + int cpt2 = 0; + char buff_int[32]; + + do { + int m10 = integer%10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + } + fmt_modifiers = 0; + break; + + case 'i': + case 'd': + { + if (! prefix_long_long) + { + int integer = va_arg(ap,int); + int cpt2 = 0; + char buff_int[16]; + + if (integer<0) + PUTCHAR('-'); + /* Ne fait pas integer = -integer ici parce que INT_MIN + n'a pas d'equivalent positif (int = [-2^31, 2^31-1]) */ + + do { + int m10 = integer%10; + m10 = (m10 < 0)? -m10:m10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + else + { + long long int integer = va_arg(ap,long long int); + int cpt2 = 0; + char buff_int[32]; + + if (integer<0) + PUTCHAR('-'); + /* Ne fait pas integer = -integer ici parce que INT_MIN + n'a pas d'equivalent positif (int = [-2^63, 2^63-1]) */ + + do { + int m10 = integer%10; + m10 = (m10 < 0)? -m10:m10; + buff_int[cpt2++]=(char)('0'+ m10); + integer=integer/10; + } while(integer!=0); + + for(cpt2 = cpt2 - 1 ; cpt2 >= 0 ; cpt2--) + PUTCHAR(buff_int[cpt2]); + } + } + fmt_modifiers = 0; + break; + + case 'c': + { + int value = va_arg(ap,int); + PUTCHAR((char)value); + fmt_modifiers = 0; + break; + } + + case 's': + { + char *string = va_arg(ap,char *); + if (! string) + string = "(null)"; + for( ; *string != '\0' ; string++) + PUTCHAR(*string); + fmt_modifiers = 0; + break; + } + + case 'p': + PUTCHAR('0'); + PUTCHAR('x'); + case 'x': + { + unsigned long long int hexa; + unsigned long long int nb; + int i, had_nonzero = 0; + + if (prefix_long_long) + hexa = va_arg(ap,unsigned long long int); + else + hexa = va_arg(ap,unsigned int); + + for(i=0 ; i < 16 ; i++) + { + nb = (unsigned long long int)(hexa << (i*4)); + nb = (nb >> 60) & 0xf; + // Skip the leading zeros + if (nb == 0) + { + if (had_nonzero) + PUTCHAR('0'); + } + else + { + had_nonzero = 1; + if (nb < 10) + PUTCHAR('0'+nb); + else + PUTCHAR('a'+(nb-10)); + } + } + if (! had_nonzero) + PUTCHAR('0'); + } + fmt_modifiers = 0; + break; + + default: + PUTCHAR('%'); + if (prefix_long) + PUTCHAR('l'); + if (prefix_long_long) + PUTCHAR('l'); + PUTCHAR(format[i]); + fmt_modifiers = 0; + } + } + + *buff = '\0'; + return result; +} + + +int snprintf(char * buff, size_t len, const char *format, ...) +{ + va_list ap; + + va_start(ap, format); + len = vsnprintf(buff, len, format, ap); + va_end(ap); + + return len; +} diff --git a/userland/stdarg.h b/userland/stdarg.h new file mode 100644 index 0000000..c24234f --- /dev/null +++ b/userland/stdarg.h @@ -0,0 +1,50 @@ +/* Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_LIBC_STDARG_H_ +#define _SOS_LIBC_STDARG_H_ + +#include + +/** + * @file stdarg.h + */ + +/* Borrowed from GCC */ +#define __GNUC_VA_LIST +typedef void *__gnuc_va_list; +typedef __gnuc_va_list va_list; +#define __va_rounded_size(TYPE) \ + (((sizeof (TYPE) + sizeof (int) - 1) / sizeof (int)) * sizeof (int)) +#define va_start(AP, LASTARG) \ + (AP = ((__gnuc_va_list) __builtin_next_arg (LASTARG))) +#define va_end(AP) \ + ((void)0) +#define va_arg(AP, TYPE) \ + (AP = (__gnuc_va_list) ((char *) (AP) + __va_rounded_size (TYPE)), \ + *((TYPE *) (void *) ((char *) (AP) - __va_rounded_size (TYPE)))) +#define __va_copy(dest, src) \ + (dest) = (src) + +/* stdarg.h functions. There might be a non-standard behavior: there + will always be a trailing '\0' in the resulting string */ +int vsnprintf(char *, size_t, const char *, va_list); +int snprintf(char *, size_t, const char *, /*args*/ ...) + __attribute__ ((format (printf, 3, 4))); + +#endif /* _SOS_LIBC_STDARG_H_ */ diff --git a/userland/string.c b/userland/string.c new file mode 100644 index 0000000..bd38494 --- /dev/null +++ b/userland/string.c @@ -0,0 +1,142 @@ +/* Copyright (C) 2004 David Decotigny (with INSA Rennes for vsnprintf) + Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#include "string.h" + +/* For an optimized version, see BSD sources ;) */ +void *memcpy(void *dst0, const void *src0, register unsigned int size) +{ + char *dst; + const char *src; + for (dst = (char*)dst0, src = (const char*)src0 ; + size > 0 ; + dst++, src++, size--) + *dst = *src; + return dst0; +} + +/* ditto */ +void *memset(void *dst0, register int c, register unsigned int length) +{ + char *dst; + for (dst = (char*) dst0 ; + length > 0 ; + dst++, length --) + *dst = (char)c; + return dst0; +} + +int memcmp(const void *s1, const void *s2, size_t len) +{ + const unsigned char *c1, *c2; + unsigned int i; + + for (i = 0, c1 = s1, c2 = s2; i < len; i++, c1++, c2++) + { + if(*c1 != *c2) + return *c1 - *c2; + } + + return 0; +} + + +unsigned int strlen(register const char *str) +{ + unsigned int retval = 0; + + while (*str++) + retval++; + + return retval; +} + + +unsigned int strnlen(const char * s, size_t count) +{ + const char *sc; + + for (sc = s; count-- && *sc != '\0'; ++sc) + /* nothing */continue; + + return sc - s; +} + + +char *strzcpy(register char *dst, register const char *src, register int len) +{ + int i; + + if (len <= 0) + return dst; + + for (i = 0; i < len; i++) + { + dst[i] = src[i]; + if(src[i] == '\0') + return dst; + } + + dst[len-1] = '\0'; + return dst; +} + + +char *strzcat (char *dest, const char *src, size_t n) +{ + char *res = dest; + + for ( ; *dest ; dest++); + + for ( ; *src ; src++, dest++) { + *dest = *src; + n--; + if (n <= 0) + break; + } + + *dest = '\0'; + return res; +} + +int strcmp(register const char *s1, register const char *s2) +{ + while (*s1 == *s2++) + if (*s1++ == 0) + return (0); + + return (*(const unsigned char *)s1 - *(const unsigned char *)(s2 - 1)); +} + + +int strncmp(register const char *s1, register const char *s2, register int len) +{ + char c1 = '\0', c2 = '\0'; + + while (len > 0) + { + c1 = (unsigned char) *s1++; + c2 = (unsigned char) *s2++; + if (c1 == '\0' || c1 != c2) + return c1 - c2; + len--; + } + + return c1 - c2; +} diff --git a/userland/string.h b/userland/string.h new file mode 100644 index 0000000..4ee50bd --- /dev/null +++ b/userland/string.h @@ -0,0 +1,61 @@ +/* Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_LIBC_STRING_H_ +#define _SOS_LIBC_STRING_H_ + +#include + +/** + * @file string.h + * + * Most of the prototypes of these functions are borrowed from + * FreeBSD, but their implementation (in klibc.c) come either from Kos + * (GPL v2) or from David Decotigny (SOS). + */ + +void *memcpy(void *dst, const void *src, register unsigned int size ) ; +void *memset(void *dst, register int c, register unsigned int length ) ; +int memcmp(const void *s1, const void *s2, size_t n); + +unsigned int strlen( register const char *str) ; +unsigned int strnlen(const char * s, size_t maxlen); + +/** + * @note Same as strncpy(), with a slightly different semantic. + * Actually, strncpy(3C) says " The result will not be null-terminated + * if the length of 'from' is n or more.". Here, 'dst' is ALWAYS + * null-terminated. And its total len will ALWAYS be <= len, with + * null-terminating-char included. + */ +char *strzcpy( register char *dst, register const char *src, + register int len ) ; + +/** + * @note Same as strncat(), with the same semantic : 'dst' is ALWAYS + * null-terminated. And its total len will ALWAYS be <= len, with + * null-terminating-char included. + */ +char *strzcat (char *dest, const char *src, + const size_t len); + +int strcmp(register const char *s1, register const char *s2 ); +int strncmp(register const char *s1, register const char *s2, + register int len ); + +#endif /* _SOS_LIBC_STRING_H_ */ diff --git a/userland/types.h b/userland/types.h new file mode 100644 index 0000000..5942234 --- /dev/null +++ b/userland/types.h @@ -0,0 +1,29 @@ +/* Copyright (C) 2003 The KOS Team + Copyright (C) 1999 Free Software Foundation + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + USA. +*/ +#ifndef _SOS_LIBC_TYPES_H_ +#define _SOS_LIBC_TYPES_H_ + +/** + * @file types.h + */ + +typedef unsigned int size_t; + + +#endif /* _SOS_LIBC_TYPES_H_ */