├── AUTHORS ├── SConscript ├── readme.md ├── rt_kprintf.c └── LICENSE /AUTHORS: -------------------------------------------------------------------------------- 1 | uCOS-III Wrapper Design & Implementation 2 | - Meco Man 3 | -------------------------------------------------------------------------------- /SConscript: -------------------------------------------------------------------------------- 1 | from building import * 2 | 3 | src = ['rt_kprintf.c'] 4 | 5 | group = DefineGroup('rt_kprintf', src, depend = ['PKG_USING_RT_KPRINTF_THREADSAFE']) 6 | 7 | Return('group') 8 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # 线程安全版本的`rt_kprintf()` 2 | 3 | 原版RT-Thread `kserver.c `文件中的`rt_kprintf()`函数是线程不安全的，这是因为按照ISO C标准，`printf`本身就是线程不安全的。此外，`rt_kprintf` 希望减少过多的依赖，做到简单，以保证在任何环境下都可以正常使用。 4 | 5 | 因此，如果同时有两个线程同时使用`rt_kprintf()`打印数据，可能会导致数据被冲刷掉或者一方的信息根本没有打印出来等一系列奇奇怪怪的问题。比如：https://club.rt-thread.org/ask/question/429525.html 6 | 7 | 关于newlib下使用自带printf函数的问题可以参考这边帖子的评论区：https://club.rt-thread.org/ask/article/2b0a1d202135b205.html 8 | 9 | 本安全版本`rt_kprintf()`函数会自动判断当前所处环境： 10 | 11 | 1. 若RT-Thread尚未启动调度器，则采用没有任何保护的方式； 12 | 13 | 2. 若在中断中调用`rt_kprintf()`，则采用没有任何保护的方式； 14 | 15 | 3. 若在线程中调用`rt_kprintf()`，方可采用线程安全保护措施。 16 | 17 | 1) 若RT-Thread启用互斥量则使用互斥量保护； 18 | 19 | 2) 若RT-Thread没有启用互斥量则退而求其次使用信号量保护； 20 | 21 | 3) 若RT-Thread连信号量(或互斥量)都没有启用，则采用关调度器的方式进行保护。 22 | 23 | 总之，线程安全版本`rt_kprintf()`函数会和原版函数一样可以在任何环境下调用，不会受到影响，使用时和原版`rt_kprintf`无任何区别，用户无感。 24 | 25 | 26 | ## 适用版本 27 | - 4.0.4版本以上**无需屏蔽** `kservice.c` 内的 `rt_kprintf`，因为其弱函数，本软件包会自动覆盖原版`rt_kprintf`。 28 | - 4.0.4以下版本需要手动注释掉 `kservice.c` 内的 `rt_kprintf`函数。 29 | 30 | 31 | ## 如何添加该软件包 32 | 33 | ``` 34 | RT-Thread online packages 35 | system packages ---> 36 | enhanced kernel services ---> 37 | [*] rt_kprintf_threadsafe: thread-safe version of rt_kprintf ---> 38 | Version (latest) ---> 39 | ``` 40 | 41 | 42 | 43 | 44 | ## 维护 45 | 46 | Meco Man 47 | 48 | jiantingman@foxmail.com 49 | -------------------------------------------------------------------------------- /rt_kprintf.c: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2021, Meco Jianting Man 3 | * 4 | * SPDX-License-Identifier: Apache-2.0 5 | * 6 | * Change Logs: 7 | * Date Author Notes 8 | * 2020-12-15 Meco Man first version 9 | */ 10 | 11 | #include 12 | #include 13 | 14 | #ifndef RT_USING_CONSOLE 15 | #error "Please enable console" 16 | #endif 17 | 18 | /** 19 | * This function will print a formatted string on system console (thread safe) 20 | * 21 | * @param fmt the format 22 | */ 23 | #if (RTTHREAD_VERSION >= 40100) || (RTTHREAD_VERSION < 40000 && RTTHREAD_VERSION >= 30106) 24 | int rt_kprintf(const char *fmt, ...) 25 | #else 26 | void rt_kprintf(const char *fmt, ...) 27 | #endif 28 | { 29 | va_list args; 30 | rt_size_t length; 31 | rt_device_t console_dev; 32 | static char rt_console_buf[RT_CONSOLEBUF_SIZE]; 33 | #if defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE 34 | static unsigned char kprintf_init_flag = RT_FALSE; 35 | #if defined RT_USING_MUTEX 36 | static struct rt_mutex kprintf_mutex; 37 | #elif defined RT_USING_SEMAPHORE 38 | static struct rt_semaphore kprintf_sem; 39 | #endif /*defined RT_USING_MUTEX*/ 40 | #endif /*defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE*/ 41 | 42 | if(rt_interrupt_get_nest() == 0u && rt_thread_self() != RT_NULL) 43 | { 44 | #if defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE 45 | if(kprintf_init_flag == RT_FALSE) 46 | { 47 | #if defined RT_USING_MUTEX 48 | rt_mutex_init(&kprintf_mutex, "kprintf", RT_IPC_FLAG_FIFO); 49 | #elif defined RT_USING_SEMAPHORE 50 | rt_sem_init(&kprintf_sem, "kprintf", 1, RT_IPC_FLAG_FIFO); 51 | #endif /*defined RT_USING_MUTEX*/ 52 | kprintf_init_flag = RT_TRUE; 53 | } 54 | #if defined RT_USING_MUTEX 55 | rt_mutex_take(&kprintf_mutex, RT_WAITING_FOREVER); 56 | #elif defined RT_USING_SEMAPHORE 57 | rt_sem_take(&kprintf_sem, RT_WAITING_FOREVER); 58 | #endif /*defined RT_USING_MUTEX*/ 59 | #else 60 | rt_enter_critical(); 61 | #endif /*defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE*/ 62 | } 63 | 64 | console_dev = rt_console_get_device(); 65 | 66 | va_start(args, fmt); 67 | /* the return value of vsnprintf is the number of bytes that would be 68 | * written to buffer had if the size of the buffer been sufficiently 69 | * large excluding the terminating null byte. If the output string 70 | * would be larger than the rt_console_buf, we have to adjust the output 71 | * length. */ 72 | length = rt_vsnprintf(rt_console_buf, sizeof(rt_console_buf) - 1, fmt, args); 73 | if (length > RT_CONSOLEBUF_SIZE - 1) 74 | length = RT_CONSOLEBUF_SIZE - 1; 75 | #ifdef RT_USING_DEVICE 76 | if (console_dev == RT_NULL) 77 | { 78 | rt_hw_console_output(rt_console_buf); 79 | } 80 | else 81 | { 82 | rt_uint16_t old_flag = console_dev->open_flag; 83 | 84 | console_dev->open_flag |= RT_DEVICE_FLAG_STREAM; 85 | rt_device_write(console_dev, 0, rt_console_buf, length); 86 | console_dev->open_flag = old_flag; 87 | } 88 | #else 89 | rt_hw_console_output(rt_console_buf); 90 | #endif /*RT_USING_DEVICE*/ 91 | 92 | va_end(args); 93 | 94 | if(rt_interrupt_get_nest() == 0u && 95 | #if defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE 96 | kprintf_init_flag == RT_TRUE && 97 | #endif 98 | rt_thread_self() != RT_NULL) 99 | { 100 | #if defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE 101 | #if defined RT_USING_MUTEX 102 | rt_mutex_release(&kprintf_mutex); 103 | #elif defined RT_USING_SEMAPHORE 104 | rt_sem_release(&kprintf_sem); 105 | #endif /*defined RT_USING_MUTEX*/ 106 | #else 107 | rt_exit_critical(); 108 | #endif /*defined RT_USING_MUTEX || defined RT_USING_SEMAPHORE*/ 109 | } 110 | 111 | #if (RTTHREAD_VERSION >= 40100) || (RTTHREAD_VERSION < 40000 && RTTHREAD_VERSION >= 30106) 112 | return length; /* the total number of printed characters */ 113 | #endif 114 | } 115 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------