common/inc/tx_thread.h (threadx)

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

/**************************************************************************/ /* */ /* Copyright (c) Microsoft Corporation. All rights reserved. */ /* */ /* This software is licensed under the Microsoft Software License */ /* Terms for Microsoft Azure RTOS. Full text of the license can be */ /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ /* and in the root directory of this software. */ /* */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /** */ /** ThreadX Component */ /** */ /** Thread */ /** */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /* */ /* COMPONENT DEFINITION RELEASE */ /* */ /* tx_thread.h PORTABLE C */ /* 6.1.9 */ /* AUTHOR */ /* */ /* William E. Lamie, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This file defines the ThreadX thread control component, including */ /* data types and external references. It is assumed that tx_api.h */ /* and tx_port.h have already been included. */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 05-19-2020 William E. Lamie Initial Version 6.0 */ /* 09-30-2020 Yuxin Zhou Modified comment(s), */ /* resulting in version 6.1 */ /* 11-09-2020 Yuxin Zhou Modified comment(s), and */ /* moved TX_THREAD_GET_SYSTEM_ */ /* STATE to tx_api.h, */ /* resulting in version 6.1.2 */ /* 10-15-2021 Scott Larson Modified comment(s), improved */ /* stack check error handling, */ /* resulting in version 6.1.9 */ /* */ /**************************************************************************/ #ifndef TX_THREAD_H #define TX_THREAD_H /* Define thread control specific data definitions. */ #define TX_THREAD_ID ((ULONG) 0x54485244) #define TX_THREAD_PRIORITY_GROUP_MASK ((ULONG) 0xFF) #define TX_THREAD_EXECUTE_LOG_SIZE ((UINT) 8) /* Define the MOD32 bit set macro that is used to set/clear a priority bit within a specific priority group. */ #if TX_MAX_PRIORITIES > 32 #define MAP_INDEX (map_index) #ifndef TX_MOD32_BIT_SET #define TX_MOD32_BIT_SET(a,b) (b) = (((ULONG) 1) << ((a)%((UINT)32))); #endif #else #define MAP_INDEX (0) #ifndef TX_MOD32_BIT_SET #define TX_MOD32_BIT_SET(a,b) (b) = (((ULONG) 1) << ((a))); #endif #endif /* Define the DIV32 bit set macro that is used to set/clear a priority group bit and is only necessary when using priorities greater than 32. */ #if TX_MAX_PRIORITIES > 32 #ifndef TX_DIV32_BIT_SET #define TX_DIV32_BIT_SET(a,b) (b) = (((ULONG) 1) << ((a)/((UINT) 32))); #endif #endif /* Define state change macro that can be used by run-mode debug agents to keep track of thread state changes. By default, it is mapped to white space. */ #ifndef TX_THREAD_STATE_CHANGE #define TX_THREAD_STATE_CHANGE(a, b) #endif /* Define the macro to get the current thread pointer. This is particularly useful in SMP versions of ThreadX to add additional processing. The default implementation is to simply access the global current thread pointer directly. */ #ifndef TX_THREAD_GET_CURRENT #define TX_THREAD_GET_CURRENT(a) (a) = _tx_thread_current_ptr; #endif /* Define the macro to set the current thread pointer. This is particularly useful in SMP versions of ThreadX to add additional processing. The default implementation is to simply access the global current thread pointer directly. */ #ifndef TX_THREAD_SET_CURRENT #define TX_THREAD_SET_CURRENT(a) _tx_thread_current_ptr = (a); #endif /* Define the get system state macro. By default, it simply maps to the variable _tx_thread_system_state. */ /* This symbol is moved to tx_api.h. Therefore removed from this file. #ifndef TX_THREAD_GET_SYSTEM_STATE #define TX_THREAD_GET_SYSTEM_STATE() _tx_thread_system_state #endif */ /* Define the check for whether or not to call the _tx_thread_system_return function. A non-zero value indicates that _tx_thread_system_return should not be called. */ #ifndef TX_THREAD_SYSTEM_RETURN_CHECK #define TX_THREAD_SYSTEM_RETURN_CHECK(c) (c) = (ULONG) _tx_thread_preempt_disable; (c) = (c) | TX_THREAD_GET_SYSTEM_STATE(); #endif /* Define the timeout setup macro used in _tx_thread_create. */ #ifndef TX_THREAD_CREATE_TIMEOUT_SETUP #define TX_THREAD_CREATE_TIMEOUT_SETUP(t) (t) -> tx_thread_timer.tx_timer_internal_timeout_function = &(_tx_thread_timeout); \ (t) -> tx_thread_timer.tx_timer_internal_timeout_param = TX_POINTER_TO_ULONG_CONVERT((t)); #endif /* Define the thread timeout pointer setup macro used in _tx_thread_timeout. */ #ifndef TX_THREAD_TIMEOUT_POINTER_SETUP #define TX_THREAD_TIMEOUT_POINTER_SETUP(t) (t) = TX_ULONG_TO_THREAD_POINTER_CONVERT(timeout_input); #endif /* Define the lowest bit set macro. Note, that this may be overridden by a port specific definition if there is supporting assembly language instructions in the architecture. */ #ifndef TX_LOWEST_SET_BIT_CALCULATE #define TX_LOWEST_SET_BIT_CALCULATE(m, b) \ (b) = ((ULONG) 0); \ (m) = (m) & ((~(m)) + ((ULONG) 1)); \ if ((m) < ((ULONG) 0x10)) \ { \ if ((m) >= ((ULONG) 4)) \ { \ (m) = (m) >> ((ULONG) 2); \ (b) = (b) + ((ULONG) 2); \ } \ (b) = (b) + ((m) >> ((ULONG) 1)); \ } \ else if ((m) < ((ULONG) 0x100)) \ { \ (m) = (m) >> ((ULONG) 4); \ (b) = (b) + ((ULONG) 4); \ if ((m) >= ((ULONG) 4)) \ { \ (m) = (m) >> ((ULONG) 2); \ (b) = (b) + ((ULONG) 2); \ } \ (b) = (b) + ((m) >> ((ULONG) 1)); \ } \ else if ((m) < ((ULONG) 0x10000)) \ { \ (m) = (m) >> ((ULONG) 8); \ (b) = (b) + ((ULONG) 8); \ if ((m) >= ((ULONG) 0x10)) \ { \ (m) = (m) >> ((ULONG) 4); \ (b) = (b) + ((ULONG) 4); \ } \ if ((m) >= ((ULONG) 4)) \ { \ (m) = (m) >> ((ULONG) 2); \ (b) = (b) + ((ULONG) 2); \ } \ (b) = (b) + ((m) >> ((ULONG) 1)); \ } \ else \ { \ (m) = (m) >> ((ULONG) 16); \ (b) = (b) + ((ULONG) 16); \ if ((m) >= ((ULONG) 0x100)) \ { \ (m) = (m) >> ((ULONG) 8); \ (b) = (b) + ((ULONG) 8); \ } \ if ((m) >= ((ULONG) 16)) \ { \ (m) = (m) >> ((ULONG) 4); \ (b) = (b) + ((ULONG) 4); \ } \ if ((m) >= ((ULONG) 4)) \ { \ (m) = (m) >> ((ULONG) 2); \ (b) = (b) + ((ULONG) 2); \ } \ (b) = (b) + ((m) >> ((ULONG) 1)); \ } #endif /* Define the default thread stack checking. This can be overridden by a particular port, which is necessary if the stack growth is from low address to high address (the default logic is for stacks that grow from high address to low address. */ #ifndef TX_THREAD_STACK_CHECK #define TX_THREAD_STACK_CHECK(thread_ptr) \ { \ TX_INTERRUPT_SAVE_AREA \ TX_DISABLE \ if (((thread_ptr)) && ((thread_ptr) -> tx_thread_id == TX_THREAD_ID)) \ { \ if (((ULONG *) (thread_ptr) -> tx_thread_stack_ptr) < ((ULONG *) (thread_ptr) -> tx_thread_stack_highest_ptr)) \ { \ (thread_ptr) -> tx_thread_stack_highest_ptr = (thread_ptr) -> tx_thread_stack_ptr; \ } \ if ((*((ULONG *) (thread_ptr) -> tx_thread_stack_start) != TX_STACK_FILL) || \ (*((ULONG *) (((UCHAR *) (thread_ptr) -> tx_thread_stack_end) + 1)) != TX_STACK_FILL) || \ (((ULONG *) (thread_ptr) -> tx_thread_stack_highest_ptr) < ((ULONG *) (thread_ptr) -> tx_thread_stack_start))) \ { \ TX_RESTORE \ _tx_thread_stack_error_handler((thread_ptr)); \ TX_DISABLE \ } \ if (*(((ULONG *) (thread_ptr) -> tx_thread_stack_highest_ptr) - 1) != TX_STACK_FILL) \ { \ TX_RESTORE \ _tx_thread_stack_analyze((thread_ptr)); \ TX_DISABLE \ } \ } \ TX_RESTORE \ } #endif /* Define default post thread delete macro to whitespace, if it hasn't been defined previously (typically in tx_port.h). */ #ifndef TX_THREAD_DELETE_PORT_COMPLETION #define TX_THREAD_DELETE_PORT_COMPLETION(t) #endif /* Define default post thread reset macro to whitespace, if it hasn't been defined previously (typically in tx_port.h). */ #ifndef TX_THREAD_RESET_PORT_COMPLETION #define TX_THREAD_RESET_PORT_COMPLETION(t) #endif /* Define the thread create internal extension macro to whitespace, if it hasn't been defined previously (typically in tx_port.h). */ #ifndef TX_THREAD_CREATE_INTERNAL_EXTENSION #define TX_THREAD_CREATE_INTERNAL_EXTENSION(t) #endif /* Define internal thread control function prototypes. */ VOID _tx_thread_initialize(VOID); VOID _tx_thread_schedule(VOID); VOID _tx_thread_shell_entry(VOID); VOID _tx_thread_stack_analyze(TX_THREAD *thread_ptr); VOID _tx_thread_stack_build(TX_THREAD *thread_ptr, VOID (*function_ptr)(VOID)); VOID _tx_thread_stack_error(TX_THREAD *thread_ptr); VOID _tx_thread_stack_error_handler(TX_THREAD *thread_ptr); VOID _tx_thread_system_preempt_check(VOID); VOID _tx_thread_system_resume(TX_THREAD *thread_ptr); VOID _tx_thread_system_ni_resume(TX_THREAD *thread_ptr); VOID _tx_thread_system_return(VOID); VOID _tx_thread_system_suspend(TX_THREAD *thread_ptr); VOID _tx_thread_system_ni_suspend(TX_THREAD *thread_ptr, ULONG wait_option); VOID _tx_thread_time_slice(VOID); VOID _tx_thread_timeout(ULONG timeout_input); /* Thread control component data declarations follow. */ /* Determine if the initialization function of this component is including this file. If so, make the data definitions really happen. Otherwise, make them extern so other functions in the component can access them. */ #define THREAD_DECLARE extern /* Define the pointer that contains the system stack pointer. This is utilized when control returns from a thread to the system to reset the current stack. This is setup in the low-level initialization function. */ THREAD_DECLARE VOID * _tx_thread_system_stack_ptr; /* Define the current thread pointer. This variable points to the currently executing thread. If this variable is NULL, no thread is executing. */ THREAD_DECLARE TX_THREAD * _tx_thread_current_ptr; /* Define the variable that holds the next thread to execute. It is important to remember that this is not necessarily equal to the current thread pointer. */ THREAD_DECLARE TX_THREAD * _tx_thread_execute_ptr; /* Define the head pointer of the created thread list. */ THREAD_DECLARE TX_THREAD * _tx_thread_created_ptr; /* Define the variable that holds the number of created threads. */ THREAD_DECLARE ULONG _tx_thread_created_count; /* Define the current state variable. When this value is 0, a thread is executing or the system is idle. Other values indicate that interrupt or initialization processing is active. This variable is initialized to TX_INITIALIZE_IN_PROGRESS to indicate initialization is active. */ THREAD_DECLARE volatile ULONG _tx_thread_system_state; /* Define the 32-bit priority bit-maps. There is one priority bit map for each 32 priority levels supported. If only 32 priorities are supported there is only one bit map. Each bit within a priority bit map represents that one or more threads at the associated thread priority are ready. */ THREAD_DECLARE ULONG _tx_thread_priority_maps[TX_MAX_PRIORITIES/32]; /* Define the priority map active bit map that specifies which of the previously defined priority maps have something set. This is only necessary if more than 32 priorities are supported. */ #if TX_MAX_PRIORITIES > 32 THREAD_DECLARE ULONG _tx_thread_priority_map_active; #endif #ifndef TX_DISABLE_PREEMPTION_THRESHOLD /* Define the 32-bit preempt priority bit maps. There is one preempt bit map for each 32 priority levels supported. If only 32 priorities are supported there is only one bit map. Each set set bit corresponds to a preempted priority level that had preemption-threshold active to protect against preemption of a range of relatively higher priority threads. */ THREAD_DECLARE ULONG _tx_thread_preempted_maps[TX_MAX_PRIORITIES/32]; /* Define the preempt map active bit map that specifies which of the previously defined preempt maps have something set. This is only necessary if more than 32 priorities are supported. */ #if TX_MAX_PRIORITIES > 32 THREAD_DECLARE ULONG _tx_thread_preempted_map_active; #endif #endif /* Define the variable that holds the highest priority group ready for execution. It is important to note that this is not necessarily the same as the priority of the thread pointed to by _tx_execute_thread. */ THREAD_DECLARE UINT _tx_thread_highest_priority; /* Define the array of thread pointers. Each entry represents the threads that are ready at that priority group. For example, index 10 in this array represents the first thread ready at priority 10. If this entry is NULL, no threads are ready at that priority. */ THREAD_DECLARE TX_THREAD * _tx_thread_priority_list[TX_MAX_PRIORITIES]; /* Define the global preempt disable variable. If this is non-zero, preemption is disabled. It is used internally by ThreadX to prevent preemption of a thread in the middle of a service that is resuming or suspending another thread. */ THREAD_DECLARE volatile UINT _tx_thread_preempt_disable; /* Define the global function pointer for mutex cleanup on thread completion or termination. This pointer is setup during mutex initialization. */ THREAD_DECLARE VOID (*_tx_thread_mutex_release)(TX_THREAD *thread_ptr); /* Define the global build options variable. This contains a bit map representing how the ThreadX library was built. The following are the bit field definitions: Bit(s) Meaning 31 TX_NOT_INTERRUPTABLE defined 30 TX_INLINE_THREAD_RESUME_SUSPEND define 29-24 Priority groups 1 -> 32 priorities 2 -> 64 priorities 3 -> 96 priorities ... 32 -> 1024 priorities 23 TX_TIMER_PROCESS_IN_ISR defined 22 TX_REACTIVATE_INLINE defined 21 TX_DISABLE_STACK_FILLING defined 20 TX_ENABLE_STACK_CHECKING defined 19 TX_DISABLE_PREEMPTION_THRESHOLD defined 18 TX_DISABLE_REDUNDANT_CLEARING defined 17 TX_DISABLE_NOTIFY_CALLBACKS defined 16 TX_BLOCK_POOL_ENABLE_PERFORMANCE_INFO defined 15 TX_BYTE_POOL_ENABLE_PERFORMANCE_INFO defined 14 TX_EVENT_FLAGS_ENABLE_PERFORMANCE_INFO defined 13 TX_MUTEX_ENABLE_PERFORMANCE_INFO defined 12 TX_QUEUE_ENABLE_PERFORMANCE_INFO defined 11 TX_SEMAPHORE_ENABLE_PERFORMANCE_INFO defined 10 TX_THREAD_ENABLE_PERFORMANCE_INFO defined 9 TX_TIMER_ENABLE_PERFORMANCE_INFO defined 8 TX_ENABLE_EVENT_TRACE defined 7 TX_ENABLE_EXECUTION_CHANGE_NOTIFY defined 6-0 Port Specific */ THREAD_DECLARE ULONG _tx_build_options; #if defined(TX_ENABLE_STACK_CHECKING) || defined(TX_PORT_THREAD_STACK_ERROR_HANDLING) /* Define the global function pointer for stack error handling. If a stack error is detected and the application has registered a stack error handler, it will be called via this function pointer. */ THREAD_DECLARE VOID (*_tx_thread_application_stack_error_handler)(TX_THREAD *thread_ptr); #endif #ifdef TX_THREAD_ENABLE_PERFORMANCE_INFO /* Define the total number of thread resumptions. Each time a thread enters the ready state this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_resume_count; /* Define the total number of thread suspensions. Each time a thread enters a suspended state this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_suspend_count; /* Define the total number of solicited thread preemptions. Each time a thread is preempted by directly calling a ThreadX service, this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_solicited_preemption_count; /* Define the total number of interrupt thread preemptions. Each time a thread is preempted as a result of an ISR calling a ThreadX service, this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_interrupt_preemption_count; /* Define the total number of priority inversions. Each time a thread is blocked by a mutex owned by a lower-priority thread, this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_priority_inversion_count; /* Define the total number of time-slices. Each time a time-slice operation is actually performed (another thread is setup for running) this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_time_slice_count; /* Define the total number of thread relinquish operations. Each time a thread relinquish operation is actually performed (another thread is setup for running) this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_relinquish_count; /* Define the total number of thread timeouts. Each time a thread has a timeout this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_timeout_count; /* Define the total number of thread wait aborts. Each time a thread's suspension is lifted by the tx_thread_wait_abort call this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_wait_abort_count; /* Define the total number of idle system thread returns. Each time a thread returns to an idle system (no other thread is ready to run) this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_idle_return_count; /* Define the total number of non-idle system thread returns. Each time a thread returns to a non-idle system (another thread is ready to run) this variable is incremented. */ THREAD_DECLARE ULONG _tx_thread_performance_non_idle_return_count; /* Define the last TX_THREAD_EXECUTE_LOG_SIZE threads scheduled in ThreadX. This is a circular list, where the index points to the oldest entry. */ THREAD_DECLARE ULONG _tx_thread_performance__execute_log_index; THREAD_DECLARE TX_THREAD * _tx_thread_performance_execute_log[TX_THREAD_EXECUTE_LOG_SIZE]; #endif #endif