| | 1 | .\" Copyright (c) 1994 SigmaSoft, Th. Lockert <tholo@sigmasoft.com> |
| | 2 | .\" All rights reserved. |
| | 3 | .\" |
| | 4 | .\" Redistribution and use in source and binary forms, with or without |
| | 5 | .\" modification, are permitted provided that the following conditions |
| | 6 | .\" are met: |
| | 7 | .\" 1. Redistributions of source code must retain the above copyright |
| | 8 | .\" notice, this list of conditions and the following disclaimer. |
| | 9 | .\" 2. Redistributions in binary form must reproduce the above copyright |
| | 10 | .\" notice, this list of conditions and the following disclaimer in the |
| | 11 | .\" documentation and/or other materials provided with the distribution. |
| | 12 | .\" 3. The name of the author may not be used to endorse or promote products |
| | 13 | .\" derived from this software without specific prior written permission. |
| | 14 | .\" |
| | 15 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| | 16 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| | 17 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| | 18 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| | 19 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| | 20 | .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; |
| | 21 | .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, |
| | 22 | .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR |
| | 23 | .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
| | 24 | .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| | 25 | .\" |
| | 26 | .\" $FreeBSD: src/lib/libc/gen/ftok.3,v 1.17 2009/07/13 12:53:43 trasz Exp $ |
| | 27 | .Dd July 9, 2009 |
| | 28 | .Os |
| | 29 | .Dt FTOK 3 |
| | 30 | .Sh NAME |
| | 31 | .Nm ftok |
| | 32 | .Nd create IPC identifier from path name |
| | 33 | .Sh LIBRARY |
| | 34 | .Lb libc |
| | 35 | .Sh SYNOPSIS |
| | 36 | .In sys/ipc.h |
| | 37 | .Ft key_t |
| | 38 | .Fn ftok "const char *path" "int id" |
| | 39 | .Sh DESCRIPTION |
| | 40 | The |
| | 41 | .Fn ftok |
| | 42 | function attempts to create a unique key suitable for use with the |
| | 43 | .Xr semget 2 , |
| | 44 | and |
| | 45 | .Xr shmget 2 |
| | 46 | functions, given the |
| | 47 | .Fa path |
| | 48 | of an existing file and a user-selectable |
| | 49 | .Fa id . |
| | 50 | .Pp |
| | 51 | The specified |
| | 52 | .Fa path |
| | 53 | must specify an existing file that is accessible to the calling process |
| | 54 | or the call will fail. |
| | 55 | Also, note that links to files will return the |
| | 56 | same key, given the same |
| | 57 | .Fa id . |
| | 58 | .Sh RETURN VALUES |
| | 59 | The |
| | 60 | .Fn ftok |
| | 61 | function will return -1 if |
| | 62 | .Fa path |
| | 63 | does not exist or if it cannot be accessed by the calling process. |
| | 64 | .Sh LEGACY SYNOPSIS |
| | 65 | .Fd #include <sys/types.h> |
| | 66 | .Fd #include <sys/ipc.h> |
| | 67 | .Pp |
| | 68 | The include file |
| | 69 | .In sys/types.h |
| | 70 | is necessary. |
| | 71 | .Sh SEE ALSO |
| | 72 | .Xr semget 2 , |
| | 73 | .Xr shmget 2 , |
| | 74 | .Xr compat 5 |
| | 75 | .Sh HISTORY |
| | 76 | The |
| | 77 | .Fn ftok |
| | 78 | function originates with System V and is typically used by programs |
| | 79 | that use the System V IPC routines. |
| | 80 | .Sh AUTHORS |
| | 81 | .An Thorsten Lockert Aq tholo@sigmasoft.com |
| | 82 | .Sh BUGS |
| | 83 | The returned key is computed based on the device minor number and inode |
| | 84 | of the specified |
| | 85 | .Fa path , |
| | 86 | in combination with the lower 8 bits of the given |
| | 87 | .Fa id . |
| | 88 | Thus, it is quite possible for the routine to return duplicate keys. |
projects / apple / libc.git / blame_incremental