-
Notifications
You must be signed in to change notification settings - Fork 97
/
errlentry.C
1546 lines (1342 loc) · 54.3 KB
/
errlentry.C
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/errl/errlentry.C $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,2017 */
/* [+] Google Inc. */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file errlentry.C
*
* @brief Implementation of ErrlEntry class
*/
/*****************************************************************************/
// I n c l u d e s
/*****************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <hbotcompid.H>
#include <errl/errlentry.H>
#include <errl/errlmanager.H>
#include <errl/errludbacktrace.H>
#include <errl/errludcallout.H>
#include <errl/errlreasoncodes.H>
#include <errl/errludstring.H>
#include <errl/errluserdetails.H>
#include <errl/errludattribute.H>
#include <trace/interface.H>
#include <arch/ppc.H>
#include <hwas/common/hwasCallout.H>
#include <hwas/common/deconfigGard.H>
#include <targeting/common/targetservice.H>
#include <targeting/common/utilFilter.H>
#include <config.h>
#include <initservice/initserviceif.H>
#include <attributeenums.H>
#include "errlentry_consts.H"
#include <util/misc.H>
// Hostboot Image ID string
extern char hbi_ImageId;
using namespace ERRORLOG;
using namespace HWAS;
namespace ERRORLOG
{
// Trace definition
trace_desc_t* g_trac_errl = NULL;
TRAC_INIT(&g_trac_errl, "ERRL", KILOBYTE, TRACE::BUFFER_SLOW);
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
ErrlEntry::ErrlEntry(const errlSeverity_t i_sev,
const uint8_t i_modId,
const uint16_t i_reasonCode,
const uint64_t i_user1,
const uint64_t i_user2,
const bool i_hbSwError ) :
iv_Private( static_cast<compId_t>(i_reasonCode & 0xFF00)),
iv_User( i_sev ),
// The SRC_ERR_INFO becomes part of the SRC; example, B1 in SRC B180xxxx
// iv_Src assigns the epubSubSystem_t; example, 80 in SRC B180xxxx
iv_Src( SRC_ERR_INFO, i_modId, i_reasonCode, i_user1, i_user2 ),
iv_termState(TERM_STATE_UNKNOWN),
iv_sevFinal(false),
iv_skipShowingLog(true)
{
#ifdef CONFIG_ERRL_ENTRY_TRACE
TRACFCOMP( g_trac_errl, ERR_MRK"Error created : PLID=%.8X, RC=%.4X, Mod=%.2X, Userdata=%.16X %.16X", plid(), i_reasonCode, i_modId, i_user1, i_user2 );
#else
TRACDCOMP( g_trac_errl, ERR_MRK"Error created : PLID=%.8X, RC=%.4X, Mod=%.2X, Userdata=%.16X %.16X", plid(), i_reasonCode, i_modId, i_user1, i_user2 );
#endif
// Collect the Backtrace and add it to the error log
iv_pBackTrace = new ErrlUserDetailsBackTrace();
// Automatically add a software callout if asked
if( i_hbSwError )
{
addProcedureCallout( HWAS::EPUB_PRC_HB_CODE,
HWAS::SRCI_PRIORITY_HIGH );
}
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
ErrlEntry::~ErrlEntry()
{
// Free memory of all sections
for (std::vector<ErrlUD*>::const_iterator l_itr = iv_SectionVector.begin();
l_itr != iv_SectionVector.end(); ++l_itr)
{
delete (*l_itr);
}
delete iv_pBackTrace;
iv_pBackTrace = NULL;
}
///////////////////////////////////////////////////////////////////////////////
// add a new UD section to the list of optional sections
ErrlUD * ErrlEntry::addFFDC(const compId_t i_compId,
const void * i_dataPtr,
const uint32_t i_ffdcLen,
const uint8_t i_ffdcVer,
const uint8_t i_ffdcSubSect,
bool i_merge)
{
ErrlUD * l_ffdcSection = NULL;
if ( (i_dataPtr != NULL) && (i_ffdcLen != 0) )
{
TRACDCOMP( g_trac_errl, INFO_MRK"addFFDC(): %x %d %d - %s merge",
i_compId, i_ffdcVer,
i_ffdcSubSect, i_merge == true ? "DO" : "NO" );
// if we're to try to merge, AND there's at least 1 section
if ((i_merge) && (iv_SectionVector.size() > 0))
{ // look at the last one to see if it's a match or not.
// this is done to preserve the order of the errlog - we
// only merge like sections if they are being put in at the
// 'same time'.
ErrlUD *pErrlUD = iv_SectionVector.back();
if ((i_compId == pErrlUD->iv_header.iv_compId) &&
(i_ffdcVer == pErrlUD->iv_header.iv_ver) &&
(i_ffdcSubSect == pErrlUD->iv_header.iv_sst))
{
TRACDCOMP( g_trac_errl, INFO_MRK"appending to matched %p",
pErrlUD);
appendToFFDC(pErrlUD, i_dataPtr, i_ffdcLen);
l_ffdcSection = pErrlUD;
}
} // i_merge && >0 section
// i_merge == false, or it was true but we didn't find a match
if (l_ffdcSection == NULL)
{
// Create a user-defined section.
l_ffdcSection = new ErrlUD( i_dataPtr,
i_ffdcLen,
i_compId,
i_ffdcVer,
i_ffdcSubSect );
// Add to the vector of sections for this error log.
iv_SectionVector.push_back( l_ffdcSection );
}
}
else
{
TRACFCOMP( g_trac_errl,
ERR_MRK"addFFDC(): Invalid FFDC data pointer or size, no add");
}
return l_ffdcSection;
}
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
void ErrlEntry::appendToFFDC(ErrlUD * i_pErrlUD,
const void *i_dataPtr,
const uint32_t i_dataLen)
{
uint64_t l_rc;
TRACDCOMP( g_trac_errl, ENTER_MRK"appendToFFDC(%p, %p, %d)",
i_pErrlUD, i_dataPtr, i_dataLen);
l_rc = i_pErrlUD->addData( i_dataPtr, i_dataLen );
if( 0 == l_rc )
{
TRACFCOMP( g_trac_errl, ERR_MRK"ErrlEntry::appendToFFDC() rets zero" );
}
return;
}
///////////////////////////////////////////////////////////////////////////////
// Return a Boolean indication of success.
bool ErrlEntry::collectTrace(const char i_name[], const uint64_t i_max)
{
bool l_rc = false; // assume a problem.
char * l_pBuffer = NULL;
uint64_t l_cbOutput = 0;
uint64_t l_cbBuffer = 0;
do
{
// By passing nil arguments 2 and 3, obtain the size of the buffer.
// Besides getting buffer size, it validates i_name.
uint64_t l_cbFull = TRACE::getBuffer( i_name, NULL,0 );
if( 0 == l_cbFull )
{
// Problem, likely unknown trace buffer name.
TRACFCOMP( g_trac_errl,
ERR_MRK"ErrlEntry::collectTrace(): getBuffer(%s) rets zero.",i_name);
break;
}
if(( 0 == i_max ) || ( i_max >= l_cbFull ))
{
// Full trace buffer desired
l_cbBuffer = l_cbFull;
}
else
{
// Partial buffer desired
l_cbBuffer = i_max;
}
// allocate the buffer
l_pBuffer = new char[ l_cbBuffer ];
// Get the data into the buffer.
l_cbOutput = TRACE::getBuffer( i_name, l_pBuffer, l_cbBuffer );
if( 0 == l_cbOutput )
{
// Problem.
TRACFCOMP( g_trac_errl,
ERR_MRK"ErrlEntry::collectTrace(): getBuffer(%s,%ld) rets zero.",
i_name,
l_cbBuffer );
break;
}
// Save the trace buffer as a UD section on this.
ErrlUD * l_udSection = new ErrlUD( l_pBuffer,
l_cbOutput,
FIPS_ERRL_COMP_ID,
FIPS_ERRL_UDV_DEFAULT_VER_1,
FIPS_ERRL_UDT_HB_TRACE );
// Add the trace section to the vector of sections
// for this error log.
iv_SectionVector.push_back( l_udSection );
l_rc = true;
}
while(0);
delete[] l_pBuffer;
return l_rc;
}
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
void ErrlEntry::removeBackTrace()
{
delete iv_pBackTrace;
iv_pBackTrace = NULL;
}
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
void ErrlEntry::addClockCallout(const TARGETING::Target *i_target,
const HWAS::clockTypeEnum i_clockType,
const HWAS::callOutPriority i_priority,
const HWAS::DeconfigEnum i_deconfigState,
const HWAS::GARD_ErrorType i_gardErrorType)
{
TRACFCOMP(g_trac_errl, ENTER_MRK"addClockCallout(%p, %d, 0x%x)",
i_target, i_clockType, i_priority);
TARGETING::EntityPath ep;
const void *pData;
uint32_t size;
if (i_target == TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL)
{
size = sizeof(HWAS::TARGET_IS_SENTINEL);
pData = &HWAS::TARGET_IS_SENTINEL;
}
else
{ // we got a non MASTER_SENTINEL target, therefore the targeting
// module is loaded, therefore we can make this call.
ep = i_target->getAttr<TARGETING::ATTR_PHYS_PATH>();
// size is total EntityPath size minus unused path elements
size = sizeof(ep) -
(TARGETING::EntityPath::MAX_PATH_ELEMENTS - ep.size()) *
sizeof(TARGETING::EntityPath::PathElement);
pData = &ep;
}
ErrlUserDetailsCallout( pData, size, i_clockType,
i_priority, i_deconfigState, i_gardErrorType).addToLog(this);
if (i_gardErrorType != GARD_NULL)
{
setGardBit();
}
if (i_deconfigState != NO_DECONFIG)
{
setDeconfigBit();
}
} // addClockCallout
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
void ErrlEntry::addPartCallout(const TARGETING::Target *i_target,
const HWAS::partTypeEnum i_partType,
const HWAS::callOutPriority i_priority,
const HWAS::DeconfigEnum i_deconfigState,
const HWAS::GARD_ErrorType i_gardErrorType)
{
TRACFCOMP(g_trac_errl, ENTER_MRK"addPartCallout(%p, %d, 0x%x)",
i_target, i_partType, i_priority);
TARGETING::EntityPath ep;
const void *pData;
uint32_t size;
if (i_target == TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL)
{
size = sizeof(HWAS::TARGET_IS_SENTINEL);
pData = &HWAS::TARGET_IS_SENTINEL;
}
else
{ // we got a non MASTER_SENTINEL target, therefore the targeting
// module is loaded, therefore we can make this call.
ep = i_target->getAttr<TARGETING::ATTR_PHYS_PATH>();
// size is total EntityPath size minus unused path elements
size = sizeof(ep) -
(TARGETING::EntityPath::MAX_PATH_ELEMENTS - ep.size()) *
sizeof(TARGETING::EntityPath::PathElement);
pData = &ep;
}
ErrlUserDetailsCallout( pData, size, i_partType,
i_priority, i_deconfigState, i_gardErrorType).addToLog(this);
if (i_gardErrorType != GARD_NULL)
{
setGardBit();
}
if (i_deconfigState != NO_DECONFIG)
{
setDeconfigBit();
}
} // addPartCallout
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
void ErrlEntry::addBusCallout(const TARGETING::Target *i_target_endp1,
const TARGETING::Target *i_target_endp2,
const HWAS::busTypeEnum i_busType,
const HWAS::callOutPriority i_priority)
{
TRACFCOMP(g_trac_errl, ENTER_MRK"addBusCallout(%p, %p, %d, 0x%x)",
i_target_endp1, i_target_endp2, i_busType, i_priority);
TARGETING::EntityPath ep1, ep2;
const void *pData1, *pData2;
uint32_t size1, size2;
if (i_target_endp1 == TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL)
{
size1 = sizeof(HWAS::TARGET_IS_SENTINEL);
pData1 = &HWAS::TARGET_IS_SENTINEL;
}
else
{ // we got a non MASTER_SENTINEL target, therefore the targeting
// module is loaded, therefore we can make this call.
ep1 = i_target_endp1->getAttr<TARGETING::ATTR_PHYS_PATH>();
// size is total EntityPath size minus unused path elements
size1 = sizeof(ep1) -
(TARGETING::EntityPath::MAX_PATH_ELEMENTS - ep1.size()) *
sizeof(TARGETING::EntityPath::PathElement);
pData1 = &ep1;
}
if (i_target_endp2 == TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL)
{
size2 = sizeof(HWAS::TARGET_IS_SENTINEL);
pData2 = &HWAS::TARGET_IS_SENTINEL;
}
else
{ // we got a non MASTER_SENTINEL target, therefore the targeting
// module is loaded, therefore we can make this call.
ep2 = i_target_endp2->getAttr<TARGETING::ATTR_PHYS_PATH>();
// size is total EntityPath size minus unused path elements
size2 = sizeof(ep2) -
(TARGETING::EntityPath::MAX_PATH_ELEMENTS - ep2.size()) *
sizeof(TARGETING::EntityPath::PathElement);
pData2 = &ep2;
}
ErrlUserDetailsCallout( pData1, size1, pData2, size2, i_busType,
i_priority).addToLog(this);
} // addBusCallout
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
void ErrlEntry::addHwCallout(const TARGETING::Target *i_target,
const HWAS::callOutPriority i_priority,
const HWAS::DeconfigEnum i_deconfigState,
const HWAS::GARD_ErrorType i_gardErrorType)
{
if (i_target == nullptr)
{
TRACFCOMP(g_trac_errl, ENTER_MRK
"addHwCallout called with NULL target");
addProcedureCallout( HWAS::EPUB_PRC_HB_CODE,
HWAS::SRCI_PRIORITY_HIGH);
return;
}
if (i_target == TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL)
{
#ifdef CONFIG_ERRL_ENTRY_TRACE
TRACFCOMP(g_trac_errl, ENTER_MRK
"addHwCallout(\"MASTER_PROC_SENTINEL\" 0x%x 0x%x 0x%x)",
i_target, i_priority, i_deconfigState, i_gardErrorType);
#else
TRACDCOMP(g_trac_errl, ENTER_MRK
"addHwCallout(\"MASTER_PROC_SENTINEL\" 0x%x 0x%x 0x%x)",
i_target, i_priority, i_deconfigState, i_gardErrorType);
#endif
//need to override deconfig value to avoid possible deadlocks
// in pnor
HWAS::DeconfigEnum l_deconfigState = i_deconfigState;
if( i_deconfigState == HWAS::DELAYED_DECONFIG )
{
TRACFCOMP( g_trac_errl, "addHwCallout> Forcing delayed deconfig to standard deconfig on sentinel" );
l_deconfigState = HWAS::DECONFIG;
}
ErrlUserDetailsCallout(
&HWAS::TARGET_IS_SENTINEL, sizeof(HWAS::TARGET_IS_SENTINEL),
i_priority, l_deconfigState, i_gardErrorType).addToLog(this);
}
else
{ // we got a non MASTER_SENTINEL target, therefore the targeting
// module is loaded, therefore we can make this call.
#ifdef CONFIG_ERRL_ENTRY_TRACE
TRACFCOMP(g_trac_errl, ENTER_MRK"addHwCallout(0x%.8x 0x%x 0x%x 0x%x)",
get_huid(i_target), i_priority,
i_deconfigState, i_gardErrorType);
#else
TRACDCOMP(g_trac_errl, ENTER_MRK"addHwCallout(0x%.8x 0x%x 0x%x 0x%x)",
get_huid(i_target), i_priority,
i_deconfigState, i_gardErrorType);
#endif
TARGETING::EntityPath ep;
TARGETING::TYPE l_type = i_target->getAttr<TARGETING::ATTR_TYPE>();
TARGETING::TYPE l_type_ecid = l_type;
const TARGETING::Target* l_parentTarget = i_target;
if((l_type_ecid != TARGETING::TYPE_MEMBUF) ||
(l_type_ecid != TARGETING::TYPE_PROC) ||
(l_type_ecid != TARGETING::TYPE_NODE)
)
{
//since this returns NULL if the parent is not found,
// we need a placeholder
const TARGETING::Target* l_tempParentTarget =
getParentChip(l_parentTarget);
if(l_tempParentTarget != NULL)
{
l_parentTarget = l_tempParentTarget;
l_type_ecid = l_parentTarget->getAttr<TARGETING::ATTR_TYPE>();
}
}
//if we have found a type_membuf or type_proc, store the ecid
//otherwise, (type_node), do nothing.
if(l_type_ecid == TARGETING::TYPE_MEMBUF ||
l_type_ecid == TARGETING::TYPE_PROC)
{
ErrlUserDetailsAttribute(l_parentTarget,
TARGETING::ATTR_ECID).addToLog(this);
}
ep = i_target->getAttr<TARGETING::ATTR_PHYS_PATH>();
// size is total EntityPath size minus unused path elements
uint32_t size1 = sizeof(ep) -
(TARGETING::EntityPath::MAX_PATH_ELEMENTS - ep.size()) *
sizeof(TARGETING::EntityPath::PathElement);
ErrlUserDetailsCallout(&ep, size1,
i_priority, i_deconfigState, i_gardErrorType).addToLog(this);
}
if (i_gardErrorType != GARD_NULL)
{
setGardBit();
}
if (i_deconfigState != NO_DECONFIG)
{
setDeconfigBit();
}
} // addHwCallout
////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////
void ErrlEntry::addProcedureCallout(const HWAS::epubProcedureID i_procedure,
const HWAS::callOutPriority i_priority)
{
#ifdef CONFIG_ERRL_ENTRY_TRACE
TRACFCOMP( g_trac_errl, ENTER_MRK"addProcedureCallout(0x%x, 0x%x)",
i_procedure, i_priority);
#else
TRACDCOMP( g_trac_errl, ENTER_MRK"addProcedureCallout(0x%x, 0x%x)",
i_procedure, i_priority);
#endif
ErrlUserDetailsCallout(i_procedure, i_priority).addToLog(this);
} // addProcedureCallout
///////////////////////////////////////////////////////////////////////////////
// Function to add a UD section containing the Hostboot Build ID to the
// current error log being committed
void ErrlEntry::addHbBuildId()
{
// Title string
const char * const l_title = "Hostboot Build ID: ";
// Char[] based on title + Hostboot image ID
char l_pString[strlen(l_title) + strlen(&hbi_ImageId) + 1];
// Set beginning of string
strcpy(l_pString, l_title);
// Concatenate the Hostboot Image ID
strcat(l_pString, &hbi_ImageId);
// Create UD section and add string
ErrlUserDetailsString(l_pString).addToLog(this);
}
enum {
SKIP_INFO_RECOVERABLE_LOGS =
TARGETING::HIDDEN_ERRLOGS_ENABLE_NO_HIDDEN_LOGS,
ENABLE_INFORMATIONAL_LOGS =
TARGETING::HIDDEN_ERRLOGS_ENABLE_ALLOW_INFORMATIONAL,
ENABLE_RECOVERABLE_LOGS =
TARGETING::HIDDEN_ERRLOGS_ENABLE_ALLOW_RECOVERED,
ENABLE_ALL_LOGS =
TARGETING::HIDDEN_ERRLOGS_ENABLE_ALLOW_ALL_LOGS
};
void ErrlEntry::checkHiddenLogsEnable( )
{
// Note: iv_skipShowingLog is set to True by default
//0 = Prevent INFORMATIONAL/RECOVERED error logs from being processed.
//1 = Send only INFORMATIONAL error logs.
//2 = Send only RECOVERED error logs.
//3 = Allow all hidden error logs to be processed.
uint8_t l_enableLogs = getHiddenLogsEnable();
// enable all logs to be displayed
if( l_enableLogs == ENABLE_ALL_LOGS )
{
iv_skipShowingLog = false;
}
else
{
// need to check based on severity
switch( iv_User.iv_severity )
{
case ERRL_SEV_INFORMATIONAL:
if(l_enableLogs == ENABLE_INFORMATIONAL_LOGS )
{
iv_skipShowingLog = false;
}
break;
case ERRL_SEV_RECOVERED:
if(l_enableLogs == ENABLE_RECOVERABLE_LOGS )
{
iv_skipShowingLog = false;
}
break;
default:
// For any error log that is not INFORMATIONAL
// or RECOVERED, we want to show the log
iv_skipShowingLog = false;
}
}
}
///////////////////////////////////////////////////////////////////////////////
// Called by addHwCallout to get the part and serial numbers from the current
// target so that it can be appended to the error log
#ifdef CONFIG_BMC_IPMI
void ErrlEntry::addPartAndSerialNumbersToErrLog
(const TARGETING::Target * i_target)
{
TRACDCOMP(g_trac_errl, ENTER_MRK"ErrlEntry::addPartAndSerialNumbersToErrLog()");
// Get the type of the target
const TARGETING::Target * l_target = i_target;
TARGETING::TYPE l_type = l_target->getAttr<TARGETING::ATTR_TYPE>();
do
{
if((l_type != TARGETING::TYPE_PROC ) &&
(l_type != TARGETING::TYPE_DIMM ) &&
(l_type != TARGETING::TYPE_MEMBUF ))
{
TARGETING::PredicatePostfixExpr l_procDimmMembuf;
TARGETING::TargetHandleList l_pList;
TARGETING::PredicateCTM l_procs(TARGETING::CLASS_CHIP,
TARGETING::TYPE_PROC);
TARGETING::PredicateCTM l_dimms(TARGETING::CLASS_CARD,
TARGETING::TYPE_DIMM);
TARGETING::PredicateCTM l_membufs(TARGETING::CLASS_CHIP,
TARGETING::TYPE_MEMBUF);
l_procDimmMembuf.push(&l_procs).push(&l_dimms).Or()
.push(&l_membufs).Or();
// Search for any parents with TYPE_PROC, TYPE_DIMM, or TYPE_MEMBUF
TARGETING::targetService().getAssociated( l_pList, l_target,
TARGETING::TargetService::PARENT,
TARGETING::TargetService::ALL,
&l_procDimmMembuf);
// If no parent of desired type is present, break
if(!l_pList.size())
{
TRACFCOMP(g_trac_errl, "Error! errlentry.C::addPartAndSerialNumbersToErrLog - No parent containing Serial/Part numbers found.");
break;
}
else
{
// We have found the parent
l_target = l_pList[0];
}
}
// We have made it here so we have found a target that contains
// ATTR_SERIAL_NUMBER and ATTR_PART_NUMBER
//Add the part number to the error log.
ErrlUserDetailsAttribute( l_target,
TARGETING::ATTR_PART_NUMBER).addToLog(this);
//Add the serial number to the error log.
ErrlUserDetailsAttribute( l_target,
TARGETING::ATTR_SERIAL_NUMBER).addToLog(this);
}while( 0 );
TRACDCOMP(g_trac_errl, EXIT_MRK"ErrlEntry::addPartAndSerialNumbersToErrLog()");
}
#endif
///////////////////////////////////////////////////////////////////////////////
// for use by ErrlManager
void ErrlEntry::commit( compId_t i_committerComponent )
{
// TODO RTC 35258 need a better timepiece, or else apply a transform onto
// timebase for an approximation of real time.
iv_Private.iv_committed = getTB();
// User header contains the component ID of the committer.
iv_User.setComponentId( i_committerComponent );
setSubSystemIdBasedOnCallouts();
// Add the captured backtrace to the error log
if (iv_pBackTrace)
{
iv_pBackTrace->addToLog(this);
delete iv_pBackTrace;
iv_pBackTrace = NULL;
}
// Add the Hostboot Build ID to the error log
addHbBuildId();
// check to see if we should skip info and recoverable errors?
checkHiddenLogsEnable();
// Check to make sure targeting is initialized. If so, collect part and
// serial numbers
if(Util::isTargetingLoaded() && TARGETING::targetService().isInitialized())
{
// If this error was a hardware callout, add the serial and part numbers
// to the log. FSP provides this data so if there is no FSP, get them here.
if(!INITSERVICE::spBaseServicesEnabled())
{
for(size_t i = 0; i < iv_SectionVector.size(); i++)
{
ErrlUD * l_udSection = iv_SectionVector[i];
HWAS::callout_ud_t * l_ud =
reinterpret_cast<HWAS::callout_ud_t*>(l_udSection->iv_pData);
if((ERRL_COMP_ID == (l_udSection)->iv_header.iv_compId) &&
(1 == (l_udSection)->iv_header.iv_ver) &&
(ERRL_UDT_CALLOUT == (l_udSection)->iv_header.iv_sst) &&
(HWAS::HW_CALLOUT == l_ud->type))
{
uint8_t * l_uData = (uint8_t *)(l_ud + 1);
TARGETING::Target * l_target = NULL;
bool l_err = HWAS::retrieveTarget(l_uData,
l_target,
this);
if(!l_err)
{
#ifdef CONFIG_BMC_IPMI
addPartAndSerialNumbersToErrLog( l_target );
#endif
}
else
{
TRACFCOMP(g_trac_errl, "ErrlEntry::commit() - Error retrieving target");
}
}
}
}
}
else
{
TRACFCOMP(g_trac_errl,
"TARGETING has not been initialized yet! Skipping serial/part "
"number collection!");
}
}
///////////////////////////////////////////////////////////////////////////////
// Function to set the correct subsystem ID based on callout priorities
void ErrlEntry::setSubSystemIdBasedOnCallouts()
{
TRACDCOMP(g_trac_errl, INFO_MRK
"ErrlEntry::getSubSystemIdBasedOnCallouts()");
HWAS::callout_ud_t * pData = NULL;
HWAS::callout_ud_t * highestPriorityCallout = NULL;
// look thru the errlog for any Callout UserDetail sections
for( std::vector<ErrlUD*>::const_iterator it = iv_SectionVector.begin();
it != iv_SectionVector.end();
it++ )
{
// look for a CALLOUT section
if ((ERRL_COMP_ID == (*it)->iv_header.iv_compId) &&
(1 == (*it)->iv_header.iv_ver) &&
(ERRL_UDT_CALLOUT == (*it)->iv_header.iv_sst))
{
// its a callout, grab the priority
pData = reinterpret_cast<HWAS::callout_ud_t *>
( (*it)->iv_pData );
// figure out the highest priority callout, just grab
// the first one if there are several with the same
// priority.
if( highestPriorityCallout == NULL ||
( pData->priority > highestPriorityCallout->priority) )
{
highestPriorityCallout = pData;
}
}
} // for each SectionVector
// if this pointer is not null it will be pointing to the
// highest priority entry
if( highestPriorityCallout == NULL )
{
// no callouts in log, add default callout for hb code and
// add trace
TRACFCOMP(g_trac_errl, "WRN>> No callouts in elog %.8X", eid());
TRACFCOMP(g_trac_errl, "Adding default callout EPUB_PRC_HB_CODE ");
addProcedureCallout( HWAS::EPUB_PRC_HB_CODE,
HWAS::SRCI_PRIORITY_LOW);
iv_User.setSubSys( EPUB_FIRMWARE_HOSTBOOT );
}
else
{
pData = highestPriorityCallout;
if( pData->type == HWAS::HW_CALLOUT )
{
// rebuild the target from the entity path, then use
// the target type to determine the ssid
if (*((uint8_t *)(pData + 1)) != TARGET_IS_SENTINEL)
{
// copy the entity path from the data buffer
TARGETING::EntityPath ep;
memcpy(&ep, ( pData + 1), sizeof(ep));
// convert the EntityPath to a Target pointer
TARGETING::Target *pTarget =
TARGETING::targetService().toTarget(ep);
TRACDCOMP(g_trac_errl, INFO_MRK
"mapping highest priority target 0x%x "
"callout to determine SSID",
pTarget->getAttr<TARGETING::ATTR_TYPE>() );
// use the target type to get the failing ssid.
iv_User.setSubSys( getSubSystem(
pTarget->getAttr<TARGETING::ATTR_TYPE>()));
}
else
{
// it was the sentinel -- so just use the proc ssid
iv_User.setSubSys( EPUB_PROCESSOR_SUBSYS );
}
}
else if ( pData->type == HWAS::PROCEDURE_CALLOUT )
{
// for procedures, map the procedure to a subsystem
TRACDCOMP(g_trac_errl, INFO_MRK
"mapping highest priority procedure 0x%x "
"callout to determine SSID", pData->procedure);
iv_User.setSubSys(getSubSystem( pData->procedure));
}
else if ( pData->type == HWAS::BUS_CALLOUT )
{
TRACFCOMP(g_trac_errl, INFO_MRK
"mapping highest priority bus 0x%x "
"callout to determine SSID", pData->busType);
iv_User.setSubSys(getSubSystem(pData->busType));
}
else if ( pData->type == HWAS::CLOCK_CALLOUT )
{
TRACFCOMP(g_trac_errl, INFO_MRK
"mapping highest priority clock 0x%x "
"callout to determine SSID", pData->clockType);
iv_User.setSubSys(getSubSystem(pData->clockType));
}
else if ( pData->type == HWAS::PART_CALLOUT )
{
TRACFCOMP(g_trac_errl, INFO_MRK
"mapping highest priority part 0x%x "
"callout to determine SSID", pData->partType);
iv_User.setSubSys(getSubSystem(pData->partType));
}
else
{
TRACFCOMP(g_trac_errl, ERR_MRK
"Unknown callout type 0x%x, setting subsys to unknown",
pData->type);
iv_User.setSubSys(EPUB_UNKNOWN);
}
}
// add ssid to the SRC too, it is defined in the ErrlUH in FSP land
// in hb code it has been defined in both places and is also used
// in both places.
iv_Src.setSubSys( iv_User.getSubSys() );
TRACDCOMP(g_trac_errl, INFO_MRK
"ErrlEntry::setSubSystemIdBasedOnCallouts() "
"ssid selected 0x%X", iv_Src.getSubSys() );
}
///////////////////////////////////////////////////////////////////////////////
// Determine if this log should cause a termination
bool ErrlEntry::isTerminateLog() const
{
bool l_terminate = false;
switch( iv_termState )
{
case TERM_STATE_MNFG:
l_terminate = true;
break;
case TERM_STATE_SOFT:
l_terminate = true;
break;
default:
l_terminate = false;
break;
}
return l_terminate;
}
///////////////////////////////////////////////////////////////////////////////
// Map the target type to correct subsystem ID using a binary search
epubSubSystem_t ErrlEntry::getSubSystem( TARGETING::TYPE i_target ) const
{
TRACDCOMP(g_trac_errl, ENTER_MRK"getSubSystem()"
" i_target = 0x%x", i_target );
// local variables
epubSubSystem_t subsystem = EPUB_MISC_UNKNOWN;
uint32_t TARGET_TO_SUBSYS_TABLE_ENTRIES =
sizeof(TARGET_TO_SUBSYS_TABLE)/
sizeof(TARGET_TO_SUBSYS_TABLE[0]);
uint32_t low = 0;
uint32_t high = TARGET_TO_SUBSYS_TABLE_ENTRIES - 1;
uint32_t mid = 0;
while( low <= high )
{
mid = low + (( high - low)/2);
if ( TARGET_TO_SUBSYS_TABLE[mid].xType > i_target )
{
high = mid -1;
}
else if ( TARGET_TO_SUBSYS_TABLE[mid].xType < i_target )
{
low = mid + 1;
}
else
{
// found it
subsystem = TARGET_TO_SUBSYS_TABLE[mid].xSubSys;
break;
}
}
if( subsystem == EPUB_MISC_UNKNOWN )
{
TRACFCOMP(g_trac_errl,"WRN>> Failed to find subsystem ID for "
"target type 0x%x", i_target);
}
TRACDCOMP(g_trac_errl, EXIT_MRK"getSubSystem() ssid 0x%x", subsystem );
return (subsystem);
}
///////////////////////////////////////////////////////////////////////////////
// Map the procedure type to correct subsystem ID using a binary search
epubSubSystem_t ErrlEntry::getSubSystem( epubProcedureID i_procedure ) const
{
TRACDCOMP(g_trac_errl, ENTER_MRK"getSubSystem()"
" from procedure 0x%x", i_procedure );
// local variables
epubSubSystem_t subsystem = EPUB_MISC_UNKNOWN;
uint32_t PROCEDURE_TO_SUBSYS_TABLE_ENTRIES =
sizeof(PROCEDURE_TO_SUBSYS_TABLE)/
sizeof(PROCEDURE_TO_SUBSYS_TABLE[0]);
uint32_t low = 0;
uint32_t high = PROCEDURE_TO_SUBSYS_TABLE_ENTRIES -1;
uint32_t mid = 0;
while( low <= high )
{
mid = low + (( high - low)/2);
if ( PROCEDURE_TO_SUBSYS_TABLE[mid].xProc > i_procedure )
{
high = mid -1;
}
else if ( PROCEDURE_TO_SUBSYS_TABLE[mid].xProc < i_procedure )
{
low = mid + 1;
}
else
{
subsystem = PROCEDURE_TO_SUBSYS_TABLE[mid].xSubSys;
break;
}
}
if( subsystem == EPUB_MISC_UNKNOWN )
{