| Message ID | 80089f3783372c8fd7833f28ce774a171b2ef252.1609232919.git.baruch@tkos.co.il (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | e4da63cda51f17fa1e86a10e84d47d692932530d |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [v2,1/2] docs: networking: packet_mmap: fix formatting for C macros | expand |
| Context | Check | Description |
|---|---|---|
| netdev/cover_letter | success | Link |
| netdev/fixes_present | success | Link |
| netdev/patch_count | success | Link |
| netdev/tree_selection | success | Guessed tree name to be net-next |
| netdev/subject_prefix | warning | Target tree name not specified in the subject |
| netdev/cc_maintainers | success | CCed 5 of 5 maintainers |
| netdev/source_inline | success | Was 0 now: 0 |
| netdev/verify_signedoff | success | Link |
| netdev/module_param | success | Was 0 now: 0 |
| netdev/build_32bit | success | Errors and warnings before: 0 this patch: 0 |
| netdev/kdoc | success | Errors and warnings before: 0 this patch: 0 |
| netdev/verify_fixes | success | Link |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 31 lines checked |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 0 this patch: 0 |
| netdev/header_inline | success | Link |
| netdev/stable | success | Stable not CCed |
Hi Ulises, On Tue, Dec 29 2020, Ulises Alonso wrote: > Can you also replace the sentence > > "(like libpcap always does)." > > with > > "(which old libpcap versions used do)." Are you sure this change is correct? The text says: ... it requires two if you want to get packet's timestamp (like libpcap always does). I think libpcap still reads packets timestamps, though it most likely uses the newer interface for that. Maybe we should just drop the libpcap reference here? Thanks for reviewing the patch, baruch > On Tue, Dec 29, 2020 at 10:11 AM Baruch Siach <baruch@tkos.co.il> wrote: > >> Before commit 889b8f964f2f ("packet: Kill CONFIG_PACKET_MMAP.") there >> used to be a CONFIG_PACKET_MMAP config symbol that depended on >> CONFIG_PACKET. The text still implies that PACKET_MMAP can be disabled. >> Remove that from the text, as well as reference to old kernel versions. >> >> Also, drop reference to broken link to information for pre 2.6.5 >> kernels. >> >> Make a slight working improvement (s/In/On/) while at it. >> >> Signed-off-by: Baruch Siach <baruch@tkos.co.il> >> --- >> v2: Address comments from Jakub Kicinski and Willem de Bruijn >> >> * Don't change PACKET_MMAP >> >> * Remove mention of specific kernel versions >> >> * Don't reflow paragraphs >> >> * s/In/On/ >> --- >> Documentation/networking/packet_mmap.rst | 9 ++++----- >> 1 file changed, 4 insertions(+), 5 deletions(-) >> >> diff --git a/Documentation/networking/packet_mmap.rst >> b/Documentation/networking/packet_mmap.rst >> index f3646c80b019..500ef60b1b82 100644 >> --- a/Documentation/networking/packet_mmap.rst >> +++ b/Documentation/networking/packet_mmap.rst >> @@ -8,7 +8,7 @@ Abstract >> ======== >> >> This file documents the mmap() facility available with the PACKET >> -socket interface on 2.4/2.6/3.x kernels. This type of sockets is used for >> +socket interface. This type of sockets is used for >> >> i) capture network traffic with utilities like tcpdump, >> ii) transmit network traffic, or any other that needs raw >> @@ -25,12 +25,12 @@ Please send your comments to >> Why use PACKET_MMAP >> =================== >> >> -In Linux 2.4/2.6/3.x if PACKET_MMAP is not enabled, the capture process >> is very >> +Non PACKET_MMAP capture process (plain AF_PACKET) is very >> inefficient. It uses very limited buffers and requires one system call to >> capture each packet, it requires two if you want to get packet's timestamp >> (like libpcap always does). >> >> -In the other hand PACKET_MMAP is very efficient. PACKET_MMAP provides a >> size >> +On the other hand PACKET_MMAP is very efficient. PACKET_MMAP provides a >> size >> configurable circular buffer mapped in user space that can be used to >> either >> send or receive packets. This way reading packets just needs to wait for >> them, >> most of the time there is no need to issue a single system call. >> Concerning >> @@ -252,8 +252,7 @@ PACKET_MMAP setting constraints >> >> In kernel versions prior to 2.4.26 (for the 2.4 branch) and 2.6.5 (2.6 >> branch), >> the PACKET_MMAP buffer could hold only 32768 frames in a 32 bit >> architecture or >> -16384 in a 64 bit architecture. For information on these kernel versions >> -see >> http://pusa.uv.es/~ulisses/packet_mmap/packet_mmap.pre-2.4.26_2.6.5.txt >> +16384 in a 64 bit architecture. >> >> Block size limit >> ---------------- >> -- >> 2.29.2
diff --git a/Documentation/networking/packet_mmap.rst b/Documentation/networking/packet_mmap.rst index f3646c80b019..500ef60b1b82 100644 --- a/Documentation/networking/packet_mmap.rst +++ b/Documentation/networking/packet_mmap.rst @@ -8,7 +8,7 @@ Abstract ======== This file documents the mmap() facility available with the PACKET -socket interface on 2.4/2.6/3.x kernels. This type of sockets is used for +socket interface. This type of sockets is used for i) capture network traffic with utilities like tcpdump, ii) transmit network traffic, or any other that needs raw @@ -25,12 +25,12 @@ Please send your comments to Why use PACKET_MMAP =================== -In Linux 2.4/2.6/3.x if PACKET_MMAP is not enabled, the capture process is very +Non PACKET_MMAP capture process (plain AF_PACKET) is very inefficient. It uses very limited buffers and requires one system call to capture each packet, it requires two if you want to get packet's timestamp (like libpcap always does). -In the other hand PACKET_MMAP is very efficient. PACKET_MMAP provides a size +On the other hand PACKET_MMAP is very efficient. PACKET_MMAP provides a size configurable circular buffer mapped in user space that can be used to either send or receive packets. This way reading packets just needs to wait for them, most of the time there is no need to issue a single system call. Concerning @@ -252,8 +252,7 @@ PACKET_MMAP setting constraints In kernel versions prior to 2.4.26 (for the 2.4 branch) and 2.6.5 (2.6 branch), the PACKET_MMAP buffer could hold only 32768 frames in a 32 bit architecture or -16384 in a 64 bit architecture. For information on these kernel versions -see http://pusa.uv.es/~ulisses/packet_mmap/packet_mmap.pre-2.4.26_2.6.5.txt +16384 in a 64 bit architecture. Block size limit ----------------
Before commit 889b8f964f2f ("packet: Kill CONFIG_PACKET_MMAP.") there used to be a CONFIG_PACKET_MMAP config symbol that depended on CONFIG_PACKET. The text still implies that PACKET_MMAP can be disabled. Remove that from the text, as well as reference to old kernel versions. Also, drop reference to broken link to information for pre 2.6.5 kernels. Make a slight working improvement (s/In/On/) while at it. Signed-off-by: Baruch Siach <baruch@tkos.co.il> --- v2: Address comments from Jakub Kicinski and Willem de Bruijn * Don't change PACKET_MMAP * Remove mention of specific kernel versions * Don't reflow paragraphs * s/In/On/ --- Documentation/networking/packet_mmap.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-)