Coverage Report

Created: 2025-08-29 06:29

/src/capstonenext/SStream.c
Line
Count
Source (jump to first uncovered line)
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.12M
{
23
2.12M
  assert(ss);
24
2.12M
  ss->index = 0;
25
2.12M
  memset(ss->buffer, 0, sizeof(ss->buffer));
26
2.12M
  ss->is_closed = false;
27
2.12M
  ss->markup_stream = false;
28
2.12M
  ss->prefixed_by_markup = false;
29
2.12M
  ss->unsigned_num = false;
30
2.12M
}
31
32
void SStream_opt_unum(SStream *ss, bool print_unsigned_numbers)
33
2.05M
{
34
2.05M
  assert(ss);
35
2.05M
  ss->unsigned_num = print_unsigned_numbers;
36
2.05M
}
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
94.6k
{
42
94.6k
  assert(ss);
43
94.6k
  return ss->buffer;
44
94.6k
}
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
65.1k
{
53
65.1k
  assert(ss);
54
65.1k
  char *found = strchr(ss->buffer, elem);
55
65.1k
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
56
65.1k
    return NULL;
57
65.1k
  }
58
0
  *found = repl;
59
0
  found++;
60
0
  return found;
61
65.1k
}
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
23.1k
{
67
23.1k
  assert(ss && rstr);
68
23.1k
  char *found = strchr(ss->buffer, chr);
69
23.1k
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
70
0
    return;
71
0
  }
72
23.1k
  size_t post_len = strlen(found + 1);
73
23.1k
  size_t buf_str_len = strlen(ss->buffer);
74
23.1k
  size_t repl_len = strlen(rstr);
75
23.1k
  if (repl_len - 1 + buf_str_len >= SSTREAM_BUF_LEN) {
76
0
    return;
77
0
  }
78
23.1k
  memmove(found + repl_len, found + 1, post_len);
79
23.1k
  memcpy(found, rstr, repl_len);
80
23.1k
  ss->index = strlen(ss->buffer);
81
23.1k
}
82
83
/// Removes the space characters '\t' and ' ' from the beginning of the stream buffer.
84
void SStream_trimls(SStream *ss)
85
2.11M
{
86
2.11M
  assert(ss);
87
2.11M
  size_t buf_off = 0;
88
  /// Remove leading spaces
89
2.15M
  while (ss->buffer[buf_off] == ' ' || ss->buffer[buf_off] == '\t') {
90
37.4k
    buf_off++;
91
37.4k
  }
92
2.11M
  if (buf_off > 0) {
93
37.4k
    memmove(ss->buffer, ss->buffer + buf_off,
94
37.4k
      SSTREAM_BUF_LEN - buf_off);
95
37.4k
    ss->index -= buf_off;
96
37.4k
  }
97
2.11M
}
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.05M
{
106
2.05M
  assert(ss && mnem_buf && mnem_buf_size > 0 && op_str_buf &&
107
2.05M
         op_str_buf_size > 0);
108
2.05M
  size_t off = 0;
109
  // Copy all non space chars to as mnemonic.
110
11.8M
  while (ss->buffer[off] && ss->buffer[off] != ' ' &&
111
11.8M
         ss->buffer[off] != '\t') {
112
9.75M
    if (off < mnem_buf_size - 1) {
113
      // Only copy if there is space left.
114
9.75M
      mnem_buf[off] = ss->buffer[off];
115
9.75M
    }
116
9.75M
    off++;
117
9.75M
  }
118
2.05M
  if (!ss->buffer[off]) {
119
103k
    return;
120
103k
  }
121
122
  // Iterate until next non space char.
123
1.96M
  do {
124
1.96M
    off++;
125
1.96M
  } while (ss->buffer[off] &&
126
1.96M
     (ss->buffer[off] == ' ' || ss->buffer[off] == '\t'));
127
128
1.94M
  if (!ss->buffer[off]) {
129
30.4k
    return;
130
30.4k
  }
131
132
  // Copy all follow up characters as op_str
133
1.91M
  const char *ss_op_str = ss->buffer + off;
134
1.91M
  off = 0;
135
27.5M
  while (ss_op_str[off] && off < op_str_buf_size - 1) {
136
25.6M
    op_str_buf[off] = ss_op_str[off];
137
25.6M
    off++;
138
25.6M
  }
139
1.91M
}
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
23.8k
{
145
23.8k
  assert(ss);
146
23.8k
  if (file) {
147
0
    fprintf(file, "%s\n", ss->buffer);
148
0
  }
149
23.8k
  SStream_Init(ss);
150
23.8k
}
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.9M
{
175
11.9M
#ifndef CAPSTONE_DIET
176
11.9M
  assert(ss && s);
177
11.9M
  SSTREAM_RETURN_IF_CLOSED(ss);
178
11.9M
  if (s[0] == '\0')
179
3.63M
    return;
180
8.27M
  unsigned int len = (unsigned int)strlen(s);
181
182
8.27M
  SSTREAM_OVERFLOW_CHECK(ss, len);
183
184
8.27M
  memcpy(ss->buffer + ss->index, s, len);
185
8.27M
  ss->index += len;
186
8.27M
  ss->buffer[ss->index] = '\0';
187
8.27M
  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
8.27M
#endif
194
8.27M
}
195
196
/**
197
 * Copy the single char \p c to the buffer of \p ss.
198
 */
199
void SStream_concat1(SStream *ss, const char c)
200
1.38M
{
201
1.38M
#ifndef CAPSTONE_DIET
202
1.38M
  assert(ss);
203
1.38M
  SSTREAM_RETURN_IF_CLOSED(ss);
204
1.38M
  if (c == '\0')
205
14.2k
    return;
206
207
1.37M
  SSTREAM_OVERFLOW_CHECK(ss, 1);
208
209
1.37M
  ss->buffer[ss->index] = c;
210
1.37M
  ss->index++;
211
1.37M
  ss->buffer[ss->index] = '\0';
212
1.37M
  if (ss->markup_stream && ss->prefixed_by_markup) {
213
0
    SSTREAM_OVERFLOW_CHECK(ss, 1);
214
0
    ss->buffer[ss->index] = '>';
215
0
    ss->index++;
216
0
  }
217
1.37M
#endif
218
1.37M
}
219
220
/**
221
 * Copy all strings given to the buffer of \p ss according to formatting \p fmt.
222
 */
223
void SStream_concat(SStream *ss, const char *fmt, ...)
224
5.28M
{
225
5.28M
#ifndef CAPSTONE_DIET
226
5.28M
  assert(ss && fmt);
227
5.28M
  SSTREAM_RETURN_IF_CLOSED(ss);
228
5.28M
  va_list ap;
229
5.28M
  int ret;
230
231
5.28M
  va_start(ap, fmt);
232
5.28M
  ret = cs_vsnprintf(ss->buffer + ss->index,
233
5.28M
         sizeof(ss->buffer) - (ss->index + 1), fmt, ap);
234
5.28M
  va_end(ap);
235
5.28M
  ss->index += ret;
236
5.28M
  if (ss->markup_stream && ss->prefixed_by_markup) {
237
0
    SSTREAM_OVERFLOW_CHECK(ss, 1);
238
0
    ss->buffer[ss->index] = '>';
239
0
    ss->index += 1;
240
0
  }
241
5.28M
#endif
242
5.28M
}
243
244
// print number with prefix #
245
void printInt64Bang(SStream *ss, int64_t val)
246
51.6k
{
247
51.6k
  assert(ss);
248
51.6k
  if (ss->unsigned_num) {
249
0
    printUInt64Bang(ss, val);
250
0
    return;
251
0
  }
252
51.6k
  SSTREAM_RETURN_IF_CLOSED(ss);
253
51.6k
  SStream_concat1(ss, '#');
254
51.6k
  printInt64(ss, val);
255
51.6k
}
256
257
void printUInt64Bang(SStream *ss, uint64_t val)
258
7.47k
{
259
7.47k
  assert(ss);
260
7.47k
  SSTREAM_RETURN_IF_CLOSED(ss);
261
7.47k
  SStream_concat1(ss, '#');
262
7.47k
  printUInt64(ss, val);
263
7.47k
}
264
265
// print number
266
void printInt64(SStream *ss, int64_t val)
267
474k
{
268
474k
  assert(ss);
269
474k
  if (ss->unsigned_num) {
270
0
    printUInt64(ss, val);
271
0
    return;
272
0
  }
273
474k
  SSTREAM_RETURN_IF_CLOSED(ss);
274
474k
  if (val >= 0) {
275
433k
    if (val > HEX_THRESHOLD)
276
275k
      SStream_concat(ss, "0x%" PRIx64, val);
277
158k
    else
278
158k
      SStream_concat(ss, "%" PRIu64, val);
279
433k
  } else {
280
41.1k
    if (val < -HEX_THRESHOLD) {
281
38.1k
      if (val == INT64_MIN)
282
64
        SStream_concat(ss, "-0x%" PRIx64,
283
64
                 (uint64_t)INT64_MAX + 1);
284
38.0k
      else
285
38.0k
        SStream_concat(ss, "-0x%" PRIx64,
286
38.0k
                 (uint64_t)-val);
287
38.1k
    } else
288
3.02k
      SStream_concat(ss, "-%" PRIu64, -val);
289
41.1k
  }
290
474k
}
291
292
void printUInt64(SStream *ss, uint64_t val)
293
119k
{
294
119k
  assert(ss);
295
119k
  SSTREAM_RETURN_IF_CLOSED(ss);
296
119k
  if (val > HEX_THRESHOLD)
297
80.5k
    SStream_concat(ss, "0x%" PRIx64, val);
298
39.2k
  else
299
39.2k
    SStream_concat(ss, "%" PRIu64, val);
300
119k
}
301
302
// print number in decimal mode
303
void printInt32BangDec(SStream *ss, int32_t val)
304
{
305
  assert(ss);
306
  SSTREAM_RETURN_IF_CLOSED(ss);
307
  if (val >= 0)
308
    SStream_concat(ss, "#%" PRIu32, val);
309
  else {
310
    if (val == INT32_MIN)
311
      SStream_concat(ss, "#-%" PRIu32, val);
312
    else
313
      SStream_concat(ss, "#-%" PRIu32, (uint32_t)-val);
314
  }
315
}
316
317
void printInt32Bang(SStream *ss, int32_t val)
318
120k
{
319
120k
  assert(ss);
320
120k
  if (ss->unsigned_num) {
321
0
    printUInt32Bang(ss, val);
322
0
    return;
323
0
  }
324
120k
  SSTREAM_RETURN_IF_CLOSED(ss);
325
120k
  SStream_concat1(ss, '#');
326
120k
  printInt32(ss, val);
327
120k
}
328
329
void printUInt8(SStream *ss, uint8_t val)
330
0
{
331
0
  assert(ss);
332
0
  if (val > HEX_THRESHOLD)
333
0
    SStream_concat(ss, "0x%" PRIx8, val);
334
0
  else
335
0
    SStream_concat(ss, "%" PRIu8, val);
336
0
}
337
338
void printUInt16(SStream *ss, uint16_t val)
339
0
{
340
0
  assert(ss);
341
0
  if (val > HEX_THRESHOLD)
342
0
    SStream_concat(ss, "0x%" PRIx16, val);
343
0
  else
344
0
    SStream_concat(ss, "%" PRIu16, val);
345
0
}
346
347
void printInt8(SStream *ss, int8_t val)
348
719
{
349
719
  assert(ss);
350
719
  if (ss->unsigned_num) {
351
0
    printUInt8(ss, val);
352
0
    return;
353
0
  }
354
719
  SSTREAM_RETURN_IF_CLOSED(ss);
355
719
  if (val >= 0) {
356
402
    if (val > HEX_THRESHOLD)
357
357
      SStream_concat(ss, "0x%" PRIx8, val);
358
45
    else
359
45
      SStream_concat(ss, "%" PRId8, val);
360
402
  } else {
361
317
    if (val < -HEX_THRESHOLD) {
362
89
      if (val == INT8_MIN)
363
15
        SStream_concat(ss, "-0x%" PRIx8,
364
15
                 (uint8_t)INT8_MAX + 1);
365
74
      else
366
74
        SStream_concat(ss, "-0x%" PRIx8, (int8_t)-val);
367
89
    } else
368
228
      SStream_concat(ss, "-%" PRIu8, -val);
369
317
  }
370
719
}
371
372
void printInt16(SStream *ss, int16_t val)
373
1.62k
{
374
1.62k
  assert(ss);
375
1.62k
  if (ss->unsigned_num) {
376
0
    printUInt16(ss, val);
377
0
    return;
378
0
  }
379
1.62k
  SSTREAM_RETURN_IF_CLOSED(ss);
380
1.62k
  if (val >= 0) {
381
835
    if (val > HEX_THRESHOLD)
382
639
      SStream_concat(ss, "0x%" PRIx16, val);
383
196
    else
384
196
      SStream_concat(ss, "%" PRId16, val);
385
835
  } else {
386
793
    if (val < -HEX_THRESHOLD) {
387
393
      if (val == INT16_MIN)
388
56
        SStream_concat(ss, "-0x%" PRIx16,
389
56
                 (uint16_t)INT16_MAX + 1);
390
337
      else
391
337
        SStream_concat(ss, "-0x%" PRIx16,
392
337
                 (int16_t)-val);
393
393
    } else
394
400
      SStream_concat(ss, "-%" PRIu16, -val);
395
793
  }
396
1.62k
}
397
398
void printInt16HexOffset(SStream *ss, int16_t val)
399
4.12k
{
400
4.12k
  assert(ss);
401
4.12k
  if (ss->unsigned_num) {
402
0
    printUInt16(ss, val);
403
0
    return;
404
0
  }
405
4.12k
  SSTREAM_RETURN_IF_CLOSED(ss);
406
4.12k
  if (val >= 0) {
407
3.52k
    SStream_concat(ss, "+0x%" PRIx16, val);
408
3.52k
  } else {
409
597
    if (val == INT16_MIN)
410
6
      SStream_concat(ss, "-0x%" PRIx16,
411
6
               (uint16_t)INT16_MAX + 1);
412
591
    else
413
591
      SStream_concat(ss, "-0x%" PRIx16, (int16_t)-val);
414
597
  }
415
4.12k
}
416
417
void printInt32(SStream *ss, int32_t val)
418
167k
{
419
167k
  assert(ss);
420
167k
  if (ss->unsigned_num) {
421
0
    printUInt32(ss, val);
422
0
    return;
423
0
  }
424
167k
  SSTREAM_RETURN_IF_CLOSED(ss);
425
167k
  if (val >= 0) {
426
121k
    if (val > HEX_THRESHOLD)
427
71.4k
      SStream_concat(ss, "0x%" PRIx32, val);
428
49.6k
    else
429
49.6k
      SStream_concat(ss, "%" PRId32, val);
430
121k
  } else {
431
46.7k
    if (val < -HEX_THRESHOLD) {
432
44.1k
      if (val == INT32_MIN)
433
20
        SStream_concat(ss, "-0x%" PRIx32,
434
20
                 (uint32_t)INT32_MAX + 1);
435
44.1k
      else
436
44.1k
        SStream_concat(ss, "-0x%" PRIx32,
437
44.1k
                 (int32_t)-val);
438
44.1k
    } else {
439
2.57k
      SStream_concat(ss, "-%" PRIu32, (uint32_t)-val);
440
2.57k
    }
441
46.7k
  }
442
167k
}
443
444
void printInt32HexOffset(SStream *ss, int32_t val)
445
264
{
446
264
  assert(ss);
447
264
  if (ss->unsigned_num) {
448
0
    printUInt32(ss, val);
449
0
    return;
450
0
  }
451
264
  SSTREAM_RETURN_IF_CLOSED(ss);
452
264
  if (val >= 0) {
453
207
    SStream_concat(ss, "+0x%" PRIx32, val);
454
207
  } else {
455
57
    if (val == INT32_MIN)
456
1
      SStream_concat(ss, "-0x%" PRIx32,
457
1
               (uint32_t)INT32_MAX + 1);
458
56
    else
459
56
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
460
57
  }
461
264
}
462
463
void printInt32Hex(SStream *ss, int32_t val)
464
2.56k
{
465
2.56k
  assert(ss);
466
2.56k
  SSTREAM_RETURN_IF_CLOSED(ss);
467
2.56k
  if (val >= 0) {
468
1.80k
    SStream_concat(ss, "0x%" PRIx32, val);
469
1.80k
  } else {
470
752
    if (val == INT32_MIN)
471
13
      SStream_concat(ss, "-0x%" PRIx32,
472
13
               (uint32_t)INT32_MAX + 1);
473
739
    else
474
739
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
475
752
  }
476
2.56k
}
477
478
void printUInt32Bang(SStream *ss, uint32_t val)
479
126k
{
480
126k
  assert(ss);
481
126k
  SSTREAM_RETURN_IF_CLOSED(ss);
482
126k
  SStream_concat1(ss, '#');
483
126k
  printUInt32(ss, val);
484
126k
}
485
486
void printUInt32(SStream *ss, uint32_t val)
487
186k
{
488
186k
  assert(ss);
489
186k
  SSTREAM_RETURN_IF_CLOSED(ss);
490
186k
  if (val > HEX_THRESHOLD)
491
143k
    SStream_concat(ss, "0x%x", val);
492
42.9k
  else
493
42.9k
    SStream_concat(ss, "%u", val);
494
186k
}
495
496
void printFloat(SStream *ss, float val)
497
0
{
498
0
  assert(ss);
499
0
  SSTREAM_RETURN_IF_CLOSED(ss);
500
0
  SStream_concat(ss, "%e", val);
501
0
}
502
503
void printFloatBang(SStream *ss, float val)
504
394
{
505
394
  assert(ss);
506
394
  SSTREAM_RETURN_IF_CLOSED(ss);
507
394
  SStream_concat(ss, "#%e", val);
508
394
}
509
510
void printExpr(SStream *ss, uint64_t val)
511
0
{
512
0
  assert(ss);
513
0
  SSTREAM_RETURN_IF_CLOSED(ss);
514
0
  SStream_concat(ss, "%" PRIu64, val);
515
0
}
516
517
SStream *markup_OS(SStream *OS, SStreamMarkup style)
518
426k
{
519
426k
  assert(OS);
520
521
426k
  if (OS->is_closed || !OS->markup_stream) {
522
426k
    return OS;
523
426k
  }
524
0
  OS->markup_stream = false; // Disable temporarily.
525
0
  switch (style) {
526
0
  default:
527
0
    SStream_concat0(OS, "<UNKNOWN:");
528
0
    return OS;
529
0
  case Markup_Immediate:
530
0
    SStream_concat0(OS, "<imm:");
531
0
    break;
532
0
  case Markup_Register:
533
0
    SStream_concat0(OS, "<reg:");
534
0
    break;
535
0
  case Markup_Target:
536
0
    SStream_concat0(OS, "<tar:");
537
0
    break;
538
0
  case Markup_Memory:
539
0
    SStream_concat0(OS, "<mem:");
540
0
    break;
541
0
  }
542
0
  OS->markup_stream = true;
543
0
  OS->prefixed_by_markup = true;
544
0
  return OS;
545
0
}