1.\"	$NetBSD: dwarf_expr_into_block.3,v 1.2 2014/03/09 16:58:03 christos Exp $
2.\"
3.\" Copyright (c) 2011 Kai Wang
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.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Id: dwarf_expr_into_block.3 2073 2011-10-27 03:30:47Z jkoshy
28.\"
29.Dd September 13, 2011
30.Os
31.Dt DWARF_EXPR_INTO_BLOCK 3
32.Sh NAME
33.Nm dwarf_expr_into_block
34.Nd retrieve the byte stream for a location expression
35.Sh LIBRARY
36.Lb libdwarf
37.Sh SYNOPSIS
38.In libdwarf.h
39.Ft "Dwarf_Addr"
40.Fo dwarf_expr_into_block
41.Fa "Dwarf_P_Expr expr"
42.Fa "Dwarf_Unsigned *length"
43.Fa "Dwarf_Error *err"
44.Fc
45.Sh DESCRIPTION
46Function
47.Fn dwarf_expr_into_block
48retrieves the byte stream representation of a location expression.
49.Pp
50Argument
51.Ar expr
52should reference a location expression descriptor allocated using
53.Xr dwarf_new_expr 3 .
54.Pp
55Argument
56.Ar length
57should point to a location which will hold the size in bytes of
58the retrieved byte stream.
59.Pp
60If argument
61.Ar err
62is not NULL, it will be used to store error information in case
63of an error.
64.Sh RETURN VALUES
65On success, function
66.Fn dwarf_expr_into_block
67returns the address of the first byte of the generated byte stream.
68In case of an error, function
69.Fn dwarf_expr_into_block
70returns
71.Dv DW_DLV_BADADDR
72and sets the argument
73.Ar err .
74.Sh ERRORS
75Function
76.Fn dwarf_expr_into_block
77can fail with:
78.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
79.It Bq Er DW_DLE_ARGUMENT
80One of the arguments
81.Ar expr
82or
83.Ar length
84was NULL.
85.It Bq Er DW_DLE_MEMORY
86An out of memory condition was encountered during the execution of
87the function.
88.El
89.Sh SEE ALSO
90.Xr dwarf 3 ,
91.Xr dwarf_add_AT_location_expr 3 ,
92.Xr dwarf_add_expr_addr 3 ,
93.Xr dwarf_add_expr_addr_b 3 ,
94.Xr dwarf_add_expr_gen 3 ,
95.Xr dwarf_expr_current_offset 3 ,
96.Xr dwarf_new_expr 3
97