codeql/cpp/ql/lib/semmle/code/cpp/Variable.qll at codeql-cli/v2.27.1 · github/codeql · GitHub

Repository navigation

History

707 lines (619 loc) · 21.6 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

/**

* Provides classes for modeling variables and their declarations.

import semmle.code.cpp.Element

import semmle.code.cpp.exprs.Access

import semmle.code.cpp.Initializer

private import semmle.code.cpp.internal.ResolveClass

private import semmle.code.cpp.internal.ResolveGlobalVariable

/**

* A C/C++ variable. For example, in the following code there are four

* variables, `a`, `b`, `c` and `d`:

* ```

* extern int a;

* int a;

* void myFunction(int b) {

* int c;

* }

* namespace N {

* extern int d;

* int d = 1;

* }

* ```

* For local variables, there is a one-to-one correspondence between

* `Variable` and `VariableDeclarationEntry`.

* For other types of variable, there is a one-to-many relationship between

* `Variable` and `VariableDeclarationEntry`. For example, a `Parameter`

* can have multiple declarations.

class Variable extends Declaration, @variable {

Variable() { isVariable(underlyingElement(this)) }

override string getAPrimaryQlClass() { result = "Variable" }

/** Gets the initializer of this variable, if any. */

Initializer getInitializer() { result.getDeclaration() = this }

/** Holds if this variable has an initializer. */

predicate hasInitializer() { exists(this.getInitializer()) }

/** Gets an access to this variable. */

VariableAccess getAnAccess() { result.getTarget() = this }

/**

* Gets a specifier of this variable. This includes `extern`, `static`,

* `auto`, `private`, `protected`, `public`. Specifiers of the *type* of

* this variable, such as `const` and `volatile`, are instead accessed

* through `this.getType().getASpecifier()`.

override Specifier getASpecifier() {

varspecifiers(underlyingElement(this), unresolveElement(result))

}

/** Gets an attribute of this variable. */

Attribute getAnAttribute() { varattributes(underlyingElement(this), unresolveElement(result)) }

/** Holds if this variable is `const`. */

predicate isConst() { this.getType().isConst() }

/** Holds if this variable is `volatile`. */

predicate isVolatile() { this.getType().isVolatile() }

/** Gets the name of this variable. */

override string getName() { none() }

/** Gets the type of this variable. */

Type getType() { none() }

/** Gets the type of this variable, after typedefs have been resolved. */

Type getUnderlyingType() { result = this.getType().getUnderlyingType() }

/**

* Gets the type of this variable, after specifiers have been deeply

* stripped and typedefs have been resolved.

Type getUnspecifiedType() { result = this.getType().getUnspecifiedType() }

/**

* Gets the type of this variable prior to deduction caused by the C++11

* `auto` keyword.

* If the type of this variable was not declared with the C++11 `auto`

* keyword, then this predicate does not hold.

* If the type of this variable is completely `auto`, then `result` is an

* instance of `AutoType`. For example:

* `auto four = 4;`

* If the type of this variable is partially `auto`, then a descendant of

* `result` is an instance of `AutoType`. For example:

* `const auto& c = container;`

Type getTypeWithAuto() { autoderivation(underlyingElement(this), unresolveElement(result)) }

/**

* Holds if the type of this variable is declared using the C++ `auto`

* keyword.

predicate declaredUsingAutoType() { autoderivation(underlyingElement(this), _) }

override VariableDeclarationEntry getADeclarationEntry() { result.getDeclaration() = this }

override Location getADeclarationLocation() { result = this.getADeclarationEntry().getLocation() }

override VariableDeclarationEntry getDefinition() {

result = this.getADeclarationEntry() and

result.isDefinition()

}

override Location getDefinitionLocation() { result = this.getDefinition().getLocation() }

override Location getLocation() {

if exists(this.getDefinition())

then result = this.getDefinitionLocation()

else result = this.getADeclarationLocation()

}

/**

* Gets an expression that is assigned to this variable somewhere in the

* program.

Expr getAnAssignedValue() {

result = this.getInitializer().getExpr()

exists(ConstructorFieldInit cfi | cfi.getTarget() = this and result = cfi.getExpr())

exists(AssignExpr ae | ae.getLValue().(Access).getTarget() = this and result = ae.getRValue())

exists(ClassAggregateLiteral l | result = l.getAFieldExpr(this))

}

/**

* Gets an assignment expression that assigns to this variable.

* For example: `x=...` or `x+=...`.

* This does _not_ include the initialization of the variable. Use

* `Variable.getInitializer()` to get the variable's initializer,

* or use `Variable.getAnAssignedValue()` to get an expression that

* is the right-hand side of an assignment or an initialization of

* the variable.

Assignment getAnAssignment() { result.getLValue() = this.getAnAccess() }

/**

* Holds if this variable is `constexpr`.

predicate isConstexpr() { this.hasSpecifier("is_constexpr") }

/**

* Holds if this variable is declared `constinit`.

predicate isConstinit() { this.hasSpecifier("declared_constinit") }

/**

* Holds if this variable is `thread_local`.

predicate isThreadLocal() { this.hasSpecifier("is_thread_local") }

/**

* Holds if this variable is constructed from `v` as a result

* of template instantiation. If so, it originates either from a template

* variable or from a variable nested in a template class.

predicate isConstructedFrom(Variable v) {

variable_instantiation(underlyingElement(this), unresolveElement(v))

}

/**

* Holds if this variable is declared as part of a structured binding

* declaration. For example, `x` in `auto [x, y] = ...`.

predicate isStructuredBinding() { is_structured_binding(underlyingElement(this)) }

/**

* Holds if this is a compiler-generated variable. For example, a

* [range-based for loop](http://en.cppreference.com/w/cpp/language/range-for)

* typically has three compiler-generated variables, named `__range`,

* `__begin`, and `__end`:

* `for (char c : str) { ... }`

predicate isCompilerGenerated() { compgenerated(underlyingElement(this)) }

/** Holds if this variable is a template specialization. */

predicate isSpecialization() {

exists(VariableDeclarationEntry vde |

var_decls(unresolveElement(vde), underlyingElement(this), _, _, _) and

vde.isSpecialization()

)

}

/**

* A particular declaration or definition of a C/C++ variable. For example, in

* the following code there are six variable declaration entries - two each for

* `a` and `d`, and one each for `b` and `c`:

* ```

* extern int a;

* int a;

* void myFunction(int b) {

* int c;

* }

* namespace N {

* extern int d;

* int d = 1;

* }

* ```

class VariableDeclarationEntry extends DeclarationEntry, @var_decl {

override Variable getDeclaration() { result = this.getVariable() }

override string getAPrimaryQlClass() { result = "VariableDeclarationEntry" }

/**

* Gets the variable which is being declared or defined.

Variable getVariable() { var_decls(underlyingElement(this), unresolveElement(result), _, _, _) }

/**

* Gets the name, if any, used for the variable at this declaration or

* definition.

* In most cases, this will be the name of the variable itself. The only

* case in which it can differ is in a parameter declaration entry,

* because the parameter may have a different name in the declaration

* than in the definition. For example:

* ```

* // Declaration. Parameter is named "x".

* int f(int x);

* // Definition. Parameter is named "y".

* int f(int y) { return y; }

* ```

override string getName() {

exists(string name |

var_decls(underlyingElement(this), _, _, name, _) and

(

name != "" and result = name

name = "" and result = this.getVariable().(LocalVariable).getName()

name = "" and

not this instanceof ParameterDeclarationEntry and

result = this.getVariable().(Parameter).getName()

)

}

/**

* Gets the type of the variable which is being declared or defined.

override Type getType() { var_decls(underlyingElement(this), _, unresolveElement(result), _, _) }

override Location getLocation() { var_decls(underlyingElement(this), _, _, _, result) }

/**

* Holds if this is a definition of a variable.

* This always holds for local variables and member variables, but need

* not hold for global variables. In the case of function parameters,

* this holds precisely when the enclosing `FunctionDeclarationEntry` is

* a definition.

override predicate isDefinition() { var_def(underlyingElement(this)) }

override string getASpecifier() { var_decl_specifiers(underlyingElement(this), result) }

/** Holds if this declaration is a template specialization. */

predicate isSpecialization() { var_specialized(underlyingElement(this)) }

/**

* Gets the requires clause if this declaration is a template with such a clause.

Expr getRequiresClause() { var_requires(underlyingElement(this), unresolveElement(result)) }

}

/**

* A parameter as described within a particular declaration or definition

* of a C/C++ function. For example the declaration of `a` in the following

* code:

* ```

* void myFunction(int a) {

* int b;

* }

* ```

class ParameterDeclarationEntry extends VariableDeclarationEntry {

ParameterDeclarationEntry() { param_decl_bind(underlyingElement(this), _, _) }

override string getAPrimaryQlClass() { result = "ParameterDeclarationEntry" }

/**

* Gets the function declaration or definition which this parameter

* description is part of.

FunctionDeclarationEntry getFunctionDeclarationEntry() {

param_decl_bind(underlyingElement(this), _, unresolveElement(result))

}

/**

* Gets the zero-based index of this parameter.

int getIndex() { param_decl_bind(underlyingElement(this), result, _) }

private string getAnonymousParameterDescription() {

not exists(this.getName()) and

exists(string anon |

anon = "(unnamed parameter " + this.getIndex().toString() + ")" and

if exists(this.getCanonicalName())

then result = "declaration of " + this.getCanonicalName() + " as " + anon

else result = "declaration of " + anon

)

}

override string toString() {

this.isDefinition() and

result = "definition of " + this.getName()

not this.isDefinition() and

if this.getName() = this.getCanonicalName()

then result = "declaration of " + this.getName()

else result = "declaration of " + this.getCanonicalName() + " as " + this.getName()

result = this.getAnonymousParameterDescription()

}

/**

* Gets the name of this `ParameterDeclarationEntry` including it's type.

* For example: "int p".

string getTypedName() {

exists(string typeString, string nameString |

(

if exists(this.getType().getName())

then typeString = this.getType().getName()

else typeString = ""

) and

(if exists(this.getName()) then nameString = this.getName() else nameString = "") and

if typeString != "" and nameString != ""

then result = typeString + " " + nameString

else result = typeString + nameString

)

}

/**

* A C/C++ variable with block scope [N4140 3.3.3]. In other words, a local

* variable or a function parameter. For example, the variables `a`, `b` and

* `c` in the following code:

* ```

* void myFunction(int a) {

* int b;

* static int c;

* }

* ```

* See also `StackVariable`, which is the class of local-scope variables

* without statics and thread-locals.

class LocalScopeVariable extends Variable, @localscopevariable {

/** Gets the function to which this variable belongs. */

Function getFunction() { none() } // overridden in subclasses

}

/**

* A C/C++ variable with _automatic storage duration_. In other words, a

* function parameter or a local variable that is not static or thread-local.

* For example, the variables `a` and `b` in the following code.

* ```

* void myFunction(int a) {

* int b;

* static int c;

* }

* ```

class StackVariable extends LocalScopeVariable {

StackVariable() {

not this.isStatic() and

not this.isThreadLocal()

}

/**

* A C/C++ local variable. In other words, any variable that has block

* scope [N4140 3.3.3], but is not a parameter of a `Function` or `CatchBlock`.

* For example the variables `b` and `c` in the following code:

* ```

* void myFunction(int a) {

* int b;

* static int c;

* }

* ```

* Local variables can be static; use the `isStatic` member predicate to detect

* those.

* A local variable can be declared by a `DeclStmt` or a `ConditionDeclExpr`.

class LocalVariable extends LocalScopeVariable, @localvariable {

override string getAPrimaryQlClass() { result = "LocalVariable" }

override string getName() { localvariables(underlyingElement(this), _, result) }

override Type getType() { localvariables(underlyingElement(this), unresolveElement(result), _) }

override Function getFunction() {

exists(DeclStmt s | s.getADeclaration() = this and s.getEnclosingFunction() = result)

exists(ConditionDeclExpr e | e.getVariable() = this and e.getEnclosingFunction() = result)

orphaned_variables(underlyingElement(this), unresolveElement(result))

coroutine_placeholder_variable(underlyingElement(this), _, unresolveElement(result))

}

override predicate isStatic() {

super.isStatic() or orphaned_variables(underlyingElement(this), _)

}

override predicate isCompilerGenerated() {

super.isCompilerGenerated() or

coroutine_placeholder_variable(underlyingElement(this), _, _)

}

/**

* A variable whose contents always have static storage duration. This can be a

* global variable, a namespace variable, a static local variable, or a static

* member variable.

class StaticStorageDurationVariable extends Variable {

StaticStorageDurationVariable() {

this instanceof GlobalOrNamespaceVariable

this.(LocalVariable).isStatic()

this.(MemberVariable).isStatic()

}

/**

* Holds if the initializer for this variable is evaluated at runtime.

predicate hasDynamicInitialization() {

runtimeExprInStaticInitializer(this.getInitializer().getExpr())

}

/**

* Holds if `e` is an expression in a static initializer that must be evaluated

* at run time. This predicate computes "is non-const" instead of "is const"

* since computing "is const" for an aggregate literal with many children would

* either involve recursion through `forall` on those children or an iteration

* through the rank numbers of the children, both of which can be slow.

private predicate runtimeExprInStaticInitializer(Expr e) {

inStaticInitializer(e) and

if e instanceof AggregateLiteral // in sync with the cast in `inStaticInitializer`

then runtimeExprInStaticInitializer(e.getAChild())

else not e.getFullyConverted().isConstant()

}

/**

* Holds if `e` is the initializer of a `StaticStorageDurationVariable`, either

* directly or below some top-level `AggregateLiteral`s.

private predicate inStaticInitializer(Expr e) {

exists(StaticStorageDurationVariable var | e = var.getInitializer().getExpr())

// The cast to `AggregateLiteral` ensures we only compute what'll later be

// needed by `runtimeExprInStaticInitializer`.

inStaticInitializer(e.getParent().(AggregateLiteral))

}

/**

* A C++ local variable declared as `static`.

class StaticLocalVariable extends LocalVariable, StaticStorageDurationVariable { }

/**

* A C/C++ variable which has global scope or namespace scope. For example the

* variables `a` and `b` in the following code:

* ```

* int a;

* namespace N {

* int b;

* }

* ```

class GlobalOrNamespaceVariable extends Variable, @globalvariable {

override string getName() { globalvariables(underlyingElement(this), _, result) }

override Type getType() { globalvariables(underlyingElement(this), unresolveElement(result), _) }

override Element getEnclosingElement() { none() }

/** Gets a link target which compiled or referenced this global or namespace variable. */

LinkTarget getALinkTarget() { this = result.getAGlobalOrNamespaceVariable() }

}

/**

* A C/C++ variable which has namespace scope. For example the variable `b`

* in the following code:

* ```

* int a;

* namespace N {

* int b;

* }

* ```

class NamespaceVariable extends GlobalOrNamespaceVariable {

NamespaceVariable() {

exists(Namespace n | namespacembrs(unresolveElement(n), underlyingElement(this)))

}

override string getAPrimaryQlClass() { result = "NamespaceVariable" }

}

/**

* A C/C++ variable which has global scope. For example the variable `a`

* in the following code:

* ```

* int a;

* namespace N {

* int b;

* }

* ```

* Note that variables declared in anonymous namespaces have namespace scope,

* even though they are accessed in the same manner as variables declared in

* the enclosing scope of said namespace (which may be the global scope).

class GlobalVariable extends GlobalOrNamespaceVariable {

GlobalVariable() { not this instanceof NamespaceVariable }

override string getAPrimaryQlClass() { result = "GlobalVariable" }

}

/**

* A C structure member or C++ member variable. For example the member

* variables `m` and `s` in the following code:

* ```

* class MyClass {

* public:

* int m;

* static int s;

* };

* ```

* This includes static member variables in C++. To exclude static member

* variables, use `Field` instead of `MemberVariable`.

class MemberVariable extends Variable, @membervariable {

MemberVariable() { this.isMember() }

override string getAPrimaryQlClass() { result = "MemberVariable" }

/** Holds if this member is private. */

predicate isPrivate() { this.hasSpecifier("private") }

/** Holds if this member is protected. */

predicate isProtected() { this.hasSpecifier("protected") }

/** Holds if this member is public. */

predicate isPublic() { this.hasSpecifier("public") }

override string getName() { membervariables(underlyingElement(this), _, result) }

override Type getType() {

if strictcount(this.getAType()) = 1

then result = this.getAType()

else

// In rare situations a member variable may have multiple types in

// different translation units. In that case, we return the unspecified

// type.

result = this.getAType().getUnspecifiedType()

}

/** Holds if this member is mutable. */

predicate isMutable() { this.getADeclarationEntry().hasSpecifier("mutable") }

private Type getAType() { membervariables(underlyingElement(this), unresolveElement(result), _) }

}

/**

* A C++14 variable template. For example, in the following code the variable

* template `v` defines a family of variables:

* ```

* template<class T>

* T v;

* ```

class TemplateVariable extends Variable {

TemplateVariable() { is_variable_template(underlyingElement(this)) }

/**

* Gets an instantiation of this variable template.

Variable getAnInstantiation() {

result.isConstructedFrom(this) and

not result.isSpecialization()

}

/**

* Gets the class member template this template was generated from.

* This predicate only has results for templates that are members of class

* template instantiations. For example, for `MyTemplateClass<int>::x<S>`

* in the following code, the result is `MyTemplateClass<T>::x<S>`.

* ```cpp

* template<class T>

* class MyTemplateClass {

* template<class S>

* static S x;

* };

* template

* class MyTemplateClass<int>;

* ```

TemplateVariable getOriginalTemplate() {

variable_template_generated_from(underlyingElement(this), unresolveElement(result))

}

/**

* A variable that is an instantiation of a template. For example

* the instantiation `myTemplateVariable<int>` in the following code:

* ```

* template<class T>

* T myTemplateVariable;

* void caller(int i) {

* myTemplateVariable<int> = i;

* }

* ```

class VariableTemplateInstantiation extends Variable {

TemplateVariable tv;

VariableTemplateInstantiation() { tv.getAnInstantiation() = this }

override string getAPrimaryQlClass() { result = "VariableTemplateInstantiation" }

/**

* Gets the variable template from which this instantiation was instantiated.

* Example: For `int x<int>`, returns `T x`.

TemplateVariable getTemplate() { result = tv }

}

/**

* An explicit specialization of a C++ variable template.

class VariableTemplateSpecialization extends Variable {

VariableTemplateSpecialization() { this.isSpecialization() }

override string getAPrimaryQlClass() { result = "VariableTemplateSpecialization" }

/**

* Gets the primary template for the specialization (the function template

* this specializes).

TemplateVariable getPrimaryTemplate() { this.isConstructedFrom(result) }

}

/**

* A non-static local variable or parameter that is not part of an

* uninstantiated template. Uninstantiated templates are purely syntax, and

* only on instantiation will they be complete with information about types,

* conversions, call targets, etc. For example in the following code, the

* variables `a` in `myFunction` and `b` in the instantiation

* `myTemplateFunction<int>`, but not `b` in the template

* `myTemplateFunction<T>`:

* ```

* void myFunction() {

* float a;

* }

* template<typename T>

* void myTemplateFunction() {

* T b;

* }

* ...

* myTemplateFunction<int>();

* ```

class SemanticStackVariable extends StackVariable {

SemanticStackVariable() { not this.isFromUninstantiatedTemplate(_) }

}

codeql/cpp/ql/lib/semmle/code/cpp/Variable.qll at codeql-cli/v2.27.1 · github/codeql · GitHub

Repository navigation

Expand file tree

Breadcrumbs

Variable.qll

Latest commit

History

Breadcrumbs

Variable.qll

File metadata and controls