1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "spdk/stdinc.h" 35 36 #include "spdk_internal/log.h" 37 38 static TAILQ_HEAD(, spdk_trace_flag) g_trace_flags = TAILQ_HEAD_INITIALIZER(g_trace_flags); 39 40 enum spdk_log_level g_spdk_log_level = SPDK_LOG_NOTICE; 41 enum spdk_log_level g_spdk_log_print_level = SPDK_LOG_NOTICE; 42 43 SPDK_LOG_REGISTER_COMPONENT("log", SPDK_LOG_LOG) 44 45 #define MAX_TMPBUF 1024 46 47 void 48 spdk_log_set_level(enum spdk_log_level level) 49 { 50 g_spdk_log_level = level; 51 } 52 53 enum spdk_log_level 54 spdk_log_get_level(void) { 55 return g_spdk_log_level; 56 } 57 58 void 59 spdk_log_set_print_level(enum spdk_log_level level) 60 { 61 g_spdk_log_print_level = level; 62 } 63 64 enum spdk_log_level 65 spdk_log_get_print_level(void) { 66 return g_spdk_log_print_level; 67 } 68 69 static struct spdk_trace_flag * 70 get_trace_flag(const char *name) 71 { 72 struct spdk_trace_flag *flag; 73 74 TAILQ_FOREACH(flag, &g_trace_flags, tailq) { 75 if (strcasecmp(name, flag->name) == 0) { 76 return flag; 77 } 78 } 79 80 return NULL; 81 } 82 83 void 84 spdk_log_register_trace_flag(const char *name, struct spdk_trace_flag *flag) 85 { 86 struct spdk_trace_flag *iter; 87 88 if (name == NULL || flag == NULL) { 89 SPDK_ERRLOG("missing spdk_trace_flag parameters\n"); 90 abort(); 91 } 92 93 if (get_trace_flag(name)) { 94 SPDK_ERRLOG("duplicate spdk_trace_flag '%s'\n", name); 95 abort(); 96 } 97 98 TAILQ_FOREACH(iter, &g_trace_flags, tailq) { 99 if (strcasecmp(iter->name, flag->name) > 0) { 100 TAILQ_INSERT_BEFORE(iter, flag, tailq); 101 return; 102 } 103 } 104 105 TAILQ_INSERT_TAIL(&g_trace_flags, flag, tailq); 106 } 107 108 bool 109 spdk_log_get_trace_flag(const char *name) 110 { 111 struct spdk_trace_flag *flag = get_trace_flag(name); 112 113 if (flag && flag->enabled) { 114 return true; 115 } 116 117 return false; 118 } 119 120 static int 121 set_trace_flag(const char *name, bool value) 122 { 123 struct spdk_trace_flag *flag; 124 125 if (strcasecmp(name, "all") == 0) { 126 TAILQ_FOREACH(flag, &g_trace_flags, tailq) { 127 flag->enabled = value; 128 } 129 return 0; 130 } 131 132 flag = get_trace_flag(name); 133 if (flag == NULL) { 134 return -1; 135 } 136 137 flag->enabled = value; 138 139 return 0; 140 } 141 142 int 143 spdk_log_set_trace_flag(const char *name) 144 { 145 return set_trace_flag(name, true); 146 } 147 148 int 149 spdk_log_clear_trace_flag(const char *name) 150 { 151 return set_trace_flag(name, false); 152 } 153 154 struct spdk_trace_flag * 155 spdk_log_get_first_trace_flag(void) 156 { 157 return TAILQ_FIRST(&g_trace_flags); 158 } 159 160 struct spdk_trace_flag * 161 spdk_log_get_next_trace_flag(struct spdk_trace_flag *flag) 162 { 163 return TAILQ_NEXT(flag, tailq); 164 } 165 166 void 167 spdk_tracelog_usage(FILE *f, const char *trace_arg) 168 { 169 #ifdef DEBUG 170 struct spdk_trace_flag *flag; 171 172 fprintf(f, " %s flag enable trace flag (all", trace_arg); 173 174 TAILQ_FOREACH(flag, &g_trace_flags, tailq) { 175 fprintf(f, ", %s", flag->name); 176 } 177 178 fprintf(f, ")\n"); 179 #else 180 fprintf(f, " %s flag enable trace flag (not supported - must rebuild with CONFIG_DEBUG=y)\n", 181 trace_arg); 182 #endif 183 } 184