Coverage Report

Created: 2025-10-10 06:20

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
1.16M
{
23
1.16M
  assert(ss);
24
1.16M
  ss->index = 0;
25
1.16M
  memset(ss->buffer, 0, sizeof(ss->buffer));
26
1.16M
  ss->is_closed = false;
27
1.16M
  ss->markup_stream = false;
28
1.16M
  ss->prefixed_by_markup = false;
29
1.16M
  ss->unsigned_num = false;
30
1.16M
}
31
32
void SStream_opt_unum(SStream *ss, bool print_unsigned_numbers)
33
1.12M
{
34
1.12M
  assert(ss);
35
1.12M
  ss->unsigned_num = print_unsigned_numbers;
36
1.12M
}
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
57.9k
{
42
57.9k
  assert(ss);
43
57.9k
  return ss->buffer;
44
57.9k
}
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
36.8k
{
53
36.8k
  assert(ss);
54
36.8k
  char *found = strchr(ss->buffer, elem);
55
36.8k
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
56
36.8k
    return NULL;
57
36.8k
  }
58
0
  *found = repl;
59
0
  found++;
60
0
  return found;
61
36.8k
}
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
14.3k
{
67
14.3k
  assert(ss && rstr);
68
14.3k
  char *found = strchr(ss->buffer, chr);
69
14.3k
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
70
0
    return;
71
0
  }
72
14.3k
  size_t post_len = strlen(found + 1);
73
14.3k
  size_t buf_str_len = strlen(ss->buffer);
74
14.3k
  size_t repl_len = strlen(rstr);
75
14.3k
  if (repl_len - 1 + buf_str_len >= SSTREAM_BUF_LEN) {
76
0
    return;
77
0
  }
78
14.3k
  memmove(found + repl_len, found + 1, post_len);
79
14.3k
  memcpy(found, rstr, repl_len);
80
14.3k
  ss->index = strlen(ss->buffer);
81
14.3k
}
82
83
/// Removes the space characters '\t' and ' ' from the beginning of the stream buffer.
84
void SStream_trimls(SStream *ss)
85
1.16M
{
86
1.16M
  assert(ss);
87
1.16M
  size_t buf_off = 0;
88
  /// Remove leading spaces
89
1.18M
  while (ss->buffer[buf_off] == ' ' || ss->buffer[buf_off] == '\t') {
90
23.7k
    buf_off++;
91
23.7k
  }
92
1.16M
  if (buf_off > 0) {
93
23.7k
    memmove(ss->buffer, ss->buffer + buf_off,
94
23.7k
      SSTREAM_BUF_LEN - buf_off);
95
23.7k
    ss->index -= buf_off;
96
23.7k
  }
97
1.16M
}
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
1.12M
{
106
1.12M
  assert(ss && mnem_buf && mnem_buf_size > 0 && op_str_buf &&
107
1.12M
         op_str_buf_size > 0);
108
1.12M
  size_t off = 0;
109
  // Copy all non space chars to as mnemonic.
110
6.56M
  while (ss->buffer[off] && ss->buffer[off] != ' ' &&
111
6.32M
         ss->buffer[off] != '\t') {
112
5.43M
    if (off < mnem_buf_size - 1) {
113
      // Only copy if there is space left.
114
5.43M
      mnem_buf[off] = ss->buffer[off];
115
5.43M
    }
116
5.43M
    off++;
117
5.43M
  }
118
1.12M
  if (!ss->buffer[off]) {
119
43.3k
    return;
120
43.3k
  }
121
122
  // Iterate until next non space char.
123
1.08M
  do {
124
1.08M
    off++;
125
1.08M
  } while (ss->buffer[off] &&
126
1.07M
     (ss->buffer[off] == ' ' || ss->buffer[off] == '\t'));
127
128
1.08M
  if (!ss->buffer[off]) {
129
11.2k
    return;
130
11.2k
  }
131
132
  // Copy all follow up characters as op_str
133
1.07M
  const char *ss_op_str = ss->buffer + off;
134
1.07M
  off = 0;
135
15.9M
  while (ss_op_str[off] && off < op_str_buf_size - 1) {
136
14.9M
    op_str_buf[off] = ss_op_str[off];
137
14.9M
    off++;
138
14.9M
  }
139
1.07M
}
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
14.5k
{
145
14.5k
  assert(ss);
146
14.5k
  if (file) {
147
0
    fprintf(file, "%s\n", ss->buffer);
148
0
  }
149
14.5k
  SStream_Init(ss);
150
14.5k
}
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
6.90M
{
175
6.90M
#ifndef CAPSTONE_DIET
176
6.90M
  assert(ss && s);
177
6.90M
  SSTREAM_RETURN_IF_CLOSED(ss);
178
6.90M
  if (s[0] == '\0')
179
2.16M
    return;
180
4.73M
  unsigned int len = (unsigned int)strlen(s);
181
182
4.73M
  SSTREAM_OVERFLOW_CHECK(ss, len);
183
184
4.73M
  memcpy(ss->buffer + ss->index, s, len);
185
4.73M
  ss->index += len;
186
4.73M
  ss->buffer[ss->index] = '\0';
187
4.73M
  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
4.73M
}
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
865k
{
203
865k
#ifndef CAPSTONE_DIET
204
865k
  assert(ss);
205
865k
  SSTREAM_RETURN_IF_CLOSED(ss);
206
865k
  if (c == '\0')
207
9.47k
    return;
208
209
856k
  SSTREAM_OVERFLOW_CHECK(ss, 1);
210
211
856k
  ss->buffer[ss->index] = c;
212
856k
  ss->index++;
213
856k
  ss->buffer[ss->index] = '\0';
214
856k
  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
856k
}
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
3.02M
{
229
3.02M
#ifndef CAPSTONE_DIET
230
3.02M
  assert(ss && fmt);
231
3.02M
  SSTREAM_RETURN_IF_CLOSED(ss);
232
3.02M
  va_list ap;
233
3.02M
  int ret;
234
235
3.02M
  va_start(ap, fmt);
236
3.02M
  ret = cs_vsnprintf(ss->buffer + ss->index,
237
3.02M
         sizeof(ss->buffer) - (ss->index + 1), fmt, ap);
238
3.02M
  va_end(ap);
239
3.02M
  ss->index += ret;
240
3.02M
  if (ss->markup_stream && ss->prefixed_by_markup) {
241
0
    SSTREAM_OVERFLOW_CHECK(ss, 1);
242
0
    ss->buffer[ss->index] = '>';
243
0
    ss->index += 1;
244
0
  }
245
#else
246
  ss->buffer[ss->index] = '\0';
247
#endif
248
3.02M
}
249
250
// print number with prefix #
251
void printInt64Bang(SStream *ss, int64_t val)
252
34.1k
{
253
34.1k
  assert(ss);
254
34.1k
  if (ss->unsigned_num) {
255
0
    printUInt64Bang(ss, val);
256
0
    return;
257
0
  }
258
34.1k
  SSTREAM_RETURN_IF_CLOSED(ss);
259
34.1k
  SStream_concat1(ss, '#');
260
34.1k
  printInt64(ss, val);
261
34.1k
}
262
263
void printUInt64Bang(SStream *ss, uint64_t val)
264
3.93k
{
265
3.93k
  assert(ss);
266
3.93k
  SSTREAM_RETURN_IF_CLOSED(ss);
267
3.93k
  SStream_concat1(ss, '#');
268
3.93k
  printUInt64(ss, val);
269
3.93k
}
270
271
// print number
272
void printInt64(SStream *ss, int64_t val)
273
281k
{
274
281k
  assert(ss);
275
281k
  if (ss->unsigned_num) {
276
0
    printUInt64(ss, val);
277
0
    return;
278
0
  }
279
281k
  SSTREAM_RETURN_IF_CLOSED(ss);
280
281k
  if (val >= 0) {
281
260k
    if (val > HEX_THRESHOLD)
282
156k
      SStream_concat(ss, "0x%" PRIx64, val);
283
104k
    else
284
104k
      SStream_concat(ss, "%" PRIu64, val);
285
260k
  } else {
286
20.9k
    if (val < -HEX_THRESHOLD) {
287
19.2k
      if (val == INT64_MIN)
288
61
        SStream_concat(ss, "-0x%" PRIx64,
289
61
                 (uint64_t)INT64_MAX + 1);
290
19.1k
      else
291
19.1k
        SStream_concat(ss, "-0x%" PRIx64,
292
19.1k
                 (uint64_t)-val);
293
19.2k
    } else
294
1.73k
      SStream_concat(ss, "-%" PRIu64, -val);
295
20.9k
  }
296
281k
}
297
298
void printUInt64(SStream *ss, uint64_t val)
299
77.9k
{
300
77.9k
  assert(ss);
301
77.9k
  SSTREAM_RETURN_IF_CLOSED(ss);
302
77.9k
  if (val > HEX_THRESHOLD)
303
46.8k
    SStream_concat(ss, "0x%" PRIx64, val);
304
31.1k
  else
305
31.1k
    SStream_concat(ss, "%" PRIu64, val);
306
77.9k
}
307
308
// print number in decimal mode
309
void printInt32BangDec(SStream *ss, int32_t val)
310
0
{
311
0
  assert(ss);
312
0
  SSTREAM_RETURN_IF_CLOSED(ss);
313
0
  if (val >= 0)
314
0
    SStream_concat(ss, "#%" PRIu32, val);
315
0
  else {
316
0
    if (val == INT32_MIN)
317
0
      SStream_concat(ss, "#-%" PRIu32, val);
318
0
    else
319
0
      SStream_concat(ss, "#-%" PRIu32, (uint32_t)-val);
320
0
  }
321
0
}
322
323
void printInt32Bang(SStream *ss, int32_t val)
324
74.8k
{
325
74.8k
  assert(ss);
326
74.8k
  if (ss->unsigned_num) {
327
0
    printUInt32Bang(ss, val);
328
0
    return;
329
0
  }
330
74.8k
  SSTREAM_RETURN_IF_CLOSED(ss);
331
74.8k
  SStream_concat1(ss, '#');
332
74.8k
  printInt32(ss, val);
333
74.8k
}
334
335
void printUInt8(SStream *ss, uint8_t val)
336
0
{
337
0
  assert(ss);
338
0
  if (val > HEX_THRESHOLD)
339
0
    SStream_concat(ss, "0x%" PRIx8, val);
340
0
  else
341
0
    SStream_concat(ss, "%" PRIu8, val);
342
0
}
343
344
void printUInt16(SStream *ss, uint16_t val)
345
0
{
346
0
  assert(ss);
347
0
  if (val > HEX_THRESHOLD)
348
0
    SStream_concat(ss, "0x%" PRIx16, val);
349
0
  else
350
0
    SStream_concat(ss, "%" PRIu16, val);
351
0
}
352
353
void printInt8(SStream *ss, int8_t val)
354
896
{
355
896
  assert(ss);
356
896
  if (ss->unsigned_num) {
357
0
    printUInt8(ss, val);
358
0
    return;
359
0
  }
360
896
  SSTREAM_RETURN_IF_CLOSED(ss);
361
896
  if (val >= 0) {
362
346
    if (val > HEX_THRESHOLD)
363
236
      SStream_concat(ss, "0x%" PRIx8, val);
364
110
    else
365
110
      SStream_concat(ss, "%" PRId8, val);
366
550
  } else {
367
550
    if (val < -HEX_THRESHOLD) {
368
160
      if (val == INT8_MIN)
369
21
        SStream_concat(ss, "-0x%" PRIx8,
370
21
                 (uint8_t)INT8_MAX + 1);
371
139
      else
372
139
        SStream_concat(ss, "-0x%" PRIx8, (int8_t)-val);
373
160
    } else
374
390
      SStream_concat(ss, "-%" PRIu8, -val);
375
550
  }
376
896
}
377
378
void printInt16(SStream *ss, int16_t val)
379
1.14k
{
380
1.14k
  assert(ss);
381
1.14k
  if (ss->unsigned_num) {
382
0
    printUInt16(ss, val);
383
0
    return;
384
0
  }
385
1.14k
  SSTREAM_RETURN_IF_CLOSED(ss);
386
1.14k
  if (val >= 0) {
387
848
    if (val > HEX_THRESHOLD)
388
549
      SStream_concat(ss, "0x%" PRIx16, val);
389
299
    else
390
299
      SStream_concat(ss, "%" PRId16, val);
391
848
  } else {
392
300
    if (val < -HEX_THRESHOLD) {
393
292
      if (val == INT16_MIN)
394
17
        SStream_concat(ss, "-0x%" PRIx16,
395
17
                 (uint16_t)INT16_MAX + 1);
396
275
      else
397
275
        SStream_concat(ss, "-0x%" PRIx16,
398
275
                 (int16_t)-val);
399
292
    } else
400
8
      SStream_concat(ss, "-%" PRIu16, -val);
401
300
  }
402
1.14k
}
403
404
void printInt16HexOffset(SStream *ss, int16_t val)
405
2.18k
{
406
2.18k
  assert(ss);
407
2.18k
  if (ss->unsigned_num) {
408
0
    printUInt16(ss, val);
409
0
    return;
410
0
  }
411
2.18k
  SSTREAM_RETURN_IF_CLOSED(ss);
412
2.18k
  if (val >= 0) {
413
1.87k
    SStream_concat(ss, "+0x%" PRIx16, val);
414
1.87k
  } else {
415
311
    if (val == INT16_MIN)
416
13
      SStream_concat(ss, "-0x%" PRIx16,
417
13
               (uint16_t)INT16_MAX + 1);
418
298
    else
419
298
      SStream_concat(ss, "-0x%" PRIx16, (int16_t)-val);
420
311
  }
421
2.18k
}
422
423
void printInt32(SStream *ss, int32_t val)
424
100k
{
425
100k
  assert(ss);
426
100k
  if (ss->unsigned_num) {
427
0
    printUInt32(ss, val);
428
0
    return;
429
0
  }
430
100k
  SSTREAM_RETURN_IF_CLOSED(ss);
431
100k
  if (val >= 0) {
432
75.7k
    if (val > HEX_THRESHOLD)
433
43.6k
      SStream_concat(ss, "0x%" PRIx32, val);
434
32.0k
    else
435
32.0k
      SStream_concat(ss, "%" PRId32, val);
436
75.7k
  } else {
437
25.2k
    if (val < -HEX_THRESHOLD) {
438
23.4k
      if (val == INT32_MIN)
439
49
        SStream_concat(ss, "-0x%" PRIx32,
440
49
                 (uint32_t)INT32_MAX + 1);
441
23.3k
      else
442
23.3k
        SStream_concat(ss, "-0x%" PRIx32,
443
23.3k
                 (int32_t)-val);
444
23.4k
    } else {
445
1.81k
      SStream_concat(ss, "-%" PRIu32, (uint32_t)-val);
446
1.81k
    }
447
25.2k
  }
448
100k
}
449
450
void printInt32HexOffset(SStream *ss, int32_t val)
451
453
{
452
453
  assert(ss);
453
453
  if (ss->unsigned_num) {
454
0
    printUInt32(ss, val);
455
0
    return;
456
0
  }
457
453
  SSTREAM_RETURN_IF_CLOSED(ss);
458
453
  if (val >= 0) {
459
414
    SStream_concat(ss, "+0x%" PRIx32, val);
460
414
  } else {
461
39
    if (val == INT32_MIN)
462
3
      SStream_concat(ss, "-0x%" PRIx32,
463
3
               (uint32_t)INT32_MAX + 1);
464
36
    else
465
36
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
466
39
  }
467
453
}
468
469
void printInt32Hex(SStream *ss, int32_t val)
470
1.32k
{
471
1.32k
  assert(ss);
472
1.32k
  SSTREAM_RETURN_IF_CLOSED(ss);
473
1.32k
  if (val >= 0) {
474
1.00k
    SStream_concat(ss, "0x%" PRIx32, val);
475
1.00k
  } else {
476
323
    if (val == INT32_MIN)
477
10
      SStream_concat(ss, "-0x%" PRIx32,
478
10
               (uint32_t)INT32_MAX + 1);
479
313
    else
480
313
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
481
323
  }
482
1.32k
}
483
484
void printUInt32Bang(SStream *ss, uint32_t val)
485
72.9k
{
486
72.9k
  assert(ss);
487
72.9k
  SSTREAM_RETURN_IF_CLOSED(ss);
488
72.9k
  SStream_concat1(ss, '#');
489
72.9k
  printUInt32(ss, val);
490
72.9k
}
491
492
void printUInt32(SStream *ss, uint32_t val)
493
108k
{
494
108k
  assert(ss);
495
108k
  SSTREAM_RETURN_IF_CLOSED(ss);
496
108k
  if (val > HEX_THRESHOLD)
497
80.9k
    SStream_concat(ss, "0x%x", val);
498
27.9k
  else
499
27.9k
    SStream_concat(ss, "%u", val);
500
108k
}
501
502
void printFloat(SStream *ss, float val)
503
0
{
504
0
  assert(ss);
505
0
  SSTREAM_RETURN_IF_CLOSED(ss);
506
0
  SStream_concat(ss, "%e", val);
507
0
}
508
509
void printFloatBang(SStream *ss, float val)
510
257
{
511
257
  assert(ss);
512
257
  SSTREAM_RETURN_IF_CLOSED(ss);
513
257
  SStream_concat(ss, "#%e", val);
514
257
}
515
516
void printExpr(SStream *ss, uint64_t val)
517
0
{
518
0
  assert(ss);
519
0
  SSTREAM_RETURN_IF_CLOSED(ss);
520
0
  SStream_concat(ss, "%" PRIu64, val);
521
0
}
522
523
SStream *markup_OS(SStream *OS, SStreamMarkup style)
524
282k
{
525
282k
  assert(OS);
526
527
282k
  if (OS->is_closed || !OS->markup_stream) {
528
282k
    return OS;
529
282k
  }
530
0
  OS->markup_stream = false; // Disable temporarily.
531
0
  switch (style) {
532
0
  default:
533
0
    SStream_concat0(OS, "<UNKNOWN:");
534
0
    return OS;
535
0
  case Markup_Immediate:
536
0
    SStream_concat0(OS, "<imm:");
537
0
    break;
538
0
  case Markup_Register:
539
0
    SStream_concat0(OS, "<reg:");
540
0
    break;
541
0
  case Markup_Target:
542
0
    SStream_concat0(OS, "<tar:");
543
0
    break;
544
0
  case Markup_Memory:
545
0
    SStream_concat0(OS, "<mem:");
546
0
    break;
547
0
  }
548
0
  OS->markup_stream = true;
549
  OS->prefixed_by_markup = true;
550
0
  return OS;
551
0
}