1.\" $OpenBSD: dohooks.9,v 1.8 2015/12/12 11:26:32 mpi Exp $ 2.\" 3.\" Copyright (c) 2001 Niklas Hallqvist. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. The name of the author may not be used to endorse or promote products 15.\" derived from this software without specific prior written permission 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27.\" 28.Dd $Mdocdate: December 12 2015 $ 29.Dt DOHOOKS 9 30.Os 31.Sh NAME 32.Nm dohooks 33.Nd run all hooks in a list 34.Sh SYNOPSIS 35.In sys/types.h 36.In sys/systm.h 37.Ft void 38.Fn dohooks "struct hook_desc_head *head" "int flags" 39.Sh DESCRIPTION 40The 41.Fn dohooks 42function invokes all hooks established using the 43.Xr hook_establish 9 44function. 45Hooks are called in the order of the TAILQ that 46.Fa head 47points to, however 48.Xr hook_establish 9 49can put the hooks either at the head or the tail of that queue, 50making it possible to call the hooks either in the order of 51establishment, or its reverse. 52.Pp 53The flags can specify 54.Dv HOOK_REMOVE 55to remove already processed hooks from the hook list and 56.Dv HOOK_FREE 57to also free them. 58In most cases either no flags should be used or 59.Dv HOOK_REMOVE 60and 61.Dv HOOK_FREE 62at the same time, since just HOOK_REMOVE will drop the only reference to 63allocated memory and should only be used in situations where freeing 64memory would be illegal and unnecessary. 65.Pp 66This function is used to implement the 67.Xr dostartuphooks 9 68macro. 69.Sh SEE ALSO 70.Xr dostartuphooks 9 , 71.Xr hook_establish 9 72