/* ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio. This file is part of ChibiOS. ChibiOS is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. ChibiOS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ /** * @file chregistry.c * @brief Threads registry code. * * @addtogroup registry * @details Threads Registry related APIs and services. *

Operation mode

* The Threads Registry is a double linked list that holds all the * active threads in the system.
* Operations defined for the registry: * - First, returns the first, in creation order, active thread * in the system. * - Next, returns the next, in creation order, active thread * in the system. * . * The registry is meant to be mainly a debug feature, for example, * using the registry a debugger can enumerate the active threads * in any given moment or the shell can print the active threads * and their state.
* Another possible use is for centralized threads memory management, * terminating threads can pulse an event source and an event handler * can perform a scansion of the registry in order to recover the * memory. * @pre In order to use the threads registry the @p CH_CFG_USE_REGISTRY * option must be enabled in @p chconf.h. * @{ */ #include #include "ch.h" #if (CH_CFG_USE_REGISTRY == TRUE) || defined(__DOXYGEN__) /*===========================================================================*/ /* Module exported variables. */ /*===========================================================================*/ /*===========================================================================*/ /* Module local types. */ /*===========================================================================*/ /*===========================================================================*/ /* Module local variables. */ /*===========================================================================*/ /*===========================================================================*/ /* Module local functions. */ /*===========================================================================*/ #define _offsetof(st, m) \ /*lint -save -e9005 -e9033 -e413 [11.8, 10.8 1.3] Normal pointers arithmetic, it is safe.*/ \ ((size_t)((char *)&((st *)0)->m - (char *)0)) \ /*lint -restore*/ /*===========================================================================*/ /* Module exported functions. */ /*===========================================================================*/ /* * OS signature in ROM plus debug-related information. */ ROMCONST chdebug_t ch_debug = { {'m', 'a', 'i', 'n'}, (uint8_t)0, (uint8_t)sizeof (chdebug_t), (uint16_t)(((unsigned)CH_KERNEL_MAJOR << 11U) | ((unsigned)CH_KERNEL_MINOR << 6U) | ((unsigned)CH_KERNEL_PATCH << 0U)), (uint8_t)sizeof (void *), (uint8_t)sizeof (systime_t), (uint8_t)sizeof (thread_t), (uint8_t)_offsetof(thread_t, prio), (uint8_t)_offsetof(thread_t, ctx), (uint8_t)_offsetof(thread_t, newer), (uint8_t)_offsetof(thread_t, older), (uint8_t)_offsetof(thread_t, name), #if (CH_DBG_ENABLE_STACK_CHECK == TRUE) || (CH_CFG_USE_DYNAMIC == TRUE) (uint8_t)_offsetof(thread_t, wabase), #else (uint8_t)0, #endif (uint8_t)_offsetof(thread_t, state), (uint8_t)_offsetof(thread_t, flags), #if CH_CFG_USE_DYNAMIC == TRUE (uint8_t)_offsetof(thread_t, refs), #else (uint8_t)0, #endif #if CH_CFG_TIME_QUANTUM > 0 (uint8_t)_offsetof(thread_t, preempt), #else (uint8_t)0, #endif #if CH_DBG_THREADS_PROFILING == TRUE (uint8_t)_offsetof(thread_t, time) #else (uint8_t)0 #endif }; /** * @brief Returns the first thread in the system. * @details Returns the most ancient thread in the system, usually this is * the main thread unless it terminated. A reference is added to the * returned thread in order to make sure its status is not lost. * @note This function cannot return @p NULL because there is always at * least one thread in the system. * * @return A reference to the most ancient thread. * * @api */ thread_t *chRegFirstThread(void) { thread_t *tp; chSysLock(); tp = ch.rlist.newer; #if CH_CFG_USE_DYNAMIC == TRUE tp->refs++; #endif chSysUnlock(); return tp; } /** * @brief Returns the thread next to the specified one. * @details The reference counter of the specified thread is decremented and * the reference counter of the returned thread is incremented. * * @param[in] tp pointer to the thread * @return A reference to the next thread. * @retval NULL if there is no next thread. * * @api */ thread_t *chRegNextThread(thread_t *tp) { thread_t *ntp; chSysLock(); ntp = tp->newer; /*lint -save -e9087 -e740 [11.3, 1.3] Cast required by list handling.*/ if (ntp == (thread_t *)&ch.rlist) { /*lint -restore*/ ntp = NULL; } #if CH_CFG_USE_DYNAMIC == TRUE else { chDbgAssert(ntp->refs < (trefs_t)255, "too many references"); ntp->refs++; } #endif chSysUnlock(); #if CH_CFG_USE_DYNAMIC == TRUE chThdRelease(tp); #endif return ntp; } /** * @brief Retrieves a thread pointer by name. * @note The reference counter of the found thread is increased by one so * it cannot be disposed incidentally after the pointer has been * returned. * * @param[in] name the thread name * @return A pointer to the found thread. * @retval NULL if a matching thread has not been found. * * @api */ thread_t *chRegFindThreadByName(const char *name) { thread_t *ctp; /* Scanning registry.*/ ctp = chRegFirstThread(); do { if (strcmp(chRegGetThreadNameX(ctp), name) == 0) { return ctp; } ctp = chRegNextThread(ctp); } while (ctp != NULL); return NULL; } /** * @brief Confirms that a pointer is a valid thread pointer. * @note The reference counter of the found thread is increased by one so * it cannot be disposed incidentally after the pointer has been * returned. * * @param[in] tp pointer to the thread * @return A pointer to the found thread. * @retval NULL if a matching thread has not been found. * * @api */ thread_t *chRegFindThreadByPointer(thread_t *tp) { thread_t *ctp; /* Scanning registry.*/ ctp = chRegFirstThread(); do { if (ctp == tp) { return ctp; } ctp = chRegNextThread(ctp); } while (ctp != NULL); return NULL; } #if (CH_DBG_ENABLE_STACK_CHECK == TRUE) || (CH_CFG_USE_DYNAMIC == TRUE) || \ defined(__DOXYGEN__) /** * @brief Confirms that a working area is being used by some active thread. * @note The reference counter of the found thread is increased by one so * it cannot be disposed incidentally after the pointer has been * returned. * * @param[in] wa pointer to a static working area * @return A pointer to the found thread. * @retval NULL if a matching thread has not been found. * * @api */ thread_t *chRegFindThreadByWorkingArea(stkalign_t *wa) { thread_t *ctp; /* Scanning registry.*/ ctp = chRegFirstThread(); do { if (chThdGetWorkingAreaX(ctp) == wa) { return ctp; } ctp = chRegNextThread(ctp); } while (ctp != NULL); return NULL; } #endif #endif /* CH_CFG_USE_REGISTRY == TRUE */ /** @} */ f='#n147'>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