[babeltrace.git] / include / babeltrace / format.h

#ifndef _BABELTRACE_FORMAT_H
#define _BABELTRACE_FORMAT_H

/*
 * BabelTrace
 *
 * Trace Format Header
 *
 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
 *
 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 */

#include <babeltrace/types.h>
#include <babeltrace/ctf/types.h>
#include <stdint.h>
#include <stdio.h>
#include <glib.h>

/* Parent trace descriptor */
struct trace_descriptor {
};

struct mmap_stream {
	int fd;
	struct cds_list_head list;
};

struct mmap_stream_list {
	struct cds_list_head head;
};

struct format {
	GQuark name;

	struct trace_descriptor *(*open_trace)(const char *collection_path,
			const char *path, int flags,
			void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
				int whence), FILE *metadata_fp);
	struct trace_descriptor *(*open_mmap_trace)(
			struct mmap_stream_list *mmap_list,
			void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
				int whence), FILE *metadata_fp);
	void (*close_trace)(struct trace_descriptor *descriptor);
};

extern struct format *bt_lookup_format(GQuark qname);
extern void bt_fprintf_format_list(FILE *fp);
extern int bt_register_format(struct format *format);

/* TBD: format unregistration */

#endif /* _BABELTRACE_FORMAT_H */
Commit	Line	Data
fc93b2bd MD	1	#ifndef _BABELTRACE_FORMAT_H
	2	#define _BABELTRACE_FORMAT_H
	3
	4	/*
	5	* BabelTrace
	6	*
	7	* Trace Format Header
	8	*
64fa3fec MD	9	* Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
	10	*
	11	* Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fc93b2bd	12	*
ccd7e1c8 MD	13	* Permission is hereby granted, free of charge, to any person obtaining a copy
	14	* of this software and associated documentation files (the "Software"), to deal
	15	* in the Software without restriction, including without limitation the rights
	16	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	17	* copies of the Software, and to permit persons to whom the Software is
	18	* furnished to do so, subject to the following conditions:
fc93b2bd	19	*
ccd7e1c8 MD	20	* The above copyright notice and this permission notice shall be included in
ccd7e1c8 MD	21	* all copies or substantial portions of the Software.
fc93b2bd MD	22	*/
fc93b2bd MD	23
4c8bfb7e	24	#include <babeltrace/types.h>
b086c01a	25	#include <babeltrace/ctf/types.h>
fc93b2bd	26	#include <stdint.h>
7fb21036	27	#include <stdio.h>
fc93b2bd MD	28	#include <glib.h>
fc93b2bd MD	29
46322b33 MD	30	/* Parent trace descriptor */
	31	struct trace_descriptor {
	32	};
bbefb8dd	33
f571dfb1 JD	34	struct mmap_stream {
	35	int fd;
	36	struct cds_list_head list;
	37	};
	38
	39	struct mmap_stream_list {
	40	struct cds_list_head head;
	41	};
	42
fc93b2bd MD	43	struct format {
	44	GQuark name;
	45
8c250d87 MD	46	struct trace_descriptor (open_trace)(const char *collection_path,
8c250d87 MD	47	const char *path, int flags,
b086c01a	48	void (move_pos_slow)(struct ctf_stream_pos pos, size_t offset,
ae23d232	49	int whence), FILE *metadata_fp);
f571dfb1 JD	50	struct trace_descriptor (open_mmap_trace)(
	51	struct mmap_stream_list *mmap_list,
	52	void (move_pos_slow)(struct ctf_stream_pos pos, size_t offset,
	53	int whence), FILE *metadata_fp);
bbefb8dd	54	void (close_trace)(struct trace_descriptor descriptor);
fc93b2bd MD	55	};
fc93b2bd MD	56
5901aa79 MD	57	extern struct format *bt_lookup_format(GQuark qname);
	58	extern void bt_fprintf_format_list(FILE *fp);
	59	extern int bt_register_format(struct format *format);
fc93b2bd MD	60
	61	/* TBD: format unregistration */
	62
	63	#endif /* _BABELTRACE_FORMAT_H */