source: rtems-libbsd/libbsd.txt @ 0c24e06

5-freebsd-12freebsd-9.3
Last change on this file since 0c24e06 was 0c24e06, checked in by Sebastian Huber <sebastian.huber@…>, on Aug 23, 2016 at 12:22:26 PM

mmc: Update to FreeBSD trunk 2016-08-23

  • Property mode set to 100644
File size: 49.7 KB
Line 
1RTEMS BSD Library Guide
2=======================
3:toc:
4:icons:
5:numbered:
6:website: http://www.rtems.org/
7
8RTEMS uses FreeBSD 9.2 as the source of its TCP/IP and USB stacks.
9This is a guide which captures information on the
10process of merging code from FreeBSD, building this library,
11RTEMS specific support files, and general guidelines on what
12modifications to the FreeBSD source are permitted.
13
14Goals of this effort are
15
16* update TCP/IP and provide USB in RTEMS,
17* ease updating to future FreeBSD versions,
18* ease tracking changes in FreeBSD code,
19* minimize manual changes in FreeBSD code, and
20* define stable kernel/device driver API which is implemented
21by both RTEMS and FreeBSD. This is the foundation of the port.
22
23We will work to push our changes upstream to the FreeBSD Project
24and minimize changes required at each update point.
25
26*******************************************************************************
27This is a work in progress and is very likely to be incomplete.
28Please help by adding to it.
29*******************************************************************************
30
31== Getting Started
32
33=== Tool Chain ===
34
35You need a tool chain for RTEMS based on at least RSB 4.12 April 2016 or later.
36
37=== Installation Overview ===
38
39. You must configure your BSP with the +--disable-networking+ option to disable
40the old network stack.  Make sure no header files of the old network stack are
41installed.
42
43. Clone the Git repository +git clone git://git.rtems.org/rtems-libbsd.git+.
44. Change into the RTEMS BSD library root directory.
45. Edit the `config.inc` configuration file and adjust it to your environment.
46. Run +waf configure ...+.
47. Run +waf+.
48. Run +waf install+.
49
50Refer to the README.waf for Waf building instructions.
51
52Make sure the submodules have been initialised and are updated. If a 'git
53status' says `rtems_waf` need updating run the submodule update command:
54
55 $ git submodule rtems_waf update
56
57=== Board Support Package Requirements ===
58
59The RTEMS version must be at least 4.12.  The Board Support Package (BSP)
60should support the
61http://www.rtems.org/onlinedocs/doxygen/cpukit/html/group\__rtems\__interrupt__extension.html[Interrupt Manager Extension]
62// The first underscores have to be masked to stop asciidoc interpreting them
63to make use of generic FreeBSD based drivers.
64
65The linker command file of the BSP must contain the following section
66definitions:
67
68-------------------------------------------------------------------------------
69.rtemsroset : {
70        KEEP (*(SORT(.rtemsroset.*)))
71}
72
73.rtemsrwset : {
74        KEEP (*(SORT(.rtemsrwset.*)))
75}
76-------------------------------------------------------------------------------
77
78The first output section can be placed in read-only memory.  The second output
79section must be placed in read-write memory.  The output section name is not
80relevant.  The output sections may also contain other input sections.
81
82=== Board Support Package Configuration and Build ===
83
84You need to configure RTEMS for the desired BSP and install it.  The BSP should
85be configured with a disabled network stack.  The BSD library containing the
86new network stack is a separate package.  Using a BSP installation containing
87the old network stack may lead to confusion and unpredictable results.
88
89The following script is used to build the `arm/xilinx_zynq_a9_qemu` BSP for
90our internal testing purposes:
91
92-------------------------------------------------------------------------------
93#!/bin/sh
94
95cd ${HOME}/sandbox
96rm -rf b-xilinx_zynq_a9_qemu
97mkdir b-xilinx_zynq_a9_qemu
98cd b-xilinx_zynq_a9_qemu
99${HOME}/git-rtems/configure \
100        --prefix=${HOME}/sandbox/install \
101        --target=arm-rtems4.12 \
102        --enable-rtemsbsp=xilinx_zynq_a9_qemu \
103        --disable-networking && \
104        make && \
105        make install
106-------------------------------------------------------------------------------
107
108The `arm/xilinx_zynq_a9_qemu` BSP running on the Qemu simulator has some
109benefits for development and test of the BSD library
110
111* it offers a NULL pointer read and write protection,
112* Qemu is a fast simulator,
113* Qemu provides support for GDB watchpoints,
114* Qemu provides support for virtual Ethernet networks, e.g. TUN and bridge
115devices (you can run multiple test instances on one virtual network).
116
117=== BSD Library Configuration and Build ===
118
119The build system based on the Waf build system. To build with Waf please refer
120to the README.waf file.
121
122===== Example Configuration =====
123
124In the BSD library source directory edit the file `config.inc`.  Continuing on
125the above, the `config.inc` used to match the above is:
126
127-------------------------------------------------------------------------------
128# Mandatory: Select your BSP and installation prefix
129TARGET = arm-rtems4.12
130BSP = xilinx_zynq_a9_qemu
131PREFIX = $(HOME)/sandbox/install
132
133# Optional: Separate installation base directory
134INSTALL_BASE = $(PREFIX)/$(TARGET)/$(BSP)
135
136# Optional: Network test configuration
137TEST_RUNNER = $(BSP)
138NET_CFG_SELF_IP = 10.0.0.2
139NET_CFG_NETMASK = 255.255.0.0
140NET_CFG_PEER_IP = 10.0.0.1
141NET_CFG_GATEWAY_IP = 10.0.0.1
142NET_TAP_INTERFACE = tap0
143-------------------------------------------------------------------------------
144
145=== BSD Library Initialization ===
146
147To initialise the BSD Library create a suitable rc.conf file. The FreeBSD man
148page rc.conf(5) provides the details needed to create a suitable format file:
149
150 https://www.freebsd.org/cgi/man.cgi?rc.conf
151
152You can call one of three functions to run the initialisation once BSD has
153initialised:
154
155 - rtems_bsd_run_etc_rc_conf: Run /etc/rc.conf.
156 - rtems_bsd_run_rc_conf: Run a user supplied file.
157 - rtems_bsd_run_rc_conf_script: Run the in memory line feed separated text string.
158
159For exapmle:
160
161 void
162 network_init(void)
163 {
164   rtems_status_code sc;
165
166   sc = rtems_bsd_initialize();
167   assert(sc == RTEMS_SUCCESSFUL);
168
169   rtems_bsd_run_etc_rc_conf(true); /* verbose = true */
170
171}
172
173By default the networking support is builtin. Other directives can be added and
174are found in 'machine/rtems-bsd-rc-conf-directives.h'. Please check the file
175for the list.
176
177The following network names are supported:
178
179  cloned_interfaces
180  ifconfig_'interface'
181  defaultrouter
182  hostname
183
184For example:
185
186 #
187 # My BSD initialisation.
188 #
189 hostname="myhost"
190 cloned_interfaces="vlan0 vlan1"
191 ifconfig_re0="inet inet 10.10.10.10 netmask 255.255.255.0"
192 fconfig_vlan0="inet 10.11.10.10 255.255.255.0 vlan 101 vlandev re0"
193 defaultrouter="10.10.10.1"
194
195You can also intialise the BSD library using code. The following code to
196initialize the BSD library:
197
198-------------------------------------------------------------------------------
199#include <assert.h>
200#include <sysexits.h>
201
202#include <machine/rtems-bsd-commands.h>
203#include <rtems/bsd/bsd.h>
204
205static void
206network_ifconfig_lo0(void)
207{
208        int exit_code;
209        char *lo0[] = {
210                "ifconfig",
211                "lo0",
212                "inet",
213                "127.0.0.1",
214                "netmask",
215                "255.255.255.0",
216                NULL
217        };
218        char *lo0_inet6[] = {
219                "ifconfig",
220                "lo0",
221                "inet6",
222                "::1",
223                "prefixlen",
224                "128",
225                NULL
226        };
227
228        exit_code = rtems_bsd_command_ifconfig(RTEMS_BSD_ARGC(lo0), lo0);
229        assert(exit_code == EX_OK);
230
231        exit_code = rtems_bsd_command_ifconfig(RTEMS_BSD_ARGC(lo0_inet6), lo0_inet6);
232        assert(exit_code == EX_OK);
233}
234
235void
236network_init(void)
237{
238        rtems_status_code sc;
239
240        sc = rtems_bsd_initialize();
241        assert(sc == RTEMS_SUCCESSFUL);
242
243        network_ifconfig_lo0();
244}
245-------------------------------------------------------------------------------
246
247This performs the basic network stack initialization with a loopback interface.
248Further initialization must be done using the standard BSD network
249configuration commands
250http://www.freebsd.org/cgi/man.cgi?query=ifconfig&apropos=0&sektion=8&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[IFCONFIG(8)]
251using `rtems_bsd_command_ifconfig()` and
252http://www.freebsd.org/cgi/man.cgi?query=route&apropos=0&sektion=8&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[ROUTE(8)]
253using `rtems_bsd_command_route()`.  For an example please have a look at
254`testsuite/include/rtems/bsd/test/default-network-init.h`.
255
256=== Task Priorities and Stack Size ===
257
258The default task priority is 96 for the interrupt server task (name "IRQS"), 98
259for the timer server task (name "TIME") and 100 for all other tasks.  The
260application may provide their own implementation of the
261`rtems_bsd_get_task_priority()` function (for example in the module which calls
262`rtems_bsd_initialize()`) if different values are desired.
263
264The task stack size is determined by the `rtems_bsd_get_task_stack_size()`
265function which may be provided by the application in case the default is not
266appropriate.
267
268=== Size for Allocator Domains ===
269
270The size for an allocator domain can be specified via the
271`rtems_bsd_get_allocator_domain_size()` function.  The application may provide
272their own implementation of the `rtems_bsd_get_allocator_domain_size()`
273function (for example in the module which calls `rtems_bsd_initialize()`) if
274different values are desired.  The default size is 8MiB for all domains.
275
276== Network Stack Features
277
278http://roy.marples.name/projects/dhcpcd/index[DHCPCD(8)]:: DHCP client
279
280https://developer.apple.com/library/mac/documentation/Networking/Reference/DNSServiceDiscovery_CRef/Reference/reference.html[dns_sd.h]:: DNS Service Discovery
281
282http://www.opensource.apple.com/source/mDNSResponder/mDNSResponder-320.10/mDNSCore/mDNSEmbeddedAPI.h[mDNS]:: Multi-Cast DNS
283
284http://www.freebsd.org/cgi/man.cgi?query=unix&sektion=4&apropos=0&manpath=FreeBSD+9.2-RELEASE[UNIX(4)]:: UNIX-domain protocol family
285
286http://www.freebsd.org/cgi/man.cgi?query=inet&sektion=4&apropos=0&manpath=FreeBSD+9.2-RELEASE[INET(4)]:: Internet protocol family
287
288http://www.freebsd.org/cgi/man.cgi?query=inet6&apropos=0&sektion=4&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[INET6(4)]:: Internet protocol version 6 family
289
290http://www.freebsd.org/cgi/man.cgi?query=tcp&apropos=0&sektion=4&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[TCP(4)]:: Internet Transmission Control Protocol
291
292http://www.freebsd.org/cgi/man.cgi?query=udp&apropos=0&sektion=4&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[UDP(4)]:: Internet User Datagram Protocol
293
294http://www.freebsd.org/cgi/man.cgi?query=route&sektion=4&apropos=0&manpath=FreeBSD+9.2-RELEASE[ROUTE(4)]:: Kernel packet forwarding database
295
296http://www.freebsd.org/cgi/man.cgi?query=bpf&apropos=0&sektion=4&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[BPF(4)]:: Berkeley Packet Filter
297
298http://www.freebsd.org/cgi/man.cgi?query=socket&apropos=0&sektion=2&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[SOCKET(2)]:: Create an endpoint for communication
299
300http://www.freebsd.org/cgi/man.cgi?query=kqueue&apropos=0&sektion=2&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[KQUEUE(2)]:: Kernel event notification mechanism
301
302http://www.freebsd.org/cgi/man.cgi?query=select&apropos=0&sektion=2&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[SELECT(2)]:: Synchronous I/O multiplexing
303
304http://www.freebsd.org/cgi/man.cgi?query=poll&apropos=0&sektion=2&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[POLL(2)]:: Synchronous I/O multiplexing
305
306http://www.freebsd.org/cgi/man.cgi?query=route&apropos=0&sektion=8&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[ROUTE(8)]:: Manually manipulate the routing tables
307
308http://www.freebsd.org/cgi/man.cgi?query=ifconfig&apropos=0&sektion=8&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[IFCONFIG(8)]:: Configure network interface parameters
309
310http://www.freebsd.org/cgi/man.cgi?query=netstat&apropos=0&sektion=1&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[NETSTAT(1)]:: Show network status
311
312http://www.freebsd.org/cgi/man.cgi?query=ping&apropos=0&sektion=8&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[PING(8)]:: Send ICMP ECHO_REQUEST packets to network hosts
313
314http://www.freebsd.org/cgi/man.cgi?query=ping6&apropos=0&sektion=8&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[PING6(8)]:: Send ICMPv6 ECHO_REQUEST packets to network hosts
315
316http://www.freebsd.org/cgi/man.cgi?query=sysctl&sektion=3&apropos=0&manpath=FreeBSD+9.2-RELEASE[SYSCTL(3)]:: Get or set system information
317
318http://www.freebsd.org/cgi/man.cgi?query=resolver&sektion=3&apropos=0&manpath=FreeBSD+9.2-RELEASE[RESOLVER(3)]:: Resolver routines
319
320http://www.freebsd.org/cgi/man.cgi?query=gethostbyname&sektion=3&apropos=0&manpath=FreeBSD+9.2-RELEASE[GETHOSTBYNAME(3)]:: Get network host entry
321
322== Network Interface Drivers
323
324=== Link Up/Down Events
325
326You can notifiy the application space of link up/down events in your network
327interface driver via the if_link_state_change(LINK_STATE_UP/LINK_STATE_DOWN)
328function.  The DHCPCD(8) client is a consumer of these events for example.
329Make sure that the interface flag IFF_UP and the interface driver flag
330IFF_DRV_RUNNING is set in case the link is up, otherwise ether_output() will
331return the error status ENETDOWN.
332
333== Shell Commands
334
335=== HOSTNAME(1)
336
337In addition to the standard options the RTEMS version of the HOSTNAME(1)
338command supports the -m flag to set/get the multicast hostname of the
339mDNS resolver instance.  See also rtems_mdns_sethostname() and
340rtems_mdns_gethostname().
341
342== Qemu
343
344Use the following script to set up a virtual network with three tap devices
345connected via one bridge device.
346
347-------------------------------------------------------------------------------
348#!/bin/sh -x
349
350user=`whoami`
351interfaces=(1 2 3)
352
353tap=qtap
354bri=qbri
355
356case $1 in
357        up)
358                sudo -i brctl addbr $bri
359                for i in ${interfaces[@]} ; do
360                        sudo -i tunctl -t $tap$i -u $user ;
361                        sudo -i ifconfig $tap$i up ;
362                        sudo -i brctl addif $bri $tap$i ;
363                done
364                sudo -i ifconfig $bri up
365                ;;
366        down)
367                for i in ${interfaces[@]} ; do
368                        sudo -i ifconfig $tap$i down ;
369                        sudo -i tunctl -d $tap$i ;
370                done
371                sudo -i ifconfig $bri down
372                sudo -i brctl delbr $bri
373                ;;
374esac
375-------------------------------------------------------------------------------
376
377Connect your Qemu instance to one of the tap devices, e.g.
378
379-------------------------------------------------------------------------------
380qemu-system-i386 -m 512 -boot a -cpu pentium3 \
381        -drive file=$HOME/qemu/pc386_fda,index=0,if=floppy,format=raw \
382        -drive file=fat:$HOME/qemu/hd,format=raw \
383        -net nic,model=e1000,macaddr=0e:b0:ba:5e:ba:11 \
384        -net tap,ifname=qtap1,script=no,downscript=no \
385        -nodefaults -nographic -serial stdio
386-------------------------------------------------------------------------------
387
388-------------------------------------------------------------------------------
389qemu-system-arm \
390        -serial null \
391        -serial mon:stdio \
392        -nographic \
393        -M xilinx-zynq-a9 \
394        -net nic,model=cadence_gem,macaddr=0e:b0:ba:5e:ba:11 \
395        -net tap,ifname=qtap1,script=no,downscript=no \
396        -m 256M \
397        -kernel build/arm-rtems4.12-xilinx_zynq_a9_qemu/media01.exe
398-------------------------------------------------------------------------------
399
400Make sure that each Qemu instance uses its own MAC address to avoid an address
401conflict (or otherwise use it as a test).
402
403To connect the Qemu instances with your local network use the following
404(replace 'eth0' with the network interface of your host).
405
406-------------------------------------------------------------------------------
407ifconfig eth0 0.0.0.0
408brctl addif qbri eth0
409dhclient qbri
410-------------------------------------------------------------------------------
411
412=== VDE and QEMU
413
414On FreeBSD you can create VDE or the Virtual Distributed Ethernet to create a
415network environment that does not need to run qemu as root or needing to drop
416the tap's privileges to run qemu.
417
418VDE creates a software switch with a default of 32 ports which means a single
419kernel tap can support 32 qemu networking sessions.
420
421To use VDE you need to build qemu with VDE support. The RSB can detect a VDE
422plug and enable VDE support in qemu when building. On FreeBSD install the VDE
423support with:
424
425 # pkg install -u vde2
426
427Build qemu with the RSB.
428
429To network create a bridge and a tap. The network is 10.10.1.0/24. On FreeBSD
430add to your /etc/rc.conf:
431
432 cloned_interfaces="bridge0 tap0"
433 autobridge_interfaces="bridge0"
434 autobridge_bridge0="re0 tap0"
435 ifconfig_re0="up"
436 ifconfig_tap0="up"
437 ifconfig_bridge0="inet 10.1.1.2 netmask 255.255.255.0"
438 defaultrouter="10.10.1.1"
439
440Start the VDE switch as root:
441
442 # sysctl net.link.tap.user_open=1
443 # sysctl net.link.tap.up_on_open=1
444 # vde_switch -d -s /tmp/vde1 -M /tmp/mgmt1 -tap tap0 -m 660 --mgmtmode 660
445 # chmod 660 /dev/tap0
446
447You can connect to the VDE switch's management channel using:
448
449 $ vdeterm /tmp/mgmt1
450
451To run qemu:
452
453 $ qemu-system-arm \
454        -serial null \
455        -serial mon:stdio \
456        -nographic \
457        -M xilinx-zynq-a9 \
458        -net nic,model=cadence_gem,macaddr=0e:b0:ba:5e:ba:11 \
459        -net vde,id=vde0,sock=/tmp/vde1
460        -m 256M \
461        -kernel build/arm-rtems4.12-xilinx_zynq_a9_qemu/rcconf02.exe
462
463== Issues and TODO
464
465* PCI support on x86 uses a quick and dirty hack, see pci_reserve_map().
466
467* Priority queues are broken with clustered scheduling.
468
469* Per-CPU data should be enabled once the new stack is ready for SMP.
470
471* Per-CPU NETISR(9) should be enabled onece the new stack is ready for SMP.
472
473* Multiple routing tables are not supported.  Every FIB value is set to zero
474  (= BSD_DEFAULT_FIB).
475
476* Process identifiers are not supported.  Every PID value is set to zero
477  (= BSD_DEFAULT_PID).
478
479* User credentials are not supported.  The following functions allow the
480  operation for everyone
481  - prison_equal_ip4(),
482  - chgsbsize(),
483  - cr_cansee(),
484  - cr_canseesocket() and
485  - cr_canseeinpcb().
486
487* A basic USB functionality test that is known to work on Qemu is desirable.
488
489* Adapt generic IRQ PIC interface code to Simple Vectored Interrupt Model
490  so that those architectures can use new TCP/IP and USB code.
491
492* freebsd-userspace/rtems/include/sys/syslog.h is a copy from the old
493  RTEMS TCP/IP stack. For some reason, the __printflike markers do not
494  compile in this environment. We may want to use the FreeBSD syslog.h
495  and get this addressed.
496
497* in_cksum implementations for architectures not supported by FreeBSD.
498  This will require figuring out where to put implementations that do
499  not originate from FreeBSD and are populated via the script.
500
501* MAC support functions are not thread-safe ("freebsd/lib/libc/posix1e/mac.c").
502
503* IFCONFIG(8): IEEE80211 support is disabled.  This module depends on a XML
504  parser and mmap().
505
506* get_cyclecount(): The implementation is a security problem.
507
508* What to do with the priority parameter present in the FreeBSD synchronization
509  primitives and the thread creation functions?
510
511* TASKQUEUE(9): Support spin mutexes.
512
513* ZONE(9): Review allocator lock usage in rtems-bsd-chunk.c.
514
515* KQUEUE(2): Choose proper lock for global kqueue list.
516
517* TIMEOUT(9): Maybe use special task instead of timer server to call
518  callout_tick().
519
520* sysctl_handle_opaque(): Implement reliable snapshots.
521
522* PING6(8): What to do with SIGALARM?
523
524* <sys/param.h>: Update Newlib to use a MSIZE of 256.
525
526* BPF(4): Add support for zero-copy buffers.
527
528* UNIX(4): Fix race conditions in the area of socket object and file node
529  destruction.  Add support for file descriptor transmission via control
530  messages.
531
532* PRINTF(9): Add support for log(), the %D format specifier is missing in the
533  normal printf() family.
534
535* Why is the interrupt server used?  The BSD interrupt handlers can block on
536synchronization primitives like mutexes.  This is in contrast to RTEMS
537interrupt service routines.  The BSPs using the generic interrupt support must
538implement the `bsp_interrupt_vector_enable()` and
539`bsp_interrupt_vector_disable()` routines.  They normally enable/disable a
540particular interrupt source at the interrupt controller.  This can be used to
541implement the interrupt server.  The interrupt server is a task that wakes-up
542in case an associated interrupt happens.  The interrupt source is disabled in
543a generic interrupt handler that wakes-up the interrupt server task.   Once the
544postponed interrupt processing is performed in the interrupt server the
545interrupt source is enabled again.
546
547* Convert all BSP linkcmds to use a linkcmds.base so the sections are
548easier to insert.
549
550* NIC Device Drivers
551- Only common PCI NIC drivers have been included in the initial set. These
552do not include any system on chip or ISA drivers.
553- PCI configuration probe does not appear to happen to determine if a
554NIC is in I/O or memory space. We have worked around this by using a
555static hint to tell the fxp driver the correct mode. But this needs to
556be addressed.
557- The ISA drivers require more BSD infrastructure to be addressed. This was
558outside the scope of the initial porting effort.
559
560== FreeBSD Source
561
562You should be able to rely on FreebSD manual pages and documentation
563for details on the code itself.
564
565=== Automatically Generated FreeBSD Files
566
567Some source and header files are automatically generated during the FreeBSD
568build process.  The `Makefile.todo` file performs this manually.  The should be
569included in `freebsd-to-rtems.py` script some time in the future.  For details,
570see also
571http://www.freebsd.org/cgi/man.cgi?query=kobj&sektion=9&apropos=0&manpath=FreeBSD+9.2-RELEASE[KOBJ(9)].
572
573=== Rules for Modifying FreeBSD Source
574
575Only add lines.  If your patch contains lines starting with a '-', then this is
576wrong.  Subtract code by added `#ifndef __rtems__`.  This makes merging easier
577in the future.  For example:
578
579-------------------------------------------------------------------------------
580/* Global variables for the kernel. */
581
582#ifndef __rtems__
583/* 1.1 */
584extern char kernelname[MAXPATHLEN];
585#endif /* __rtems__ */
586
587extern int tick;                        /* usec per tick (1000000 / hz) */
588-------------------------------------------------------------------------------
589
590-------------------------------------------------------------------------------
591#if defined(_KERNEL) || defined(_WANT_FILE)
592#ifdef __rtems__
593#include <rtems/libio_.h>
594#include <sys/fcntl.h>
595#endif /* __rtems__ */
596/*
597 * Kernel descriptor table.
598 * One entry for each open kernel vnode and socket.
599 *
600 * Below is the list of locks that protects members in struct file.
601 *
602 * (f) protected with mtx_lock(mtx_pool_find(fp))
603 * (d) cdevpriv_mtx
604 * none not locked
605 */
606-------------------------------------------------------------------------------
607
608-------------------------------------------------------------------------------
609extern int profprocs;                   /* number of process's profiling */
610#ifndef __rtems__
611extern volatile int ticks;
612#else /* __rtems__ */
613#include <rtems/score/watchdogimpl.h>
614#define ticks _Watchdog_Ticks_since_boot
615#endif /* __rtems__ */
616
617#endif /* _KERNEL */
618-------------------------------------------------------------------------------
619
620Add nothing (even blank lines) before or after the `__rtems__` guards.  Always
621include a `__rtems__` in the guards to make searches easy, so use
622
623* `#ifndef __rtems__`,
624* `#ifdef __rtems__`,
625* `#else /* __rtems__ */`, and
626* `#endif /* __rtems__ */`.
627
628The guards must start at the begin of the line.  Examples for wrong guards:
629
630-------------------------------------------------------------------------------
631static void
632guards_must_start_at_the_begin_of_the_line(int j)
633{
634
635        #ifdef __rtems__
636        return (j + 1);
637        #else /* __rtems__ */
638        return (j + 2);
639        #endif /* __rtems__ */
640}
641
642static void
643missing_rtems_comments_in_the_guards(int j)
644{
645
646#ifdef __rtems__
647        return (j + 3);
648#else
649        return (j + 4);
650#endif
651}
652-------------------------------------------------------------------------------
653
654Do not disable option header includes via guards.  Instead, add an empty option
655header, e.g. `rtemsbsd/include/rtems/bsd/local/opt_xyz.h`.  In general, provide
656empty header files and do not guard includes.
657
658For new code use
659http://www.freebsd.org/cgi/man.cgi?query=style&apropos=0&sektion=9&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[STYLE(9)].
660Do not format original FreeBSD code.
661
662== BSD Library Source
663
664=== What is in the Git Repository
665
666There is a self-contained kit with FreeBSD and RTEMS components pre-merged. The
667Waf wscript in this kit is automatically generated.
668
669Any changes to source in the `freebsd` directories will need to be merged
670upstream into our master FreeBSD checkout, the `freebsd-org` submodule.
671
672The repository contains two FreeBSD source trees.  In the `freebsd` directory
673are the so called 'managed' FreeBSD sources used to build the BSD library.  The
674FreeBSD source in `freebsd-org` is the 'master' version.  The
675`freebsd-to-rtems.py` script is used to transfer files between the two trees.
676In general terms, if you have modified managed FreeBSD sources, you will need
677to run the script in 'revert' or 'reverse' mode using the `-R` switch.  This
678will copy the source back to your local copy of the master FreeBSD source so
679you can run `git diff` against the upstream FreeBSD source.  If you want to
680transfer source files from the master FreeBSD source to the manged FreeBSD
681sources, then you must run the script in 'forward' mode (the default).
682
683=== Organization
684
685The top level directory contains a few directories and files. The following
686are important to understand
687
688* `freebsd-to-rtems.py` - script to convert to and free FreeBSD and RTEMS trees,
689* `create-kernel-namespace.sh` - script to create the kernel namespace header <machine/rtems-bsd-kernel-namespace.h,
690* `wscript` - automatically generated,
691* `freebsd/` - from FreeBSD by script,
692* `rtemsbsd/` - RTEMS specific implementations of FreeBSD kernel support routines,
693* `testsuite/` - RTEMS specific tests, and
694* `libbsd.txt` - documentation in Asciidoc.
695
696== Moving Code Between Managed and Master FreeBSD Source
697
698The script `freebsd-to-rtems.py` is used to copy code from FreeBSD to the
699rtems-libbsd tree and to reverse this process. This script attempts to
700automate this process as much as possible and performs some transformations
701on the FreeBSD code. Its command line arguments are shown below:
702
703----
704freebsd-to-rtems.py [args]
705  -?|-h|--help      print this and exit
706  -d|--dry-run      run program but no modifications
707  -D|--diff         provide diff of files between trees
708  -e|--early-exit   evaluate arguments, print results, and exit
709  -m|--makefile     Warning: depreciated and will be removed
710  -b|--buildscripts just generate the build scripts
711  -S|--stats        Print a statistics report
712  -R|--reverse      default FreeBSD -> RTEMS, reverse that
713  -r|--rtems        RTEMS Libbsd directory (default: '.')
714  -f|--freebsd      FreeBSD SVN directory (default: 'freebsd-org')
715  -v|--verbose      enable verbose output mode
716----
717
718In its default mode of operation, freebsd-to-rtems.py is used to copy code
719from FreeBSD to the rtems-libbsd tree and perform transformations.  In forward
720mode, the script may be requested to just generate the Waf script.
721
722In "reverse mode", this script undoes those transformations and copies
723the source code back to the FreeBSD SVN tree. This allows us to do
724'svn diff', evaluate changes made by the RTEMS Project, and report changes
725back to FreeBSD upstream.
726
727In either mode, the script may be asked to perform a dry-run or be verbose.
728Also, in either mode, the script is also smart enough to avoid copying over
729files which have not changed. This means that the timestamps of files are
730not changed unless the contents change. The script will also report the
731number of files which changed. In verbose mode, the script will print
732the name of the files which are changed.
733
734To add or update files in the RTEMS FreeBSD tree first run the 'reverse mode'
735and move the current set of patches FreeBSD. The script may warn you if a file
736is not present at the destination for the direction. This can happen as files
737not avaliable at the FreeBSD snapshot point have been specially added to the
738RTEMS FreeBSD tree. Warnings can also appear if you have changed the list of
739files in libbsd.py. The reverse mode will result in the FreeBSD having
740uncommitted changes. You can ignore these. Once the reverse process has
741finished edit libbsd.py and add any new files then run the forwad mode to bring
742those files into the RTEMS FreeBSD tree.
743
744The following is an example forward run with no changes.
745
746----
747$ ~/newbsd/git/libbsd-8.2/freebsd-to-rtems.py \
748    -r /home/joel/newbsd/git/libbsd-8.2 \
749    -f /home/joel/newbsd/libbsd/freebsd-8.2 -v
750Verbose:                yes (1)
751Dry Run:                no
752Only Generate Makefile: no
753RTEMS Directory:        /home/joel/newbsd/git/libbsd-8.2
754FreeBSD Directory:      /home/joel/newbsd/libbsd/freebsd-8.2
755Direction:              forward
756Generating into /home/joel/newbsd/git/libbsd-8.2
7570 files were changed.
758----
759
760The script may also be used to generate a diff in either forward or reverse
761direction.
762
763You can add more than one verbose option (-v) to the command line and get more
764detail and debug level information from the command.
765
766== FreeBSD version of imported files and directories
767
768. sys/dev/dwc/*, trunk, 2015-03-26, cfc3df2b8f708ce8494d9d556e3472a5c8c21b8a
769. sys/dev/mmc/*, trunk, 2016-08-23, 9fe7c416e6abb28b1398fd3e5687099846800cfd
770. sys/dev/usb/*, trunk, 2015-10-30, 968dafb4fcf133cb8beb6fa3c558fecd7dc00ef0
771. *, stable/9, 2015-04-08, 99a648a912e81e29d9c4c159cbbe263462f2d719
772
773== How to import code from FreeBSD
774
775. In case you import files from a special FreeBSD version, then update the list above.
776. Run `git status` and make sure your working directory is clean.
777. Run `./freebsd-to-rtems.py -R`
778. Run `./freebsd-to-rtems.py`
779. Run `git status` and make sure your working directory is clean.  If you see modified files, then the `freebsd-to-rtems.py` script needs to be fixed first.
780. Add the files to import to `libbsd.py`.
781. Run `./freebsd-to-rtems.py`
782. Immediately check in the imported files without the changes to `libbsd_waf.py`.  Do not touch the imported files yourself at this point.
783. Port the imported files to RTEMS.  See 'Rules for Modifying FreeBSD Source'.
784. Add a test to the testsuite if possible.
785. Run `./create-kernel-namespace.sh` if you imported kernel space headers.  Add only your new defines via `git add -p rtemsbsd/include/machine/rtems-bsd-kernel-namespace.h`.
786. Create one commit from this.
787
788The -S or --stats option generates reports the changes we have made to
789FreeBSD. If the code has been reserved into the original FreeBSD tree it will
790show nothing has changed. To see what we have change:
791
792 $ cd freebsd-org
793 $ git checkout -- .
794 $ cd ..
795 $ ./freebsd-to-rtems.py -R -S -d
796
797The report lists the files change based on the opacity level. The opacity is a
798measure on how much of a file differs from the original FreeBSD source. The
799lower the value the more transparent the source file it.
800
801== Porting of user space utilities
802
803The theory behind the described method is to put all BSS and initialized data
804objects into a named section. This section then will be saved before the code is
805executed and restored after it has finished. This method limits to a single
806threaded execution of the application but minimizes the necessary changes to the
807original FreeBSD code.
808
809. Import and commit the unchanged source files like described above.
810. Add the files to the libbsd.py and build them.
811. Use nm on the generated object files to find out which objects are initialized
812  (either in BSS -- type b or B -- or in the initialized data segment -- type d
813  or D). An example call could look like follows:
814  `arm-rtems4.12-nm build/arm-rtems4.12-xilinx_zynq_a9_qemu/freebsd/contrib/pf/pfctl/pfctl.c.10.o | grep ' [DdbB] '`
815. Check the sources for everything that can be made const. This type of patches
816  should go back to the upstream FreeBSD sources.
817. Check the sources for every global variable that can be made static. This type
818  of patches should go back to the upstream FreeBSD sources.
819. Move static variables out of functions. This patches should also go upstream.
820. Create one `xxx-data.h` file per c module. This header should contain
821  declarations for the remaining initialized objects matching the original
822  declarations but adding a section attribute. The section name has to match the
823  name of the RTEMS_LINKER_RWSET defined further below. For an example look at
824  `freebsd/contrib/pf/pfctl/pfctl-data.h`.
825. Include the header files at the end of the corresponding c files.
826. Add a rtems_bsd_command_xxx wrapper function to the c file containing the main
827  function. For an example look at `rtems_bsd_command_pfctl(...)` in
828  `freebsd/contrib/pf/pfctl/pfctl.c`.
829. Create one compilable commit.
830
831== Initialization of the BSD Library
832
833The initialization of the BSD library is based on the FreeBSD SYSINIT(9)
834infrastructure.  The key to initializing a system is to ensure that the desired
835device drivers are explicitly pulled into the linked application.  This plus
836linking against the BSD library (`libbsd.a`) will pull in the necessary FreeBSD
837infrastructure.
838
839The FreeBSD kernel is not a library like the RTEMS kernel.  It is a bunch of
840object files linked together.  If we have a library, then creating the
841executable is simple.  We begin with a start symbol and recursively resolve all
842references.  With a bunch of object files linked together we need a different
843mechanism.  Most object files don't know each other.  Lets say we have a driver
844module.  The rest of the system has no references to this driver module.  The
845driver module needs a way to tell the rest of the system: Hey, kernel I am
846here, please use my services!
847
848This registration of independent components is performed by SYSINIT(9) and
849specializations:
850
851http://www.freebsd.org/cgi/man.cgi?query=SYSINIT
852
853The SYSINIT(9) uses some global data structures that are placed in a certain
854section.  In the linker command file we need this:
855
856-------------------------------------------------------------------------------
857.rtemsroset : {
858        KEEP (*(SORT(.rtemsroset.*)))
859}
860
861.rtemsrwset : {
862        KEEP (*(SORT(.rtemsrwset.*)))
863}
864-------------------------------------------------------------------------------
865
866This results for example in this executable layout:
867
868-------------------------------------------------------------------------------
869[...]
870 *(SORT(.rtemsroset.*))
871 .rtemsroset.bsd.modmetadata_set.begin
872                0x000000000025fe00        0x0 libbsd.a(rtems-bsd-init.o)
873                0x000000000025fe00                _bsd__start_set_modmetadata_set
874 .rtemsroset.bsd.modmetadata_set.content
875                0x000000000025fe00        0x8 libbsd.a(rtems-bsd-nexus.o)
876 .rtemsroset.bsd.modmetadata_set.content
877                0x000000000025fe08        0x4 libbsd.a(kern_module.o)
878[...]
879 .rtemsroset.bsd.modmetadata_set.content
880                0x000000000025fe68        0x4 libbsd.a(mii.o)
881 .rtemsroset.bsd.modmetadata_set.content
882                0x000000000025fe6c        0x4 libbsd.a(mii_bitbang.o)
883 .rtemsroset.bsd.modmetadata_set.end
884                0x000000000025fe70        0x0 libbsd.a(rtems-bsd-init.o)
885                0x000000000025fe70                _bsd__stop_set_modmetadata_set
886[...]
887.rtemsrwset     0x000000000030bad0      0x290
888 *(SORT(.rtemsrwset.*))
889 .rtemsrwset.bsd.sysinit_set.begin
890                0x000000000030bad0        0x0 libbsd.a(rtems-bsd-init.o)
891                0x000000000030bad0                _bsd__start_set_sysinit_set
892 .rtemsrwset.bsd.sysinit_set.content
893                0x000000000030bad0        0x4 libbsd.a(rtems-bsd-nexus.o)
894 .rtemsrwset.bsd.sysinit_set.content
895                0x000000000030bad4        0x8 libbsd.a(rtems-bsd-thread.o)
896 .rtemsrwset.bsd.sysinit_set.content
897                0x000000000030badc        0x4 libbsd.a(init_main.o)
898[...]
899 .rtemsrwset.bsd.sysinit_set.content
900                0x000000000030bd54        0x4 libbsd.a(frag6.o)
901 .rtemsrwset.bsd.sysinit_set.content
902                0x000000000030bd58        0x8 libbsd.a(uipc_accf.o)
903 .rtemsrwset.bsd.sysinit_set.end
904                0x000000000030bd60        0x0 libbsd.a(rtems-bsd-init.o)
905                0x000000000030bd60                _bsd__stop_set_sysinit_set
906[...]
907-------------------------------------------------------------------------------
908
909Here you can see, that some global data structures are collected into
910continuous memory areas.  This memory area can be identified by start and stop
911symbols.  This constructs a table of uniform items.
912
913The low level FreeBSD code calls at some time during the initialization the
914mi_startup() function (machine independent startup).  This function will sort
915the SYSINIT(9) set and call handler functions which perform further
916initialization.  The last step is the scheduler invocation.
917
918The SYSINIT(9) routines are run in mi_startup() which is called by
919rtems_bsd_initialize().
920
921This is also explained in "The Design and Implementation of the FreeBSD
922Operating System" section 14.3 "Kernel Initialization".
923
924In RTEMS we have a library and not a bunch of object files.  Thus we need a way
925to pull-in the desired services out of the libbsd.  Here the
926`rtems-bsd-sysinit.h` comes into play.  The SYSINIT(9) macros have been
927modified and extended for RTEMS in `<sys/kernel.h>`:
928
929-------------------------------------------------------------------------------
930#ifndef __rtems__
931#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
932        static struct sysinit uniquifier ## _sys_init = {       \
933                subsystem,                                      \
934                order,                                          \
935                func,                                           \
936                (ident)                                         \
937        };                                                      \
938        DATA_SET(sysinit_set,uniquifier ## _sys_init)
939#else /* __rtems__ */
940#define SYSINIT_ENTRY_NAME(uniquifier)                          \
941        _bsd_ ## uniquifier ## _sys_init
942#define SYSINIT_REFERENCE_NAME(uniquifier)                      \
943        _bsd_ ## uniquifier ## _sys_init_ref
944#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
945        struct sysinit SYSINIT_ENTRY_NAME(uniquifier) = {       \
946                subsystem,                                      \
947                order,                                          \
948                func,                                           \
949                (ident)                                         \
950        };                                                      \
951        RWDATA_SET(sysinit_set,SYSINIT_ENTRY_NAME(uniquifier))
952#define SYSINIT_REFERENCE(uniquifier)                           \
953        extern struct sysinit SYSINIT_ENTRY_NAME(uniquifier);   \
954        static struct sysinit const * const                     \
955        SYSINIT_REFERENCE_NAME(uniquifier) __used               \
956        = &SYSINIT_ENTRY_NAME(uniquifier)
957#define SYSINIT_MODULE_REFERENCE(mod)                           \
958        SYSINIT_REFERENCE(mod ## module)
959#define SYSINIT_DRIVER_REFERENCE(driver, bus)                   \
960        SYSINIT_MODULE_REFERENCE(driver ## _ ## bus)
961#define SYSINIT_DOMAIN_REFERENCE(dom)                           \
962        SYSINIT_REFERENCE(domain_add_ ## dom)
963#endif /* __rtems__ */
964-------------------------------------------------------------------------------
965
966Here you see that the SYSINIT(9) entries are no longer static.  The
967\*_REFERENCE() macros will create references to the corresponding modules which
968are later resolved by the linker.  The application has to provide an object
969file with references to all required FreeBSD modules.
970
971The FreeBSD device model is quite elaborated (with follow-ups):
972
973http://www.freebsd.org/cgi/man.cgi?query=driver
974
975The devices form a tree with the Nexus device at a high-level.  This Nexus
976device is architecture specific in FreeBSD.  In RTEMS we have our own Nexus
977device, see `rtemsbsd/bsp/bsp-bsd-nexus-devices.c`.
978
979=== SYSCTL_NODE Example
980
981During development, we had an undefined reference to
982_bsd_sysctl__net_children that we had trouble tracking down. Thanks to
983Chris Johns, we located it. He explained how to read SYSCTL_NODE
984definitions. This line from freebsd/netinet/in_proto.c is attempting
985to add the "inet" node to the parent node "_net".
986
987----
988SYSCTL_NODE(_net,      PF_INET,         inet,   CTLFLAG_RW, 0,
989        "Internet Family");
990----
991
992Our problem was that we could not find where _bsd_sysctl__net_children
993was defined. Chris suggested that when in doubt compile with -save-temps
994and look at the preprocessed .i files. But he did not need that. He
995explained that this the symbol name _bsd_sysctl__net_children was
996automatically generated by a SYSCTL_NODE as follows:
997
998* _bsd_ - added by RTEMS modifications to SYSCTL_NODE macro
999* sysctl_ - boilerplace added by SYSCTL_NODE macro
1000* "" - empty string for parent node
1001* net - name of SYSCTL_NODE
1002* children - added by SYSCTL macros
1003
1004This was all generated by a support macro declaring the node as this:
1005
1006----
1007struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name);
1008----
1009
1010Given this information, we located this SYSCTL_NODE declaration in
1011kern/kern_mib.c
1012
1013----
1014SYSCTL_NODE(, CTL_KERN,   kern,   CTLFLAG_RW, 0,
1015        "High kernel, proc, limits &c");
1016----
1017
1018== Core FreeBSD APIs and RTEMS Replacements ==
1019
1020=== SX(9) (Shared/exclusive locks) ===
1021
1022http://www.freebsd.org/cgi/man.cgi?query=sx
1023
1024Binary semaphores (this neglects the ability to allow shared access).
1025
1026=== MUTEX(9) (Mutual exclusion) ===
1027
1028http://www.freebsd.org/cgi/man.cgi?query=mutex
1029
1030Binary semaphores (not recursive mutexes are not supported this way).
1031
1032=== RWLOCK(9) (Reader/writer lock) ===
1033
1034http://www.freebsd.org/cgi/man.cgi?query=rwlock
1035
1036POSIX r/w lock.
1037
1038=== RMLOCK(9) (Reader/writer lock optimized for mostly read access patterns) ===
1039
1040Note:  This object was implemented as a wrapper for RWLOCK in the rm_lock header file.
1041
1042http://www.freebsd.org/cgi/man.cgi?query=rmlock
1043
1044POSIX r/w lock.
1045
1046=== CONDVAR(9) (Condition variables) ===
1047
1048http://www.freebsd.org/cgi/man.cgi?query=condvar
1049
1050POSIX condition variables with modifications (hack).
1051
1052=== CALLOUT(9) (Timer functions) ===
1053
1054http://www.freebsd.org/cgi/man.cgi?query=callout
1055
1056Timer server.
1057
1058=== TASKQUEUE(9) (Asynchronous task execution) ===
1059
1060http://www.freebsd.org/cgi/man.cgi?query=taskqueue
1061
1062TBD.
1063
1064=== KTHREAD(9), KPROC(9) (Tasks) ===
1065
1066http://www.freebsd.org/cgi/man.cgi?query=kthread
1067
1068http://www.freebsd.org/cgi/man.cgi?query=kproc
1069
1070Tasks.
1071
1072=== ZONE(9) (Zone allocator) ===
1073
1074http://www.freebsd.org/cgi/man.cgi?query=zone
1075
1076TBD.
1077
1078=== devfs (Device file system) ===
1079
1080There is a minimal implementation based on IMFS. The mount point is fixed to
1081"/dev". Note that the devfs is only used by the cdev subsystem. cdev has been
1082adapted so that the full path (including the leading "/dev") is given to devfs.
1083This saves some copy operations.
1084
1085devfs_create() first creates the full path and then creates an IMFS generic node
1086for the device.
1087
1088TBD: remove empty paths on devfs_destroy().
1089
1090=== psignal (Signals) ===
1091
1092TBD.  Seems to be not needed.
1093
1094=== poll, select ===
1095
1096TBD.  Seems to be not needed.
1097
1098=== RMAN(9) (Resource management) ===
1099
1100http://www.freebsd.org/cgi/man.cgi?query=rman
1101
1102TBD.  Seems to be not needed.
1103
1104=== DEVCLASS(9), DEVICE(9), DRIVER(9), MAKE_DEV(9) (Device management) ===
1105
1106http://www.freebsd.org/cgi/man.cgi?query=devclass
1107
1108http://www.freebsd.org/cgi/man.cgi?query=device
1109
1110http://www.freebsd.org/cgi/man.cgi?query=driver
1111
1112http://www.freebsd.org/cgi/man.cgi?query=make_dev
1113
1114Use FreeBSD implementation as far as possible.  FreeBSD has a nice API for
1115dynamic device handling.  It may be interesting for RTEMS to use this API
1116internally in the future.
1117
1118=== BUS_SPACE(9), BUS_DMA(9) (Bus and DMA access) ===
1119
1120http://www.freebsd.org/cgi/man.cgi?query=bus_space
1121
1122http://www.freebsd.org/cgi/man.cgi?query=bus_dma
1123
1124Likely BSP dependent.  A default implementation for memory mapped linear access
1125is easy to provide.  The current heap implementation supports all properties
1126demanded by bus_dma (including the boundary constraint).
1127
1128== RTEMS Replacements by File Description ==
1129
1130Note:  Files with a status of USB are used by the USB test and have at least
1131been partially tested.  If they contain both USB and Nic, then they are used
1132by both and MAY contain methods that have not been tested yet.  Files that
1133are only used by the Nic test are the most suspect.
1134
1135----
1136rtems-libbsd File:      rtems-bsd-assert.c
1137FreeBSD File:           rtems-bsd-config.h redefines BSD_ASSERT.
1138Description:            This file contains the support method rtems_bsd_assert_func().
1139Status:                 USB, Nic
1140
1141rtems-libbsd File:      rtems-bsd-autoconf.c
1142FreeBSD File:           FreeBSD has BSP specific autoconf.c
1143Description:            This file contains configuration methods that are used to setup the system.
1144Status:                 USB
1145
1146rtems-libbsd File:      rtems-bsd-bus-dma.c
1147FreeBSD File:           FreeBSD has BSP specific busdma_machdep.c
1148Description:
1149Status:                 USB, Nic
1150
1151rtems-libbsd File:      rtems-bsd-bus-dma-mbuf.c
1152FreeBSD File:           FreeBSD has BSP specific busdma_machdep.c
1153Description:
1154Status:                 Nic
1155
1156rtems-libbsd File:      rtems-bsd-callout.c
1157FreeBSD File:           kern/kern_timeout.c
1158Description:
1159Status:                 USB, Nic
1160
1161rtems-libbsd File:      rtems-bsd-cam.c
1162FreeBSD File:           cam/cam_sim.c
1163Description:
1164Status:                 USB
1165
1166rtems-libbsd File:      rtems-bsd-condvar.c
1167FreeBSD File:           kern/kern_condvar.c
1168Description:
1169Status:                 USB
1170
1171rtems-libbsd File:      rtems-bsd-copyinout.c
1172FreeBSD File:           bsp specific copyinout.c )
1173Description:            Note: The FreeBSD file is split with some methods being in rtems-bsd-support
1174Status:                 Nic
1175
1176rtems-libbsd File:      rtems-bsd-delay.c
1177FreeBSD File:           bsp specific file with multiple names
1178Description:
1179Status:                 USB, Nic
1180
1181rtems-libbsd File:      rtems-bsd-descrip.c
1182FreeBSD File:           kern/kern_descrip.c
1183Description:
1184Status:                 Nic
1185
1186rtems-libbsd File:      rtems-bsd-generic.c
1187FreeBSD File:           kern/sys_generic.c
1188Description:
1189Status:                 Nic
1190
1191rtems-libbsd File:      rtems-bsd-init.c
1192FreeBSD File:           N/A
1193Description:
1194Status:                 USB, Nic
1195
1196rtems-libbsd File:      rtems-bsd-init-with-irq.c
1197FreeBSD File:           N/A
1198Description:
1199Status:                 USB, Nic
1200
1201rtems-libbsd File:      rtems-bsd-jail.c
1202FreeBSD File:           kern/kern_jail.c
1203Description:
1204Status:                 USB, Nic
1205
1206rtems-libbsd File:      rtems-bsd-lock.c
1207FreeBSD File:           kern/subr_lock.c
1208Description:
1209Status:                 USB, Nic
1210
1211rtems-libbsd File:      rtems-bsd-log.c
1212FreeBSD File:           kern/subr_prf.c
1213Description:
1214Status:                 Nic
1215
1216rtems-libbsd File:      rtems-bsd-malloc.c
1217FreeBSD File:           kern/kern_malloc.c
1218Description:
1219Status:                 USB, Nic
1220
1221rtems-libbsd File:      rtems-bsd-mutex.c
1222FreeBSD File:           kern/kern_mutex.c
1223Description:
1224Status:                 USB, Nic
1225
1226rtems-libbsd File:      rtems-bsd-newproc.c
1227FreeBSD File:           N/A
1228Description:
1229Status:                 Nic
1230
1231rtems-libbsd File:      rtems-bsd-nexus.c
1232FreeBSD File:           bsp specific nexus.c
1233Description:
1234Status:                 USB
1235
1236rtems-libbsd File:      rtems-bsd-panic.c
1237FreeBSD File:           boot/common/panic.c
1238Description:
1239Status:                 USB, Nic
1240
1241rtems-libbsd File:      rtems-bsd-rwlock.c
1242FreeBSD File:           kern_rwlock.c
1243Description:
1244Status:                 USB, Nic
1245
1246rtems-libbsd File:      rtems-bsd-shell.c
1247FreeBSD File:           N/A
1248Description:
1249Status:                 USB
1250
1251rtems-libbsd File:      rtems-bsd-signal.c
1252FreeBSD File:           kern/kern_sig.c
1253Description:
1254Status:                 Nic
1255
1256rtems-libbsd File:      rtems-bsd-smp.c
1257FreeBSD File:           N/A
1258Description:
1259Status:                 Nic
1260
1261rtems-libbsd File:      rtems-bsd-support.c
1262FreeBSD File:           bsp specific copyinout.c
1263Description:            Note: the FreeBSD file is split with some methods being in rtems-bsd-copyinout.
1264Status:                 USB, Nic
1265
1266rtems-libbsd File:      rtems-bsd-sx.c
1267FreeBSD File:           kern/kern_sx.c
1268Description:            Status: USB, Nic
1269
1270rtems-libbsd File:      rtems-bsd-synch.c
1271FreeBSD File:           kern/kern_synch.c
1272Description:
1273Status:                 USB, Nic
1274
1275rtems-libbsd File:      rtems-bsd-syscalls.c
1276FreeBSD File:           User API for kern/uipc_syscalls.c
1277Description:
1278Status:                 Nic
1279
1280rtems-libbsd File:      rtems-bsd-sysctlbyname.c
1281FreeBSD File:           User API for sysctlbyname(3)
1282Description:
1283Status:
1284
1285rtems-libbsd File:      rtems-bsd-sysctl.c
1286FreeBSD File:           User API for sysctl(8)
1287Description:
1288Status:
1289
1290rtems-libbsd File:      rtems-bsd-sysctlnametomib.c
1291FreeBSD File:           User API for sysctlnametomib
1292Description:
1293Status:
1294
1295rtems-libbsd File:      rtems-bsd-taskqueue.c
1296FreeBSD File:           kern/subr_taskqueue.c
1297Description:
1298Status:                 Nic
1299
1300rtems-libbsd File:      rtems-bsd-thread.c
1301FreeBSD File:           kern/kern_kthread.c
1302Description:
1303Status:                 USB, Nic
1304
1305rtems-libbsd File:      rtems-bsd-timeout.c
1306FreeBSD File:           kern/kern_timeout.c
1307Description:
1308Status:                 Nic
1309
1310rtems-libbsd File:      rtems-bsd-timesupport.c
1311FreeBSD File:           kern/kern_clock.c
1312Description:
1313Status:                 Nic
1314
1315rtems-libbsd File:      rtems-bsd-vm_glue.c
1316FreeBSD File:           vm/vm_glue.c
1317Description:
1318Status:                 USB, Nic
1319----
1320
1321== Notes by File ==
1322
1323altq_subr.c - Arbitrary choices were made in this file that RTEMS would
1324not support tsc frequency change.  Additionally, the clock frequency
1325for machclk_freq is always measured for RTEMS.
1326
1327conf.h - In order to add make_dev and destroy_dev, variables in the cdev
1328structure that were not being used were conditionally compiled out. The
1329capability of supporting children did not appear to be needed and was
1330not implemented in the rtems version of these routines.
1331
1332== NICs Status ==
1333
1334----
1335Driver                  Symbol                          Status
1336======                  ======                          ======
1337RealTek                 _bsd_re_pcimodule_sys_init      Links
1338EtherExpress            _bsd_fxp_pcimodule_sys_init     Links
1339DEC tulip               _bsd_dc_pcimodule_sys_init      Links
1340Broadcom BCM57xxx       _bsd_bce_pcimodule_sys_init     Links
1341Broadcom BCM4401        _bsd_bfe_pcimodule_sys_init     Links
1342Broadcom BCM570x        _bsd_bge_pcimodule_sys_init     Needs Symbols (A)
1343E1000 IGB               _bsd_igb_pcimodule_sys_init     Links
1344E1000 EM                _bsd_em_pcimodule_sys_init      Links
1345Cadence                 ?                               Links, works.
1346----
1347
1348To add a NIC edit rtemsbsd/include/bsp/nexus-devices.h and add the driver
1349reference to the architecture and/or BSP. For example to add the RealTek driver
1350add:
1351
1352SYSINIT_DRIVER_REFERENCE(re, pci);
1353
1354and to add the MII PHY driver add:
1355
1356SYSINIT_DRIVER_REFERENCE(rge, miibus);
1357
1358The PC BSP has these entries.
1359
1360Symbols (A)
1361         pci_get_vpd_ident
1362
1363=== Cadence ===
1364
1365The cadence driver works on the Xilinx Zynq platform. The hardware checksum
1366support works on real hardware but does not seem to be supported on qemu
1367therefore the default state is to disable TXCSUM and RXCSUM and this can be
1368enabled from the shell with:
1369
1370  # ifconfig cgem0 rxcsum txcsum
1371
1372or with an ioctl call to the network interface driver with SIOCSIFCAP and the
1373mask IFCAP_TXCSUM and IFCAP_RXCSUM set.
1374
1375== PF (Firewall) ==
1376
1377It is possible to use PF as a firewall. See
1378[https://www.freebsd.org/doc/handbook/firewalls-pf.html] for details on the
1379range of functions and for how to configure the firewall.
1380
1381The following is necessary to use PF on RTEMS:
1382
1383- You have to provide a +/etc/pf.os+ file. The firewall can use it for passive
1384  OS fingerprinting. If you don't want to use this feature, the file may contain
1385  nothing except a line of comment (for example "# empty").
1386
1387- If some filters use protocol names (like tcp or udp) you have to provide a
1388  +/etc/protocols+ file.
1389
1390- If some filters use service names (like ssh or http) you have to provide a
1391  +/etc/services+ file.
1392
1393- Create a rule file (normally +/etc/pf.conf+). See the FreeBSD manual for the
1394  syntax.
1395
1396- Load the rule file using the pfctl command and enable pf. Please note that the
1397  pfctl command needs a lot of stack. You should use at least
1398  RTEMS_MINIMUM_STACK_SIZE + 8192 Bytes of stack. An example initialisation can
1399  look like follows:
1400
1401----
1402        int exit_code;
1403        char *params[] = {
1404                "pfctl",
1405                "-f",
1406                "/etc/pf.conf",
1407                "-e",
1408                NULL
1409        };
1410
1411        exit_code = rtems_bsd_command_pfctl(ARGC(params), params);
1412        assert(exit_code == EXIT_SUCCSESS);
1413----
1414
1415=== Known restrictions ===
1416
1417- Currently PF on RTEMS always uses the configuration for memory restricted
1418  systems (on FreeBSD that means systems with less than 100 MB RAM). This is
1419  fixed in +pfctl_init_options()+.
1420
1421== Problems to report to FreeBSD ==
1422
1423The MMAP_NOT_AVAILABLE define is inverted on its usage.  When it is
1424defined the mmap method is called. Additionally, it is not used
1425thoroughly. It is not used in the unmap portion of the source.
1426The file rec_open.c uses the define MMAP_NOT_AVAILABLE to wrap
1427the call to mmap and file rec_close.c uses the munmap method.
Note: See TracBrowser for help on using the repository browser.