![[BACK]](/icons/back.gif){kind=icon}
Return to m_tag.9 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [cvs.NetBSD.org] / src / share / man / man9|
Return to m_tag.9 CVS log | Up to [cvs.NetBSD.org] / src / share / man / man9 |
| File: [cvs.NetBSD.org] / src / share / man / man9 / m_tag.9 (download)
Revision 1.5, Thu Dec 2 12:54:13 2010 UTC (13 years, 4 months ago) by wiz
Remove boilerplate in CODE REFERENCES on file paths. Describe in intro(9) how to read paths in the CODE REFERENCES section. |
.\" $NetBSD: m_tag.9,v 1.5 2010/12/02 12:54:13 wiz Exp $ .\" .\" Copyright (c)2004 YAMAMOTO Takashi, .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" ------------------------------------------------------------ .Dd September 7, 2004 .Dt M_TAG 9 .Os .Sh NAME .Nm m_tag , .Nm m_tag_get , .Nm m_tag_free , .Nm m_tag_prepend , .Nm m_tag_unlink , .Nm m_tag_delete , .Nm m_tag_delete_chain , .Nm m_tag_delete_nonpersistent , .Nm m_tag_find , .Nm m_tag_copy , .Nm m_tag_copy_chain , .Nm m_tag_init , .Nm m_tag_first , .Nm m_tag_next .Nd mbuf tagging interfaces .\" ------------------------------------------------------------ .Sh SYNOPSIS .In sys/mbuf.h .Ft struct m_tag * .Fn m_tag_get "int type" "int len" "int wait" .Ft void .Fn m_tag_free "struct m_tag *t" .Ft void .Fn m_tag_prepend "struct mbuf *m" "struct m_tag *t" .Ft void .Fn m_tag_unlink "struct mbuf *m" "struct m_tag *t" .Ft void .Fn m_tag_delete "struct mbuf *m" "struct m_tag *t" .Ft void .Fn m_tag_delete_chain "struct mbuf *m" "struct m_tag *t" .Ft void .Fn m_tag_delete_nonpersistent "struct mbuf *" .Ft struct m_tag * .Fn m_tag_find "struct mbuf *m" "int type" "struct m_tag *t" .Ft struct m_tag * .Fn m_tag_copy "struct m_tag *m" .Ft int .Fn m_tag_copy_chain "struct mbuf *to" "struct mbuf *from" .Ft void .Fn m_tag_init "struct mbuf *m" .Ft struct m_tag * .Fn m_tag_first "struct mbuf *m" .Ft struct m_tag * .Fn m_tag_next "struct mbuf *m" "struct m_tag *t" .\" ------------------------------------------------------------ .Sh DESCRIPTION The .Nm interface is used to .Dq tag mbufs. .\" XXX PACKET_TAG_* .\" ------------------------------------------------------------ .Sh FUNCTIONS .Bl -tag -width compact .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_get "type" "len" "wait" Allocate an mbuf tag. .Fa type is one of the .Dv PACKET_TAG_ macros. .Fa len is the size of the data associated with the tag, in bytes. .Fa wait is either .Dv M_WAITOK or .Dv M_NOWAIT . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_free "t" Free the mbuf tag .Fa t . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_prepend "m" "t" Prepend the mbuf tag .Fa t to the mbuf .Fa m . .Fa t will become the first tag of the mbuf .Fa m . When .Fa m is freed, .Fa t will also be freed. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_unlink "m" "t" Unlink the mbuf tag .Fa t from the mbuf .Fa m . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_delete "m" "t" The same as .Fn m_tag_unlink followed by .Fn m_tag_free . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_delete_chain "m" "t" Unlink and free mbuf tags beginning with the mbuf tag .Fa t from the mbuf .Fa m . If .Fa t is .Dv NULL , .Fn m_tag_delete_chain unlinks and frees all mbuf tags associated with the mbuf .Fa m . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_delete_nonpersistent "m" Unlink and free all non persistent tags associated with the mbuf .Fa m . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_find "m" "type" "t" Find an mbuf tag with type .Fa type after the mbuf tag .Fa t in the tag chain associated with the mbuf .Fa m . If .Fa t is .Dv NULL , search from the first mbuf tag. If an mbuf tag is found, return a pointer to it. Otherwise return .Dv NULL . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_copy "t" Copy an mbuf tag .Fa t . Return a new mbuf tag on success. Otherwise return .Dv NULL . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_copy_chain "to" "from" Copy all mbuf tags associated with the mbuf .Fa from to the mbuf .Fa to . If .Fa to already has any mbuf tags, they will be unlinked and freed beforehand. Return 1 on success. Otherwise return 0. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_init "m" Initialize mbuf tag chain of the mbuf .Fa m . .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_first "m" Return the first mbuf tag associated with the mbuf .Fa m . Return .Dv NULL if no mbuf tags are found. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .It Fn m_tag_next "m" "t" Return the next mbuf tag after .Fa t associated with the mbuf .Fa m . Return .Dv NULL if .Fa t is the last tag in the chain. .\" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .El .\" ------------------------------------------------------------ .Sh CODE REFERENCES The mbuf tagging interfaces are implemented within the file .Pa sys/kern/uipc_mbuf2.c . .Pp The .Dv PACKET_TAG_ macros are defined in the file .Pa sys/sys/mbuf.h . .Sh SEE ALSO .Xr intro 9 , .Xr malloc 9 , .Xr mbuf 9 .\" ------------------------------------------------------------ .Sh BUGS The semantics of the term "persistent tag" are vague.