/* * Copyright (c) Facebook, Inc. and its affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ package codetoanalyze.java.checkers; import com.facebook.infer.annotation.ThreadSafe; import com.google.common.annotations.VisibleForTesting; import javax.annotation.concurrent.NotThreadSafe; @ThreadSafe public class ThreadSafeExample { /*Included to make sure infer does not report on class initializers*/ static Class A = ThreadSafeExample.class; Integer f; public ThreadSafeExample() { f = 86; } public void tsOK() { synchronized (this) { f = 42; } } public void tsBad() { f = 24; } public void recursiveBad() { f = 44; recursiveBad(); } // shouldn't report here because it's a private method private void assignInPrivateMethodOk() { f = 24; } // but should report here, because now it's called public void callPublicMethodBad() { assignInPrivateMethodOk(); } private void callAssignInPrivateMethod() { assignInPrivateMethodOk(); } // should report a deeperTraceBade -> callAssignInPrivateMethod -> assignInPrivateMethodOk trace public void deeperTraceBad() { callAssignInPrivateMethod(); } public synchronized void callFromSynchronizedPublicMethodOk() { assignInPrivateMethodOk(); } private synchronized void synchronizedCallerOk() { assignInPrivateMethodOk(); } public void callFromUnsynchronizedPublicMethodOk() { synchronizedCallerOk(); } // although the constructor touches f, we shouldn't complain here public void callConstructorOk() { new ThreadSafeExample(); } private Object returnConstructorOk() { return new ThreadSafeExample(); } public void transitivelyCallConstructorOk() { returnConstructorOk(); } volatile Object volatileField; // we don't warn on unsafe writes to volatile fields public void unsafeVolatileWriteOk() { this.volatileField = new Object(); } // don't count the method as public if it's marked VisibleForTesting @VisibleForTesting public void visibleForTestingNotPublicOk() { this.f = 47; } // but do complain if a VisibleForTesting method is called from a public method public void callVisibleForTestingBad() { visibleForTestingNotPublicOk(); } Object sharedField; private void writePrivateSharedFieldOk() { this.sharedField = new Object(); } public Object returnSharedFieldOk() { return this.sharedField; // ok because it only races with a private method } Object sStaticField; public Object FP_lazyInitOk() { synchronized (ThreadSafeExample.class) { if (sStaticField != null) { sStaticField = new Object(); } } return sStaticField; // we'll warn here, although this is fine } } class ExtendsThreadSafeExample extends ThreadSafeExample { Integer field; /* Presently,we will warn not just on overwridden methods from @ThreadSafe class, but potentially on other methods in subclass */ public void newmethodBad() { field = 22; } /* Bad now that it's overridden */ public void tsOK() { field = 44; } } @NotThreadSafe class NotThreadSafeExtendsThreadSafeExample extends ThreadSafeExample { Integer field; /* We don't want to warn on this */ public void newmethodBad() { field = 22; } } @ThreadSafe class YesThreadSafeExtendsNotThreadSafeExample extends NotThreadSafeExtendsThreadSafeExample { Integer subsubfield; /* We do want to warn on this */ public void subsubmethodBad() { subsubfield = 22; } } class Unannotated { int mField; // although ThreadSafeExample is annotated @ThreadSafe, mutating fields of this class in a // non-threadsafe context should be allowed void callThreadSafeAnnotatedCode1Ok(ThreadSafeExample o) { o.f = null; } void callThreadSafeAnnotatedCode2Ok(ThreadSafeExample o) { o.tsBad(); } void mutateMyFieldOk() { this.mField = 1; } }