MFC r340475

ifnet(9): Add description of IFCAP_NETMAP

Describe IFCAP_NETMAP adding a cross reference to netmap(4).

Reviewed by: bcr, 0mp
Approved by: gnn (mentor)
Differential Revision: https://reviews.freebsd.org/D17988

MFC r315802:

ifnet(9): fix some igor/manlint warnings

- Fix typos (queueing -> queuing) [1].
- Add missing section number for polling .Xr reference [2].

MFC r302548:
Belatedly remove CSUM_IP_FRAGS and CSUM_FRAGMENT offloading
capabilities. It was removed in r243624 and r254804/r271006
respectively.
This file and mbuf(9) needs updates for other offloading
capabilities(i.e. CSUM_SCTP and CSUM_TSO).

Copy head@r302406 to stable/11 as part of the 11.0-RELEASE cycle.
Prune svn:mergeinfo from the new branch, as nothing has been merged
here.

Additional commits post-branch will follow.

Approved by: re (implicit)
Sponsored by: The FreeBSD Foundation

Fix mandoc warnings/errors.

MFC after: 1 week

Deshallify.

Fix various mdoc issues and some EOL whitespace.

Found with: mandoc -Tlint

Revisions 264905 and 266860 added a "int fib" argument to ifa_ifwithnet and
ifa_ifwithdstaddr. For the sake of backwards compatibility, the new
arguments were added to new functions named ifa_ifwithnet_fib and
ifa_ifwithdstaddr_fib, while the old functions became wrappers around the
new ones that passed RT_ALL_FIBS for the fib argument. However, the
backwards compatibility is not desired for FreeBSD 11, because there are
numerous other incompatible changes to the ifnet(9) API. We therefore
decided to remove it from head but leave it in place for stable/9 and
stable/10. In addition, this commit adds the fib argument to
ifa_ifwithbroadaddr for consistency's sake.

sys/sys/param.h
Increment __FreeBSD_version

sys/net/if.c
sys/net/if_var.h
sys/net/route.c
Add fibnum argument to ifa_ifwithbroadaddr, and remove the _fib
versions of ifa_ifwithdstaddr, ifa_ifwithnet, and ifa_ifwithroute.

sys/net/route.c
sys/net/rtsock.c
sys/netinet/in_pcb.c
sys/netinet/ip_options.c
sys/netinet/ip_output.c
sys/netinet6/nd6.c
Fixup calls of modified functions.

share/man/man9/ifnet.9
Document changed API.

CR: https://reviews.freebsd.org/D458
MFC after: Never
Sponsored by: Spectra Logic

Garbage collect couple of unused fields from struct ifaddr:
- ifa_claim_addr() unused since removal of NetAtalk
- ifa_metric seems to be never utilized, always a copy of if_metric

mdoc: remove superfluous paragraph macros.

Axe IFF_SMART. Fortunately this layering violating flag was never used,
it was just declared.

Drop support for historic ioctls and also undefine them, so that code
that checks their presence via ifdef, won't use them.

Bump __FreeBSD_version as safety measure.

Document constantness of dst argument to if_output.

Submitted by: pluknet

Typo and mdoc(7) style fixes.

PR: 168117
Submitted by: Nobuyuki Koganemaru (kogane&jp!freebsd!org)
MFC after: 3 days

Expand contraction.

Spotted by: bjk

Update IFCAP_* macro descriptions.

Reviewed by: attilio (polling part, a previous version)
MFC after: 1 week

Clean up from the old kern.polling.

Reviewed by: attilio
MFC after: 1 week

Document IFT_USB referenced by IFF_CANTCONFIG since the previous change,
so that ifnet(9) is self contained.

MFC after: 1 week

Update IFF_* macro descriptions.

MFC after: 1 week

Update the list of struct ifnet fields.
- Document if_vnet, if_home_vnet, if_carp, if_vlantrunk, if_multiaddrs,
if_amcount, if_addr, if_llsoftc stub, if_broadcastaddr, if_bridge,
if_label, if_afdata, if_afdata_initialized, if_afdata_lock, if_linktask,
if_addr_mtx (now if_addr_lock), if_clones, if_groups, if_pf_kif, if_lagg,
if_alloctype
- G/c now defunct and/or commented out in the manual page if_ipending,
if_poll_slowq, if_done, if_poll_recv, if_poll_xmit, if_poll_slowinput,
if_poll_intren
- Update if_snd type changed with ALTQ integration.

MFC after: 1 week

Move struct if_data basic description to a more suitable place, and remove
a bit of .Bx 4.4 history.

MFC after: 1 week

Reflect that if_output changed to take a struct route as its fourth
argument (r191148).

MFC after: 1 week

Update ifa_rtrequest() description after post-4.4BSD change made in r85074.
3rd argument of ifa->ifa_rtrequest is now ``rt_addrinfo *'' instead of
``sockaddr *''. While here, un-document RTM_RESOLVE cmd argument for
ifa_rtrequest() that became a stub after separating L2 tables in r186119.

MFC after: 1 week

Remove if_watchdog remnants after if_timer/if_watchdog removal in r199975.
This part was missed in r199992.

MFC after: 1 week

Fix a typo: use lower case in "A Shorthand".

Noted by: maxim

Kill EoL whitespaces.

The missing part of r232588 that documents ifaddr_byindex() itself.

MFC after: 1 week

- ifnet_addrs has gone and replaced by ifaddr_byindex(), as per r83130
- access to the AF_LINK address through if_addrhead is deprecated (r128315)

MFC after: 1 week

Reflect the renaming of ifmaof_ifpforaddr() to if_findmulti() in r148652.

MFC after: 1 week

ifp->if_ioctl() has moved to u_long cmd in r36735.
Somehow that change had not reached here together with ifioctl().

MFC after: 1 week

Changes in ifaddr refcounting: ifa_refcnt IFAREF/IFAFREE macros
moved to ifa_ref()/ifa_free() refcounting functions.

MFC after: 1 week

Refine r232333 [1] and put note about ifnet refcount caller responsibility.

Spotted by: gavin [1]
MFC after: 1 week

Reflect that ifa_ifwithnet() gained ignore_ptp argument.

MFC after: 1 week

Document ifunit_ref function.

MFC after: 1 week

Document ifnet refcount.

MFC after: 1 week

List supported ioctl commands instead of old one.

Fix typo in OSIOCGIFADDR.

MFC after: 3 days

Add infrastructure to allow all frames/packets received on an interface
to be assigned to a non-default FIB instance.

You may need to recompile world or ports due to the change of struct ifnet.

Submitted by: cjsp
Submitted by: Alexander V. Chernikov (melifaro ipfw.ru)
(original versions)
Reviewed by: julian
Reviewed by: Alexander V. Chernikov (melifaro ipfw.ru)
MFC after: 2 weeks
X-MFC: use spare in struct ifnet

Missing IFCAP_* macro descriptions in ifnet(9).

PR: docs/148952
Submitted by: Lars Hartmann <lars@chaotika.org>
MFC after: 2 weeks

mdoc: order prologue macros consistently by Dd/Dt/Os

Although groff_mdoc(7) gives another impression, this is the ordering
most widely used and also required by mdocml/mandoc.

Reviewed by: ru
Approved by: philip, ed (mentors)

- Note that if_xname, if_dname, and if_dunit are usually initialized via
if_initname().
- Document if_drv_flags and replace references to IFF_(RUNNING|OACTIVE)
with references to IFF_DRV_(RUNNING|OACTIVE).
- Complete truncated sentence in the description of if_transmit by copying
from the description in if_qflush.
- Add missing line breaks for translators.

Reviewed by: brooks (1)
MFC after: 3 days

Unbreak user space after if_timer/if_watchdog removal in r199975.

Tested by: glebius

Add entry for if_transmit and if_qflush

Remove obsolete polling members from documentation for struct ifnet.

Submitted by: Aniruddha Bohra
MFC after: 5 days

Spelling fixes.

Fix all the spelling mistakes I could find in the man pages for words
that have at least 3 characters.

MFC after: 1 week
Thanks to: Music band ``Chingon''
for keeping me company while searching for these.

Assorted markup fixes and minor wordsmithing.

Approved by: re

Stop embedding struct ifnet at the top of driver softcs. Instead the
struct ifnet or the layer 2 common structure it was embedded in have
been replaced with a struct ifnet pointer to be filled by a call to the
new function, if_alloc(). The layer 2 common structure is also allocated
via if_alloc() based on the interface type. It is hung off the new
struct ifnet member, if_l2com.

This change removes the size of these structures from the kernel ABI and
will allow us to better manage them as interfaces come and go.

Other changes of note:
- Struct arpcom is no longer referenced in normal interface code.
Instead the Ethernet address is accessed via the IFP2ENADDR() macro.
To enforce this ac_enaddr has been renamed to _ac_enaddr.
- The second argument to ether_ifattach is now always the mac address
from driver private storage rather than sometimes being ac_enaddr.

Reviewed by: sobomax, sam

Add missing Va in ifi_epoch entry.

Change the definition of struct if_data's member ifi_epoch from wall
clock time to uptime because wall clock time may go backwards.

This is a change in the API which will impact SNMP agents who are using
ifi_epoch to set RFC2233's ifCounterDiscontinuityTime. None are know to
exist today. This will not impact applications that are using the
<index, epoch> tuple to verify interface uniqueness except that it
eliminates a race which could lead to a false assumption of uniqueness.

Because this is a behavior change, bump __FreeBSD_version.

Discussed with: re (jhb, scottl)
MFC after: 3 days
Pointed out by: pkh (way back at EuroBSDCon)
Pointy hat: brooks

Scheduled mdoc(7) sweep.

Remove trailing spaces.

Reviewed by: brueffer
MFC after: 3 days

Document the struct if_data members ifi_datalen, ifi_epoch, and
ifi_link_state.

Reminded by: ru

Markup fixes.

Touch .Dd (date) since new functionality has been documented.

Reminded by: ru

Make the legend to the table of interface flags compact
for the reader's convenience.

Suggested by: ru

Describe how polling(4) applies to network interfaces.

Reviewed by: ru

1. There are interface capabilities to be used by "lower" kernel
components as well, i.e., polling.

2. Stress that if_capenable should be modified only from within
the interface driver because it solely knows about how to control
the capabilities.

Add the kernel side of network interface renaming support.

The basic process is to send a routing socket announcement that the
interface has departed, change if_xname, update the sockaddr_dl
associated with the interface, and announce the arrival of the interface
on the routing socket.

As part of this change, ifunit() is greatly simplified by testing
if_xname directly. if_clone_destroy() now uses if_dname to look up the
cloner for the interface and if_dunit to identify the unit number.

Reviewed by: ru, sam (concept)
Vincent Jardin <vjardin AT free.fr>
Max Laier <max AT love2party.net>

Document the interface method if_input().

Clearly state that upon SIOCSIFFLAGS, ifp->if_flags is updated
at the common ifioctl() level.

Extend the description of SIOCSIFCAP.

Extend the description of the framework of interface capabilities.

Replace the if_name and if_unit members of struct ifnet with new members
if_xname, if_dname, and if_dunit. if_xname is the name of the interface
and if_dname/unit are the driver name and instance.

This change paves the way for interface renaming and enhanced pseudo
device creation and configuration symantics.

Approved By: re (in principle)
Reviewed By: njl, imp
Tested On: i386, amd64, sparc64
Obtained From: NetBSD (if_xname)

mdoc(7): Use the new feature of the .In macro.

Remove paragraph which describes how we might switch our packet queueing
discipline to Random Early Detection (RED) in the future. The same para
incorrectly spelt ``Random Early Detection'' as ``Random Early Drop''.

While I am there, nuke IF_ENQ_DROP from the list of functions. More
work will be done on this, since some of the functions like
if_enq_drop() and if_queue_drop() were replaced with one function
called if_handoff() that does the job of enqueing the packet and
updating interface statistics as necessary.

Reviewed by: wollman
Approved by: des (mentor)
MFC after: 1 day

fnet(9) claims that "those interfaces supporting reception of multicast
datagrams have a LIST of multicast group memberships...". On -CURRENT, that
LIST is actually a TAILQ. Note that -STABLE still uses a LIST

PR: 50426
Submitted by: Scott Mitchell <scott+freebsd@fishballoon.org>

Correct typo in function declaration (s/if_dont/if_done).

PR: docs/50136
Submitted by: Scott Mitchell <scott+freebsd@fishballoon.org>
MFC After: 4.8

mdoc(7) police: scheduled sweep.

Approved by: re

Last missed bit of user-setable promisc mode.

Pointy hat to: sobomax
MFC after: 1 day

Increase size of ifnet.if_flags from 16 bits (short) to 32 bits (int). To avoid
breaking application ABI use unused ifreq.ifru_flags[1] for upper 16 bits in
SIOCSIFFLAGS and SIOCGIFFLAGS ioctl's.

Reviewed by: -hackers, -net

mdoc(7) police: tidy up the markup, fix some minor bugs.

ispell sweep of share/man/man9/*.

Update function definitions and required include files to reflect
the current state of the system.

Approved by: alfred

mdoc(7) police: Use the new .In macro for #include statements.

mdoc(7) police: removed gratuitous .Pp calls.

Remove IFCAP_HWCSUM, it is merely a luxury #define, not a real flag.
Remove explicit mention of IP stack, since it might not be accurate for all
interfaces.
Change if_enable to if_capenable, as it is spelled.

Submitted by: jlemon

Commit descriptions for the interface capabilities support.

mdoc(7) police:

Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text.
Not only this slows down the mdoc(7) processing significantly, but it also
has an undesired (in this case) effect of disabling hyphenation within the
entire enclosed block.

Removed whitespace at end-of-line; no content changes. I simply did
cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//'

BTW, what editors are the culprits? I'm using vim and it shows
me whitespace at EOL in troff files with a thick blue block...

Reviewed by: Silence from cvs diff -b
MFC after: 7 days

mdoc(7) police: removed HISTORY info from the .Os call.

Fixed bitrot in synopsis. The Lite2 change from int to u_long for ioctl
command numbers had not reached here.

mdoc(7) police: split punctuation characters + misc fixes.

Prepare for mdoc(7)NG.

mdoc(7) police: removed history info from the .Os FreeBSD call.

Remove XXX: Describe if_init().

Reviewed by: asmodai

Supply only one author name per instance of %A, as per mdoc.samples(7).

PR: 18465
Submitted by: Kazu TAKAMUNE <takamune@avrl.mei.co.jp>

Adjust descriptions for if_up() and if_down().

Reviewed by: wollman

$Id$ -> $FreeBSD$

Fix some typos and do some minor mdoc cleanup.

.Sh AUTHOR -> .Sh AUTHORS according to mdoc specs.
Use .An/.Aq.

Document Monday's changes in the interface structure.

Make the long-awaited change from $Id$ to $FreeBSD$

This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.

Boy, I'm glad we're not using sup anymore. This update would have been
insane otherwise.

Sort cross references.

Typo police.

Create a new manual page describing how network interfaces and
addresses are glued together with the generic networking code.