186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// Copyright (c) 2011, Google Inc. 286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// All rights reserved. 386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// 486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// Redistribution and use in source and binary forms, with or without 586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// modification, are permitted provided that the following conditions are 686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// met: 786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// 886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// * Redistributions of source code must retain the above copyright 986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// notice, this list of conditions and the following disclaimer. 1086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// * Redistributions in binary form must reproduce the above 1186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// copyright notice, this list of conditions and the following disclaimer 1286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// in the documentation and/or other materials provided with the 1386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// distribution. 1486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// * Neither the name of Google Inc. nor the names of its 1586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// contributors may be used to endorse or promote products derived from 1686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// this software without specific prior written permission. 1786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// 1886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 3086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// crash_generator.h: Define the google_breakpad::CrashGenerator class, 3186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// which is used to generate a crash (and a core dump file) for testing. 3286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 3386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org#ifndef COMMON_LINUX_TESTS_CRASH_GENERATOR_H_ 3486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org#define COMMON_LINUX_TESTS_CRASH_GENERATOR_H_ 3586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 3686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org#include <sys/resource.h> 3786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 3886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org#include <string> 3986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 4086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org#include "common/tests/auto_tempdir.h" 414e518a4357a2d1c379d4a91df6d4e153ee791101ivan.penkov@gmail.com#include "common/using_std_string.h" 4286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 4386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.orgnamespace google_breakpad { 4486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 4586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// A utility class for generating a crash (and a core dump file) for 4686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// testing. It creates a child process with the specified number of 4786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// threads, which is then termainated by the specified signal. A core 4886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// dump file is expected to be created upon the termination of the child 4986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// process, which can then be used for testing code that processes core 5086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org// dump files. 5186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.orgclass CrashGenerator { 5286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org public: 5386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org CrashGenerator(); 5486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 5586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org ~CrashGenerator(); 5686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 5786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Returns true if a core dump file named 'core' will be generated in 5886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // the current directory for a test that produces a crash by checking 5986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // if /proc/sys/kernel/core_pattern has the default value 'core'. 6086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org bool HasDefaultCorePattern() const; 6186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 6286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Returns the expected path of the core dump file. 634e518a4357a2d1c379d4a91df6d4e153ee791101ivan.penkov@gmail.com string GetCoreFilePath() const; 6486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 6513de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // Returns the directory of a copy of proc files of the child process. 664e518a4357a2d1c379d4a91df6d4e153ee791101ivan.penkov@gmail.com string GetDirectoryOfProcFilesCopy() const; 6713de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org 6886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Creates a crash (and a core dump file) by creating a child process with 6986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // |num_threads| threads, and the terminating the child process by sending 7086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // a signal with number |crash_signal| to the |crash_thread|-th thread. 7186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Returns true on success. 7286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org bool CreateChildCrash(unsigned num_threads, unsigned crash_thread, 734fa638a7ecb6ab042664300767614308dbc147bbbenchan@chromium.org int crash_signal, pid_t* child_pid); 7486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 7586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Returns the thread ID of the |index|-th thread in the child process. 7686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // This method does not validate |index|. 7786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org pid_t GetThreadId(unsigned index) const; 7886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 7986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org private: 8013de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // Copies the following proc files of the process with |pid| to the directory 8113de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // at |path|: auxv, cmdline, environ, maps, status 8213de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // The directory must have been created. Returns true on success. 8313de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org bool CopyProcFiles(pid_t pid, const char* path) const; 8413de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org 8513de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // Creates |num_threads| threads in the child process. 8613de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org void CreateThreadsInChildProcess(unsigned num_threads); 8713de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org 8813de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // Sets the maximum size of core dump file (both the soft and hard limit) 8913de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org // to |limit| bytes. Returns true on success. 9013de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org bool SetCoreFileSizeLimit(rlim_t limit) const; 9113de24a86ecf4d87d9c151e496282123c4654958benchan@chromium.org 9286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Creates a shared memory of |memory_size| bytes for communicating thread 9386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // IDs between the parent and child process. Returns true on success. 9486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org bool MapSharedMemory(size_t memory_size); 9586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 9686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Releases any shared memory created by MapSharedMemory(). Returns true on 9786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // success. 9886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org bool UnmapSharedMemory(); 9986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 10086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Returns the pointer to the thread ID of the |index|-th thread in the child 10186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // process. This method does not validate |index|. 10286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org pid_t* GetThreadIdPointer(unsigned index); 10386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 10486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Temporary directory in which a core file is generated. 10586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org AutoTempDir temp_dir_; 10686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 10786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Shared memory for communicating thread IDs between the parent and 10886cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // child process. 10986cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org void* shared_memory_; 11086cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 11186cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org // Number of bytes mapped for |shared_memory_|. 11286cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org size_t shared_memory_size_; 11386cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org}; 11486cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 11586cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org} // namespace google_breakpad 11686cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org 11786cbb1e5cc967853dfc2b10f8fc8da43fc734c77benchan@chromium.org#endif // COMMON_LINUX_TESTS_CRASH_GENERATOR_H_ 118