threadinfo.hh revision 14018 
1/*
2 * Copyright (c) 2004 The Regents of The University of Michigan
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Ali Saidi
29 *          Nathan Binkert
30 *          Dam Sunwoo
31 */
32
33#ifndef __ARCH_GENERIC_LINUX_THREADINFO_HH__
34#define __ARCH_GENERIC_LINUX_THREADINFO_HH__
35
36#include "cpu/thread_context.hh"
37#include "sim/system.hh"
38#include "sim/vptr.hh"
39
40namespace Linux {
41
42class ThreadInfo
43{
44  private:
45    ThreadContext *tc;
46    System *sys;
47    Addr pcbb;
48
49    template <typename T>
50    bool
51    get_data(const char *symbol, T &data)
52    {
53        Addr addr = 0;
54        if (!sys->kernelSymtab->findAddress(symbol, addr)) {
55            warn_once("Unable to find kernel symbol %s\n", symbol);
56            warn_once("Kernel not compiled with task_struct info; can't get "
57                      "currently executing task/process/thread name/ids!\n");
58            return false;
59        }
60
61        data = tc->getVirtProxy().read<T>(addr, TheISA::GuestByteOrder);
62
63        return true;
64    }
65
66  public:
67    ThreadInfo(ThreadContext *_tc, Addr _pcbb = 0)
68        : tc(_tc), sys(tc->getSystemPtr()), pcbb(_pcbb)
69    {
70
71    }
72    ~ThreadInfo()
73    {}
74
75    inline Addr
76    curThreadInfo()
77    {
78        if (!TheISA::CurThreadInfoImplemented)
79            panic("curThreadInfo() not implemented for this ISA");
80
81        Addr addr = pcbb;
82        Addr sp;
83
84        if (!addr)
85            addr = tc->readMiscRegNoEffect(TheISA::CurThreadInfoReg);
86
87        PortProxy &p = tc->getPhysProxy();
88        p.readBlob(addr, &sp, sizeof(Addr));
89
90        return sp & ~ULL(0x3fff);
91    }
92
93    inline Addr
94    curTaskInfo(Addr thread_info = 0)
95    {
96        // Note that in Linux 4.10 the thread_info struct will no longer have a
97        // pointer to the task_struct for arm64. See:
98        // https://patchwork.kernel.org/patch/9333699/
99        int32_t offset = 0;
100        if (!get_data("thread_info_task", offset))
101            return 0;
102
103        if (!thread_info)
104            thread_info = curThreadInfo();
105
106        return tc->getVirtProxy().read<Addr>(thread_info + offset);
107    }
108
109    int32_t
110    curTaskPIDFromTaskStruct(Addr task_struct) {
111        int32_t offset = 0;
112        if (!get_data("task_struct_pid", offset))
113            return -1;
114
115        return tc->getVirtProxy().read<int32_t>(task_struct + offset);
116    }
117
118    int32_t
119    curTaskPID(Addr thread_info = 0)
120    {
121        return curTaskPIDFromTaskStruct(curTaskInfo(thread_info));
122    }
123
124    int32_t
125    curTaskTGIDFromTaskStruct(Addr task_struct)
126    {
127        int32_t offset = 0;
128        if (!get_data("task_struct_tgid", offset))
129            return -1;
130
131        return tc->getVirtProxy().read<int32_t>(task_struct + offset);
132    }
133
134    int32_t
135    curTaskTGID(Addr thread_info = 0)
136    {
137        return curTaskTGIDFromTaskStruct(curTaskInfo(thread_info));
138    }
139
140    int64_t
141    curTaskStartFromTaskStruct(Addr task_struct)
142    {
143        int32_t offset = 0;
144        if (!get_data("task_struct_start_time", offset))
145            return -1;
146
147        // start_time is actually of type timespec, but if we just
148        // grab the first long, we'll get the seconds out of it
149        return tc->getVirtProxy().read<int64_t>(task_struct + offset);
150    }
151
152    int64_t
153    curTaskStart(Addr thread_info = 0)
154    {
155        return curTaskStartFromTaskStruct(curTaskInfo(thread_info));
156    }
157
158    std::string
159    curTaskNameFromTaskStruct(Addr task_struct)
160    {
161        int32_t offset = 0;
162        int32_t size = 0;
163
164        if (!get_data("task_struct_comm", offset))
165            return "FailureIn_curTaskName";
166
167        if (!get_data("task_struct_comm_size", size))
168            return "FailureIn_curTaskName";
169
170        char buffer[size + 1];
171        tc->getVirtProxy().readString(buffer, task_struct + offset, size);
172
173        return buffer;
174    }
175
176    std::string
177    curTaskName(Addr thread_info = 0)
178    {
179        return curTaskNameFromTaskStruct(curTaskInfo(thread_info));
180    }
181
182    int32_t
183    curTaskMmFromTaskStruct(Addr task_struct)
184    {
185        int32_t offset;
186        if (!get_data("task_struct_mm", offset))
187            return -1;
188
189        return tc->getVirtProxy().read<int32_t>(task_struct + offset);
190    }
191
192    int32_t
193    curTaskMm(Addr thread_info = 0)
194    {
195        return curTaskMmFromTaskStruct(curTaskInfo(thread_info));
196    }
197};
198
199} // namespace Linux
200
201#endif // __ARCH_GENERIC_LINUX_THREADINFO_HH__
202