1*0a6a1f1dSLionel Sambuc.\" $NetBSD: elf_rand.3,v 1.2 2014/03/09 16:58:04 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 4*0a6a1f1dSLionel Sambuc.\" 5*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 6*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 7*0a6a1f1dSLionel Sambuc.\" are met: 8*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 9*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 10*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 11*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 12*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 13*0a6a1f1dSLionel Sambuc.\" 14*0a6a1f1dSLionel Sambuc.\" This software is provided by Joseph Koshy ``as is'' and 15*0a6a1f1dSLionel Sambuc.\" any express or implied warranties, including, but not limited to, the 16*0a6a1f1dSLionel Sambuc.\" implied warranties of merchantability and fitness for a particular purpose 17*0a6a1f1dSLionel Sambuc.\" are disclaimed. in no event shall Joseph Koshy be liable 18*0a6a1f1dSLionel Sambuc.\" for any direct, indirect, incidental, special, exemplary, or consequential 19*0a6a1f1dSLionel Sambuc.\" damages (including, but not limited to, procurement of substitute goods 20*0a6a1f1dSLionel Sambuc.\" or services; loss of use, data, or profits; or business interruption) 21*0a6a1f1dSLionel Sambuc.\" however caused and on any theory of liability, whether in contract, strict 22*0a6a1f1dSLionel Sambuc.\" liability, or tort (including negligence or otherwise) arising in any way 23*0a6a1f1dSLionel Sambuc.\" out of the use of this software, even if advised of the possibility of 24*0a6a1f1dSLionel Sambuc.\" such damage. 25*0a6a1f1dSLionel Sambuc.\" 26*0a6a1f1dSLionel Sambuc.\" Id: elf_rand.3 189 2008-07-20 10:38:08Z jkoshy 27*0a6a1f1dSLionel Sambuc.\" 28*0a6a1f1dSLionel Sambuc.Dd June 17, 2006 29*0a6a1f1dSLionel Sambuc.Os 30*0a6a1f1dSLionel Sambuc.Dt ELF_RAND 3 31*0a6a1f1dSLionel Sambuc.Sh NAME 32*0a6a1f1dSLionel Sambuc.Nm elf_rand 33*0a6a1f1dSLionel Sambuc.Nd provide sequential access to the next archive member 34*0a6a1f1dSLionel Sambuc.Sh LIBRARY 35*0a6a1f1dSLionel Sambuc.Lb libelf 36*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 37*0a6a1f1dSLionel Sambuc.In libelf.h 38*0a6a1f1dSLionel Sambuc.Ft off_t 39*0a6a1f1dSLionel Sambuc.Fn elf_rand "Elf *archive" "off_t offset" 40*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 41*0a6a1f1dSLionel SambucThe 42*0a6a1f1dSLionel Sambuc.Fn elf_rand 43*0a6a1f1dSLionel Sambucfunction causes the ELF descriptor 44*0a6a1f1dSLionel Sambuc.Ar archive 45*0a6a1f1dSLionel Sambucto be adjusted so that the next call to 46*0a6a1f1dSLionel Sambuc.Xr elf_begin 3 47*0a6a1f1dSLionel Sambucwill provide access to the archive member at byte offset 48*0a6a1f1dSLionel Sambuc.Ar offset 49*0a6a1f1dSLionel Sambucin the archive. 50*0a6a1f1dSLionel SambucArgument 51*0a6a1f1dSLionel Sambuc.Ar offset 52*0a6a1f1dSLionel Sambucis the byte offset from the start of the archive to the beginning of 53*0a6a1f1dSLionel Sambucthe archive header for the desired member. 54*0a6a1f1dSLionel Sambuc.Pp 55*0a6a1f1dSLionel SambucArchive member offsets may be retrieved using the 56*0a6a1f1dSLionel Sambuc.Xr elf_getarsym 3 57*0a6a1f1dSLionel Sambucfunction. 58*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 59*0a6a1f1dSLionel SambucFunction 60*0a6a1f1dSLionel Sambuc.Fn elf_rand 61*0a6a1f1dSLionel Sambucreturns 62*0a6a1f1dSLionel Sambuc.Ar offset 63*0a6a1f1dSLionel Sambucif successful or zero in case of an error. 64*0a6a1f1dSLionel Sambuc.Sh EXAMPLES 65*0a6a1f1dSLionel SambucTo process all the members of an archive use: 66*0a6a1f1dSLionel Sambuc.Bd -literal -offset indent 67*0a6a1f1dSLionel Sambucoff_t off; 68*0a6a1f1dSLionel SambucElf *archive, *e; 69*0a6a1f1dSLionel Sambuc\&... 70*0a6a1f1dSLionel Sambuccmd = ELF_C_READ; 71*0a6a1f1dSLionel Sambucarchive = elf_begin(fd, cmd, NULL); 72*0a6a1f1dSLionel Sambucwhile ((e = elf_begin(fd, cmd, archive)) != (Elf *) 0) 73*0a6a1f1dSLionel Sambuc{ 74*0a6a1f1dSLionel Sambuc ... process `e' here ... 75*0a6a1f1dSLionel Sambuc elf_end(e); 76*0a6a1f1dSLionel Sambuc 77*0a6a1f1dSLionel Sambuc off = ...new value...; 78*0a6a1f1dSLionel Sambuc if (elf_rand(archive, off) != off) { 79*0a6a1f1dSLionel Sambuc ... process error ... 80*0a6a1f1dSLionel Sambuc } 81*0a6a1f1dSLionel Sambuc} 82*0a6a1f1dSLionel Sambucelf_end(archive); 83*0a6a1f1dSLionel Sambuc.Ed 84*0a6a1f1dSLionel Sambuc.Pp 85*0a6a1f1dSLionel SambucTo rewind an archive, use: 86*0a6a1f1dSLionel Sambuc.Bd -literal -offset indent 87*0a6a1f1dSLionel SambucElf *archive; 88*0a6a1f1dSLionel Sambuc\&... 89*0a6a1f1dSLionel Sambucif (elf_rand(archive, SARMAG) != SARMAG) { 90*0a6a1f1dSLionel Sambuc ... error ... 91*0a6a1f1dSLionel Sambuc} 92*0a6a1f1dSLionel Sambuc.Ed 93*0a6a1f1dSLionel Sambuc.Sh ERRORS 94*0a6a1f1dSLionel SambucFunction 95*0a6a1f1dSLionel Sambuc.Fn elf_rand 96*0a6a1f1dSLionel Sambucmay fail with the following errors: 97*0a6a1f1dSLionel Sambuc.Bl -tag -width "[ELF_E_RESOURCE]" 98*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARGUMENT 99*0a6a1f1dSLionel SambucArgument 100*0a6a1f1dSLionel Sambuc.Ar archive 101*0a6a1f1dSLionel Sambucwas null. 102*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARGUMENT 103*0a6a1f1dSLionel SambucArgument 104*0a6a1f1dSLionel Sambuc.Ar archive 105*0a6a1f1dSLionel Sambucwas not a descriptor for an 106*0a6a1f1dSLionel Sambuc.Xr ar 1 107*0a6a1f1dSLionel Sambucarchive. 108*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARCHIVE 109*0a6a1f1dSLionel SambucArgument 110*0a6a1f1dSLionel Sambuc.Ar offset 111*0a6a1f1dSLionel Sambucdid not correspond to the start of an archive member header. 112*0a6a1f1dSLionel Sambuc.El 113*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 114*0a6a1f1dSLionel Sambuc.Xr ar 1 , 115*0a6a1f1dSLionel Sambuc.Xr elf 3 , 116*0a6a1f1dSLionel Sambuc.Xr elf_begin 3 , 117*0a6a1f1dSLionel Sambuc.Xr elf_end 3 , 118*0a6a1f1dSLionel Sambuc.Xr elf_getarsym 3 , 119*0a6a1f1dSLionel Sambuc.Xr elf_next 3 , 120*0a6a1f1dSLionel Sambuc.Xr gelf 3 121