Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: collaborative wordsmithing

...

It

...

is

...

critical

...

to

...

ensure

...

that

...

threads

...

are

...

started correctly.

...

Thread

...

startup can

...

be

...

misleading

...

because

...

sometimes

...

the

...

code

...

appears

...

to

...

be

...

performing

...

the

...

function

...

correctly, when in fact it may be executing in the wrong thread.

The Thread.start() method starts executing a thread's run() method in that thread. It is a mistake to directly invoke the run() method on a Thread object. When invoked directly, the statements in the run() method execute in the current thread instead of the newly created thread. Furthermore, if the Thread object is not constructed from a Runnable object but rather by instantiating a subclass of Thread that does not override the run() method, a call to the subclass's run() method invokes Thread.run() which performs a no-op.

Noncompliant Code Example

This noncompliant code example explicitly invokes run() in the context of the current thread.

Code Block
bgColor#FFCCCC
 whereas it may be operating in the presence of subtle concurrency issues.

It is usually a mistake to invoke the {{run()}} method on a {{Thread}} object. When invoked directly, the statements in the {{run()}} method execute, however, in the current thread instead of the newly created thread. Furthermore, if the {{Thread}} object is not constructed from a {{Runnable}} object but by instantiating a subclass of {{Thread}} that does not override the {{run()}} method, a call to the subclass's {{run()}} method invokes {{Thread.run()}} which does not perform any useful operations.

{mc}
// Hidden text: What does this line mean? 
It is recommended that if you have a {{Thread}} object that extends {{Runnable}}, and you wish to execute the object's {{run()}} method in the current thread, first cast the object to a {{Runnable}} and then invoke {{run()}}.
{mc}

h2. Noncompliant Code Example

The {{run()}} method of interface {{Runnable}} must be invoked in its own thread, however, this noncompliant code example explicitly invokes it in the context of the current thread. 

{code:bgColor=#FFCCCC}
class Foo implements Runnable {
  public void run() {
    // ...
  }
  
  public static void main(String[] args) {
    Foo f = new foo();
    new Thread(f).run();
  }
}
{code}

The {{

The start()

...

method

...

is

...

not

...

invoked

...

on

...

the

...

new

...

thread

...

because

...

of

...

the

...

incorrect

...

assumption

...

that

...

run()

...

starts the new thread.

...

Consequently,

...

the

...

statements

...

in

...

the

...

run()

...

method

...

execute

...

in

...

the

...

same

...

thread

...

instead

...

of

...

the

...

new

...

one.

...

Compliant

...

Solution

...

This

...

compliant

...

solution

...

correctly

...

uses

...

the

...

start()

...

method

...

to

...

start

...

a

...

new

...

thread

...

which

...

then

...

executes

...

the

...

run()

...

method.

{:=
Code Block
bgColor
#ccccff
}
class Foo implements Runnable {
  public void run() {
    // ...
  }
  
  public static void main(String[] args) {
    Foo f = new foo();
    new Thread(f).start();
  }
}
{code}

h2. Exceptions

*EX1*: The {{Thread.

Exceptions

EX1: The run()

...

method

...

may

...

be

...

invoked when

...

unit

...

testing

...

its functionality. Note that a class cannot be tested for multithreaded use by invoking run().

EX2: When using a Thread object that implements Runnable, and you wish to execute the object's run() method in the current thread, first cast the object to a Runnable and then invoke run().

Code Block
bgColor#ccccff

Thread t = new Thread(new Runnable() {
    public void run() {
      // ...
    }
  });
t.run();               // bad, user prob meant t.start()
((Runnable) t).run();  // OK

Casting a thread to a Runnable before calling run() serves to document the intention of explicitly calling Thread.run().

Risk Assessment

Failing to activate threads correctly can cause unexpected behavior.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

CON05- J

low

probable

medium

P4

L3

Automated Detection

TODO

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

References

Wiki Markup
\[[API 06|AA. Java References#API 06]\] Interface {{Runnable}} and class {{Thread}}

...

...

CON04-J.

...

Synchronize

...

using

...

an

...

internal

...

private

...

final

...

lock

...

object      11. Concurrency (CON)      VOID CON06-J.

...

Do

...

not

...

defer

...

a

...

thread

...

that

...

is

...

holding

...

a

...

lock

...