Home | History | Annotate | Download | only in linker
      1 /*
      2  * Copyright (C) 2016 The Android Open Source Project
      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
      7  * are met:
      8  *  * Redistributions of source code must retain the above copyright
      9  *    notice, this list of conditions and the following disclaimer.
     10  *  * Redistributions in binary form must reproduce the above copyright
     11  *    notice, this list of conditions and the following disclaimer in
     12  *    the documentation and/or other materials provided with the
     13  *    distribution.
     14  *
     15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
     18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
     20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
     21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
     22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
     23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
     25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     26  * SUCH DAMAGE.
     27  */
     28 
     29 #pragma once
     30 
     31 #include "linker.h"
     32 #include "linker_debug.h"
     33 
     34 #include <algorithm>
     35 
     36 #include "private/CFIShadow.h"
     37 
     38 // This class keeps the contents of CFI shadow up-to-date with the current set of loaded libraries.
     39 // See the comment in CFIShadow.h for more context.
     40 // See documentation in http://clang.llvm.org/docs/ControlFlowIntegrityDesign.html#shared-library-support.
     41 //
     42 // Shadow is mapped and initialized lazily as soon as the first CFI-enabled DSO is loaded.
     43 // It is updated after any library is loaded (but before any constructors are ran), and
     44 // before any library is unloaded.
     45 class CFIShadowWriter : private CFIShadow {
     46   // Returns pointer to the shadow element for an address.
     47   uint16_t* MemToShadow(uintptr_t x) {
     48     return reinterpret_cast<uint16_t*>(*shadow_start + MemToShadowOffset(x));
     49   }
     50 
     51   // Update shadow for the address range to the given constant value.
     52   void AddConstant(uintptr_t begin, uintptr_t end, uint16_t v);
     53 
     54   // Update shadow for the address range to kUncheckedShadow.
     55   void AddUnchecked(uintptr_t begin, uintptr_t end);
     56 
     57   // Update shadow for the address range to kInvalidShadow.
     58   void AddInvalid(uintptr_t begin, uintptr_t end);
     59 
     60   // Update shadow for the address range to the given __cfi_check value.
     61   void Add(uintptr_t begin, uintptr_t end, uintptr_t cfi_check);
     62 
     63   // Add a DSO to CFI shadow.
     64   bool AddLibrary(soinfo* si);
     65 
     66   // Map CFI shadow.
     67   uintptr_t MapShadow();
     68 
     69   // Initialize CFI shadow and update its contents for everything in solist if any loaded library is
     70   // CFI-enabled. If new_si != nullptr, do an incremental check by looking only at new_si; otherwise
     71   // look at the entire solist.
     72   bool MaybeInit(soinfo *new_si, soinfo *solist);
     73 
     74   // Set a human readable name for the entire shadow region.
     75   void FixupVmaName();
     76 
     77   // Pass the pointer to the mapped shadow region to libdl. Must only be called once.
     78   // Flips shadow_start to a non-nullptr value.
     79   bool NotifyLibDl(soinfo *solist, uintptr_t p);
     80 
     81   // Pointer to the shadow start address.
     82   uintptr_t *shadow_start;
     83 
     84   bool initial_link_done;
     85 
     86  public:
     87   // Update shadow after loading a DSO.
     88   // This function will initialize the shadow if it sees a CFI-enabled DSO for the first time.
     89   // In that case it will retroactively update shadow for all previously loaded DSOs. "solist" is a
     90   // pointer to the global list.
     91   // This function must be called before any user code has observed the newly loaded DSO.
     92   bool AfterLoad(soinfo* si, soinfo *solist);
     93 
     94   // Update shadow before unloading a DSO.
     95   void BeforeUnload(soinfo* si);
     96 
     97   // This is called as soon as the initial set of libraries is linked.
     98   bool InitialLinkDone(soinfo *solist);
     99 
    100   // Handle failure to locate __cfi_check for a target address.
    101   static void CfiFail(uint64_t CallSiteTypeId, void* Ptr, void* DiagData, void *caller_pc);
    102 };
    103 
    104 CFIShadowWriter* get_cfi_shadow();
    105