Coverage Report

Created: 2026-04-12 06:30

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/capstonenext/SStream.c
Line
Count
Source
1
/* Capstone Disassembly Engine */
2
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2019 */
3
4
#include <stdarg.h>
5
#if defined(CAPSTONE_HAS_OSXKERNEL)
6
#include <Availability.h>
7
#include <libkern/libkern.h>
8
#include <i386/limits.h>
9
#else
10
#include <stdio.h>
11
#include <limits.h>
12
#endif
13
#include <string.h>
14
15
#include <capstone/platform.h>
16
17
#include "SStream.h"
18
#include "cs_priv.h"
19
#include "utils.h"
20
21
void SStream_Init(SStream *ss)
22
2.10M
{
23
2.10M
  assert(ss);
24
2.10M
  ss->index = 0;
25
2.10M
  memset(ss->buffer, 0, sizeof(ss->buffer));
26
2.10M
  ss->is_closed = false;
27
2.10M
  ss->markup_stream = false;
28
2.10M
  ss->prefixed_by_markup = false;
29
2.10M
  ss->unsigned_num = false;
30
2.10M
}
31
32
void SStream_opt_unum(SStream *ss, bool print_unsigned_numbers)
33
2.03M
{
34
2.03M
  assert(ss);
35
2.03M
  ss->unsigned_num = print_unsigned_numbers;
36
2.03M
}
37
38
/// Returns the a pointer to the internal string buffer of the stream.
39
/// For reading only.
40
const char *SStream_rbuf(const SStream *ss)
41
98.0k
{
42
98.0k
  assert(ss);
43
98.0k
  return ss->buffer;
44
98.0k
}
45
46
/// Searches in the stream for the first (from the left) occurrence of @elem and replaces
47
/// it with @repl. It returns the pointer *after* the replaced character
48
/// or NULL if no character was replaced.
49
///
50
/// It will never replace the final \0 byte in the stream buffer.
51
const char *SStream_replc(const SStream *ss, char elem, char repl)
52
73.0k
{
53
73.0k
  assert(ss);
54
73.0k
  char *found = strchr(ss->buffer, elem);
55
73.0k
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
56
73.0k
    return NULL;
57
73.0k
  }
58
0
  *found = repl;
59
0
  found++;
60
0
  return found;
61
73.0k
}
62
63
/// Searches in the stream for the first (from the left) occurrence of @chr and replaces
64
/// it with @rstr.
65
void SStream_replc_str(SStream *ss, char chr, const char *rstr)
66
24.2k
{
67
24.2k
  assert(ss && rstr);
68
24.2k
  char *found = strchr(ss->buffer, chr);
69
24.2k
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
70
0
    return;
71
0
  }
72
24.2k
  size_t post_len = strlen(found + 1);
73
24.2k
  size_t buf_str_len = strlen(ss->buffer);
74
24.2k
  size_t repl_len = strlen(rstr);
75
24.2k
  if (repl_len - 1 + buf_str_len >= SSTREAM_BUF_LEN) {
76
0
    return;
77
0
  }
78
24.2k
  memmove(found + repl_len, found + 1, post_len);
79
24.2k
  memcpy(found, rstr, repl_len);
80
24.2k
  ss->index = strlen(ss->buffer);
81
24.2k
}
82
83
/// Removes the space characters '\t' and ' ' from the beginning of the stream buffer.
84
void SStream_trimls(SStream *ss)
85
2.10M
{
86
2.10M
  assert(ss);
87
2.10M
  size_t buf_off = 0;
88
  /// Remove leading spaces
89
2.14M
  while (ss->buffer[buf_off] == ' ' || ss->buffer[buf_off] == '\t') {
90
37.8k
    buf_off++;
91
37.8k
  }
92
2.10M
  if (buf_off > 0) {
93
37.8k
    memmove(ss->buffer, ss->buffer + buf_off,
94
37.8k
      SSTREAM_BUF_LEN - buf_off);
95
37.8k
    ss->index -= buf_off;
96
37.8k
  }
97
2.10M
}
98
99
/// Extract the mnemonic to @mnem_buf and the operand string into @op_str_buf from the stream buffer.
100
/// The mnemonic is everything up until the first ' ' or '\t' character.
101
/// The operand string is everything after the first ' ' or '\t' sequence.
102
void SStream_extract_mnem_opstr(const SStream *ss, char *mnem_buf,
103
        size_t mnem_buf_size, char *op_str_buf,
104
        size_t op_str_buf_size)
105
2.03M
{
106
2.03M
  assert(ss && mnem_buf && mnem_buf_size > 0 && op_str_buf &&
107
2.03M
         op_str_buf_size > 0);
108
2.03M
  size_t off = 0;
109
  // Copy all non space chars to as mnemonic.
110
11.5M
  while (ss->buffer[off] && ss->buffer[off] != ' ' &&
111
11.0M
         ss->buffer[off] != '\t') {
112
9.51M
    if (off < mnem_buf_size - 1) {
113
      // Only copy if there is space left.
114
9.51M
      mnem_buf[off] = ss->buffer[off];
115
9.51M
    }
116
9.51M
    off++;
117
9.51M
  }
118
2.03M
  if (!ss->buffer[off]) {
119
105k
    return;
120
105k
  }
121
122
  // Iterate until next non space char.
123
1.93M
  do {
124
1.93M
    off++;
125
1.93M
  } while (ss->buffer[off] &&
126
1.90M
     (ss->buffer[off] == ' ' || ss->buffer[off] == '\t'));
127
128
1.92M
  if (!ss->buffer[off]) {
129
28.2k
    return;
130
28.2k
  }
131
132
  // Copy all follow up characters as op_str
133
1.89M
  const char *ss_op_str = ss->buffer + off;
134
1.89M
  off = 0;
135
27.1M
  while (ss_op_str[off] && off < op_str_buf_size - 1) {
136
25.2M
    op_str_buf[off] = ss_op_str[off];
137
25.2M
    off++;
138
25.2M
  }
139
1.89M
}
140
141
/// Empty the stream @ss to given @file (stdin/stderr).
142
/// @file can be NULL. Then the buffer content is not emitted.
143
void SStream_Flush(SStream *ss, FILE *file)
144
24.6k
{
145
24.6k
  assert(ss);
146
24.6k
  if (file) {
147
0
    fprintf(file, "%s\n", ss->buffer);
148
0
  }
149
24.6k
  SStream_Init(ss);
150
24.6k
}
151
152
/**
153
 * Open the output stream. Every write attempt is accepted again.
154
 */
155
void SStream_Open(SStream *ss)
156
0
{
157
0
  assert(ss);
158
0
  ss->is_closed = false;
159
0
}
160
161
/**
162
 * Closes the output stream. Every write attempt is ignored.
163
 */
164
void SStream_Close(SStream *ss)
165
0
{
166
0
  assert(ss);
167
0
  ss->is_closed = true;
168
0
}
169
170
/**
171
 * Copy the string \p s to the buffer of \p ss and terminate it with a '\\0' byte.
172
 */
173
void SStream_concat0(SStream *ss, const char *s)
174
11.7M
{
175
11.7M
#ifndef CAPSTONE_DIET
176
11.7M
  assert(ss && s);
177
11.7M
  SSTREAM_RETURN_IF_CLOSED(ss);
178
11.7M
  if (s[0] == '\0')
179
3.55M
    return;
180
8.15M
  unsigned int len = (unsigned int)strlen(s);
181
182
8.15M
  SSTREAM_OVERFLOW_CHECK(ss, len);
183
184
8.15M
  memcpy(ss->buffer + ss->index, s, len);
185
8.15M
  ss->index += len;
186
8.15M
  ss->buffer[ss->index] = '\0';
187
8.15M
  if (ss->markup_stream && ss->prefixed_by_markup) {
188
0
    SSTREAM_OVERFLOW_CHECK(ss, 1);
189
0
    ss->buffer[ss->index] = '>';
190
0
    ss->index += 1;
191
0
    ss->buffer[ss->index] = '\0';
192
0
  }
193
#else
194
  ss->buffer[ss->index] = '\0';
195
#endif
196
8.15M
}
197
198
/**
199
 * Copy the single char \p c to the buffer of \p ss.
200
 */
201
void SStream_concat1(SStream *ss, const char c)
202
1.35M
{
203
1.35M
#ifndef CAPSTONE_DIET
204
1.35M
  assert(ss);
205
1.35M
  SSTREAM_RETURN_IF_CLOSED(ss);
206
1.35M
  if (c == '\0')
207
15.3k
    return;
208
209
1.34M
  SSTREAM_OVERFLOW_CHECK(ss, 1);
210
211
1.34M
  ss->buffer[ss->index] = c;
212
1.34M
  ss->index++;
213
1.34M
  ss->buffer[ss->index] = '\0';
214
1.34M
  if (ss->markup_stream && ss->prefixed_by_markup) {
215
0
    SSTREAM_OVERFLOW_CHECK(ss, 1);
216
0
    ss->buffer[ss->index] = '>';
217
0
    ss->index++;
218
0
  }
219
#else
220
  ss->buffer[ss->index] = '\0';
221
#endif
222
1.34M
}
223
224
/**
225
 * Copy all strings given to the buffer of \p ss according to formatting \p fmt.
226
 */
227
void SStream_concat(SStream *ss, const char *fmt, ...)
228
5.15M
{
229
5.15M
#ifndef CAPSTONE_DIET
230
5.15M
  assert(ss && fmt);
231
5.15M
  SSTREAM_RETURN_IF_CLOSED(ss);
232
5.15M
  va_list ap;
233
5.15M
  int ret;
234
235
5.15M
  va_start(ap, fmt);
236
5.15M
  ret = cs_vsnprintf(ss->buffer + ss->index,
237
5.15M
         sizeof(ss->buffer) - (ss->index + 1), fmt, ap);
238
5.15M
  va_end(ap);
239
5.15M
  if (ret < 0) {
240
0
    return;
241
0
  }
242
5.15M
  SSTREAM_OVERFLOW_CHECK(ss, ret);
243
5.15M
  ss->index += ret;
244
5.15M
  if (ss->markup_stream && ss->prefixed_by_markup) {
245
0
    SSTREAM_OVERFLOW_CHECK(ss, 1);
246
0
    ss->buffer[ss->index] = '>';
247
0
    ss->index += 1;
248
0
  }
249
#else
250
  ss->buffer[ss->index] = '\0';
251
#endif
252
5.15M
}
253
254
// print number with prefix #
255
void printInt64Bang(SStream *ss, int64_t val)
256
51.3k
{
257
51.3k
  assert(ss);
258
51.3k
  if (ss->unsigned_num) {
259
0
    printUInt64Bang(ss, val);
260
0
    return;
261
0
  }
262
51.3k
  SSTREAM_RETURN_IF_CLOSED(ss);
263
51.3k
  SStream_concat1(ss, '#');
264
51.3k
  printInt64(ss, val);
265
51.3k
}
266
267
void printUInt64Bang(SStream *ss, uint64_t val)
268
8.26k
{
269
8.26k
  assert(ss);
270
8.26k
  SSTREAM_RETURN_IF_CLOSED(ss);
271
8.26k
  SStream_concat1(ss, '#');
272
8.26k
  printUInt64(ss, val);
273
8.26k
}
274
275
// print number
276
void printInt64(SStream *ss, int64_t val)
277
480k
{
278
480k
  assert(ss);
279
480k
  if (ss->unsigned_num) {
280
0
    printUInt64(ss, val);
281
0
    return;
282
0
  }
283
480k
  SSTREAM_RETURN_IF_CLOSED(ss);
284
480k
  if (val >= 0) {
285
433k
    if (val > HEX_THRESHOLD)
286
273k
      SStream_concat(ss, "0x%" PRIx64, val);
287
159k
    else
288
159k
      SStream_concat(ss, "%" PRIu64, val);
289
433k
  } else {
290
46.8k
    if (val < -HEX_THRESHOLD) {
291
41.6k
      if (val == INT64_MIN)
292
36
        SStream_concat(ss, "-0x%" PRIx64,
293
36
                 (uint64_t)INT64_MAX + 1);
294
41.6k
      else
295
41.6k
        SStream_concat(ss, "-0x%" PRIx64,
296
41.6k
                 (uint64_t)-val);
297
41.6k
    } else
298
5.19k
      SStream_concat(ss, "-%" PRIu64, -val);
299
46.8k
  }
300
480k
}
301
302
void printUInt64(SStream *ss, uint64_t val)
303
127k
{
304
127k
  assert(ss);
305
127k
  SSTREAM_RETURN_IF_CLOSED(ss);
306
127k
  if (val > HEX_THRESHOLD)
307
85.5k
    SStream_concat(ss, "0x%" PRIx64, val);
308
41.5k
  else
309
41.5k
    SStream_concat(ss, "%" PRIu64, val);
310
127k
}
311
312
// print number in decimal mode
313
void printInt32BangDec(SStream *ss, int32_t val)
314
0
{
315
0
  assert(ss);
316
0
  SSTREAM_RETURN_IF_CLOSED(ss);
317
0
  if (val >= 0)
318
0
    SStream_concat(ss, "#%" PRIu32, val);
319
0
  else {
320
0
    if (val == INT32_MIN)
321
0
      SStream_concat(ss, "#-%" PRIu32, val);
322
0
    else
323
0
      SStream_concat(ss, "#-%" PRIu32, (uint32_t)-val);
324
0
  }
325
0
}
326
327
void printInt32Bang(SStream *ss, int32_t val)
328
120k
{
329
120k
  assert(ss);
330
120k
  if (ss->unsigned_num) {
331
0
    printUInt32Bang(ss, val);
332
0
    return;
333
0
  }
334
120k
  SSTREAM_RETURN_IF_CLOSED(ss);
335
120k
  SStream_concat1(ss, '#');
336
120k
  printInt32(ss, val);
337
120k
}
338
339
void printUInt8(SStream *ss, uint8_t val)
340
0
{
341
0
  assert(ss);
342
0
  if (val > HEX_THRESHOLD)
343
0
    SStream_concat(ss, "0x%" PRIx8, val);
344
0
  else
345
0
    SStream_concat(ss, "%" PRIu8, val);
346
0
}
347
348
void printUInt16(SStream *ss, uint16_t val)
349
0
{
350
0
  assert(ss);
351
0
  if (val > HEX_THRESHOLD)
352
0
    SStream_concat(ss, "0x%" PRIx16, val);
353
0
  else
354
0
    SStream_concat(ss, "%" PRIu16, val);
355
0
}
356
357
void printInt8(SStream *ss, int8_t val)
358
1.22k
{
359
1.22k
  assert(ss);
360
1.22k
  if (ss->unsigned_num) {
361
0
    printUInt8(ss, val);
362
0
    return;
363
0
  }
364
1.22k
  SSTREAM_RETURN_IF_CLOSED(ss);
365
1.22k
  if (val >= 0) {
366
925
    if (val > HEX_THRESHOLD)
367
783
      SStream_concat(ss, "0x%" PRIx8, val);
368
142
    else
369
142
      SStream_concat(ss, "%" PRId8, val);
370
925
  } else {
371
304
    if (val < -HEX_THRESHOLD) {
372
152
      if (val == INT8_MIN)
373
20
        SStream_concat(ss, "-0x%" PRIx8,
374
20
                 (uint8_t)INT8_MAX + 1);
375
132
      else
376
132
        SStream_concat(ss, "-0x%" PRIx8, (int8_t)-val);
377
152
    } else
378
152
      SStream_concat(ss, "-%" PRIu8, -val);
379
304
  }
380
1.22k
}
381
382
void printInt16(SStream *ss, int16_t val)
383
1.54k
{
384
1.54k
  assert(ss);
385
1.54k
  if (ss->unsigned_num) {
386
0
    printUInt16(ss, val);
387
0
    return;
388
0
  }
389
1.54k
  SSTREAM_RETURN_IF_CLOSED(ss);
390
1.54k
  if (val >= 0) {
391
1.10k
    if (val > HEX_THRESHOLD)
392
788
      SStream_concat(ss, "0x%" PRIx16, val);
393
315
    else
394
315
      SStream_concat(ss, "%" PRId16, val);
395
1.10k
  } else {
396
442
    if (val < -HEX_THRESHOLD) {
397
408
      if (val == INT16_MIN)
398
16
        SStream_concat(ss, "-0x%" PRIx16,
399
16
                 (uint16_t)INT16_MAX + 1);
400
392
      else
401
392
        SStream_concat(ss, "-0x%" PRIx16,
402
392
                 (int16_t)-val);
403
408
    } else
404
34
      SStream_concat(ss, "-%" PRIu16, -val);
405
442
  }
406
1.54k
}
407
408
void printInt16HexOffset(SStream *ss, int16_t val)
409
3.34k
{
410
3.34k
  assert(ss);
411
3.34k
  if (ss->unsigned_num) {
412
0
    printUInt16(ss, val);
413
0
    return;
414
0
  }
415
3.34k
  SSTREAM_RETURN_IF_CLOSED(ss);
416
3.34k
  if (val >= 0) {
417
2.49k
    SStream_concat(ss, "+0x%" PRIx16, val);
418
2.49k
  } else {
419
854
    if (val == INT16_MIN)
420
7
      SStream_concat(ss, "-0x%" PRIx16,
421
7
               (uint16_t)INT16_MAX + 1);
422
847
    else
423
847
      SStream_concat(ss, "-0x%" PRIx16, (int16_t)-val);
424
854
  }
425
3.34k
}
426
427
void printInt32(SStream *ss, int32_t val)
428
163k
{
429
163k
  assert(ss);
430
163k
  if (ss->unsigned_num) {
431
0
    printUInt32(ss, val);
432
0
    return;
433
0
  }
434
163k
  SSTREAM_RETURN_IF_CLOSED(ss);
435
163k
  if (val >= 0) {
436
123k
    if (val > HEX_THRESHOLD)
437
71.9k
      SStream_concat(ss, "0x%" PRIx32, val);
438
51.2k
    else
439
51.2k
      SStream_concat(ss, "%" PRId32, val);
440
123k
  } else {
441
40.0k
    if (val < -HEX_THRESHOLD) {
442
38.5k
      if (val == INT32_MIN)
443
68
        SStream_concat(ss, "-0x%" PRIx32,
444
68
                 (uint32_t)INT32_MAX + 1);
445
38.4k
      else
446
38.4k
        SStream_concat(ss, "-0x%" PRIx32,
447
38.4k
                 (int32_t)-val);
448
38.5k
    } else {
449
1.54k
      SStream_concat(ss, "-%" PRIu32, (uint32_t)-val);
450
1.54k
    }
451
40.0k
  }
452
163k
}
453
454
void printInt32HexOffset(SStream *ss, int32_t val)
455
557
{
456
557
  assert(ss);
457
557
  if (ss->unsigned_num) {
458
0
    printUInt32(ss, val);
459
0
    return;
460
0
  }
461
557
  SSTREAM_RETURN_IF_CLOSED(ss);
462
557
  if (val >= 0) {
463
459
    SStream_concat(ss, "+0x%" PRIx32, val);
464
459
  } else {
465
98
    if (val == INT32_MIN)
466
8
      SStream_concat(ss, "-0x%" PRIx32,
467
8
               (uint32_t)INT32_MAX + 1);
468
90
    else
469
90
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
470
98
  }
471
557
}
472
473
void printInt32Hex(SStream *ss, int32_t val)
474
2.44k
{
475
2.44k
  assert(ss);
476
2.44k
  SSTREAM_RETURN_IF_CLOSED(ss);
477
2.44k
  if (val >= 0) {
478
1.62k
    SStream_concat(ss, "0x%" PRIx32, val);
479
1.62k
  } else {
480
817
    if (val == INT32_MIN)
481
25
      SStream_concat(ss, "-0x%" PRIx32,
482
25
               (uint32_t)INT32_MAX + 1);
483
792
    else
484
792
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
485
817
  }
486
2.44k
}
487
488
void printUInt32Bang(SStream *ss, uint32_t val)
489
124k
{
490
124k
  assert(ss);
491
124k
  SSTREAM_RETURN_IF_CLOSED(ss);
492
124k
  SStream_concat1(ss, '#');
493
124k
  printUInt32(ss, val);
494
124k
}
495
496
void printUInt32(SStream *ss, uint32_t val)
497
183k
{
498
183k
  assert(ss);
499
183k
  SSTREAM_RETURN_IF_CLOSED(ss);
500
183k
  if (val > HEX_THRESHOLD)
501
141k
    SStream_concat(ss, "0x%x", val);
502
41.9k
  else
503
41.9k
    SStream_concat(ss, "%u", val);
504
183k
}
505
506
void printFloat(SStream *ss, float val)
507
0
{
508
0
  assert(ss);
509
0
  SSTREAM_RETURN_IF_CLOSED(ss);
510
0
  SStream_concat(ss, "%e", val);
511
0
}
512
513
void printfFloat(SStream *ss, const char *fmt, float val)
514
147
{
515
147
  assert(ss);
516
147
  SSTREAM_RETURN_IF_CLOSED(ss);
517
147
  SStream_concat(ss, fmt, val);
518
147
}
519
520
void printFloatBang(SStream *ss, float val)
521
340
{
522
340
  assert(ss);
523
340
  SSTREAM_RETURN_IF_CLOSED(ss);
524
340
  SStream_concat(ss, "#%e", val);
525
340
}
526
527
void printExpr(SStream *ss, uint64_t val)
528
0
{
529
0
  assert(ss);
530
0
  SSTREAM_RETURN_IF_CLOSED(ss);
531
0
  SStream_concat(ss, "%" PRIu64, val);
532
0
}
533
534
SStream *markup_OS(SStream *OS, SStreamMarkup style)
535
492k
{
536
492k
  assert(OS);
537
538
492k
  if (OS->is_closed || !OS->markup_stream) {
539
492k
    return OS;
540
492k
  }
541
0
  OS->markup_stream = false; // Disable temporarily.
542
0
  switch (style) {
543
0
  default:
544
0
    SStream_concat0(OS, "<UNKNOWN:");
545
0
    return OS;
546
0
  case Markup_Immediate:
547
0
    SStream_concat0(OS, "<imm:");
548
0
    break;
549
0
  case Markup_Register:
550
0
    SStream_concat0(OS, "<reg:");
551
0
    break;
552
0
  case Markup_Target:
553
0
    SStream_concat0(OS, "<tar:");
554
0
    break;
555
0
  case Markup_Memory:
556
0
    SStream_concat0(OS, "<mem:");
557
0
    break;
558
0
  }
559
0
  OS->markup_stream = true;
560
  OS->prefixed_by_markup = true;
561
0
  return OS;
562
0
}