1.\" $NetBSD: lfs_segwait.2,v 1.9 2017/05/14 12:30:37 wiz Exp $ 2.\" 3.\" Copyright (c) 2000 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Konrad Schroder. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd May 23, 2000 31.Dt LFS_SEGWAIT 2 32.Os 33.Sh NAME 34.Nm lfs_segwait 35.Nd wait until a segment is written 36.Sh LIBRARY 37.Lb libc 38.Sh SYNOPSIS 39.In sys/types.h 40.Ft int 41.Fn lfs_segwait "fsid_t *fsidp" "struct timeval *tv" 42.Sh DESCRIPTION 43.Fn lfs_segwait 44blocks until a new segment is acquired for writing by the file system 45specified by 46.Fa *fsidp 47or if 48.Fa *fsidp 49is \-1, until a segment is acquired for writing by any LFS file system. 50.Pp 51If 52.Fa timeout 53is non-zero, 54.Fn lfs_segwait 55will return after 56.Fa timeout 57milliseconds regardless of whether a new segment has been designated for 58writing or not. 59.Sh RETURN VALUES 60.Fn lfs_segwait 61returns 0 if a new segment was acquired; 1 if it timed out; or \-1 on error. 62.Sh ERRORS 63An error return from 64.Fn lfs_segwait 65indicates: 66.Bl -tag -width Er 67.It Bq Er EFAULT 68.Fa fsidp 69points outside the process's allocated address space. 70.It Bq Er EINTR 71A signal was delivered before the time limit expired and 72before a new segment was designated for writing. 73.It Bq Er EINVAL 74The specified time limit is negative. 75.El 76.Sh SEE ALSO 77.Xr lfs_bmapv 2 , 78.Xr lfs_markv 2 , 79.Xr lfs_segclean 2 , 80.Xr lfs_cleanerd 8 81.Sh HISTORY 82The 83.Fn lfs_segwait 84function call appeared in 85.Bx 4.4 . 86