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 "FreeRTOS.h" 17 #include "pw_function/function.h" 18 #include "pw_span/span.h" 19 #include "pw_status/status.h" 20 #include "task.h" 21 22 namespace pw::thread::freertos { 23 24 // A callback that is executed for each thread when using ForEachThread(). The 25 // callback should return true if thread iteration should continue. When this 26 // callback returns false, ForEachThread() will cease iteration of threads and 27 // return an `Aborted` error code. 28 using ThreadCallback = pw::Function<bool(TaskHandle_t, eTaskState)>; 29 30 // Iterates through all threads that haven't been deleted, calling the provided 31 // callback on each thread. If the callback fails on one thread, the iteration 32 // stops. 33 // 34 // Note: this uses an unsupported method to iterate the threads in a more 35 // efficient manner while also supporting interrupt contexts. This requires 36 // linking against internal statics from theFreeRTOS kernel, 37 // pw_third_party_freertos_DISABLE_TASKS_STATICS must be used. 38 // 39 // Precondition: 40 // vTaskStartScheduler() must be called prior to using this function. 41 // 42 // Returns: 43 // FailedPrecondition - The scheduler has not yet been initialized. 44 // Aborted - The callback requested an early-termination of thread iteration. 45 // OkStatus - Successfully iterated over all threads. 46 // 47 // Warning: This is only safe to use when the scheduler and interrupts are 48 // disabled. 49 Status ForEachThread(const ThreadCallback& cb); 50 51 } // namespace pw::thread::freertos 52