share/man/man9f/pollhead_clean.9f

   1 '\" te
   2 .\"  Copyright (c) 2015, Joyent, Inc. All Rights Reserved.
   3 .\"  This file and its contents are supplied under the terms of the
   4 .\"  Common Development and Distribution License ("CDDL"), version 1.0.
   5 .\"  You may only use this file in accordance with the terms of version
   6 .\"  1.0 of the CDDL.
   7 .\"
   8 .\"  A full copy of the text of the CDDL should have accompanied this
   9 .\"  source.  A copy of the CDDL is also available via the Internet at
  10 .\"  http://www.illumos.org/license/CDDL.
  11 .TH POLLHEAD_CLEAN 9F "Jun 12, 1998"
  12 .\"
  13 .\" A little inside joke with the above date: that's the date that the
  14 .\" devpoll work integrated (under bug 1265897).  The original work included
  15 .\" pollhead_clean() -- but didn't bother to document it!  With the date,
  16 .\" we are therefore giving this man page the date it should have had in an
  17 .\" attempt to right an historical wrong -- albeit nearly two decades after
  18 .\" the fact.
  19 .\"
  20 .SH NAME
  21 pollhead_clean \- inform the kernel that a pollhead is being deallocated
  22 .SH SYNOPSIS
  23 .LP
  24 .nf
  25 #include <sys/poll.h>
  26
  27
  28
  29 \fBvoid\fR \fBpollhead_clean\fR(\fBstruct pollhead *\fR\fIphp\fR);
  30 .fi
  31
  32 .SH INTERFACE LEVEL
  33 .LP
  34 Architecture independent level 1 (DDI/DKI).
  35 .SH PARAMETERS
  36 .ne 2
  37 .na
  38 \fB\fIphp\fR\fR
  39 .ad
  40 .RS 9n
  41 Pointer to a \fBpollhead\fR structure.
  42 .RE
  43
  44 .SH DESCRIPTION
  45 .LP
  46 The \fBpollhead_clean()\fR function informs the kernel that a driver's
  47 \fBpollhead\fR structure is about to be deallocated, usually as part of
  48 the driver's \fBclose\fR(9E) entry point before the software state that
  49 contains the \fBpollhead\fR is deallocated via \fBddi_soft_state_free\fR(9F).
  50 See \fBchpoll\fR(9E), \fBpollwakeup\fR(9F) and \fBpoll\fR(2) for more detail.
  51 .SH CONTEXT
  52 .LP
  53 The \fBpollhead_clean()\fR function is generally called from the context
  54 of a \fBclose\fR(9E) entry point, but may be called from user or kernel
  55 context.
  56 .SH SEE ALSO
  57 .LP
  58 \fBpoll\fR(2), \fBchpoll\fR(9E), \fBpollwakeup\fR(9F)
  59