15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2010 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met: 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions of source code must retain the above copyright 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer. 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions in binary form must reproduce the above 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution. 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission. 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Utility for using SideStep with unit tests. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CEEE_TESTING_SIDESTEP_AUTO_TESTING_HOOK_H_ 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CEEE_TESTING_SIDESTEP_AUTO_TESTING_HOOK_H_ 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h" 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "preamble_patcher.h" 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define SIDESTEP_CHK(x) CHECK(x) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define SIDESTEP_EXPECT_TRUE(x) SIDESTEP_CHK(x) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace sidestep { 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Same trick as common/scope_cleanup.h ScopeGuardImplBase 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AutoTestingHookBase { 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~AutoTestingHookBase() {} 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This is the typedef you normally use for the class, e.g. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// AutoTestingHook hook = MakeTestingHook(TargetFunc, HookTargetFunc); 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The 'hook' variable will then be destroyed when it goes out of scope. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// NOTE: You must not hold this type as a member of another class. Its 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// destructor will not get called. 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef const AutoTestingHookBase& AutoTestingHook; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This is the class you must use when holding a hook as a member of another 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// class, e.g. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// public: 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// AutoTestingHookHolder holder_; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// MyClass() : my_hook_holder(MakeTestingHookHolder(Target, Hook)) {} 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AutoTestingHookHolder { 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit AutoTestingHookHolder(AutoTestingHookBase* hook) : hook_(hook) {} 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~AutoTestingHookHolder() { delete hook_; } 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AutoTestingHookHolder() {} // disallow 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AutoTestingHookBase* hook_; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class helps patch a function, then unpatch it when the object exits 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// scope, and also maintains the pointer to the original function stub. 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// To enable use of the class without having to explicitly provide the 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// type of the function pointers (and instead only providing it 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// implicitly) we use the same trick as ScopeGuard (see 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// common/scope_cleanup.h) uses, so to create a hook you use the MakeHook 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// function rather than a constructor. 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// NOTE: This function is only safe for e.g. unit tests and _not_ for 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// production code. See PreamblePatcher class for details. 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template <typename T> 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AutoTestingHookImpl : public AutoTestingHookBase { 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static AutoTestingHookImpl<T> MakeTestingHook(T target_function, 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T replacement_function, 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool do_it) { 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return AutoTestingHookImpl<T>(target_function, replacement_function, do_it); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static AutoTestingHookImpl<T>* MakeTestingHookHolder(T target_function, 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T replacement_function, 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool do_it) { 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return new AutoTestingHookImpl<T>(target_function, 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) replacement_function, do_it); 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~AutoTestingHookImpl() { 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (did_it_) { 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SIDESTEP_CHK(SIDESTEP_SUCCESS == PreamblePatcher::Unpatch( 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (void*)target_function_, (void*)replacement_function_, 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) (void*)original_function_)); 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a pointer to the original function. To use this method you will 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // have to explicitly create an AutoTestingHookImpl of the specific 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // function pointer type (i.e. not use the AutoTestingHook typedef). 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T original_function() { 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return original_function_; 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AutoTestingHookImpl(T target_function, T replacement_function, bool do_it) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : target_function_(target_function), 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) original_function_(NULL), 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) replacement_function_(replacement_function), 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) did_it_(do_it) { 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (do_it) { 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) SIDESTEP_CHK(SIDESTEP_SUCCESS == PreamblePatcher::Patch(target_function, 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) replacement_function, 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) &original_function_)); 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T target_function_; // always valid 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T original_function_; // always valid 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T replacement_function_; // always valid 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool did_it_; // Remember if we did it or not... 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template <typename T> 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline AutoTestingHookImpl<T> MakeTestingHook(T target, 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) T replacement, 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool do_it) { 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return AutoTestingHookImpl<T>::MakeTestingHook(target, replacement, do_it); 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template <typename T> 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline AutoTestingHookImpl<T> MakeTestingHook(T target, T replacement) { 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return AutoTestingHookImpl<T>::MakeTestingHook(target, replacement, true); 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template <typename T> 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)inline AutoTestingHookImpl<T>* MakeTestingHookHolder(T target, T replacement) { 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return AutoTestingHookImpl<T>::MakeTestingHookHolder(target, replacement, 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) true); 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; // namespace sidestep 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CEEE_TESTING_SIDESTEP_AUTO_TESTING_HOOK_H_ 156