ltt/branches/poly/ltt/facility.h

   1 /* This file is part of the Linux Trace Toolkit trace reading library
   2  * Copyright (C) 2003-2004 Michel Dagenais
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License Version 2.1 as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 02111-1307, USA.
  17  */
  18
  19 #ifndef FACILITY_H
  20 #define FACILITY_H
  21
  22 #include <ltt/ltt.h>
  23
  24 /* Facilities are obtained from an opened trace. The structures associated
  25    with a facility are released when the trace is closed. Each facility
  26    is characterized by its name and checksum. */
  27
  28 char *ltt_facility_name(LttFacility *f);
  29
  30 LttChecksum ltt_facility_checksum(LttFacility *f);
  31
  32 /* open facility */
  33 void ltt_facility_open(LttTrace * t, char * facility_name);
  34
  35 /* Discover the event types within the facility. The event type integer id
  36    relative to the trace is from 0 to nb_event_types - 1. The event
  37    type id within the trace is the relative id + the facility base event
  38    id. */
  39
  40 unsigned ltt_facility_base_id(LttFacility *f);
  41
  42 unsigned ltt_facility_eventtype_number(LttFacility *f);
  43
  44 LttEventType *ltt_facility_eventtype_get(LttFacility *f, unsigned i);
  45
  46 LttEventType *ltt_facility_eventtype_get_by_name(LttFacility *f, char *name);
  47
  48 #endif // FACILITY_H
  49