File: HpiIterators.py

package info (click to toggle)
openhpi 3.8.0-2.3
  • links: PTS
  • area: main
  • in suites: trixie
  • size: 31,888 kB
  • sloc: ansic: 225,326; cpp: 63,687; java: 16,472; cs: 15,161; python: 11,884; sh: 11,508; makefile: 4,945; perl: 1,529; xml: 36; asm: 13
file content (241 lines) | stat: -rw-r--r-- 8,571 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

#      -*- python -*-
#
# Copyright (C) 2012, Pigeon Point Systems
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  This
# file and program are licensed under a BSD style license.  See
# the Copying file included with the OpenHPI distribution for
# full licensing terms.
#
# Author(s):
#      Anton Pak <anton.pak@pigeonpoint.com>
#

from openhpi_baselib.HpiDataTypes import *
from openhpi_baselib.Hpi import *
from openhpi_baselib import HpiUtil


#**********************************************************
# Helper functions
# TODO - move to HpiUtils?
#**********************************************************
def new_cond():
    c             = SaHpiConditionT()
    c.Type        = SAHPI_STATUS_COND_TYPE_USER
    c.Entity      = HpiUtil.makeUnspecifiedSaHpiEntityPathT()
    c.DomainId    = SAHPI_UNSPECIFIED_DOMAIN_ID
    c.ResourceId  = SAHPI_UNSPECIFIED_RESOURCE_ID
    c.SensorNum   = SAHPI_ENTRY_UNSPECIFIED
    c.EventState  = SAHPI_ES_UNSPECIFIED
    c.Name        = SaHpiNameT()
    c.Name.Length = 0
    c.Name.Value  = "".ljust( SA_HPI_MAX_NAME_LENGTH, chr(0) )
    c.Mid         = SAHPI_MANUFACTURER_ID_UNSPECIFIED
    c.Data        = HpiUtil.toSaHpiTextBufferT( "" )
    return c

def new_alarm( id, timestamp ):
    a              = SaHpiAlarmT()
    a.AlarmId      = id
    a.Timestamp    = timestamp
    a.Severity     = SAHPI_ALL_SEVERITIES
    a.Acknowledged = SAHPI_FALSE
    a.AlarmCond    = new_cond()
    return a

def new_announcement( id, timestamp ):
    a              = SaHpiAnnouncementT()
    a.EntryId      = id
    a.Timestamp    = timestamp
    a.AddedByUser  = SAHPI_TRUE
    a.Severity     = SAHPI_ALL_SEVERITIES
    a.Acknowledged = SAHPI_FALSE
    a.StatusCond   = new_cond()
    return a


#**********************************************************
# HPI Utility Functions: Iterators
#**********************************************************

#**********************************************************
# Iterate over DRT
# Provides SaHpiDrtEntryT
#**********************************************************
def Drt( sid ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, drte ) = saHpiDrtEntryGet( sid, id )
        if rv != SA_OK:
            break
        yield drte

#**********************************************************
# Iterate over DAT
# Provides SaHpiAlarmT
#**********************************************************
def Dat( sid, severity = SAHPI_ALL_SEVERITIES, unacknowledged_only = SAHPI_FALSE ):
    id = SAHPI_FIRST_ENTRY
    timestamp = 0L
    while id != SAHPI_LAST_ENTRY:
        a = new_alarm( id, timestamp )
        ( rv, a ) = saHpiAlarmGetNext( sid, severity, unacknowledged_only, a )
        if rv != SA_OK:
            break
        id        = a.AlarmId
        timestamp = a.Timestamp
        yield a

#**********************************************************
# Iterate over Event Log
# Provides ( SaHpiEventLogEntryT, SaHpiRdrT, SaHpiRptEntryT ) tuple
#**********************************************************
def EventLogEntries( sid, rid, readforward = True ):
    id = SAHPI_OLDEST_ENTRY if readforward else SAHPI_NEWEST_ENTRY
    while id != SAHPI_NO_MORE_ENTRIES:
        ( rv, previd, nextid, entry, rdr, rpte ) = saHpiEventLogEntryGet( sid, rid, id )
        if rv != SA_OK:
            break
        id = nextid if readforward else previd
        yield ( entry, rdr, rpte )

#**********************************************************
# Iterate over entity resource ids
# Provides SaHpiResourceIdT
#**********************************************************
def EntityResourceIds( sid, ep ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, rid, instrid, rptcnt ) = saHpiGetIdByEntityPath( sid, ep, SAHPI_NO_RECORD, id )
        if rv != SA_OK:
            break
        yield rid

#**********************************************************
# Iterate over entity instrument ids
# Provides ( SaHpiResourceIdT, SaHpiInstrumentIdT ) tuple
#**********************************************************
def EntityInstrumentIds( sid, ep, rdrtype ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, rid, instrid, rptcnt ) = saHpiGetIdByEntityPath( sid, ep, rdrtype, id )
        if rv != SA_OK:
            break
        yield ( rid, instrid )

#**********************************************************
# Iterate over child entities
# Provides SaHpiEntityPathT
#**********************************************************
def ChildEntities( sid, parent_ep ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, child_ep, rptcnt ) = saHpiGetChildEntityPath( sid, parent_ep, id )
        if rv != SA_OK:
            break
        yield child_ep

#**********************************************************
# Iterate over RPT
# Provides SaHpiRptEntryT
#**********************************************************
def Rpt( sid ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, rpte ) = saHpiRptEntryGet( sid, id )
        if rv != SA_OK:
            break
        yield rpte

#**********************************************************
# Iterate over RDRs
# Provides SaHpiRdrT
#**********************************************************
def Rdrs( sid, rid ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, rdr ) = saHpiRdrGet( sid, rid, id )
        if rv != SA_OK:
            break
        yield rdr

#**********************************************************
# Iterate over Idr Areas
# Provides SaHpiIdrAreaHeaderT
#**********************************************************
def IdrAreaHeaders( sid, rid, iid, atype = SAHPI_IDR_AREATYPE_UNSPECIFIED ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, ahdr ) = saHpiIdrAreaHeaderGet( sid, rid, iid, atype, id )
        if rv != SA_OK:
            break
        yield ahdr

#**********************************************************
# Iterate over Idr Area Fields
# Provides SaHpiIdrFieldT
#**********************************************************
def IdrAreaFields( sid, rid, iid, aid, ftype = SAHPI_IDR_FIELDTYPE_UNSPECIFIED ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, field ) = saHpiIdrFieldGet( sid, rid, iid, aid, ftype, id )
        if rv != SA_OK:
            break
        yield field

#**********************************************************
# Iterate over annuncuator announcements
# Provides SaHpiAnnouncementT
#**********************************************************
def Announcements( sid, rid, annnum, severity = SAHPI_ALL_SEVERITIES, unacknowledged_only = SAHPI_FALSE ):
    id = SAHPI_FIRST_ENTRY
    timestamp = 0L
    while id != SAHPI_LAST_ENTRY:
        a = new_announcement( id, timestamp )
        ( rv, a ) = saHpiAnnunciatorGetNext( sid, rid, annnum, severity, unacknowledged_only, a )
        if rv != SA_OK:
            break
        id        = a.EntryId
        timestamp = a.Timestamp
        yield a

#**********************************************************
# Iterate over FUMI Source Components
# Provides SaHpiFumiComponentInfoT
#**********************************************************
def FumiSourceComponents( sid, rid, fuminum, banknum ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, info ) = saHpiFumiSourceComponentInfoGet( sid, rid, fuminum, banknum, id )
        if rv != SA_OK:
            break
        yield info

#**********************************************************
# Iterate over FUMI Target Components
# Provides SaHpiFumiComponentInfoT
#**********************************************************
def FumiTargetComponents( sid, rid, fuminum, banknum ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, info ) = saHpiFumiTargetComponentInfoGet( sid, rid, fuminum, banknum, id )
        if rv != SA_OK:
            break
        yield info

#**********************************************************
# Iterate over FUMI Logical Target Components
# Provides SaHpiFumiLogicalComponentInfoT
#**********************************************************
def FumiLogicalTargetComponents( sid, rid, fuminum ):
    id = SAHPI_FIRST_ENTRY
    while id != SAHPI_LAST_ENTRY:
        ( rv, id, info ) = saHpiFumiLogicalTargetComponentInfoGet( sid, rid, fuminum, id )
        if rv != SA_OK:
            break
        yield info