1 // Copyright 2021 The Pigweed Authors 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); you may not 4 // use this file except in compliance with the License. You may obtain a copy of 5 // the License at 6 // 7 // https://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 // License for the specific language governing permissions and limitations under 13 // the License. 14 #pragma once 15 16 #include <span> 17 18 #include "FreeRTOS.h" 19 #include "pw_function/function.h" 20 #include "pw_status/status.h" 21 #include "task.h" 22 23 namespace pw::thread::freertos { 24 25 // A callback that is executed for each thread when using ForEachThread(). The 26 // callback should return true if thread iteration should continue. When this 27 // callback returns false, ForEachThread() will cease iteration of threads and 28 // return an `Aborted` error code. 29 using ThreadCallback = pw::Function<bool(TaskHandle_t, eTaskState)>; 30 31 // Iterates through all threads that haven't been deleted, calling the provided 32 // callback on each thread. If the callback fails on one thread, the iteration 33 // stops. 34 // 35 // Note: this uses an unsupported method to iterate the threads in a more 36 // efficient manner while also supporting interrupt contexts. This requires 37 // linking against internal statics from theFreeRTOS kernel, 38 // pw_third_party_freertos_DISABLE_TASKS_STATICS must be used. 39 // 40 // Precondition: 41 // vTaskStartScheduler() must be called prior to using this function. 42 // 43 // Returns: 44 // FailedPrecondition - The scheduler has not yet been initialized. 45 // Aborted - The callback requested an early-termination of thread iteration. 46 // OkStatus - Successfully iterated over all threads. 47 // 48 // Warning: This is only safe to use when the scheduler and interrupts are 49 // disabled. 50 Status ForEachThread(const ThreadCallback& cb); 51 52 } // namespace pw::thread::freertos 53