dynamic_annotations.c

/* Copyright (c) 2008-2009, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ---
 * Author: Kostya Serebryany
 */

#ifdef_MSC_VER
# include<windows.h>
#endif

#ifdef__cplusplus
# error "This file should be built as pure C to avoid name mangling"
#endif

#include<stdlib.h>
#include<string.h>

#include"dynamic_annotations.h"

/* Each function is empty and called (via a macro) only in debug mode.
 The arguments are captured by dynamic tools at runtime. */

#ifDYNAMIC_ANNOTATIONS_ENABLED==1

voidAnnotateRWLockCreate(constchar*file, intline,
constvolatilevoid*lock){}
voidAnnotateRWLockDestroy(constchar*file, intline,
constvolatilevoid*lock){}
voidAnnotateRWLockAcquired(constchar*file, intline,
constvolatilevoid*lock, longis_w){}
voidAnnotateRWLockReleased(constchar*file, intline,
constvolatilevoid*lock, longis_w){}
voidAnnotateBarrierInit(constchar*file, intline,
constvolatilevoid*barrier, longcount,
longreinitialization_allowed) {}
voidAnnotateBarrierWaitBefore(constchar*file, intline,
constvolatilevoid*barrier) {}
voidAnnotateBarrierWaitAfter(constchar*file, intline,
constvolatilevoid*barrier) {}
voidAnnotateBarrierDestroy(constchar*file, intline,
constvolatilevoid*barrier) {}

voidAnnotateCondVarWait(constchar*file, intline,
constvolatilevoid*cv,
constvolatilevoid*lock){}
voidAnnotateCondVarSignal(constchar*file, intline,
constvolatilevoid*cv){}
voidAnnotateCondVarSignalAll(constchar*file, intline,
constvolatilevoid*cv){}
voidAnnotatePublishMemoryRange(constchar*file, intline,
constvolatilevoid*address,
longsize){}
voidAnnotateUnpublishMemoryRange(constchar*file, intline,
constvolatilevoid*address,
longsize){}
voidAnnotatePCQCreate(constchar*file, intline,
constvolatilevoid*pcq){}
voidAnnotatePCQDestroy(constchar*file, intline,
constvolatilevoid*pcq){}
voidAnnotatePCQPut(constchar*file, intline,
constvolatilevoid*pcq){}
voidAnnotatePCQGet(constchar*file, intline,
constvolatilevoid*pcq){}
voidAnnotateNewMemory(constchar*file, intline,
constvolatilevoid*mem,
longsize){}
voidAnnotateExpectRace(constchar*file, intline,
constvolatilevoid*mem,
constchar*description){}
voidAnnotateBenignRace(constchar*file, intline,
constvolatilevoid*mem,
constchar*description){}
voidAnnotateBenignRaceSized(constchar*file, intline,
constvolatilevoid*mem,
longsize,
constchar*description) {}
voidAnnotateMutexIsUsedAsCondVar(constchar*file, intline,
constvolatilevoid*mu){}
voidAnnotateTraceMemory(constchar*file, intline,
constvolatilevoid*arg){}
voidAnnotateThreadName(constchar*file, intline,
constchar*name){}
voidAnnotateIgnoreReadsBegin(constchar*file, intline){}
voidAnnotateIgnoreReadsEnd(constchar*file, intline){}
voidAnnotateIgnoreWritesBegin(constchar*file, intline){}
voidAnnotateIgnoreWritesEnd(constchar*file, intline){}
voidAnnotateIgnoreSyncBegin(constchar*file, intline){}
voidAnnotateIgnoreSyncEnd(constchar*file, intline){}
voidAnnotateEnableRaceDetection(constchar*file, intline, intenable){}
voidAnnotateNoOp(constchar*file, intline,
constvolatilevoid*arg){}
voidAnnotateFlushState(constchar*file, intline){}

staticintGetRunningOnValgrind(void) {
#ifdefRUNNING_ON_VALGRIND
if (RUNNING_ON_VALGRIND) return1;
#endif

#ifndef_MSC_VER
constchar*running_on_valgrind_str=getenv("RUNNING_ON_VALGRIND");
if (running_on_valgrind_str) {
returnstrcmp(running_on_valgrind_str, "0") !=0;
 }
#else
/* Visual Studio issues warnings if we use getenv,
 * so we use GetEnvironmentVariableA instead.
 */
charvalue[100] ="1";
intres=GetEnvironmentVariableA("RUNNING_ON_VALGRIND",
value, sizeof(value));
/* value will remain "1" if res == 0 or res >= sizeof(value). The latter
 * can happen only if the given value is long, in this case it can't be "0".
 */
if (res>0&& !strcmp(value, "0"))
return1;
#endif
return0;
}

/* See the comments in dynamic_annotations.h */
intRunningOnValgrind(void) {
staticvolatileintrunning_on_valgrind=-1;
/* C doesn't have thread-safe initialization of statics, and we
 don't want to depend on pthread_once here, so hack it. */
intlocal_running_on_valgrind=running_on_valgrind;
if (local_running_on_valgrind==-1)
running_on_valgrind=local_running_on_valgrind=GetRunningOnValgrind();
returnlocal_running_on_valgrind;
}

#endif/* DYNAMIC_ANNOTATIONS_ENABLED == 1 */