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
|
/*
* Copyright (c) 2011-2014, Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or
* other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <pthread.h>
#include <map>
#include <vector>
#include <list>
#include "RemoteCommandHandlerTemplate.h"
#include "PathNavigator.h"
#include "SelectionCriterionType.h"
#include "SelectionCriterion.h"
#include "Element.h"
#include "XmlDocSink.h"
#include "XmlDocSource.h"
#include <string>
class CElementLibrarySet;
class CSubsystemLibrary;
class CSystemClass;
class CSelectionCriteria;
class CParameterFrameworkConfiguration;
class CSystemClassConfiguration;
class CParameterBlackboard;
class CConfigurableDomains;
class IRemoteProcessorServerInterface;
class CBackSynchronizer;
class CParameterHandle;
class CSubsystemPlugins;
class CParameterAccessContext;
class CConfigurableElement;
class CParameterMgr : private CElement
{
enum ChildElement {
EFrameworkConfiguration,
ESelectionCriteria,
ESystemClass,
EConfigurableDomains
};
enum ElementLibrary {
EFrameworkConfigurationLibrary,
EParameterCreationLibrary,
EParameterConfigurationLibrary
};
// Remote command parsers
typedef TRemoteCommandHandlerTemplate<CParameterMgr> CCommandHandler;
typedef CCommandHandler::CommandStatus (CParameterMgr::*RemoteCommandParser)(const IRemoteCommand& remoteCommand, std::string& strResult);
// Parser descriptions
struct SRemoteCommandParserItem
{
const char* _pcCommandName;
CParameterMgr::RemoteCommandParser _pfnParser;
uint32_t _uiMinArgumentCount;
const char* _pcHelp;
const char* _pcDescription;
};
// Version
static const uint32_t guiEditionMajor = 0x2;
static const uint32_t guiEditionMinor = 0x4;
static const uint32_t guiRevision = 0x0;
// Parameter handle friendship
friend class CParameterHandle;
public:
// Logger interface
class ILogger
{
public:
virtual void log(bool bIsWarning, const std::string& strLog) = 0;
protected:
virtual ~ILogger() {}
};
// Construction
CParameterMgr(const std::string& strConfigurationFilePath);
virtual ~CParameterMgr();
// Logging
void setLogger(ILogger* pLogger);
/** Load plugins, structures and settings from the config file given.
*
* @param[out] strError is a std::string describing the error if an error occurred
* undefined otherwise.
*
* @return true if no error occurred, false otherwise.
*/
bool load(std::string& strError);
// Selection Criteria
CSelectionCriterionType* createSelectionCriterionType(bool bIsInclusive);
CSelectionCriterion* createSelectionCriterion(const std::string& strName, const CSelectionCriterionType* pSelectionCriterionType);
// Selection criterion retrieval
CSelectionCriterion* getSelectionCriterion(const std::string& strName);
// Configuration application
void applyConfigurations();
/**
* Returns the CConfigurableElement corresponding to the path given in argument.
*
* @param[in] strPath A std::string representing a path to an element.
* @param[out] strError Error message
*
* @return A const pointer to the corresponding CConfigurableElement.
* On error, NULL is returned and the error is explained in strError.
*/
const CConfigurableElement* getConfigurableElement(const std::string& strPath,
std::string& strError) const;
// Dynamic parameter handling
CParameterHandle* createParameterHandle(const std::string& strPath, std::string& strError);
/** Is the remote interface forcefully disabled ?
*/
bool getForceNoRemoteInterface() const;
/**
* Forcefully disable the remote interface or cancel this policy
*
* @param[in] bForceNoRemoteInterface disable the remote interface if true.
*/
void setForceNoRemoteInterface(bool bForceNoRemoteInterface);
/** Should start fail in case of missing subsystems.
*
* @param[in] bFail: If set to true, parameterMgr start will fail on missing subsystems.
* If set to false, missing subsystems will fallback on virtual subsystem.
*/
void setFailureOnMissingSubsystem(bool bFail);
/** Would start fail in case of missing subsystems.
*
* @return true if the subsystem will fail on missing subsystem, false otherwise.
*/
bool getFailureOnMissingSubsystem() const;
/** Should start fail in failed settings load.
*
* @param[in] bFail: If set to true, parameterMgr start will fail on failed settings load.
* If set to false, failed settings load will be ignored.
*/
void setFailureOnFailedSettingsLoad(bool bFail);
/** Would start fail in case of failed settings load.
*
* @return failure on failed settings load policy state.
*/
bool getFailureOnFailedSettingsLoad();
/** Get the path to the directory containing the XML Schemas
*
* @returns the directory containing the XML Schemas
*/
const std::string& getSchemaFolderLocation() const;
/** Override the directory containing the XML Schemas
*
* @param[in] strSchemaFolderLocation directory containing the XML Schemas
*/
void setSchemaFolderLocation(const std::string& strSchemaFolderLocation);
/** Should .xml files be validated on start ?
*
* @param[in] bValidate:
* If set to true, parameterMgr will report an error
* when being unable to validate .xml files
* If set to false, no .xml/xsd validation will happen
* (default behaviour)
*
* @return false if unable to set, true otherwise.
*/
void setValidateSchemasOnStart(bool bValidate);
/** Would .xml files be validated on start?
*
* @return areSchemasValidated
*/
bool getValidateSchemasOnStart() const;
//////////// Tuning /////////////
// Tuning mode
bool setTuningMode(bool bOn, std::string& strError);
bool tuningModeOn() const;
// Current value space for user set/get value interpretation
void setValueSpace(bool bIsRaw);
bool valueSpaceIsRaw();
// Current Output Raw Format for user get value interpretation
void setOutputRawFormat(bool bIsHex);
bool outputRawFormatIsHex();
// Automatic hardware synchronization control (during tuning session)
bool setAutoSync(bool bAutoSyncOn, std::string& strError);
bool autoSyncOn() const;
bool sync(std::string& strError);
// User set/get parameters
bool accessParameterValue(const std::string& strPath, std::string& strValue, bool bSet, std::string& strError);
/**
* Returns the element mapping corresponding to the path given in parameter.
*
* @param[in] strPath Path of an element
* @param[out] strValue A sting containing the mapping
*
* @return true if a mapping was found for this element
*/
bool getParameterMapping(const std::string& strPath, std::string& strValue) const;
bool accessConfigurationValue(const std::string &strDomain, const std::string &stConfiguration, const std::string& strPath, std::string& strValue, bool bSet, std::string& strError);
////////// Configuration/Domains handling //////////////
// Creation/Deletion
bool createDomain(const std::string& strName, std::string& strError);
bool renameDomain(const std::string& strName, const std::string& strNewName,
std::string& strError);
bool deleteDomain(const std::string& strName, std::string& strError);
bool deleteAllDomains(std::string& strError);
bool setSequenceAwareness(const std::string& strName, bool bSequenceAware,
std::string& strResult);
bool getSequenceAwareness(const std::string& strName, bool& bSequenceAware,
std::string& strResult);
bool createConfiguration(const std::string& strDomain, const std::string& strConfiguration, std::string& strError);
bool deleteConfiguration(const std::string& strDomain, const std::string& strConfiguration, std::string& strError);
bool renameConfiguration(const std::string& strDomain, const std::string& strConfiguration, const std::string& strNewConfiguration, std::string& strError);
// Save/Restore
bool restoreConfiguration(const std::string& strDomain, const std::string& strConfiguration, std::list<std::string>& strError);
bool saveConfiguration(const std::string& strDomain, const std::string& strConfiguration, std::string& strError);
// Configurable element - domain association
bool addConfigurableElementToDomain(const std::string& strDomain, const std::string& strConfigurableElementPath, std::string& strError);
bool removeConfigurableElementFromDomain(const std::string& strDomain, const std::string& strConfigurableElementPath, std::string& strError);
bool split(const std::string& strDomain, const std::string& strConfigurableElementPath, std::string& strError);
bool setElementSequence(const std::string& strDomain, const std::string& strConfiguration,
const std::vector<std::string>& astrNewElementSequence,
std::string& strError);
bool getApplicationRule(const std::string& strDomain, const std::string& strConfiguration,
std::string& strResult);
bool setApplicationRule(const std::string& strDomain, const std::string& strConfiguration,
const std::string& strApplicationRule, std::string& strError);
bool clearApplicationRule(const std::string& strDomain, const std::string& strConfiguration,
std::string& strError);
/**
* Method that imports Configurable Domains from an Xml source.
*
* @param[in] strXmlSource a std::string containing an xml description or a path to an xml file
* @param[in] bWithSettings a boolean that determines if the settings should be used in the
* xml description
* @param[in] bFromFile a boolean that determines if the source is an xml description in
* strXmlSource or contained in a file. In that case strXmlSource is just the file path.
* @param[out] strError is used as the error output
*
* @return false if any error occures
*/
bool importDomainsXml(const std::string& strXmlSource, bool bWithSettings, bool bFromFile,
std::string& strError);
/**
* Method that imports a single Configurable Domain from an Xml source.
*
* @param[in] strXmlSource a string containing an xml description or a path to an xml file
* @param[in] bWithSettings a boolean that determines if the settings should be used in the
* xml description
* @param[in] bFromFile a boolean that determines if the source is an xml description in
* strXmlSource or contained in a file. In that case strXmlSource is just the file path.
* @param[out] strError is used as the error output
*
* @return false if any error occurs
*/
bool importSingleDomainXml(const std::string& strXmlSource, bool bOverwrite,
std::string& strError);
/**
* Method that exports Configurable Domains to an Xml destination.
*
* @param[in,out] strXmlDest a string containing an xml description or a path to an xml file
* @param[in] bWithSettings a boolean that determines if the settings should be used in the
* xml description
* @param[in] bToFile a boolean that determines if the destination is an xml description in
* strXmlDest or contained in a file. In that case strXmlDest is just the file path.
* @param[out] strError is used as the error output
*
* @return false if any error occurs, true otherwise.
*/
bool exportDomainsXml(std::string& strXmlDest, bool bWithSettings, bool bToFile,
std::string& strError) const;
/**
* Method that exports a given Configurable Domain to an Xml destination.
*
* @param[in,out] strXmlDest a string containing an xml description or a path to an xml file
* @param[in] strDomainName the name of the domain to be exported
* @param[in] bWithSettings a boolean that determines if the settings should be used in the
* xml description
* @param[in] bToFile a boolean that determines if the destination is an xml description in
* strXmlDest or contained in a file. In that case strXmlDest is just the file path.
* @param[out] strError is used as the error output
*
* @return false if any error occurs, true otherwise.
*/
bool exportSingleDomainXml(std::string& strXmlDest, const std::string& strDomainName,
bool bWithSettings, bool bToFile, std::string& strError) const;
// Binary Import/Export
bool importDomainsBinary(const std::string& strFileName, std::string& strError);
bool exportDomainsBinary(const std::string& strFileName, std::string& strError);
/**
* Method that exports an Xml description of the passed element into a string
*
* @param[in] pXmlSource The source element to export
* @param[in] strRootElementType The XML root element name of the exported instance document
* @param[out] strResult contains the xml description or the error description in case false is returned
*
* @return true for success, false if any error occurs during the creation of the xml description (validation or encoding)
*/
bool exportElementToXMLString(const IXmlSource* pXmlSource,
const std::string& strRootElementType,
std::string& strResult) const;
// CElement
virtual std::string getKind() const;
private:
CParameterMgr(const CParameterMgr&);
CParameterMgr& operator=(const CParameterMgr&);
// Init
virtual bool init(std::string& strError);
// Logging (done by root)
virtual void doLog(bool bIsWarning, const std::string& strLog) const;
virtual void nestLog() const;
virtual void unnestLog() const;
// Version
std::string getVersion() const;
////////////////:: Remote command parsers
/// Version
CCommandHandler::CommandStatus versionCommandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Status
CCommandHandler::CommandStatus statusCommandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Tuning Mode
CCommandHandler::CommandStatus setTuningModeCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getTuningModeCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Value Space
CCommandHandler::CommandStatus setValueSpaceCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getValueSpaceCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Output Raw Format
CCommandHandler::CommandStatus setOutputRawFormatCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getOutputRawFormatCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Sync
CCommandHandler::CommandStatus setAutoSyncCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getAutoSyncCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus syncCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Criteria
CCommandHandler::CommandStatus listCriteriaCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Domains
CCommandHandler::CommandStatus listDomainsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus createDomainCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus deleteDomainCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus deleteAllDomainsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus renameDomainCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus setSequenceAwarenessCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getSequenceAwarenessCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus listDomainElementsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus addElementCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus removeElementCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus splitDomainCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Configurations
CCommandHandler::CommandStatus listConfigurationsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus dumpDomainsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus createConfigurationCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus deleteConfigurationCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus renameConfigurationCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus saveConfigurationCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus restoreConfigurationCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus setElementSequenceCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getElementSequenceCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus setRuleCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus clearRuleCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getRuleCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Elements/Parameters
CCommandHandler::CommandStatus listElementsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus listParametersCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus dumpElementCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getElementSizeCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus showPropertiesCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getParameterCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus setParameterCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus getConfigurationParameterCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus setConfigurationParameterCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus listBelongingDomainsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus listAssociatedDomainsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus showMappingCommmandProcess(const IRemoteCommand& remoteCommand,
std::string& strResult);
/// Browse
CCommandHandler::CommandStatus listAssociatedElementsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus listConflictingElementsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus listRogueElementsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/// Settings Import/Export
CCommandHandler::CommandStatus exportConfigurableDomainsToXMLCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus importConfigurableDomainsFromXMLCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus exportConfigurableDomainsWithSettingsToXMLCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus importConfigurableDomainsWithSettingsFromXMLCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus importConfigurableDomainWithSettingsFromXMLCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus exportSettingsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
CCommandHandler::CommandStatus importSettingsCommmandProcess(const IRemoteCommand& remoteCommand, std::string& strResult);
/**
* Command handler method for getConfigurableDomainsWithSettings command.
*
* @param[in] remoteCommand contains the arguments of the received command.
* @param[out] strResult a std::string containing the result of the command
*
* @return CCommandHandler::ESucceeded if command succeeded or CCommandHandler::EFailed
* in the other case
*/
CCommandHandler::CommandStatus getConfigurableDomainsWithSettingsXMLCommmandProcess(
const IRemoteCommand& remoteCommand, std::string& strResult);
/**
* Command handler method for getConfigurableDomainWithSettings command.
*
* @param[in] remoteCommand contains the arguments of the received command.
* @param[out] strResult a string containing the result of the command
*
* @return CCommandHandler::ESucceeded if command succeeded or CCommandHandler::EFailed
* in the other case
*/
CCommandHandler::CommandStatus getConfigurableDomainWithSettingsXMLCommmandProcess(
const IRemoteCommand& remoteCommand, std::string& strResult);
/**
* Command handler method for setConfigurableDomainWithSettings command.
*
* @param[in] remoteCommand contains the arguments of the received command.
* @param[out] strResult a std::string containing the result of the command
*
* @return CCommandHandler::ESucceeded if command succeeded or CCommandHandler::EFailed
* in the other case
*/
CCommandHandler::CommandStatus setConfigurableDomainsWithSettingsXMLCommmandProcess(
const IRemoteCommand& remoteCommand, std::string& strResult);
/**
* Command handler method for getSystemClass command.
*
* @param[in] remoteCommand contains the arguments of the received command.
* @param[out] strResult a std::string containing the result of the command
*
* @return CCommandHandler::ESucceeded if command succeeded or CCommandHandler::EFailed
* in the other case
*/
CCommandHandler::CommandStatus getSystemClassXMLCommmandProcess(
const IRemoteCommand& remoteCommand, std::string& strResult);
// Max command usage length, use for formatting
void setMaxCommandUsageLength();
// For tuning, check we're in tuning mode
bool checkTuningModeOn(std::string& strError) const;
// Blackboard (dynamic parameter handling)
pthread_mutex_t* getBlackboardMutex();
// Blackboard reference (dynamic parameter handling)
CParameterBlackboard* getParameterBlackboard();
// Parameter access
bool accessValue(CParameterAccessContext& parameterAccessContext, const std::string& strPath, std::string& strValue, bool bSet, std::string& strError);
bool doSetValue(const std::string& strPath, const std::string& strValue, bool bRawValueSpace, bool bDynamicAccess, std::string& strError) const;
bool doGetValue(const std::string& strPath, std::string& strValue, bool bRawValueSpace, bool bHexOutputRawFormat, bool bDynamicAccess, std::string& strError) const;
// Framework global configuration loading
bool loadFrameworkConfiguration(std::string& strError);
// System class Structure loading
bool loadStructure(std::string& strError);
// System class Structure loading
bool loadSettings(std::string& strError);
bool loadSettingsFromConfigFile(std::string& strError);
// Parse XML file into Root element
bool xmlParse(CXmlElementSerializingContext& elementSerializingContext, CElement* pRootElement, const std::string& strXmlFilePath, const std::string& strXmlFolder, ElementLibrary eElementLibrary, const std::string& strNameAttrituteName = "Name");
/**
* Export an element object to an Xml destination.
*
*
* @param[in,out] strXmlDest a string containing an xml description or a path to an xml file.
* @param[in] xmlSerializingContext the serializing context
* @param[in] bToFile a boolean that determines if the destination is an xml description in
* strXmlDest or contained in a file. In that case strXmlDest is just the file path.
* @param[in] element object to be serialized.
* @param[out] strError is used as the error output.
*
* @return false if any error occurs, true otherwise.
*/
bool serializeElement(std::string& strXmlDest, CXmlSerializingContext& xmlSerializingContext,
bool bToFile, const CElement& element, std::string& strError) const;
/**
* Method that imports a single Configurable Domain, with settings, from an Xml file.
*
* @param[in] strXmlFilePath absolute path to the xml file containing the domain
* @param[out] strError is used as the error output
*
* @return false if any error occurs
*/
bool importDomainFromFile(const std::string& strXmlFilePath, bool bOverwrite,
std::string& strError);
// Framework Configuration
CParameterFrameworkConfiguration* getFrameworkConfiguration();
const CParameterFrameworkConfiguration* getConstFrameworkConfiguration();
// Selection Criteria
CSelectionCriteria* getSelectionCriteria();
const CSelectionCriteria* getConstSelectionCriteria();
// System Class
CSystemClass* getSystemClass();
const CSystemClass* getConstSystemClass() const;
// Configurable Domains
CConfigurableDomains* getConfigurableDomains();
const CConfigurableDomains* getConstConfigurableDomains();
const CConfigurableDomains* getConstConfigurableDomains() const;
// Apply configurations
void doApplyConfigurations(bool bForce);
// Dynamic object creation libraries feeding
void feedElementLibraries();
// Remote Processor Server connection handling
bool handleRemoteProcessingInterface(std::string& strError);
// Back synchronization
CBackSynchronizer* createBackSynchronizer() const;
// Tuning
bool _bTuningModeIsOn;
// Value Space
bool _bValueSpaceIsRaw;
// Output Raw Format
bool _bOutputRawFormatIsHex;
// Automatic synchronization to HW during Tuning session
bool _bAutoSyncOn;
// Current Parameter Settings
CParameterBlackboard* _pMainParameterBlackboard;
// Dynamic object creation
CElementLibrarySet* _pElementLibrarySet;
// XML parsing, object creation handling
std::string _strXmlConfigurationFilePath; // Configuration file path
std::string _strXmlConfigurationFolderPath; // Root folder for configuration file
std::string _strSchemaFolderLocation; // Place where schemas stand
// Subsystem plugin location
const CSubsystemPlugins* _pSubsystemPlugins;
/**
* Remote processor library handle
*/
void* _pvLibRemoteProcessorHandle;
// Whole system structure checksum
uint8_t _uiStructureChecksum;
// Command Handler
CCommandHandler* _pCommandHandler;
// Remote Processor Server
IRemoteProcessorServerInterface* _pRemoteProcessorServer;
// Parser description array
static const SRemoteCommandParserItem gastRemoteCommandParserItems[];
// Parser description array size
static const uint32_t guiNbRemoteCommandParserItems;
// Maximum command usage length
uint32_t _uiMaxCommandUsageLength;
// Blackboard access mutex
pthread_mutex_t _blackboardMutex;
// Logging
ILogger* _pLogger;
mutable uint32_t _uiLogDepth;
/** If set to false, the remote interface won't be started no matter what.
* If set to true - the default - it has no impact on the policy for
* starting the remote interface.
*/
bool _bForceNoRemoteInterface;
/** If set to true, missing subsystem will abort parameterMgr start.
* If set to false, missing subsystem will fallback on virtual subsystem.
*/
bool _bFailOnMissingSubsystem;
/** If set to true, unparsable or discording domains will abort parameterMgr start.
* If set to false, unparsable or discording domains
* will continue the parameterMgr start with no domains.
*/
bool _bFailOnFailedSettingsLoad;
/**
* If set to true, parameterMgr will report an error
* when being unable to validate .xml files
* If set to false, no .xml/xsd validation will happen (default behaviour)
*/
bool _bValidateSchemasOnStart;
};
|