aux_vector.hh revision 13028:9a09c342891e 
1/*
2 * Copyright (c) 2016 Advanced Micro Devices, Inc.
3 * All rights reserved.
4 *
5 * For use for simulation and test purposes only
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 *
17 * 3. Neither the name of the copyright holder nor the names of its
18 * contributors may be used to endorse or promote products derived from this
19 * software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
32 *
33 * Authors: Brandon Potter
34 */
35
36#ifndef __AUX_VECTOR_HH__
37#define __AUX_VECTOR_HH__
38
39template<class IntType>
40class AuxVector
41{
42  public:
43    AuxVector() = default;
44    AuxVector(IntType type, IntType val);
45
46    IntType const& getAuxType() const { return _auxType; }
47    IntType const& getAuxVal() const { return _auxVal; }
48    IntType const& getHostAuxType() const { return _auxHostType; }
49    IntType const& getHostAuxVal() const { return _auxHostVal; }
50
51    void setAuxType(IntType type);
52    void setAuxVal(IntType val);
53
54  private:
55    IntType _auxType = 0;
56    IntType _auxVal = 0;
57    IntType _auxHostType = 0;
58    IntType _auxHostVal = 0;
59};
60
61enum AuxiliaryVectorType {
62    M5_AT_NULL = 0,        // End of vector.
63    M5_AT_IGNORE = 1,      // Ignored.
64    M5_AT_EXECFD = 2,      // File descriptor of program if interpreter used.
65    M5_AT_PHDR = 3,        // Address of program header tables in memory.
66    M5_AT_PHENT = 4,       // Size in bytes of one program header entry.
67    M5_AT_PHNUM = 5,       // Number of entries in program header table.
68    M5_AT_PAGESZ = 6,      // System page size.
69    M5_AT_BASE = 7,        // Base address of interpreter program in memory.
70    M5_AT_FLAGS = 8,       // Unused.
71    M5_AT_ENTRY = 9,       // Entry point of program after interpreter setup.
72    M5_AT_NOTELF = 10,     // Non-zero if format is different than ELF.
73    M5_AT_UID = 11,        // Address of real user ID of thread.
74    M5_AT_EUID = 12,       // Address of effective user ID of thread.
75    M5_AT_GID = 13,        // Address of real group ID of thread.
76    M5_AT_EGID = 14,       // Address of effective group ID of thread.
77    M5_AT_PLATFORM = 15,   // Platform string for the architecture.
78    M5_AT_HWCAP = 16,      // Bits which describe the hardware capabilities.
79    M5_AT_CLKTCK = 17,     // Frequency at which times() syscall increments.
80    M5_AT_SECURE = 23,     // Whether to enable "secure mode" in executable.
81    M5_BASE_PLATFORM = 24, // Platform string (differs on PowerPC only).
82    M5_AT_RANDOM = 25,     // Pointer to 16 bytes of random data.
83    M5_AT_HWCAP2 = 26,     // Extension of AT_HWCAP.
84    M5_AT_EXECFN = 31,     // Filename of the program.
85    M5_AT_VECTOR_SIZE = 44
86};
87
88#endif // __AUX_VECTOR_HH__
89