netdata/src/libnetdata/dictionary/dictionary-debug.c at master · netdata/netdata · GitHub

History

378 lines (320 loc) · 14.5 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

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

// SPDX-License-Identifier: GPL-3.0-or-later

#include "dictionary-internals.h"

#if defined(FSANITIZE_ADDRESS)

// Judyl for tracking all dictionaries ever created

static SPINLOCK all_dictionaries_spinlock = SPINLOCK_INITIALIZER;

static Pvoid_t all_dictionaries = NULL;

static bool all_dictionaries_initialized = false;

// Initialize the tracking system

static void all_dictionaries_initialize(void) {

// Only do this once

if (all_dictionaries_initialized)

return;

spinlock_lock(&all_dictionaries_spinlock);

if (!all_dictionaries_initialized) {

all_dictionaries = NULL;

all_dictionaries_initialized = true;

}

spinlock_unlock(&all_dictionaries_spinlock);

}

// Comparison function for sorting stacktraces by count (descending)

static int stacktrace_count_compare(const void *a, const void *b) {

typedef struct {

STACKTRACE stacktrace;

Word_t count;

} StacktraceInfo;

const StacktraceInfo *sta = (const StacktraceInfo *)a;

const StacktraceInfo *stb = (const StacktraceInfo *)b;

if (stb->count > sta->count) return 1;

if (stb->count < sta->count) return -1;

return 0;

}

// Report all allocated dictionaries that are not part of the destroyed list

static size_t report_allocated_dictionaries(void) {

// Ensure initialization

if (!all_dictionaries_initialized)

all_dictionaries_initialize();

spinlock_lock(&all_dictionaries_spinlock);

Word_t index = 0;

Pvoid_t PValue;

Word_t count = 0;

// First count dictionaries

PValue = JudyLFirst(all_dictionaries, &index, PJE0);

while (PValue != NULL) {

count++;

PValue = JudyLNext(all_dictionaries, &index, PJE0);

}

if (count > 0) {

fprintf(stderr, "\nASAN: ===== DICTIONARY TRACKING: Detected %lu dictionaries that are still allocated =====\n", count);

fflush(stderr);

// First, group by stacktrace

// Key: stacktrace pointer, Value: count

Pvoid_t stacktrace_counts = NULL;

// Key: stacktrace pointer, Value: array of dictionary pointers

Pvoid_t stacktrace_dictionaries = NULL;

// Group dictionaries by stacktrace

index = 0;

PValue = JudyLFirst(all_dictionaries, &index, PJE0);

while (PValue != NULL) {

DICTIONARY *dict = (DICTIONARY *)index;

// Process each stacktrace in the array

for (int st_idx = 0; st_idx < dict->stacktraces.num_stacktraces; st_idx++) {

STACKTRACE st = dict->stacktraces.stacktraces[st_idx];

if (st) {

Word_t st_key = (Word_t)st;

// Update count for this stacktrace

Pvoid_t PCount;

PCount = JudyLIns(&stacktrace_counts, st_key, PJE0);

if (PCount) {

(*(Word_t*)PCount)++;

} else {

*(Word_t*)PCount = 1;

}

// Add dictionary to the list for this stacktrace

Pvoid_t PDictList;

PDictList = JudyLGet(stacktrace_dictionaries, st_key, PJE0);

if (!PDictList) {

// Create a new array (starting with size 1024)

DICTIONARY **dict_list = (DICTIONARY **)callocz(1024, sizeof(DICTIONARY*));

if (dict_list) {

dict_list[0] = dict;

JudyLIns(&stacktrace_dictionaries, st_key, PJE0);

PDictList = JudyLGet(stacktrace_dictionaries, st_key, PJE0);

if (PDictList) {

*(void**)PDictList = dict_list;

}

} else {

// Add to existing array if not already present

DICTIONARY **dict_list = *(DICTIONARY***)PDictList;

bool already_added = false;

size_t i = 0;

// Check if dictionary is already in this list

while (i < 1024 && dict_list[i]) {

if (dict_list[i] == dict) {

already_added = true;

break;

}

i++;

}

// Add if not already present

if (!already_added && i < 1024) {

dict_list[i] = dict;

}

PValue = JudyLNext(all_dictionaries, &index, PJE0);

}

// Now build a sorted array of stacktraces

// Use the StacktraceInfo type defined for the comparator

typedef struct {

STACKTRACE stacktrace;

Word_t count;

} StacktraceInfo;

Word_t num_stacktraces = 0;

// Count stacktraces

index = 0;

PValue = JudyLFirst(stacktrace_counts, &index, PJE0);

while (PValue != NULL) {

num_stacktraces++;

PValue = JudyLNext(stacktrace_counts, &index, PJE0);

}

if (num_stacktraces > 0) {

StacktraceInfo *stacktraces = (StacktraceInfo *)callocz(num_stacktraces, sizeof(StacktraceInfo));

if (stacktraces) {

// Fill array

Word_t i = 0;

index = 0;

PValue = JudyLFirst(stacktrace_counts, &index, PJE0);

while (PValue != NULL) {

stacktraces[i].stacktrace = (STACKTRACE)index;

stacktraces[i].count = *(Word_t*)PValue;

i++;

PValue = JudyLNext(stacktrace_counts, &index, PJE0);

}

// Sort by count (descending)

qsort(stacktraces, num_stacktraces, sizeof(StacktraceInfo), stacktrace_count_compare);

// Print stacktraces in order

for (i = 0; i < num_stacktraces; i++) {

STACKTRACE st = stacktraces[i].stacktrace;

Word_t st_count = stacktraces[i].count;

fprintf(stderr, "\n > DICTIONARY STACKTRACE GROUP %lu/%lu (count: %lu):\n",

i+1, num_stacktraces, st_count);

fflush(stderr);

// Print stacktrace

BUFFER *wb = buffer_create(16384, NULL);

stacktrace_to_buffer(st, wb);

fprintf(stderr, "%s\n", buffer_tostring(wb));

buffer_free(wb);

fflush(stderr);

// Print dictionary pointers

Pvoid_t PDictList = JudyLGet(stacktrace_dictionaries, (Word_t)st, PJE0);

if (PDictList) {

DICTIONARY **dict_list = *(DICTIONARY***)PDictList;

fprintf(stderr, " Dictionary pointers:");

int displayed = 0;

for (int j = 0; j < 1024 && dict_list[j] && displayed < 10; j++) {

fprintf(stderr, " %p", dict_list[j]);

displayed++;

}

if (st_count > 10) {

fprintf(stderr, " ... (plus %lu more)", st_count - 10);

}

fprintf(stderr, "\n");

fflush(stderr);

}

freez(stacktraces);

}

// Clean up

index = 0;

PValue = JudyLFirst(stacktrace_dictionaries, &index, PJE0);

while (PValue != NULL) {

freez(*(void**)PValue);

PValue = JudyLNext(stacktrace_dictionaries, &index, PJE0);

}

JudyLFreeArray(&stacktrace_dictionaries, PJE0);

JudyLFreeArray(&stacktrace_counts, PJE0);

}

else {

fprintf(stderr, "\nASAN: ===== DICTIONARY TRACKING: No allocated dictionaries found =====\n");

fflush(stderr);

}

spinlock_unlock(&all_dictionaries_spinlock);

return count;

}

/**

* @brief Print information about dictionaries that have delayed destruction

* This function is called during shutdown to print information about dictionaries that

* could not be destroyed because they have referenced items

void dictionary_debug_print_delayed_dictionaries(size_t destroyed_dicts) {

if (destroyed_dicts > 0) {

fprintf(stderr, "\nASAN: ===== DICTIONARY TRACKING: %zu dictionaries with references couldn't be destroyed =====\n",

destroyed_dicts);

fflush(stderr);

}

// Public API functions

void dictionary_debug_init(void) {

all_dictionaries_initialize();

}

void dictionary_debug_track_dict(DICTIONARY *dict) {

// Make sure we're initialized

if (!all_dictionaries_initialized)

all_dictionaries_initialize();

spinlock_lock(&all_dictionaries_spinlock);

// No need to capture return value

JudyLIns(&all_dictionaries, (Word_t)dict, PJE0);

spinlock_unlock(&all_dictionaries_spinlock);

}

void dictionary_debug_untrack_dict(DICTIONARY *dict) {

// Only attempt to untrack if we've initialized the tracking

if (!all_dictionaries_initialized)

return;

spinlock_lock(&all_dictionaries_spinlock);

// No need to capture return value

JudyLDel(&all_dictionaries, (Word_t)dict, PJE0);

spinlock_unlock(&all_dictionaries_spinlock);

}

void dictionary_print_still_allocated_stacktraces(void) {

size_t allocated = report_allocated_dictionaries();

if (allocated > 0) {

fprintf(stderr, "\nASAN: ===== DICTIONARY TRACKING: Found %zu dictionaries that are still allocated but not in the destroyed list =====\n",

allocated);

fflush(stderr);

}

void dictionary_debug_shutdown(void) {

if (!all_dictionaries_initialized)

return;

spinlock_lock(&all_dictionaries_spinlock);

JudyLFreeArray(&all_dictionaries, PJE0);

spinlock_unlock(&all_dictionaries_spinlock);

}

void dictionary_debug_internal_check_with_trace(DICTIONARY *dict, DICTIONARY_ITEM *item, const char *function, bool allow_null_dict, bool allow_null_item) {

if(!allow_null_dict && !dict) {

// Create a buffer for the item's dict stacktrace

BUFFER *wb = buffer_create(1024, NULL);

if (item && item->dict && item->dict->stacktraces.num_stacktraces > 0) {

buffer_strcat(wb, "\nItem's dictionary stacktraces:\n");

for (int i = 0; i < item->dict->stacktraces.num_stacktraces && i < 3; i++) {

if (item->dict->stacktraces.stacktraces[i]) {

buffer_sprintf(wb, "Stacktrace #%d:\n", i+1);

stacktrace_to_buffer(item->dict->stacktraces.stacktraces[i], wb);

buffer_strcat(wb, "\n");

}

if (item->dict->stacktraces.num_stacktraces > 3)

buffer_sprintf(wb, "...and %d more stacktraces\n", item->dict->stacktraces.num_stacktraces - 3);

} else {

buffer_strcat(wb, "\nItem's dictionary stacktrace not available");

}

internal_error(

item,

"DICTIONARY: attempted to %s() with a NULL dictionary, passing an item. %s",

function,

buffer_tostring(wb));

buffer_free(wb);

fatal("DICTIONARY: attempted to %s() but dict is NULL", function);

}

if(!allow_null_item && !item) {

dictionary_internal_error(true, dict,

"DICTIONARY: attempted to %s() without an item on a dictionary",

function);

fatal("DICTIONARY: attempted to %s() but item is NULL", function);

}

if(dict && item && dict != item->dict) {

// Create buffer for both dictionaries' stacktraces

BUFFER *wb = buffer_create(1024, NULL);

if (dict->stacktraces.num_stacktraces > 0) {

buffer_strcat(wb, "\nDictionary stacktraces:\n");

for (int i = 0; i < dict->stacktraces.num_stacktraces && i < 3; i++) {

if (dict->stacktraces.stacktraces[i]) {

buffer_sprintf(wb, "Stacktrace #%d:\n", i+1);

stacktrace_to_buffer(dict->stacktraces.stacktraces[i], wb);

buffer_strcat(wb, "\n");

}

if (dict->stacktraces.num_stacktraces > 3)

buffer_sprintf(wb, "...and %d more stacktraces\n", dict->stacktraces.num_stacktraces - 3);

} else {

buffer_strcat(wb, "\nDictionary stacktrace not available");

}

if (item->dict && item->dict->stacktraces.num_stacktraces > 0) {

buffer_strcat(wb, "\nItem's dictionary stacktraces:\n");

for (int i = 0; i < item->dict->stacktraces.num_stacktraces && i < 3; i++) {

if (item->dict->stacktraces.stacktraces[i]) {

buffer_sprintf(wb, "Stacktrace #%d:\n", i+1);

stacktrace_to_buffer(item->dict->stacktraces.stacktraces[i], wb);

buffer_strcat(wb, "\n");

}

if (item->dict->stacktraces.num_stacktraces > 3)

buffer_sprintf(wb, "...and %d more stacktraces\n", item->dict->stacktraces.num_stacktraces - 3);

} else {

buffer_strcat(wb, "\nItem's dictionary stacktrace not available");

}

internal_error(

true,

"DICTIONARY: attempted to %s() an item on a dictionary different from the item's dictionary. %s",

function,

buffer_tostring(wb));

buffer_free(wb);

fatal("DICTIONARY: %s(): item does not belong to this dictionary.", function);

}

if(item) {

REFCOUNT refcount = DICTIONARY_ITEM_REFCOUNT_GET(dict, item);

if (unlikely(refcount <= 0)) {

dictionary_internal_error(true, item->dict,

"DICTIONARY: attempted to %s() of an item with reference counter = %d on a dictionary",

function,

refcount);

fatal("DICTIONARY: attempted to %s but item is having refcount = %d", function, refcount);

}

#endif // FSANITIZE_ADDRESS

netdata/src/libnetdata/dictionary/dictionary-debug.c at master · netdata/netdata · GitHub

Uh oh!

Expand file tree

Breadcrumbs

dictionary-debug.c

Latest commit

History

Breadcrumbs

dictionary-debug.c

File metadata and controls