projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| ebdb334b JR |
1 | lttng-add-map(1) |
| 2 | ================ | |
| 3 | :revdate: 30 Mars 2021 | |
| 4 | ||
| 5 | ||
| 6 | NAME | |
| 7 | ---- | |
| 8 | lttng-add-map - Create LTTng map | |
| 9 | ||
| 10 | ||
| 11 | SYNOPSIS | |
| 12 | -------- | |
| 13 | ||
| 14 | Create a Linux kernel map: | |
| 15 | [verse] | |
| 16 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-map* option:--kernel | |
| 17 | [option:--session='SESSION'] [--bitness='BITNESS'] | |
| 18 | [option:--coalesce-hits] | |
| 19 | [option:--may-key-count='MAX_KEY_COUNT'] | |
| 20 | 'MAP' | |
| 21 | ||
| 22 | Create a user space map: | |
| 23 | [verse] | |
| 24 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *add-map* option:--userspace | |
| 25 | [option:--session='SESSION'] [--bitness='BITNESS'] | |
| 26 | [(option:--per-pid | option:--per-uid)] | |
| 27 | [option:--coalesce-hits] | |
| 28 | [option:--may-key-count='MAX_KEY_COUNT'] | |
| 29 | 'MAP' | |
| 30 | ||
| 31 | ||
| 32 | DESCRIPTION | |
| 33 | ----------- | |
| 34 | ||
| 35 | The `lttng add-map` command is used to create maps. | |
| 36 | ||
| 37 | A map is key-value data structure used to count events occurences. When | |
| 38 | creating a map, many parameters related to this data structure can be | |
| 39 | fine-tuned. | |
| 40 | ||
| 41 | When 'MAP' does not name an existing map, a map named | |
| 42 | 'MAP' is created. | |
| 43 | ||
| 44 | OPTIONS | |
| 45 | ------- | |
| 46 | ||
| 47 | option:-k, option:--kernel:: | |
| 48 | Create map in the Linux kernel domain. | |
| 49 | ||
| 50 | option:-u, option:--userspace:: | |
| 51 | Create map in the user space domain. | |
| 52 | ||
| 53 | option:-s 'SESSION', option:--session='SESSION':: | |
| 54 | Create map in the tracing session named 'SESSION' | |
| 55 | instead of the current tracing session. | |
| 56 | ||
| 57 | option:--bitness='BITNESS':: | |
| 58 | Set the counter bucket size to BITNESS bits. | |
| 59 | ||
| 60 | option:--coalesce-hits:: | |
| 61 | Coalesces hits from identical event rules. | |
| 62 | ||
| 63 | option:--per-pid:: | |
| 64 | Keep one event counter per process. | |
| 65 | ||
| 66 | option:--per-uid:: | |
| 67 | Keep one event counter for all processes of a single user. | |
| 68 | ||
| 69 | include::common-cmd-help-options.txt[] | |
| 70 | ||
| 71 | include::common-cmd-footer.txt[] | |
| 72 | ||
| 73 | ||
| 74 | SEE ALSO | |
| 75 | -------- | |
| 76 | man:lttng-enable-map(1), | |
| 77 | man:lttng-disable-map(1), | |
| 78 | man:lttng-view-map(1), | |
| 79 | man:lttng-list(1), | |
| 80 | man:lttng-add-trigger(1), | |
| 81 | man:lttng(1) |