1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2003 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
* Copyright 2018 Joyent, Inc.
*/
#ifndef _CTF_HEADERS_H
#define _CTF_HEADERS_H
/*
* Because the ON tools are executed on the system where they are built,
* the tools need to include the headers installed on the build system,
* rather than those in the ON source tree. However, some of the headers
* required by the tools are part of the ON source tree, but not delivered
* as part of illumos. These include the following:
*
* $(SRC)/lib/libctf/common/libctf.h
* $(SRC)/lib/libctf/common/libctf_impl.h
* $(SRC)/uts/common/sys/ctf_api.h
* $(SRC)/uts/common/sys/ctf.h
*
* These headers get installed in the proto area in the build environment
* under $(ROOT)/usr/include and $(ROOT)/usr/include/sys. Though these
* headers are not part of the release, in releases including and prior to
* Solaris 9, they did get installed on the build system via bfu. Therefore,
* we can not simply force the order of inclusion with -I/usr/include first
* in Makefile.ctf because we might actually get downlevel versions of the
* ctf headers. Depending on the order of the -I includes, we can also have
* a problem with mismatched headers when building the ctf tools with some
* headers getting pulled in from /usr/include and others from
* $(SRC)/uts/common/sys.
*
* To address the problem, we have done two things:
* 1) Created this header with a specific order of inclusion for the
* ctf headers. Because the <libctf.h> header includes <sys/ctf_api.h>
* which in turn includes <sys/ctf.h> we need to include these in
* reverse order to guarantee that we get the correct versions of
* the headers.
* 2) In $(SRC)/tools/ctf/Makefile.ctf, we order the -I includes such
* that we first search the directories where the ctf headers
* live, followed by /usr/include, followed by $(SRC)/uts/common.
* This last -I include is needed in order to prevent a build failure
* when <sys/ctf_api.h> is included via a nested #include rather than
* an explicit path #include.
*
* We'll also include the local ccompile.h - older build systems often lack
* useful definitions like __unused. Finally, we'll also define ARRAY_SIZE:
* unfortunately, older systems sysmacros.h only have this defined for the
* kernel, and we can't easily pick it up otherwise.
*/
#include <uts/common/sys/ccompile.h>
#include <uts/common/sys/ctf.h>
#include <uts/common/sys/ctf_api.h>
#include <common/ctf/ctf_impl.h>
#include <lib/libctf/common/libctf.h>
#include <lib/libctf/common/libctf_impl.h>
#if !defined(ARRAY_SIZE)
#define ARRAY_SIZE(x) (sizeof (x) / sizeof (x[0]))
#endif
#endif /* _CTF_HEADERS_H */
|
