src/arch/x86/process.cc

   1 /*
   2  * Copyright (c) 2003-2006 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: Gabe Black
  29  *          Ali Saidi
  30  */
  31
  32 /*
  33  * Copyright (c) 2007 The Hewlett-Packard Development Company
  34  * All rights reserved.
  35  *
  36  * Redistribution and use of this software in source and binary forms,
  37  * with or without modification, are permitted provided that the
  38  * following conditions are met:
  39  *
  40  * The software must be used only for Non-Commercial Use which means any
  41  * use which is NOT directed to receiving any direct monetary
  42  * compensation for, or commercial advantage from such use.  Illustrative
  43  * examples of non-commercial use are academic research, personal study,
  44  * teaching, education and corporate research & development.
  45  * Illustrative examples of commercial use are distributing products for
  46  * commercial advantage and providing services using the software for
  47  * commercial advantage.
  48  *
  49  * If you wish to use this software or functionality therein that may be
  50  * covered by patents for commercial use, please contact:
  51  *     Director of Intellectual Property Licensing
  52  *     Office of Strategy and Technology
  53  *     Hewlett-Packard Company
  54  *     1501 Page Mill Road
  55  *     Palo Alto, California  94304
  56  *
  57  * Redistributions of source code must retain the above copyright notice,
  58  * this list of conditions and the following disclaimer.  Redistributions
  59  * in binary form must reproduce the above copyright notice, this list of
  60  * conditions and the following disclaimer in the documentation and/or
  61  * other materials provided with the distribution.  Neither the name of
  62  * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
  63  * contributors may be used to endorse or promote products derived from
  64  * this software without specific prior written permission.  No right of
  65  * sublicense is granted herewith.  Derivatives of the software and
  66  * output created using the software may be prepared, but only for
  67  * Non-Commercial Uses.  Derivatives of the software may be shared with
  68  * others provided: (i) the others agree to abide by the list of
  69  * conditions herein which includes the Non-Commercial Use restrictions;
  70  * and (ii) such Derivatives of the software include the above copyright
  71  * notice to acknowledge the contribution from this software where
  72  * applicable, this list of conditions and the disclaimer below.
  73  *
  74  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  75  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  76  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  77  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  78  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  79  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  80  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  81  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  82  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  83  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  84  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  85  *
  86  * Authors: Gabe Black
  87  */
  88
  89 #include "arch/x86/isa_traits.hh"
  90 #include "arch/x86/process.hh"
  91 #include "arch/x86/segmentregs.hh"
  92 #include "arch/x86/types.hh"
  93 #include "base/loader/object_file.hh"
  94 #include "base/loader/elf_object.hh"
  95 #include "base/misc.hh"
  96 #include "base/trace.hh"
  97 #include "cpu/thread_context.hh"
  98 #include "mem/page_table.hh"
  99 #include "mem/translating_port.hh"
 100 #include "sim/process_impl.hh"
 101 #include "sim/system.hh"
 102
 103 using namespace std;
 104 using namespace X86ISA;
 105
 106 M5_64_auxv_t::M5_64_auxv_t(int64_t type, int64_t val)
 107 {
 108     a_type = X86ISA::htog(type);
 109     a_val = X86ISA::htog(val);
 110 }
 111
 112 X86LiveProcess::X86LiveProcess(LiveProcessParams * params,
 113         ObjectFile *objFile)
 114     : LiveProcess(params, objFile)
 115 {
 116     brk_point = objFile->dataBase() + objFile->dataSize() + objFile->bssSize();
 117     brk_point = roundUp(brk_point, VMPageSize);
 118
 119     // Set pointer for next thread stack.  Reserve 8M for main stack.
 120     next_thread_stack_base = stack_base - (8 * 1024 * 1024);
 121
 122     // Set up stack. On X86_64 Linux, stack goes from the top of memory
 123     // downward, less the hole for the kernel address space plus one page
 124     // for undertermined purposes.
 125     stack_base = (Addr)0x7FFFFFFFF000ULL;
 126
 127     // Set up region for mmaps. This was determined empirically and may not
 128     // always be correct.
 129     mmap_start = mmap_end = (Addr)0x2aaaaaaab000ULL;
 130 }
 131
 132 void X86LiveProcess::handleTrap(int trapNum, ThreadContext *tc)
 133 {
 134     switch(trapNum)
 135     {
 136       default:
 137         panic("Unimplemented trap to operating system: trap number %#x.\n", trapNum);
 138     }
 139 }
 140
 141 void
 142 X86LiveProcess::startup()
 143 {
 144     if (checkpointRestored)
 145         return;
 146
 147     argsInit(sizeof(IntReg), VMPageSize);
 148
 149     for (int i = 0; i < contextIds.size(); i++) {
 150         ThreadContext * tc = system->getThreadContext(contextIds[i]);
 151
 152         SegAttr dataAttr = 0;
 153         dataAttr.writable = 1;
 154         dataAttr.readable = 1;
 155         dataAttr.expandDown = 0;
 156         dataAttr.dpl = 3;
 157         dataAttr.defaultSize = 0;
 158         dataAttr.longMode = 1;
 159
 160         //Initialize the segment registers.
 161         for(int seg = 0; seg < NUM_SEGMENTREGS; seg++) {
 162             tc->setMiscRegNoEffect(MISCREG_SEG_BASE(seg), 0);
 163             tc->setMiscRegNoEffect(MISCREG_SEG_EFF_BASE(seg), 0);
 164             tc->setMiscRegNoEffect(MISCREG_SEG_ATTR(seg), dataAttr);
 165         }
 166
 167         SegAttr csAttr = 0;
 168         csAttr.writable = 0;
 169         csAttr.readable = 1;
 170         csAttr.expandDown = 0;
 171         csAttr.dpl = 3;
 172         csAttr.defaultSize = 0;
 173         csAttr.longMode = 1;
 174
 175         tc->setMiscRegNoEffect(MISCREG_CS_ATTR, csAttr);
 176
 177         //Set up the registers that describe the operating mode.
 178         CR0 cr0 = 0;
 179         cr0.pg = 1; // Turn on paging.
 180         cr0.cd = 0; // Don't disable caching.
 181         cr0.nw = 0; // This is bit is defined to be ignored.
 182         cr0.am = 0; // No alignment checking
 183         cr0.wp = 0; // Supervisor mode can write read only pages
 184         cr0.ne = 1;
 185         cr0.et = 1; // This should always be 1
 186         cr0.ts = 0; // We don't do task switching, so causing fp exceptions
 187                     // would be pointless.
 188         cr0.em = 0; // Allow x87 instructions to execute natively.
 189         cr0.mp = 1; // This doesn't really matter, but the manual suggests
 190                     // setting it to one.
 191         cr0.pe = 1; // We're definitely in protected mode.
 192         tc->setMiscReg(MISCREG_CR0, cr0);
 193
 194         Efer efer = 0;
 195         efer.sce = 1; // Enable system call extensions.
 196         efer.lme = 1; // Enable long mode.
 197         efer.lma = 1; // Activate long mode.
 198         efer.nxe = 1; // Enable nx support.
 199         efer.svme = 0; // Disable svm support for now. It isn't implemented.
 200         efer.ffxsr = 1; // Turn on fast fxsave and fxrstor.
 201         tc->setMiscReg(MISCREG_EFER, efer);
 202     }
 203 }
 204
 205 void
 206 X86LiveProcess::argsInit(int intSize, int pageSize)
 207 {
 208     typedef M5_64_auxv_t auxv_t;
 209     Process::startup();
 210
 211     string filename;
 212     if(argv.size() < 1)
 213         filename = "";
 214     else
 215         filename = argv[0];
 216
 217     //We want 16 byte alignment
 218     uint64_t align = 16;
 219
 220     // load object file into target memory
 221     objFile->loadSections(initVirtMem);
 222
 223     enum X86CpuFeature {
 224         X86_OnboardFPU = 1 << 0,
 225         X86_VirtualModeExtensions = 1 << 1,
 226         X86_DebuggingExtensions = 1 << 2,
 227         X86_PageSizeExtensions = 1 << 3,
 228
 229         X86_TimeStampCounter = 1 << 4,
 230         X86_ModelSpecificRegisters = 1 << 5,
 231         X86_PhysicalAddressExtensions = 1 << 6,
 232         X86_MachineCheckExtensions = 1 << 7,
 233
 234         X86_CMPXCHG8Instruction = 1 << 8,
 235         X86_OnboardAPIC = 1 << 9,
 236         X86_SYSENTER_SYSEXIT = 1 << 11,
 237
 238         X86_MemoryTypeRangeRegisters = 1 << 12,
 239         X86_PageGlobalEnable = 1 << 13,
 240         X86_MachineCheckArchitecture = 1 << 14,
 241         X86_CMOVInstruction = 1 << 15,
 242
 243         X86_PageAttributeTable = 1 << 16,
 244         X86_36BitPSEs = 1 << 17,
 245         X86_ProcessorSerialNumber = 1 << 18,
 246         X86_CLFLUSHInstruction = 1 << 19,
 247
 248         X86_DebugTraceStore = 1 << 21,
 249         X86_ACPIViaMSR = 1 << 22,
 250         X86_MultimediaExtensions = 1 << 23,
 251
 252         X86_FXSAVE_FXRSTOR = 1 << 24,
 253         X86_StreamingSIMDExtensions = 1 << 25,
 254         X86_StreamingSIMDExtensions2 = 1 << 26,
 255         X86_CPUSelfSnoop = 1 << 27,
 256
 257         X86_HyperThreading = 1 << 28,
 258         X86_AutomaticClockControl = 1 << 29,
 259         X86_IA64Processor = 1 << 30
 260     };
 261
 262     //Setup the auxilliary vectors. These will already have endian conversion.
 263     //Auxilliary vectors are loaded only for elf formatted executables.
 264     ElfObject * elfObject = dynamic_cast<ElfObject *>(objFile);
 265     if(elfObject)
 266     {
 267         uint64_t features =
 268             X86_OnboardFPU |
 269             X86_VirtualModeExtensions |
 270             X86_DebuggingExtensions |
 271             X86_PageSizeExtensions |
 272             X86_TimeStampCounter |
 273             X86_ModelSpecificRegisters |
 274             X86_PhysicalAddressExtensions |
 275             X86_MachineCheckExtensions |
 276             X86_CMPXCHG8Instruction |
 277             X86_OnboardAPIC |
 278             X86_SYSENTER_SYSEXIT |
 279             X86_MemoryTypeRangeRegisters |
 280             X86_PageGlobalEnable |
 281             X86_MachineCheckArchitecture |
 282             X86_CMOVInstruction |
 283             X86_PageAttributeTable |
 284             X86_36BitPSEs |
 285 //            X86_ProcessorSerialNumber |
 286             X86_CLFLUSHInstruction |
 287 //            X86_DebugTraceStore |
 288 //            X86_ACPIViaMSR |
 289             X86_MultimediaExtensions |
 290             X86_FXSAVE_FXRSTOR |
 291             X86_StreamingSIMDExtensions |
 292             X86_StreamingSIMDExtensions2 |
 293 //            X86_CPUSelfSnoop |
 294 //            X86_HyperThreading |
 295 //            X86_AutomaticClockControl |
 296 //            X86_IA64Processor |
 297             0;
 298
 299         //Bits which describe the system hardware capabilities
 300         //XXX Figure out what these should be
 301         auxv.push_back(auxv_t(M5_AT_HWCAP, features));
 302         //The system page size
 303         auxv.push_back(auxv_t(M5_AT_PAGESZ, X86ISA::VMPageSize));
 304         //Frequency at which times() increments
 305         auxv.push_back(auxv_t(M5_AT_CLKTCK, 100));
 306         // For statically linked executables, this is the virtual address of the
 307         // program header tables if they appear in the executable image
 308         auxv.push_back(auxv_t(M5_AT_PHDR, elfObject->programHeaderTable()));
 309         // This is the size of a program header entry from the elf file.
 310         auxv.push_back(auxv_t(M5_AT_PHENT, elfObject->programHeaderSize()));
 311         // This is the number of program headers from the original elf file.
 312         auxv.push_back(auxv_t(M5_AT_PHNUM, elfObject->programHeaderCount()));
 313         //Defined to be 100 in the kernel source.
 314         //This is the address of the elf "interpreter", It should be set
 315         //to 0 for regular executables. It should be something else
 316         //(not sure what) for dynamic libraries.
 317         auxv.push_back(auxv_t(M5_AT_BASE, 0));
 318
 319         //XXX Figure out what this should be.
 320         auxv.push_back(auxv_t(M5_AT_FLAGS, 0));
 321         //The entry point to the program
 322         auxv.push_back(auxv_t(M5_AT_ENTRY, objFile->entryPoint()));
 323         //Different user and group IDs
 324         auxv.push_back(auxv_t(M5_AT_UID, uid()));
 325         auxv.push_back(auxv_t(M5_AT_EUID, euid()));
 326         auxv.push_back(auxv_t(M5_AT_GID, gid()));
 327         auxv.push_back(auxv_t(M5_AT_EGID, egid()));
 328         //Whether to enable "secure mode" in the executable
 329         auxv.push_back(auxv_t(M5_AT_SECURE, 0));
 330         //The string "x86_64" with unknown meaning
 331         auxv.push_back(auxv_t(M5_AT_PLATFORM, 0));
 332     }
 333
 334     //Figure out how big the initial stack needs to be
 335
 336     // A sentry NULL void pointer at the top of the stack.
 337     int sentry_size = intSize;
 338
 339     //This is the name of the file which is present on the initial stack
 340     //It's purpose is to let the user space linker examine the original file.
 341     int file_name_size = filename.size() + 1;
 342
 343     string platform = "x86_64";
 344     int aux_data_size = platform.size() + 1;
 345
 346     int env_data_size = 0;
 347     for (int i = 0; i < envp.size(); ++i) {
 348         env_data_size += envp[i].size() + 1;
 349     }
 350     int arg_data_size = 0;
 351     for (int i = 0; i < argv.size(); ++i) {
 352         arg_data_size += argv[i].size() + 1;
 353     }
 354
 355     //The info_block needs to be padded so it's size is a multiple of the
 356     //alignment mask. Also, it appears that there needs to be at least some
 357     //padding, so if the size is already a multiple, we need to increase it
 358     //anyway.
 359     int base_info_block_size =
 360         sentry_size + file_name_size + env_data_size + arg_data_size;
 361
 362     int info_block_size = roundUp(base_info_block_size, align);
 363
 364     int info_block_padding = info_block_size - base_info_block_size;
 365
 366     //Each auxilliary vector is two 8 byte words
 367     int aux_array_size = intSize * 2 * (auxv.size() + 1);
 368
 369     int envp_array_size = intSize * (envp.size() + 1);
 370     int argv_array_size = intSize * (argv.size() + 1);
 371
 372     int argc_size = intSize;
 373
 374     //Figure out the size of the contents of the actual initial frame
 375     int frame_size =
 376         aux_array_size +
 377         envp_array_size +
 378         argv_array_size +
 379         argc_size;
 380
 381     //There needs to be padding after the auxiliary vector data so that the
 382     //very bottom of the stack is aligned properly.
 383     int partial_size = frame_size + aux_data_size;
 384     int aligned_partial_size = roundUp(partial_size, align);
 385     int aux_padding = aligned_partial_size - partial_size;
 386
 387     int space_needed =
 388         info_block_size +
 389         aux_data_size +
 390         aux_padding +
 391         frame_size;
 392
 393     stack_min = stack_base - space_needed;
 394     stack_min = roundDown(stack_min, align);
 395     stack_size = stack_base - stack_min;
 396
 397     // map memory
 398     pTable->allocate(roundDown(stack_min, pageSize),
 399                      roundUp(stack_size, pageSize));
 400
 401     // map out initial stack contents
 402     Addr sentry_base = stack_base - sentry_size;
 403     Addr file_name_base = sentry_base - file_name_size;
 404     Addr env_data_base = file_name_base - env_data_size;
 405     Addr arg_data_base = env_data_base - arg_data_size;
 406     Addr aux_data_base = arg_data_base - info_block_padding - aux_data_size;
 407     Addr auxv_array_base = aux_data_base - aux_array_size - aux_padding;
 408     Addr envp_array_base = auxv_array_base - envp_array_size;
 409     Addr argv_array_base = envp_array_base - argv_array_size;
 410     Addr argc_base = argv_array_base - argc_size;
 411
 412     DPRINTF(X86, "The addresses of items on the initial stack:\n");
 413     DPRINTF(X86, "0x%x - file name\n", file_name_base);
 414     DPRINTF(X86, "0x%x - env data\n", env_data_base);
 415     DPRINTF(X86, "0x%x - arg data\n", arg_data_base);
 416     DPRINTF(X86, "0x%x - aux data\n", aux_data_base);
 417     DPRINTF(X86, "0x%x - auxv array\n", auxv_array_base);
 418     DPRINTF(X86, "0x%x - envp array\n", envp_array_base);
 419     DPRINTF(X86, "0x%x - argv array\n", argv_array_base);
 420     DPRINTF(X86, "0x%x - argc \n", argc_base);
 421     DPRINTF(X86, "0x%x - stack min\n", stack_min);
 422
 423     // write contents to stack
 424
 425     // figure out argc
 426     uint64_t argc = argv.size();
 427     uint64_t guestArgc = X86ISA::htog(argc);
 428
 429     //Write out the sentry void *
 430     uint64_t sentry_NULL = 0;
 431     initVirtMem->writeBlob(sentry_base,
 432             (uint8_t*)&sentry_NULL, sentry_size);
 433
 434     //Write the file name
 435     initVirtMem->writeString(file_name_base, filename.c_str());
 436
 437     //Fix up the aux vector which points to the "platform" string
 438     assert(auxv[auxv.size() - 1].a_type = M5_AT_PLATFORM);
 439     auxv[auxv.size() - 1].a_val = aux_data_base;
 440
 441     //Copy the aux stuff
 442     for(int x = 0; x < auxv.size(); x++)
 443     {
 444         initVirtMem->writeBlob(auxv_array_base + x * 2 * intSize,
 445                 (uint8_t*)&(auxv[x].a_type), intSize);
 446         initVirtMem->writeBlob(auxv_array_base + (x * 2 + 1) * intSize,
 447                 (uint8_t*)&(auxv[x].a_val), intSize);
 448     }
 449     //Write out the terminating zeroed auxilliary vector
 450     const uint64_t zero = 0;
 451     initVirtMem->writeBlob(auxv_array_base + 2 * intSize * auxv.size(),
 452             (uint8_t*)&zero, 2 * intSize);
 453
 454     initVirtMem->writeString(aux_data_base, platform.c_str());
 455
 456     copyStringArray(envp, envp_array_base, env_data_base, initVirtMem);
 457     copyStringArray(argv, argv_array_base, arg_data_base, initVirtMem);
 458
 459     initVirtMem->writeBlob(argc_base, (uint8_t*)&guestArgc, intSize);
 460
 461     ThreadContext *tc = system->getThreadContext(contextIds[0]);
 462     //Set the stack pointer register
 463     tc->setIntReg(StackPointerReg, stack_min);
 464
 465     Addr prog_entry = objFile->entryPoint();
 466     // There doesn't need to be any segment base added in since we're dealing
 467     // with the flat segmentation model.
 468     tc->setPC(prog_entry);
 469     tc->setNextPC(prog_entry + sizeof(MachInst));
 470
 471     //Align the "stack_min" to a page boundary.
 472     stack_min = roundDown(stack_min, pageSize);
 473
 474 //    num_processes++;
 475 }