इंटरफ़ेस हैशिंग

यह दस्तावेज़ HIDL इंटरफ़ेस हैशिंग का वर्णन करता है, जो आकस्मिक इंटरफ़ेस परिवर्तनों को रोकने और यह सुनिश्चित करने के लिए एक तंत्र है कि इंटरफ़ेस परिवर्तनों की पूरी तरह से जाँच की जाती है। इस तंत्र की आवश्यकता है क्योंकि HIDL इंटरफ़ेस संस्करणित हैं, जिसका अर्थ है कि एक इंटरफ़ेस जारी होने के बाद इसे एप्लिकेशन बाइनरी इंटरफ़ेस (एबीआई) संरक्षित तरीके (जैसे टिप्पणी सुधार) को छोड़कर नहीं बदला जाना चाहिए।

लेआउट

प्रत्येक पैकेज रूट निर्देशिका (यानी hardware/interfaces के लिए android.hardware मैपिंग या vendor/foo/hardware/interfaces के लिए vendor.foo मैपिंग) में एक current.txt फ़ाइल होनी चाहिए जो सभी रिलीज़ की गई HIDL इंटरफ़ेस फ़ाइलों को सूचीबद्ध करती है।

# current.txt files support comments starting with a ‘#' character
# this file, for instance, would be vendor/foo/hardware/interfaces/current.txt

# Each line has a SHA-256 hash followed by the name of an interface.
# They have been shortened in this doc for brevity but they are
# 64 characters in length in an actual current.txt file.
d4ed2f0e...995f9ec4 vendor.awesome.foo@1.0::IFoo # comments can also go here

# types.hal files are also noted in current.txt files
c84da9f5...f8ea2648 vendor.awesome.foo@1.0::types

# Multiple hashes can be in the file for the same interface. This can be used
# to note how ABI sustaining changes were made to the interface.
# For instance, here is another hash for IFoo:

# Fixes type where "FooCallback" was misspelled in comment on "FooStruct"
822998d7...74d63b8c vendor.awesome.foo@1.0::IFoo

ध्यान दें: कौन सा हैश कहां से आता है, इस पर नज़र रखने में मदद के लिए, Google HIDL current.txt फ़ाइलों को अलग-अलग अनुभागों में अलग करता है: पहला अनुभाग Android O में जारी किया गया है; अगला भाग Android O MR1 में जारी किया जाएगा। हम आपकी current.txt फ़ाइल में समान लेआउट का उपयोग करने की दृढ़ता से अनुशंसा करते हैं।

हिडल-जेन के साथ हैशिंग

आप current.txt फ़ाइल में मैन्युअल रूप से या hidl-gen उपयोग करके हैश जोड़ सकते हैं। निम्नलिखित कोड स्निपेट उन कमांड के उदाहरण प्रदान करता है जिनका उपयोग आप current.txt फ़ाइल को प्रबंधित करने के लिए hidl-gen के साथ कर सकते हैं (हैश को छोटा कर दिया गया है):

hidl-gen -L hash -r vendor.awesome:vendor/awesome/hardware/interfaces -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport vendor.awesome.nfc@1.0::types
9626fd18...f9d298a6 vendor.awesome.nfc@1.0::types
hidl-gen -L hash -r vendor.awesome:vendor/awesome/hardware/interfaces -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport vendor.awesome.nfc@1.0::INfc
07ac2dc9...11e3cf57 vendor.awesome.nfc@1.0::INfc
hidl-gen -L hash -r vendor.awesome:vendor/awesome/hardware/interfaces -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport vendor.awesome.nfc@1.0
9626fd18...f9d298a6 vendor.awesome.nfc@1.0::types
07ac2dc9...11e3cf57 vendor.awesome.nfc@1.0::INfc
f2fe5442...72655de6 vendor.awesome.nfc@1.0::INfcClientCallback
hidl-gen -L hash -r vendor.awesome:vendor/awesome/hardware/interfaces -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport vendor.awesome.nfc@1.0 >> vendor/awesome/hardware/interfaces/current.txt

चेतावनी: पहले जारी किए गए इंटरफ़ेस के लिए हैश को न बदलें। ऐसे इंटरफ़ेस को बदलते समय, current.txt फ़ाइल के अंत में एक नया हैश जोड़ें। विवरण के लिए, एबीआई स्थिरता देखें।

hidl-gen द्वारा उत्पन्न प्रत्येक इंटरफ़ेस परिभाषा लाइब्रेरी में हैश शामिल है, जिसे IBase::getHashChain पर कॉल करके पुनर्प्राप्त किया जा सकता है। जब hidl-gen एक इंटरफ़ेस संकलित कर रहा है, तो यह HAL पैकेज की रूट निर्देशिका में current.txt फ़ाइल की जाँच करता है यह देखने के लिए कि क्या HAL को बदल दिया गया है:

• यदि एचएएल के लिए कोई हैश नहीं मिलता है, तो इंटरफ़ेस को अप्रकाशित (विकास में) माना जाता है और संकलन जारी रहता है।
• यदि हैश पाए जाते हैं, तो उन्हें वर्तमान इंटरफ़ेस के विरुद्ध जांचा जाता है:
  • यदि इंटरफ़ेस हैश से मेल खाता है, तो संकलन आगे बढ़ता है।
  • यदि इंटरफ़ेस हैश से मेल नहीं खाता है, तो संकलन रोक दिया जाता है क्योंकि इसका मतलब है कि पहले से जारी इंटरफ़ेस बदला जा रहा है।
    • ABI-संरक्षण परिवर्तन ( ABI स्थिरता देखें) के लिए, संकलन आगे बढ़ने से पहले current.txt फ़ाइल को संशोधित किया जाना चाहिए।
    • अन्य सभी परिवर्तन इंटरफ़ेस के छोटे या बड़े संस्करण अपग्रेड में किए जाने चाहिए।

एबीआई स्थिरता

एक एप्लिकेशन बाइनरी इंटरफ़ेस (एबीआई) में बाइनरी लिंकेज/कॉलिंग कन्वेंशन/आदि शामिल हैं। यदि एबीआई/एपीआई बदलता है, तो इंटरफ़ेस सामान्य system.img के साथ काम नहीं करता है जिसे आधिकारिक इंटरफ़ेस के साथ संकलित किया गया था।

यह सुनिश्चित करना कि इंटरफ़ेस संस्करणबद्ध हैं और ABI स्थिर कई कारणों से महत्वपूर्ण है:

• यह सुनिश्चित करता है कि आपका कार्यान्वयन वेंडर टेस्ट सूट (वीटीएस) पास कर सकता है, जो आपको केवल-फ्रेमवर्क ओटीए करने में सक्षम होने की राह पर रखता है।
• एक ओईएम के रूप में, यह आपको एक बोर्ड सपोर्ट पैकेज (बीएसपी) प्रदान करने में सक्षम बनाता है जो उपयोग में आसान और अनुपालन में आसान है।
• यह आपको ट्रैक रखने में मदद करता है कि कौन से इंटरफ़ेस जारी किए जा सकते हैं। current.txt एक इंटरफेस निर्देशिका के मानचित्र पर विचार करें जो आपको पैकेज रूट में प्रदान किए जा रहे सभी इंटरफेस का इतिहास और स्थिति देखने की अनुमति देता है।

किसी ऐसे इंटरफ़ेस के लिए नया हैश जोड़ते समय, जिसमें पहले से ही current.txt में एक प्रविष्टि है, सुनिश्चित करें कि केवल वही हैश जोड़ें जो उन इंटरफ़ेस का प्रतिनिधित्व करते हैं जो ABI स्थिरता बनाए रखते हैं। निम्नलिखित प्रकार के परिवर्तनों की समीक्षा करें: