event-fields.h 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. #ifndef BABELTRACE_CTF_WRITER_EVENT_FIELDS_H
  2. #define BABELTRACE_CTF_WRITER_EVENT_FIELDS_H
  3. /*
  4. * BabelTrace - CTF Writer: Event Fields
  5. *
  6. * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  7. *
  8. * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  9. *
  10. * Permission is hereby granted, free of charge, to any person obtaining a copy
  11. * of this software and associated documentation files (the "Software"), to deal
  12. * in the Software without restriction, including without limitation the rights
  13. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14. * copies of the Software, and to permit persons to whom the Software is
  15. * furnished to do so, subject to the following conditions:
  16. *
  17. * The above copyright notice and this permission notice shall be included in
  18. * all copies or substantial portions of the Software.
  19. *
  20. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26. * SOFTWARE.
  27. *
  28. * The Common Trace Format (CTF) Specification is available at
  29. * http://www.efficios.com/ctf
  30. */
  31. #include <babeltrace/ctf-ir/fields.h>
  32. #ifdef __cplusplus
  33. extern "C" {
  34. #endif
  35. /*
  36. * bt_ctf_field_get and bt_ctf_field_put: increment and decrement the
  37. * field's reference count.
  38. *
  39. * You may also use bt_ctf_get() and bt_ctf_put() with field objects.
  40. *
  41. * These functions ensure that the field won't be destroyed when it
  42. * is in use. The same number of get and put (plus one extra put to
  43. * release the initial reference done at creation) have to be done to
  44. * destroy a field.
  45. *
  46. * When the field's reference count is decremented to 0 by a bt_ctf_field_put,
  47. * the field is freed.
  48. *
  49. * @param field Field instance.
  50. */
  51. extern void bt_ctf_field_get(struct bt_ctf_field *field);
  52. extern void bt_ctf_field_put(struct bt_ctf_field *field);
  53. #ifdef __cplusplus
  54. }
  55. #endif
  56. #endif /* BABELTRACE_CTF_WRITER_EVENT_FIELDS_H */