Commit Graph

71 Commits

Author SHA1 Message Date
gjb
cae1f5b994 Typo and mdoc(7) style fixes.
PR:		168117
Submitted by:	Nobuyuki Koganemaru (kogane&jp!freebsd!org)
MFC after:	3 days
2012-05-20 16:43:47 +00:00
glebius
5beb62e535 It is already seven years since mbuf allocator uses same
M_WAITOK/M_NOWAIT flags as malloc(9). Update manual page.

Submitted by:	Vadim Goncharov <vadimnuclight tpu.ru>
2011-04-18 15:30:25 +00:00
uqs
8ae3afcfad mdoc: drop redundant .Pp and .LP calls
They have no effect when coming in pairs, or before .Bl/.Bd
2010-10-08 12:40:16 +00:00
des
fba9d4fdfa Document the MEXTADD macro.
MFC after:	2 weeks
2010-08-07 13:26:08 +00:00
ru
3b1bf8c2e9 Replaced the misleading uses of a historical artefact M_TRYWAIT with M_WAIT.
Removed dead code that assumed that M_TRYWAIT can return NULL; it's not true
since the advent of MBUMA.

Reviewed by:	arch

There are ongoing disputes as to whether we want to switch to directly using
UMA flags M_WAITOK/M_NOWAIT for mbuf(9) allocation.
2008-03-25 09:39:02 +00:00
phk
df9c99b9c2 Give MEXTADD() another argument to make both void pointers to the
free function controlable, instead of passing the KVA of the buffer
storage as the first argument.

Fix all conventional users of the API to pass the KVA of the buffer
as the first argument, to make this a no-op commit.

Likely break the only non-convetional user of the API, after informing
the relevant committer.

Update the mbuf(9) manual page, which was already out of sync on
this point.

Bump __FreeBSD_version to 800016 as there is no way to tell how
many arguments a CPP macro needs any other way.

This paves the way for giving sendfile(9) a way to wait for the
passed storage to have been accessed before returning.

This does not affect the memory layout or size of mbufs.

Parental oversight by:	sam and rwatson.

No MFC is anticipated.
2008-02-01 19:36:27 +00:00
bms
b0363fd079 Document m_pulldown().
Obtained from:	MBUF issues in 4.4BSD IPv6/IPsec support (itojun)
2007-02-26 15:17:19 +00:00
rwatson
5b953c01a1 Expand history and authors section of mbuf.9 man page to discuss recent
transition to mbuma (FreeBSD 5.3) and the fact that mbufs are now limited
almost entirely to packet storage, with straight UMA zones being used for
most other network data types.
2007-02-15 14:44:46 +00:00
julian
2df82cb38b Explicitly emphasize a facet of m_pullup() that some people seem to
frequently forget. i.e. that you can not keep using pointers to
within the old chain.
2006-12-08 23:44:30 +00:00
maxim
06359e9e2a o GC MT_FTABLE removed in rev. 1.192 mbuf.h.
o Correct MT_HEADER define.
2006-07-24 07:32:23 +00:00
sam
bf44b23991 promote fast ipsec's m_clone routine for public use; it is renamed
m_unshare and the caller can now control how mbufs are allocated

Reviewed by:	andre, luigi, mlaier
MFC after:	1 week
2006-03-15 21:11:11 +00:00
andre
c43b76d70f Remove references to MEXT_ADD_REF, MEXT_REM_REF and MEXT_IS_REF
which were removed with rev. 1.179 of mbuf.h.

Sponsored by:	TCP/IP Optimization Fundraise 2005
2005-11-18 17:04:49 +00:00
sam
3060bdb672 describe m_align 2005-08-08 00:50:25 +00:00
hmp
6b954a1933 Use 'manual page' instead of 'man page' for consistency.
Approved by:	re (hrs)
2005-06-28 20:15:19 +00:00
ru
10fbbd3d56 Assorted markup fixes and minor wordsmithing.
Approved by:	re
2005-06-15 13:31:23 +00:00
jmg
19da85af4a add m_copyup function.. This can be used to help make our ip stack less
alignment restrictive, and help performance on some ethernet cards which
currently copy the entire packet a couple bytes to get the packet aligned
properly...

Wordsmithing by:	dwhite
Obtained from:	NetBSD (code only)
I'll clean it up later:	rwatson
2005-03-17 19:34:57 +00:00
ru
6b6b8c04f6 Expand contractions. 2005-02-13 23:45:54 +00:00
ru
1541af42f1 Expand *n't contractions. 2005-02-13 22:25:33 +00:00
sam
18e5f36d99 document m_append 2004-12-08 17:47:49 +00:00
jmg
3a05fa07b2 document that m_free returns m_next of the free'd mbuf 2004-08-28 03:46:18 +00:00
maxim
4463bbe1ce MT_TAG is dead. 2004-07-07 16:48:16 +00:00
ru
1cf1598667 Mechanically kill hard sentence breaks and double whitespaces. 2004-07-03 18:29:24 +00:00
ru
e2a0b37a4a Forgot to bump the document date, *blush*. 2004-05-20 09:52:48 +00:00
ru
0c1ed2c94f Document mbuf tags based on the OpenBSD manpage.
Submitted by:	Gleb Smirnoff
2004-05-20 09:34:19 +00:00
maxim
1502ecbc2e o Document m_getcl(9).
Submitted by:	Gleb Smirnoff
MFC after:	2 weeks
2004-05-04 14:53:34 +00:00
maxim
59b5c3d082 o Add a missed description for m_free(9).
Optained from:	NetBSD
MFC after:	1 week
2004-04-28 14:53:49 +00:00
ru
88ceef53a8 Assorted mdoc(7) fixes. 2004-04-01 07:54:27 +00:00
silby
0ccb317ee8 Fix last commit to conform to mdoc style.
Submitted by:	hmp
2004-04-01 07:36:56 +00:00
silby
5a95a9a0f2 Document the m_defrag function. (Mostly copied from the description
in uipc_mbuf.c)
2004-04-01 06:50:21 +00:00
ru
65491e7b35 mtod() returns pointer to the specified type, not necessarily "void *". 2004-02-27 17:14:00 +00:00
bms
e68c776541 Document the functions m_apply() and m_getptr().
Requested by: Maxim Konovalov
2004-02-11 02:39:24 +00:00
ale
11fbbb1d40 Fix MSIZE definition location.
PR:		docs/62129
Submitted by:	Lee Brotherston <lee@nerds.org.uk> (PR),
		Marc Silver <marcs@draenor.org> (patch)
Approved by:	blackend (mentor)
2004-02-01 22:33:59 +00:00
yar
7e2d68f5cb As I've been pointed out by Andrew Gallatin, there are some
network interface cards smart (or twisted?) enough to be able
to calculate a TCP/UDP checksum for a packet fragmented by the
host CPU.  Therefore the paragraph on the case has been revised.
2004-01-21 23:32:50 +00:00
yar
a260fb7b00 A couple of minor clarifications. 2004-01-21 13:17:24 +00:00
yar
c939cff388 Add a description for the hardware-assisted checksumming
facilities based on http://people.freebsd.org/~jlemon/csum.txt
and my own observations.
2004-01-21 12:45:37 +00:00
yar
12d55dd7ec Reformat the list of essential mbuf fields according
to the nice style used in ifnet(9).
This includes specifying field types, starting descriptions
with a capital letter, and ending them with a full stop.
Improve the language a bit, as well.
2004-01-18 23:42:28 +00:00
yar
967828a92a Update the list of mbuf types from <sys/mbuf.h>. 2004-01-18 21:29:46 +00:00
yar
1f04fb4a42 Update the list of possible mbuf flags from <sys/mbuf.h>. 2004-01-18 21:23:30 +00:00
trhodes
893ed3a244 Remove an extra 'for' in the HISTORY section. 2003-11-15 14:23:48 +00:00
ru
1edcd1b018 mdoc(7): Properly mark C headers. 2003-09-10 19:24:35 +00:00
yar
59a924bc28 Name a function argument "mbuf", not "buf", if it is
a pointer to struct mbuf for clarity and consistency.
2003-06-15 14:47:12 +00:00
yar
18c9b0b6c2 Add missing descriptions of macros M_ALIGN and MH_ALIGN.
Remove a reference to the defunct macro M_COPY_PKTHDR;
document the new functions m_dup_pkthdr() and m_move_pkthdr(),
and the macro variant of the latter, M_MOVE_PKTHDR().
2003-06-15 14:40:03 +00:00
yar
e159c6524a Add more markup to the mbuf(9) manpage. This includes:
- tagging plaintext "mbuf", "mbuf cluster", and "mbuf chain"
  with .Vt (variable type) since all of them are ways of managing
  data, i.e., they can be seen as data types;

- using .Vt/.Va instead of .Li (literal) where appropriate;

- tagging plaintext words that actually refer to function arguments
  with .Fa.

Suggested by:	ru
2003-06-15 14:14:11 +00:00
yar
771182b0e8 Use .Va, not .Fa, to refer to structure members.
mdoc(7) contains an ambiguous statement on the issue,
but our mdoc(7) police's opinion is solid.

Suggested by:	ru
2003-06-15 12:42:41 +00:00
ru
aaa0f05b80 Assorted mdoc(7), grammar, spelling, and punctuation fixes.
Approved by:	re (blanket)
2003-05-21 15:49:01 +00:00
hmp
7d7228c36b Remove an extraneous .El' that was reported by groff -z`.
Approved by: des (mentor), re (scottl)
2003-05-16 19:57:38 +00:00
silby
169aedfd7f Add a description of m_defragrandomfailures. 2003-04-15 02:26:13 +00:00
silby
41c5b55e03 Add info on how to use the MBUF_STRESS_TEST options. (Only 1 option
at present.)
2003-04-13 23:31:06 +00:00
trhodes
76ed67bf98 Return bits which were removed in revision 1.22.
Requested by:	imp
2003-02-24 05:59:12 +00:00
alfred
e2a653e1d2 Catch up to WAIT/NOWAIT cleanup. 2003-01-21 08:57:35 +00:00