source: rtems-libbsd/libbsd.txt @ f1941b2

5-freebsd-12freebsd-9.3
Last change on this file since f1941b2 was f1941b2, checked in by Christian Mauderer <Christian.Mauderer@…>, on Jul 12, 2016 at 11:41:39 AM

libbsd.txt: Add section describing PF.

  • Property mode set to 100644
File size: 48.0 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
628For new code use
629http://www.freebsd.org/cgi/man.cgi?query=style&apropos=0&sektion=9&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[STYLE(9)].
630Do not format original FreeBSD code.
631
632== BSD Library Source
633
634=== What is in the Git Repository
635
636There is a self-contained kit with FreeBSD and RTEMS components pre-merged. The
637Waf wscript in this kit is automatically generated.
638
639Any changes to source in the `freebsd` directories will need to be merged
640upstream into our master FreeBSD checkout, the `freebsd-org` submodule.
641
642The repository contains two FreeBSD source trees.  In the `freebsd` directory
643are the so called 'managed' FreeBSD sources used to build the BSD library.  The
644FreeBSD source in `freebsd-org` is the 'master' version.  The
645`freebsd-to-rtems.py` script is used to transfer files between the two trees.
646In general terms, if you have modified managed FreeBSD sources, you will need
647to run the script in 'revert' or 'reverse' mode using the `-R` switch.  This
648will copy the source back to your local copy of the master FreeBSD source so
649you can run `git diff` against the upstream FreeBSD source.  If you want to
650transfer source files from the master FreeBSD source to the manged FreeBSD
651sources, then you must run the script in 'forward' mode (the default).
652
653=== Organization
654
655The top level directory contains a few directories and files. The following
656are important to understand
657
658* `freebsd-to-rtems.py` - script to convert to and free FreeBSD and RTEMS trees,
659* `create-kernel-namespace.sh` - script to create the kernel namespace header <machine/rtems-bsd-kernel-namespace.h,
660* `wscript` - automatically generated,
661* `freebsd/` - from FreeBSD by script,
662* `rtemsbsd/` - RTEMS specific implementations of FreeBSD kernel support routines,
663* `testsuite/` - RTEMS specific tests, and
664* `libbsd.txt` - documentation in Asciidoc.
665
666== Moving Code Between Managed and Master FreeBSD Source
667
668The script `freebsd-to-rtems.py` is used to copy code from FreeBSD to the
669rtems-libbsd tree and to reverse this process. This script attempts to
670automate this process as much as possible and performs some transformations
671on the FreeBSD code. Its command line arguments are shown below:
672
673----
674freebsd-to-rtems.py [args]
675  -?|-h|--help      print this and exit
676  -d|--dry-run      run program but no modifications
677  -D|--diff         provide diff of files between trees
678  -e|--early-exit   evaluate arguments, print results, and exit
679  -m|--makefile     Warning: depreciated and will be removed
680  -b|--buildscripts just generate the build scripts
681  -S|--stats        Print a statistics report
682  -R|--reverse      default FreeBSD -> RTEMS, reverse that
683  -r|--rtems        RTEMS Libbsd directory (default: '.')
684  -f|--freebsd      FreeBSD SVN directory (default: 'freebsd-org')
685  -v|--verbose      enable verbose output mode
686----
687
688In its default mode of operation, freebsd-to-rtems.py is used to copy code
689from FreeBSD to the rtems-libbsd tree and perform transformations.  In forward
690mode, the script may be requested to just generate the Waf script.
691
692In "reverse mode", this script undoes those transformations and copies
693the source code back to the FreeBSD SVN tree. This allows us to do
694'svn diff', evaluate changes made by the RTEMS Project, and report changes
695back to FreeBSD upstream.
696
697In either mode, the script may be asked to perform a dry-run or be verbose.
698Also, in either mode, the script is also smart enough to avoid copying over
699files which have not changed. This means that the timestamps of files are
700not changed unless the contents change. The script will also report the
701number of files which changed. In verbose mode, the script will print
702the name of the files which are changed.
703
704To add or update files in the RTEMS FreeBSD tree first run the 'reverse mode'
705and move the current set of patches FreeBSD. The script may warn you if a file
706is not present at the destination for the direction. This can happen as files
707not avaliable at the FreeBSD snapshot point have been specially added to the
708RTEMS FreeBSD tree. Warnings can also appear if you have changed the list of
709files in libbsd.py. The reverse mode will result in the FreeBSD having
710uncommitted changes. You can ignore these. Once the reverse process has
711finished edit libbsd.py and add any new files then run the forwad mode to bring
712those files into the RTEMS FreeBSD tree.
713
714The following is an example forward run with no changes.
715
716----
717$ ~/newbsd/git/libbsd-8.2/freebsd-to-rtems.py \
718    -r /home/joel/newbsd/git/libbsd-8.2 \
719    -f /home/joel/newbsd/libbsd/freebsd-8.2 -v
720Verbose:                yes (1)
721Dry Run:                no
722Only Generate Makefile: no
723RTEMS Directory:        /home/joel/newbsd/git/libbsd-8.2
724FreeBSD Directory:      /home/joel/newbsd/libbsd/freebsd-8.2
725Direction:              forward
726Generating into /home/joel/newbsd/git/libbsd-8.2
7270 files were changed.
728----
729
730The script may also be used to generate a diff in either forward or reverse
731direction.
732
733You can add more than one verbose option (-v) to the command line and get more
734detail and debug level information from the command.
735
736== How to import code from FreeBSD
737
738. Run `git status` and make sure your working directory is clean.
739. Run `./freebsd-to-rtems.py -R`
740. Run `./freebsd-to-rtems.py`
741. 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.
742. Add the files to import to `libbsd.py`.
743. Run `./freebsd-to-rtems.py`
744. Immediately check in the imported files without the changes to `libbsd_waf.py`.  Do not touch the imported files yourself at this point.
745. Port the imported files to RTEMS.  See 'Rules for Modifying FreeBSD Source'.
746. Add a test to the testsuite if possible.
747. 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`.
748. Create one commit from this.
749
750The -S or --stats option generates reports the changes we have made to
751FreeBSD. If the code has been reserved into the original FreeBSD tree it will
752show nothing has changed. To see what we have change:
753
754 $ cd freebsd-org
755 $ git checkout -- .
756 $ cd ..
757 $ ./freebsd-to-rtems.py -R -S -d
758
759The report lists the files change based on the opacity level. The opacity is a
760measure on how much of a file differs from the original FreeBSD source. The
761lower the value the more transparent the source file it.
762
763== Porting of user space utilities
764
765The theory behind the described method is to put all BSS and initialized data
766objects into a named section. This section then will be saved before the code is
767executed and restored after it has finished. This method limits to a single
768threaded execution of the application but minimizes the necessary changes to the
769original FreeBSD code.
770
771. Import and commit the unchanged source files like described above.
772. Add the files to the libbsd.py and build them.
773. Use nm on the generated object files to find out which objects are initialized
774  (either in BSS -- type b or B -- or in the initialized data segment -- type d
775  or D). An example call could look like follows:
776  `arm-rtems4.12-nm build/arm-rtems4.12-xilinx_zynq_a9_qemu/freebsd/contrib/pf/pfctl/pfctl.c.10.o | grep ' [DdbB] '`
777. Check the sources for everything that can be made const. This type of patches
778  should go back to the upstream FreeBSD sources.
779. Check the sources for every global variable that can be made static. This type
780  of patches should go back to the upstream FreeBSD sources.
781. Move static variables out of functions. This patches should also go upstream.
782. Create one `xxx-data.h` file per c module. This header should contain
783  declarations for the remaining initialized objects matching the original
784  declarations but adding a section attribute. The section name has to match the
785  name of the RTEMS_LINKER_RWSET defined further below. For an example look at
786  `freebsd/contrib/pf/pfctl/pfctl-data.h`.
787. Include the header files at the end of the corresponding c files.
788. Add a rtems_bsd_command_xxx wrapper function to the c file containing the main
789  function. For an example look at `rtems_bsd_command_pfctl(...)` in
790  `freebsd/contrib/pf/pfctl/pfctl.c`.
791. Create one compilable commit.
792
793== Initialization of the BSD Library
794
795The initialization of the BSD library is based on the FreeBSD SYSINIT(9)
796infrastructure.  The key to initializing a system is to ensure that the desired
797device drivers are explicitly pulled into the linked application.  This plus
798linking against the BSD library (`libbsd.a`) will pull in the necessary FreeBSD
799infrastructure.
800
801The FreeBSD kernel is not a library like the RTEMS kernel.  It is a bunch of
802object files linked together.  If we have a library, then creating the
803executable is simple.  We begin with a start symbol and recursively resolve all
804references.  With a bunch of object files linked together we need a different
805mechanism.  Most object files don't know each other.  Lets say we have a driver
806module.  The rest of the system has no references to this driver module.  The
807driver module needs a way to tell the rest of the system: Hey, kernel I am
808here, please use my services!
809
810This registration of independent components is performed by SYSINIT(9) and
811specializations:
812
813http://www.freebsd.org/cgi/man.cgi?query=SYSINIT
814
815The SYSINIT(9) uses some global data structures that are placed in a certain
816section.  In the linker command file we need this:
817
818-------------------------------------------------------------------------------
819.rtemsroset : {
820        KEEP (*(SORT(.rtemsroset.*)))
821}
822
823.rtemsrwset : {
824        KEEP (*(SORT(.rtemsrwset.*)))
825}
826-------------------------------------------------------------------------------
827
828This results for example in this executable layout:
829
830-------------------------------------------------------------------------------
831[...]
832 *(SORT(.rtemsroset.*))
833 .rtemsroset.bsd.modmetadata_set.begin
834                0x000000000025fe00        0x0 libbsd.a(rtems-bsd-init.o)
835                0x000000000025fe00                _bsd__start_set_modmetadata_set
836 .rtemsroset.bsd.modmetadata_set.content
837                0x000000000025fe00        0x8 libbsd.a(rtems-bsd-nexus.o)
838 .rtemsroset.bsd.modmetadata_set.content
839                0x000000000025fe08        0x4 libbsd.a(kern_module.o)
840[...]
841 .rtemsroset.bsd.modmetadata_set.content
842                0x000000000025fe68        0x4 libbsd.a(mii.o)
843 .rtemsroset.bsd.modmetadata_set.content
844                0x000000000025fe6c        0x4 libbsd.a(mii_bitbang.o)
845 .rtemsroset.bsd.modmetadata_set.end
846                0x000000000025fe70        0x0 libbsd.a(rtems-bsd-init.o)
847                0x000000000025fe70                _bsd__stop_set_modmetadata_set
848[...]
849.rtemsrwset     0x000000000030bad0      0x290
850 *(SORT(.rtemsrwset.*))
851 .rtemsrwset.bsd.sysinit_set.begin
852                0x000000000030bad0        0x0 libbsd.a(rtems-bsd-init.o)
853                0x000000000030bad0                _bsd__start_set_sysinit_set
854 .rtemsrwset.bsd.sysinit_set.content
855                0x000000000030bad0        0x4 libbsd.a(rtems-bsd-nexus.o)
856 .rtemsrwset.bsd.sysinit_set.content
857                0x000000000030bad4        0x8 libbsd.a(rtems-bsd-thread.o)
858 .rtemsrwset.bsd.sysinit_set.content
859                0x000000000030badc        0x4 libbsd.a(init_main.o)
860[...]
861 .rtemsrwset.bsd.sysinit_set.content
862                0x000000000030bd54        0x4 libbsd.a(frag6.o)
863 .rtemsrwset.bsd.sysinit_set.content
864                0x000000000030bd58        0x8 libbsd.a(uipc_accf.o)
865 .rtemsrwset.bsd.sysinit_set.end
866                0x000000000030bd60        0x0 libbsd.a(rtems-bsd-init.o)
867                0x000000000030bd60                _bsd__stop_set_sysinit_set
868[...]
869-------------------------------------------------------------------------------
870
871Here you can see, that some global data structures are collected into
872continuous memory areas.  This memory area can be identified by start and stop
873symbols.  This constructs a table of uniform items.
874
875The low level FreeBSD code calls at some time during the initialization the
876mi_startup() function (machine independent startup).  This function will sort
877the SYSINIT(9) set and call handler functions which perform further
878initialization.  The last step is the scheduler invocation.
879
880The SYSINIT(9) routines are run in mi_startup() which is called by
881rtems_bsd_initialize().
882
883This is also explained in "The Design and Implementation of the FreeBSD
884Operating System" section 14.3 "Kernel Initialization".
885
886In RTEMS we have a library and not a bunch of object files.  Thus we need a way
887to pull-in the desired services out of the libbsd.  Here the
888`rtems-bsd-sysinit.h` comes into play.  The SYSINIT(9) macros have been
889modified and extended for RTEMS in `<sys/kernel.h>`:
890
891-------------------------------------------------------------------------------
892#ifndef __rtems__
893#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
894        static struct sysinit uniquifier ## _sys_init = {       \
895                subsystem,                                      \
896                order,                                          \
897                func,                                           \
898                (ident)                                         \
899        };                                                      \
900        DATA_SET(sysinit_set,uniquifier ## _sys_init)
901#else /* __rtems__ */
902#define SYSINIT_ENTRY_NAME(uniquifier)                          \
903        _bsd_ ## uniquifier ## _sys_init
904#define SYSINIT_REFERENCE_NAME(uniquifier)                      \
905        _bsd_ ## uniquifier ## _sys_init_ref
906#define C_SYSINIT(uniquifier, subsystem, order, func, ident)    \
907        struct sysinit SYSINIT_ENTRY_NAME(uniquifier) = {       \
908                subsystem,                                      \
909                order,                                          \
910                func,                                           \
911                (ident)                                         \
912        };                                                      \
913        RWDATA_SET(sysinit_set,SYSINIT_ENTRY_NAME(uniquifier))
914#define SYSINIT_REFERENCE(uniquifier)                           \
915        extern struct sysinit SYSINIT_ENTRY_NAME(uniquifier);   \
916        static struct sysinit const * const                     \
917        SYSINIT_REFERENCE_NAME(uniquifier) __used               \
918        = &SYSINIT_ENTRY_NAME(uniquifier)
919#define SYSINIT_MODULE_REFERENCE(mod)                           \
920        SYSINIT_REFERENCE(mod ## module)
921#define SYSINIT_DRIVER_REFERENCE(driver, bus)                   \
922        SYSINIT_MODULE_REFERENCE(driver ## _ ## bus)
923#define SYSINIT_DOMAIN_REFERENCE(dom)                           \
924        SYSINIT_REFERENCE(domain_add_ ## dom)
925#endif /* __rtems__ */
926-------------------------------------------------------------------------------
927
928Here you see that the SYSINIT(9) entries are no longer static.  The
929\*_REFERENCE() macros will create references to the corresponding modules which
930are later resolved by the linker.  The application has to provide an object
931file with references to all required FreeBSD modules.
932
933The FreeBSD device model is quite elaborated (with follow-ups):
934
935http://www.freebsd.org/cgi/man.cgi?query=driver
936
937The devices form a tree with the Nexus device at a high-level.  This Nexus
938device is architecture specific in FreeBSD.  In RTEMS we have our own Nexus
939device, see `rtemsbsd/bsp/bsp-bsd-nexus-devices.c`.
940
941=== SYSCTL_NODE Example
942
943During development, we had an undefined reference to
944_bsd_sysctl__net_children that we had trouble tracking down. Thanks to
945Chris Johns, we located it. He explained how to read SYSCTL_NODE
946definitions. This line from freebsd/netinet/in_proto.c is attempting
947to add the "inet" node to the parent node "_net".
948
949----
950SYSCTL_NODE(_net,      PF_INET,         inet,   CTLFLAG_RW, 0,
951        "Internet Family");
952----
953
954Our problem was that we could not find where _bsd_sysctl__net_children
955was defined. Chris suggested that when in doubt compile with -save-temps
956and look at the preprocessed .i files. But he did not need that. He
957explained that this the symbol name _bsd_sysctl__net_children was
958automatically generated by a SYSCTL_NODE as follows:
959
960* _bsd_ - added by RTEMS modifications to SYSCTL_NODE macro
961* sysctl_ - boilerplace added by SYSCTL_NODE macro
962* "" - empty string for parent node
963* net - name of SYSCTL_NODE
964* children - added by SYSCTL macros
965
966This was all generated by a support macro declaring the node as this:
967
968----
969struct sysctl_oid_list SYSCTL_NODE_CHILDREN(parent, name);
970----
971
972Given this information, we located this SYSCTL_NODE declaration in
973kern/kern_mib.c
974
975----
976SYSCTL_NODE(, CTL_KERN,   kern,   CTLFLAG_RW, 0,
977        "High kernel, proc, limits &c");
978----
979
980== Core FreeBSD APIs and RTEMS Replacements ==
981
982=== SX(9) (Shared/exclusive locks) ===
983
984http://www.freebsd.org/cgi/man.cgi?query=sx
985
986Binary semaphores (this neglects the ability to allow shared access).
987
988=== MUTEX(9) (Mutual exclusion) ===
989
990http://www.freebsd.org/cgi/man.cgi?query=mutex
991
992Binary semaphores (not recursive mutexes are not supported this way).
993
994=== RWLOCK(9) (Reader/writer lock) ===
995
996http://www.freebsd.org/cgi/man.cgi?query=rwlock
997
998POSIX r/w lock.
999
1000=== RMLOCK(9) (Reader/writer lock optimized for mostly read access patterns) ===
1001
1002Note:  This object was implemented as a wrapper for RWLOCK in the rm_lock header file.
1003
1004http://www.freebsd.org/cgi/man.cgi?query=rmlock
1005
1006POSIX r/w lock.
1007
1008=== CONDVAR(9) (Condition variables) ===
1009
1010http://www.freebsd.org/cgi/man.cgi?query=condvar
1011
1012POSIX condition variables with modifications (hack).
1013
1014=== CALLOUT(9) (Timer functions) ===
1015
1016http://www.freebsd.org/cgi/man.cgi?query=callout
1017
1018Timer server.
1019
1020=== TASKQUEUE(9) (Asynchronous task execution) ===
1021
1022http://www.freebsd.org/cgi/man.cgi?query=taskqueue
1023
1024TBD.
1025
1026=== KTHREAD(9), KPROC(9) (Tasks) ===
1027
1028http://www.freebsd.org/cgi/man.cgi?query=kthread
1029
1030http://www.freebsd.org/cgi/man.cgi?query=kproc
1031
1032Tasks.
1033
1034=== ZONE(9) (Zone allocator) ===
1035
1036http://www.freebsd.org/cgi/man.cgi?query=zone
1037
1038TBD.
1039
1040=== devfs (Device file system) ===
1041
1042Dummy, IMFS or new implementation (currently dummy).
1043
1044=== psignal (Signals) ===
1045
1046TBD.  Seems to be not needed.
1047
1048=== poll, select ===
1049
1050TBD.  Seems to be not needed.
1051
1052=== RMAN(9) (Resource management) ===
1053
1054http://www.freebsd.org/cgi/man.cgi?query=rman
1055
1056TBD.  Seems to be not needed.
1057
1058=== DEVCLASS(9), DEVICE(9), DRIVER(9), MAKE_DEV(9) (Device management) ===
1059
1060http://www.freebsd.org/cgi/man.cgi?query=devclass
1061
1062http://www.freebsd.org/cgi/man.cgi?query=device
1063
1064http://www.freebsd.org/cgi/man.cgi?query=driver
1065
1066http://www.freebsd.org/cgi/man.cgi?query=make_dev
1067
1068Use FreeBSD implementation as far as possible.  FreeBSD has a nice API for
1069dynamic device handling.  It may be interesting for RTEMS to use this API
1070internally in the future.
1071
1072=== BUS_SPACE(9), BUS_DMA(9) (Bus and DMA access) ===
1073
1074http://www.freebsd.org/cgi/man.cgi?query=bus_space
1075
1076http://www.freebsd.org/cgi/man.cgi?query=bus_dma
1077
1078Likely BSP dependent.  A default implementation for memory mapped linear access
1079is easy to provide.  The current heap implementation supports all properties
1080demanded by bus_dma (including the boundary constraint).
1081
1082== RTEMS Replacements by File Description ==
1083
1084Note:  Files with a status of USB are used by the USB test and have at least
1085been partially tested.  If they contain both USB and Nic, then they are used
1086by both and MAY contain methods that have not been tested yet.  Files that
1087are only used by the Nic test are the most suspect.
1088
1089----
1090rtems-libbsd File:      rtems-bsd-assert.c
1091FreeBSD File:           rtems-bsd-config.h redefines BSD_ASSERT.
1092Description:            This file contains the support method rtems_bsd_assert_func().
1093Status:                 USB, Nic
1094
1095rtems-libbsd File:      rtems-bsd-autoconf.c
1096FreeBSD File:           FreeBSD has BSP specific autoconf.c
1097Description:            This file contains configuration methods that are used to setup the system.
1098Status:                 USB
1099
1100rtems-libbsd File:      rtems-bsd-bus-dma.c
1101FreeBSD File:           FreeBSD has BSP specific busdma_machdep.c
1102Description:
1103Status:                 USB, Nic
1104
1105rtems-libbsd File:      rtems-bsd-bus-dma-mbuf.c
1106FreeBSD File:           FreeBSD has BSP specific busdma_machdep.c
1107Description:
1108Status:                 Nic
1109
1110rtems-libbsd File:      rtems-bsd-callout.c
1111FreeBSD File:           kern/kern_timeout.c
1112Description:
1113Status:                 USB, Nic
1114
1115rtems-libbsd File:      rtems-bsd-cam.c
1116FreeBSD File:           cam/cam_sim.c
1117Description:
1118Status:                 USB
1119
1120rtems-libbsd File:      rtems-bsd-condvar.c
1121FreeBSD File:           kern/kern_condvar.c
1122Description:
1123Status:                 USB
1124
1125rtems-libbsd File:      rtems-bsd-copyinout.c
1126FreeBSD File:           bsp specific copyinout.c )
1127Description:            Note: The FreeBSD file is split with some methods being in rtems-bsd-support
1128Status:                 Nic
1129
1130rtems-libbsd File:      rtems-bsd-delay.c
1131FreeBSD File:           bsp specific file with multiple names
1132Description:
1133Status:                 USB, Nic
1134
1135rtems-libbsd File:      rtems-bsd-descrip.c
1136FreeBSD File:           kern/kern_descrip.c
1137Description:
1138Status:                 Nic
1139
1140rtems-libbsd File:      rtems-bsd-generic.c
1141FreeBSD File:           kern/sys_generic.c
1142Description:
1143Status:                 Nic
1144
1145rtems-libbsd File:      rtems-bsd-init.c
1146FreeBSD File:           N/A
1147Description:
1148Status:                 USB, Nic
1149
1150rtems-libbsd File:      rtems-bsd-init-with-irq.c
1151FreeBSD File:           N/A
1152Description:
1153Status:                 USB, Nic
1154
1155rtems-libbsd File:      rtems-bsd-jail.c
1156FreeBSD File:           kern/kern_jail.c
1157Description:
1158Status:                 USB, Nic
1159
1160rtems-libbsd File:      rtems-bsd-lock.c
1161FreeBSD File:           kern/subr_lock.c
1162Description:
1163Status:                 USB, Nic
1164
1165rtems-libbsd File:      rtems-bsd-log.c
1166FreeBSD File:           kern/subr_prf.c
1167Description:
1168Status:                 Nic
1169
1170rtems-libbsd File:      rtems-bsd-malloc.c
1171FreeBSD File:           kern/kern_malloc.c
1172Description:
1173Status:                 USB, Nic
1174
1175rtems-libbsd File:      rtems-bsd-mutex.c
1176FreeBSD File:           kern/kern_mutex.c
1177Description:
1178Status:                 USB, Nic
1179
1180rtems-libbsd File:      rtems-bsd-newproc.c
1181FreeBSD File:           N/A
1182Description:
1183Status:                 Nic
1184
1185rtems-libbsd File:      rtems-bsd-nexus.c
1186FreeBSD File:           bsp specific nexus.c
1187Description:
1188Status:                 USB
1189
1190rtems-libbsd File:      rtems-bsd-panic.c
1191FreeBSD File:           boot/common/panic.c
1192Description:
1193Status:                 USB, Nic
1194
1195rtems-libbsd File:      rtems-bsd-rwlock.c
1196FreeBSD File:           kern_rwlock.c
1197Description:
1198Status:                 USB, Nic
1199
1200rtems-libbsd File:      rtems-bsd-shell.c
1201FreeBSD File:           N/A
1202Description:
1203Status:                 USB
1204
1205rtems-libbsd File:      rtems-bsd-signal.c
1206FreeBSD File:           kern/kern_sig.c
1207Description:
1208Status:                 Nic
1209
1210rtems-libbsd File:      rtems-bsd-smp.c
1211FreeBSD File:           N/A
1212Description:
1213Status:                 Nic
1214
1215rtems-libbsd File:      rtems-bsd-support.c
1216FreeBSD File:           bsp specific copyinout.c
1217Description:            Note: the FreeBSD file is split with some methods being in rtems-bsd-copyinout.
1218Status:                 USB, Nic
1219
1220rtems-libbsd File:      rtems-bsd-sx.c
1221FreeBSD File:           kern/kern_sx.c
1222Description:            Status: USB, Nic
1223
1224rtems-libbsd File:      rtems-bsd-synch.c
1225FreeBSD File:           kern/kern_synch.c
1226Description:
1227Status:                 USB, Nic
1228
1229rtems-libbsd File:      rtems-bsd-syscalls.c
1230FreeBSD File:           User API for kern/uipc_syscalls.c
1231Description:
1232Status:                 Nic
1233
1234rtems-libbsd File:      rtems-bsd-sysctlbyname.c
1235FreeBSD File:           User API for sysctlbyname(3)
1236Description:
1237Status:
1238
1239rtems-libbsd File:      rtems-bsd-sysctl.c
1240FreeBSD File:           User API for sysctl(8)
1241Description:
1242Status:
1243
1244rtems-libbsd File:      rtems-bsd-sysctlnametomib.c
1245FreeBSD File:           User API for sysctlnametomib
1246Description:
1247Status:
1248
1249rtems-libbsd File:      rtems-bsd-taskqueue.c
1250FreeBSD File:           kern/subr_taskqueue.c
1251Description:
1252Status:                 Nic
1253
1254rtems-libbsd File:      rtems-bsd-thread.c
1255FreeBSD File:           kern/kern_kthread.c
1256Description:
1257Status:                 USB, Nic
1258
1259rtems-libbsd File:      rtems-bsd-timeout.c
1260FreeBSD File:           kern/kern_timeout.c
1261Description:
1262Status:                 Nic
1263
1264rtems-libbsd File:      rtems-bsd-timesupport.c
1265FreeBSD File:           kern/kern_clock.c
1266Description:
1267Status:                 Nic
1268
1269rtems-libbsd File:      rtems-bsd-vm_glue.c
1270FreeBSD File:           vm/vm_glue.c
1271Description:
1272Status:                 USB, Nic
1273----
1274
1275== Notes by File ==
1276
1277altq_subr.c - Arbitrary choices were made in this file that RTEMS would
1278not support tsc frequency change.  Additionally, the clock frequency
1279for machclk_freq is always measured for RTEMS.
1280
1281conf.h - In order to add make_dev and destroy_dev, variables in the cdev
1282structure that were not being used were conditionally compiled out. The
1283capability of supporting children did not appear to be needed and was
1284not implemented in the rtems version of these routines.
1285
1286== NICs Status ==
1287
1288----
1289Driver                  Symbol                          Status
1290======                  ======                          ======
1291RealTek                 _bsd_re_pcimodule_sys_init      Links
1292EtherExpress            _bsd_fxp_pcimodule_sys_init     Links
1293DEC tulip               _bsd_dc_pcimodule_sys_init      Links
1294Broadcom BCM57xxx       _bsd_bce_pcimodule_sys_init     Links
1295Broadcom BCM4401        _bsd_bfe_pcimodule_sys_init     Links
1296Broadcom BCM570x        _bsd_bge_pcimodule_sys_init     Needs Symbols (A)
1297E1000 IGB               _bsd_igb_pcimodule_sys_init     Links
1298E1000 EM                _bsd_em_pcimodule_sys_init      Links
1299Cadence                 ?                               Links, works.
1300----
1301
1302To add a NIC edit rtemsbsd/include/bsp/nexus-devices.h and add the driver
1303reference to the architecture and/or BSP. For example to add the RealTek driver
1304add:
1305
1306SYSINIT_DRIVER_REFERENCE(re, pci);
1307
1308and to add the MII PHY driver add:
1309
1310SYSINIT_DRIVER_REFERENCE(rge, miibus);
1311
1312The PC BSP has these entries.
1313
1314Symbols (A)
1315         pci_get_vpd_ident
1316
1317=== Cadence ===
1318
1319The cadence driver works on the Xilinx Zynq platform. The hardware checksum
1320support works on real hardware but does not seem to be supported on qemu
1321therefore the default state is to disable TXCSUM and RXCSUM and this can be
1322enabled from the shell with:
1323
1324  # ifconfig cgem0 rxcsum txcsum
1325
1326or with an ioctl call to the network interface driver with SIOCSIFCAP and the
1327mask IFCAP_TXCSUM and IFCAP_RXCSUM set.
1328
1329== PF (Firewall) ==
1330
1331It is possible to use PF as a firewall. See
1332[https://www.freebsd.org/doc/handbook/firewalls-pf.html] for details on the
1333range of functions and for how to configure the firewall.
1334
1335The following is necessary to use PF on RTEMS:
1336
1337- You have to provide a +/etc/pf.os+ file. The firewall can use it for passive
1338  OS fingerprinting. If you don't want to use this feature, the file may contain
1339  nothing except a line of comment (for example "# empty").
1340
1341- If some filters use protocol names (like tcp or udp) you have to provide a
1342  +/etc/protocols+ file.
1343
1344- If some filters use service names (like ssh or http) you have to provide a
1345  +/etc/services+ file.
1346
1347- Create a rule file (normally +/etc/pf.conf+). See the FreeBSD manual for the
1348  syntax.
1349
1350- Load the rule file using the pfctl command and enable pf. An example
1351  initialisation can look like follows:
1352
1353----
1354        int exit_code;
1355        char *params[] = {
1356                "pfctl",
1357                "-f",
1358                "/etc/pf.conf",
1359                "-e",
1360                NULL
1361        };
1362
1363        exit_code = rtems_bsd_command_pfctl(ARGC(params), params);
1364        assert(exit_code == EXIT_SUCCSESS);
1365----
1366
1367=== Known restrictions ===
1368
1369- Currently PF on RTEMS always uses the configuration for memory restricted
1370  systems (on FreeBSD that means systems with less than 100 MB RAM). This is
1371  fixed in +pfctl_init_options()+.
1372
1373== Problems to report to FreeBSD ==
1374
1375The MMAP_NOT_AVAILABLE define is inverted on its usage.  When it is
1376defined the mmap method is called. Additionally, it is not used
1377thoroughly. It is not used in the unmap portion of the source.
1378The file rec_open.c uses the define MMAP_NOT_AVAILABLE to wrap
1379the call to mmap and file rec_close.c uses the munmap method.
Note: See TracBrowser for help on using the repository browser.