1    :  // Copyright 2015 Google Inc. All Rights Reserved.
   2    :  //
   3    :  // Licensed under the Apache License, Version 2.0 (the "License");
   4    :  // you may not use this file except in compliance with the License.
   5    :  // You may obtain a copy of the License at
   6    :  //
   7    :  //     http://www.apache.org/licenses/LICENSE-2.0
   8    :  //
   9    :  // Unless required by applicable law or agreed to in writing, software
  10    :  // distributed under the License is distributed on an "AS IS" BASIS,
  11    :  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    :  // See the License for the specific language governing permissions and
  13    :  // limitations under the License.
  14    :  //
  15    :  // This file contains helper functions for setting up and tearing down the
  16    :  // SyzyAsan runtime.
  17    :  
  18    :  #ifndef SYZYGY_AGENT_ASAN_RUNTIME_UTIL_H_
  19    :  #define SYZYGY_AGENT_ASAN_RUNTIME_UTIL_H_
  20    :  
  21    :  #include "syzygy/agent/asan/runtime.h"
  22    :  
  23  m :  namespace agent {
  24  m :  namespace asan {
  25    :  
  26    :  // Loads parameters from the module and the environment, then sets up the Asan
  27    :  // runtime library.
  28    :  // @param asan_runtime pointer that will receive the created Asan runtime
  29    :  //     object.
  30    :  // @pre |*asan_runtime| must be nullptr.
  31    :  // @returns true on success, false otherwise.
  32  m :  bool SetUpAsanRuntime(AsanRuntime** asan_runtime);
  33    :  
  34    :  // Calls the |TearDown| function of the runtime and deletes the runtime object.
  35    :  // @param asan_runtime pointer to the Asan runtime object to destruct. This
  36    :  //     pointer will be nullptr after the call.
  37  m :  void TearDownAsanRuntime(AsanRuntime** asan_runtime);
  38    :  
  39  m :  }  // namespace asan
  40  m :  }  // namespace agent
  41    :  
  42    :  #endif  // SYZYGY_AGENT_ASAN_RUNTIME_UTIL_H_