1*5ac3bc71Schristos.\" $NetBSD: dwarf_expr_into_block.3,v 1.6 2024/03/03 17:37:30 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2011 Kai Wang 49dd9d0cfSchristos.\" All rights reserved. 59dd9d0cfSchristos.\" 69dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without 79dd9d0cfSchristos.\" modification, are permitted provided that the following conditions 89dd9d0cfSchristos.\" are met: 99dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright 109dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer. 119dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright 129dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer in the 139dd9d0cfSchristos.\" documentation and/or other materials provided with the distribution. 149dd9d0cfSchristos.\" 159dd9d0cfSchristos.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 169dd9d0cfSchristos.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 179dd9d0cfSchristos.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 189dd9d0cfSchristos.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 199dd9d0cfSchristos.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 209dd9d0cfSchristos.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 219dd9d0cfSchristos.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 229dd9d0cfSchristos.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 239dd9d0cfSchristos.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 249dd9d0cfSchristos.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 259dd9d0cfSchristos.\" SUCH DAMAGE. 269dd9d0cfSchristos.\" 27cdbf1fe1Sjkoshy.\" Id: dwarf_expr_into_block.3 3962 2022-03-12 15:56:10Z jkoshy 289dd9d0cfSchristos.\" 299dd9d0cfSchristos.Dd September 13, 2011 309dd9d0cfSchristos.Dt DWARF_EXPR_INTO_BLOCK 3 31604b0842Sjkoshy.Os 329dd9d0cfSchristos.Sh NAME 339dd9d0cfSchristos.Nm dwarf_expr_into_block 349dd9d0cfSchristos.Nd retrieve the byte stream for a location expression 359dd9d0cfSchristos.Sh LIBRARY 369dd9d0cfSchristos.Lb libdwarf 379dd9d0cfSchristos.Sh SYNOPSIS 389dd9d0cfSchristos.In libdwarf.h 399dd9d0cfSchristos.Ft "Dwarf_Addr" 409dd9d0cfSchristos.Fo dwarf_expr_into_block 419dd9d0cfSchristos.Fa "Dwarf_P_Expr expr" 429dd9d0cfSchristos.Fa "Dwarf_Unsigned *length" 439dd9d0cfSchristos.Fa "Dwarf_Error *err" 449dd9d0cfSchristos.Fc 459dd9d0cfSchristos.Sh DESCRIPTION 469dd9d0cfSchristosFunction 479dd9d0cfSchristos.Fn dwarf_expr_into_block 489dd9d0cfSchristosretrieves the byte stream representation of a location expression. 499dd9d0cfSchristos.Pp 509dd9d0cfSchristosArgument 51cdbf1fe1Sjkoshy.Fa expr 529dd9d0cfSchristosshould reference a location expression descriptor allocated using 539dd9d0cfSchristos.Xr dwarf_new_expr 3 . 549dd9d0cfSchristos.Pp 559dd9d0cfSchristosArgument 56cdbf1fe1Sjkoshy.Fa length 579dd9d0cfSchristosshould point to a location which will hold the size in bytes of 589dd9d0cfSchristosthe retrieved byte stream. 599dd9d0cfSchristos.Pp 609dd9d0cfSchristosIf argument 61cdbf1fe1Sjkoshy.Fa err 62cdbf1fe1Sjkoshyis not 63cdbf1fe1Sjkoshy.Dv NULL , 64cdbf1fe1Sjkoshyit will be used to store error information in case of an error. 659dd9d0cfSchristos.Sh RETURN VALUES 669dd9d0cfSchristosOn success, function 679dd9d0cfSchristos.Fn dwarf_expr_into_block 689dd9d0cfSchristosreturns the address of the first byte of the generated byte stream. 699dd9d0cfSchristosIn case of an error, function 709dd9d0cfSchristos.Fn dwarf_expr_into_block 719dd9d0cfSchristosreturns 729dd9d0cfSchristos.Dv DW_DLV_BADADDR 739dd9d0cfSchristosand sets the argument 74cdbf1fe1Sjkoshy.Fa err . 759dd9d0cfSchristos.Sh ERRORS 769dd9d0cfSchristosFunction 779dd9d0cfSchristos.Fn dwarf_expr_into_block 789dd9d0cfSchristoscan fail with: 799dd9d0cfSchristos.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT" 809dd9d0cfSchristos.It Bq Er DW_DLE_ARGUMENT 819dd9d0cfSchristosOne of the arguments 82cdbf1fe1Sjkoshy.Fa expr 839dd9d0cfSchristosor 84cdbf1fe1Sjkoshy.Fa length 85cdbf1fe1Sjkoshywas 86cdbf1fe1Sjkoshy.Dv NULL . 879dd9d0cfSchristos.It Bq Er DW_DLE_MEMORY 889dd9d0cfSchristosAn out of memory condition was encountered during the execution of 899dd9d0cfSchristosthe function. 909dd9d0cfSchristos.El 919dd9d0cfSchristos.Sh SEE ALSO 929dd9d0cfSchristos.Xr dwarf 3 , 939dd9d0cfSchristos.Xr dwarf_add_AT_location_expr 3 , 949dd9d0cfSchristos.Xr dwarf_add_expr_addr 3 , 959dd9d0cfSchristos.Xr dwarf_add_expr_addr_b 3 , 969dd9d0cfSchristos.Xr dwarf_add_expr_gen 3 , 979dd9d0cfSchristos.Xr dwarf_expr_current_offset 3 , 989dd9d0cfSchristos.Xr dwarf_new_expr 3 99