مراقبة ABI لنظام تشغيل Android

يمكنك استخدام أدوات مراقبة واجهة التطبيق الثنائية (ABI)، المتوفّرة في Android 11 والإصدارات الأحدث، لتحسين استقرار واجهة التطبيق الثنائية (ABI) المضمّنة في نواة نظام التشغيل Android. تجمع الأدوات تمثيلات ABI من ملفات ثنائية النواة الحالية (vmlinux+ وحدات GKI) وتقارن بينها. تمثيلات ABI هذه هي ملفات .stg وقوائم الرموز. تُعرف الواجهة التي يعرض عليها التمثيل عرضًا باسم واجهة وحدة النواة (KMI). يمكنك استخدام الأدوات لتتبُّع التغييرات في مؤشر KMI والحدّ من تأثيرها.

تم تطوير أدوات مراقبة ABI في AOSP وتستخدم STG (أو libabigail في Android 13 والإصدارات الأقدم) لإنشاء نماذج مقارنة.

توضّح هذه الصفحة الأدوات وعملية جمع تمثيلات ABI وتحليلها واستخدام هذه التمثيلات لتوفير ثبات لـ ABI داخل النواة. تقدّم هذه الصفحة أيضًا معلومات للمساهمة في إدخال تغييرات على نواة Android.

معالجة

يتطلّب تحليل ABI للنواة خطوات متعدّدة، يمكن تنفيذ معظمها تلقائيًا:

  1. إنشاء النواة وتمثيل واجهة ABI
  2. تحليل الاختلافات في ABI بين الإصدار والمرجع
  3. عدِّل تمثيل ABI (إذا لزم الأمر).
  4. العمل مع قوائم الرموز

يمكن تطبيق التعليمات التالية على أي نواة يمكنك إنشاؤها باستخدام مجموعة أدوات متوافقة (مثل مجموعة أدوات Clang المُنشأة مسبقًا). تتوفر repo manifests لجميع فروع نواة Android الشائعة ولعدة ملفّات نواة خاصة بالأجهزة، وهي تضمن استخدام مجموعة الأدوات الصحيحة عند إنشاء إصدار نواة للتحليل.

قوائم الرموز

لا يتضمّن ملف KMI جميع الرموز في النواة أو حتى كل الرموز التي تم تصديرها والتي تزيد عن 30,000 رمز. بدلاً من ذلك، يتم إدراج الرموز التي يمكن أن تستخدمها وحدات المورّدين بشكل صريح في مجموعة من ملفات قائمة الرموز التي يتم الاحتفاظ بها بشكل علني في جذر شجرة النواة. يحدِّد تجميع جميع الرموز في جميع ملفات قوائم الرموز مجموعة رموز KMI التي يتم الاحتفاظ بها كمجموعة ثابتة. مثال على ملف قائمة الرموز هو abi_gki_aarch64_db845c، الذي يعرِض الرموز المطلوبة لجهاز DragonBoard 845c.

لا يُعتبَر جزءًا من قاعدة بيانات KMI سوى الرموز المدرَجة في قائمة الرموز والبنى والتعريفات ذات الصلة بها. يمكنك نشر التغييرات على قوائم الرموز إذا لم تكن الرموز التي تحتاج إليها متوفّرة. بعد أن تصبح الواجهات الجديدة في قائمة الرموز، وتصبح جزءًا من وصف KMI، يتم الحفاظ عليها باعتبارها مستقرة ويجب عدم إزالتها من قائمة الرموز أو تعديلها بعد تجميد الفرع.

يحتوي كل فرع من فروع "النواة الشائعة لنظام التشغيل Android" (ACK) على مجموعة خاصة به من قوائم الرموز. لا يتمّ إجراء أيّ محاولة لتوفير ثبات ABI بين مشاريع kernel KMI المختلفة. على سبيل المثال، يكون مقياس KMI الخاص بـ android12-5.10 مستقلاً تمامًا عن مقياس KMI الخاص بـ android13-5.10.

تستخدِم أدوات ABI قوائم رموز KMI للحدّ من الواجهات التي يجب مراقبتها من أجل الثبات. تحتوي قائمة الرموز الرئيسية على الرموز المطلوبة من وحدات نواة GKI. من المفترض أن يقدّم المورّدون ويحدّثون قوائم الرموز الإضافية لضمان الحفاظ على توافق ABI مع الواجهات التي يعتمدون عليها. على سبيل المثال، للاطّلاع على قائمة بقوائم الرموز الخاصة بـ android13-5.15، يُرجى الرجوع إلى https://android.googlesource.com/kernel/common/+/refs/heads/android13-5.15/android.

تحتوي قائمة الرموز على الرموز التي تم الإبلاغ عن أنّها مطلوبة لجهة التصنيع أو الجهاز المعيّنين. القائمة الكاملة التي تستخدمها الأدوات هي اتحاد جميع ملفات قائمة رموز KMI. تحدِّد أدوات ABI تفاصيل كل رمز، بما في ذلك توقيع الدالة وهياكل البيانات المتداخلة.

عند تجميد واجهة مستخدم KMI، لا يُسمح بإجراء أي تغييرات على واجهات KMI الحالية، لأنّها مستقرة. ومع ذلك، يُتاح للمورّدين إضافة رموز إلى قاعدة بيانات KMI في أي وقت ما دامت الإضافات لا تؤثّر في استقرار ABI الحالي. يتم الحفاظ على ثبات العلامات المُضافة حديثًا فور الإشارة إليها في قائمة رموز KMI. يجب عدم إزالة الرموز من قائمة نواة ما ما لم يكن من الممكن تأكيد أنّه لم يتم شحن أي جهاز يتضمّن رمزًا يعتمد على هذا الرمز.

يمكنك إنشاء قائمة رموز KMI لجهاز باستخدام التعليمات الواردة في مقالة كيفية التعامل مع قوائم الرموز. يرسل العديد من الشركاء قائمة رموز واحدة لكلّ رسالة تأكيد، ولكنّ هذا ليس شرطًا صارمًا. يمكنك إرسال قوائم رموز متعددة إذا كان ذلك يساعد في عملية الصيانة.

توسيع نطاق نموذج KMI

في حين أنّ رموز KMI والهياكل ذات الصلة تظلّ ثابتة (أي أنّه لا يمكن قبول التغيُّرات التي تؤدي إلى إيقاف الواجهات الثابتة في نواة تتضمّن KMI مجمّدًا)، تظلّ نواة GKI مفتوحة للاستخدام مع الإضافات حتى لا تحتاج الأجهزة التي يتم شحنها في وقت لاحق من العام إلى تحديد جميع العناصر التي تعتمد عليها قبل تجميد KMI. لتوسيع نطاق KMI، يمكنك إضافة رموز جديدة إلى KMI لدوالّ kernel الجديدة أو الحالية التي تم تصديرها، حتى إذا تم تجميد KMI. قد يتم أيضًا قبول تصحيحات ملف التمهيد الجديدة إذا كانت لا تؤدي إلى إيقاف KMI.

لمحة عن حالات تعطُّل ميزة "التجوّل الافتراضي"

تحتوي النواة على مصادر ويتم إنشاء الملفات الثنائية من هذه المصادر. تتضمّن فروع النواة التي يتم تتبُّعها من خلال ABI تمثيلًا لـ ABI لـ GKI ABI الحالي (بتنسيق ملف .stg). بعد إنشاء الملفات الثنائية (vmlinux وImage و أي وحدات GKI)، يمكن استخراج تمثيل ABI من الملفات الثنائية. يمكن أن يؤثر أي تغيير يتم إجراؤه على ملف مصدر نواة النظام في الملفات الثنائية، وبالتالي في .stg المستخرَج. يقارن محلّل AbiAnalyzerملف .stg الذي تمّコミتمنته بالملف المستخرَج من عناصر التصميم، ويضع تصنيفًا Lint-1 على التغيير في Gerrit إذا رصد اختلافًا دلاليًا.

التعامل مع حالات تعطُّل واجهات ABI

على سبيل المثال، يؤدي التصحيح التالي إلى حدوث خلل واضح جدًا في ABI:

diff --git a/include/linux/mm_types.h b/include/linux/mm_types.h
index 42786e6364ef..e15f1d0f137b 100644
--- a/include/linux/mm_types.h
+++ b/include/linux/mm_types.h
@@ -657,6 +657,7 @@ struct mm_struct {
                ANDROID_KABI_RESERVE(1);
        } __randomize_layout;

+       int tickle_count;
        /*
         * The mm_cpumask needs to be at the end of mm_struct, because it
         * is dynamically sized based on nr_cpu_ids.

عند تشغيل واجهة برمجة التطبيقات (ABI) للإصدار مع تطبيق هذا الإصلاح، تنتهي الأداة مع رمز خطأ غير صفري وتُبلغ عن اختلاف في واجهة برمجة التطبيقات (ABI) مشابه لما يلي:

function symbol 'struct block_device* I_BDEV(struct inode*)' changed
  CRC changed from 0x8d400dbd to 0xabfc92ad

function symbol 'void* PDE_DATA(const struct inode*)' changed
  CRC changed from 0xc3c38b5c to 0x7ad96c0d

function symbol 'void __ClearPageMovable(struct page*)' changed
  CRC changed from 0xf489e5e8 to 0x92bd005e

... 4492 omitted; 4495 symbols have only CRC changes

type 'struct mm_struct' changed
  byte size changed from 992 to 1000
  member 'int tickle_count' was added
  member 'unsigned long cpu_bitmap[0]' changed
    offset changed by 64

تم رصد اختلافات في ABI في وقت الإنشاء

إنّ السبب الأكثر شيوعًا للأخطاء هو استخدام برنامج تشغيل رمزًا جديدًا من ملف ‎"النواة" ليس مُدرَجًا في أي من قوائم الرموز.

إذا لم يكن الرمز مُدرَجًا في قائمة الرموز (android/abi_gki_aarch64)، عليك أولاً التأكّد من تصديره باستخدام EXPORT_SYMBOL_GPL(symbol_name) ثم تعديل تمثيل XML ورمز ABI وقائمة الرموز. على سبيل المثال، تضيف التغييرات التالية ميزة FS المتزايدة الجديدة إلى الفرع android-12-5.10، والتي تشمل تعديل قائمة الرموز وتمثيل ABI بتنسيق XML.

  • يمكنك العثور على مثال على تغيير الميزة في aosp/1345659.
  • يمكنك العثور على مثال لقائمة الرموز فيملف aosp/1346742.
  • يمكنك العثور على مثال على تغيير ملف ABI XML في aosp/1349377.

إذا تم تصدير الرمز (إما من قِبلك أو سبق أن تم تصديره) ولكن لا يستخدمه أي برنامج تشغيل آخر، قد يظهر لك خطأ في الإنشاء مشابه لما يلي.

Comparing the KMI and the symbol lists:
+ build/abi/compare_to_symbol_list out/$BRANCH/common/Module.symvers out/$BRANCH/common/abi_symbollist.raw
ERROR: Differences between ksymtab and symbol list detected!
Symbols missing from ksymtab:
Symbols missing from symbol list:
 - simple_strtoull

لحلّ هذه المشكلة، عليك تعديل قائمة رموز KMI في كلّ من النواة وACK (راجِع تعديل تمثيل ABI). للحصول على مثال على تعديل ملف ABI XML وقائمة الرموز في ACK، يُرجى الرجوع إلى aosp/1367601.

حلّ مشاكل تعذُّر استخدام واجهة برمجة التطبيقات للنواة

يمكنك التعامل مع حالات تعطُّل ABI للنواة من خلال إعادة صياغة الرمز لتجنُّب تغيير IDE أو تعديل تمثيل ABI. استخدِم الرسم البياني التالي لتحديد أفضل نهج لحالتك.

رسم بياني انسيابي لحالات كسر ABI

الشكل 1: حلّ مشكلة عدم توافق واجهة ABI

إعادة صياغة الرمز لتجنُّب تغييرات ABI

ابذل قصارى جهدك لتجنُّب تعديل ABI الحالي. في كثير من الحالات، يمكنك إعادة صياغة الرمز البرمجي لإزالة التغييرات التي تؤثّر في ABI.

  • إعادة صياغة تغييرات حقل البنية إذا كان التغيير يُعدِّل ABI ميزة debugging ، أضِف #ifdef حول الحقول (في البنى ومراجع المصدر) وتأكَّد من أنّ CONFIG المستخدَم في #ifdef غير مفعَّل لملف gki_defconfig وملف defconfig في وضع الإنتاج. للحصول على مثال على كيفية إضافة ملف برمجي لضبط debugging إلى بنية بدون إيقاف ABI، يُرجى الرجوع إلى مجموعة التعديلات هذه.

  • إعادة صياغة الميزات لتجنُّب تغيير النواة الأساسية إذا كان يجب إضافة ميزات جديدة إلى ACK لتتوافق مع وحدات الشركاء، حاوِل إعادة صياغة ABI كجزء من التغيير لتجنُّب تعديل ABI للنواة. للحصول على مثال على استخدام واجهة تطبيقات ثنائية (ABI) الحالية للنواة لإضافة إمكانات إضافية بدون تغيير واجهة تطبيقات ثنائية (ABI) للنواة، يُرجى الرجوع إلى aosp/1312213.

إصلاح واجهة برمجة تطبيقات معطّلة على Android Gerrit

إذا لم تكن قد اخترقت ABI للنواة عن قصد، عليك التحقيق في الأمر، باستخدام الإرشادات المقدَّمة من خلال أدوات مراقبة ABI. إنّ الأسباب الأكثر شيوعًا للحدوث الأعطال هي تغيير هياكل البيانات وتغيير رمز CRC المرتبط بها، أو بسبب تغييرات خيارات الضبط التي تؤدي إلى أيّ من الأسباب المذكورة أعلاه. ابدأ بمعالجة المشاكل التي عثرت عليها الأداة.

يمكنك إعادة إنتاج نتائج ABI محليًا، اطّلِع على إنشاء النواة وتمثيل ABI.

لمحة عن تصنيفات Lint-1

في حال تحميل تغييرات إلى فرع يتضمّن ملف KMI مجمّدًا أو نهائيًا، يجب أن تجتاز التغييرات AbiAnalyzer لضمان عدم تأثير التغييرات في ABI الثابت بطريقة غير متوافقة. خلال هذه العملية، يبحث AbiAnalyzer عن تقرير ABI الذي تم إنشاؤه أثناء عملية الإنشاء (عملية إنشاء موسّعة تُجري عملية الإنشاء العادية ثم بعض خطوات استخراج ABI ومقارنتها).

إذا عثر AbiAnalyzer على تقرير غير فارغ، سيضبط التصنيف Lint-1 ويتم حظر إرسال المحتوى المتغيّر إلى أن يتم حلّ المشكلة، إلى أن تتلقّى مجموعة التصحيحات تصنيف Lint+1.

تعديل واجهة برمجة التطبيقات للنواة

إذا كان لا مفر من تعديل ABI، عليك تطبيق تغييرات الرمز البرمجي، وتمثيل ABI، وقائمة الرموز على ACK. لإزالة القيمة -1 من خلال Lint وعدم إيقاف توافق GKI، اتّبِع الخطوات التالية:

  1. حمِّل التغييرات في الرمز إلى الإشعار بتلقّي الرسالة.

  2. انتظِر تلقّي مراجعة رمز +2 لمجموعة التصحيحات.

  3. تعديل تمثيل ABI المرجعي

  4. دمج تغييرات الرمز البرمجي وتغيير تحديث ABI

تحميل التغييرات في رمز ABI إلى ACK

يعتمد تعديل ABI لتطبيق ACK على نوع التغيير الذي يتم إجراؤه.

  • إذا كان تغيير ABI مرتبطًا بميزة تؤثّر في اختبارات CTS أو VTS، يمكن عادةً اختيار التغيير لتأكيده كما هو. على سبيل المثال:

    • يجب توفّر حزمة aosp/1289677 لكي يعمل الصوت.
    • يجب تثبيت الإصدار aosp/1295945 لكي يعمل منفذ USB.
  • إذا كان تغيير ABI ناتجًا عن ميزة يمكن مشاركتها مع ACK، يمكن اختيار هذا التغيير وإضافته إلى ACK كما هو. على سبيل المثال، التغييرات التالية غير مطلوبة لاختبار CTS أو VTS، ولكن يمكن مشاركتها مع ACK:

  • إذا كان تغيير ABI يقدّم ميزة جديدة لا يلزم تضمينها في ACK، يمكنك إدخال الرموز إلى ACK باستخدام رمز نائب كما هو موضّح في القسم التالي.

استخدام العناصر النائبة لتأكيد الاستلام

يجب أن تكون العناصر الأساسية ضرورية فقط لتغييرات النواة الأساسية التي لا تفيد ACK، مثل تغييرات الأداء والطاقة. توضِّح القائمة التالية أمثلة على العناصر النائبة وعمليات الاختيار الجزئي في ACK لـ GKI.

  • رمز أساسي لميزة العزل (aosp/1284493). ليست الإمكانات في ACK ضرورية، ولكن يجب أن تكون الرموز متوفّرة في ACK لكي تستخدم وحداتك هذه الرموز.

  • رمز العنصر النائب لمكوّن المورّد (aosp/1288860).

  • اختيار ABI فقط لميزة تتبُّع أحداث mm لكل عملية (aosp/1288454). تم اختيار التصحيح الأصلي للموافقة عليه، ثم تم اقتصاصه ليشمل فقط التغييرات اللازمة لحلّ مشكلة اختلاف ABI في task_struct و mm_event_count. يُعدّل هذا الإصلاح أيضًا قائمة القيم المحدّدة mm_event_type لتشمل الأعضاء النهائيين.

  • اختيار جزئي لتغييرات ABI في البنية الحرارية التي تتطلّب أكثر من إضافة حقول ABI الجديدة

    • تم حلّ الاختلافات في ABI بين نواة الشريك وACK من خلال التصحيح aosp/1255544.

    • تم حلّ المشاكل المتعلقة بالوظائف في التصحيح aosp/1291018 الذي تم رصده أثناء اختبار GKI للتصحيح السابق. يتضمّن الإصلاح إعداد بنية مَعلمات الاستشعار لتسجيل مناطق حرارية متعددة في جهاز استشعار واحد.

  • CONFIG_NL80211_TESTMODE تغييرات ABI (aosp/1344321) أضاف هذا الإصلاح التغييرات اللازمة في البنية لـ ABI والتأكّد من أنّه لم تتسبب الحقول الإضافية في حدوث اختلافات وظيفية، ما سمح للشركاء بتضمين CONFIG_NL80211_TESTMODE في نواة الإصدار العلني مع مواصلة الالتزام بمعايير GKI.

فرض نموذج KMI في وقت التشغيل

تستخدم نوى GKI خيارَي الضبط TRIM_UNUSED_KSYMS=y وUNUSED_KSYMS_WHITELIST=<union of all symbol lists>، ما يحدّ من الرموز التي يتم تصديرها (مثل الرموز التي يتم تصديرها باستخدام EXPORT_SYMBOL_GPL()) إلى تلك المدرَجة في قائمة الرموز. ولا يتم تصدير جميع الرموز الأخرى، ويتم رفض تحميل وحدة تتطلّب استخدام رمز غير مُصدَّر. يتم فرض هذا القيد في وقت الإنشاء ويتم وضع علامة على الإدخالات المفقودة.

لأغراض التطوير، يمكنك استخدام إصدار من نواة GKI لا يتضمّن تقطيع الرموز (أي يمكن استخدام جميع الرموز التي يتم تصديرها عادةً). لتحديد موقع هذه الإصدارات، ابحث عن إصدارات kernel_debug_aarch64 على ci.android.com.

فرض نموذج KMI باستخدام نظام تحديد الإصدارات للوحدات

تستخدِم نوى "صورة النواة العامة" (GKI) نظام ترقيم الإصدارات للوحدات (CONFIG_MODVERSIONS) كإجراء إضافي لفرض الامتثال لـ KMI أثناء وقت التشغيل. يمكن أن يؤدي تحديث الوحدات إلى حدوث أخطاء في فحص التكرار الدوري (CRC) في وقت تحميل الوحدة إذا لم يتطابق معيار KMI المتوقّع للوحدة مع vmlinux معيار KMI. على سبيل المثال، في ما يلي خطأ شائع يحدث في وقتتحميل الوحدات بسبب عدم تطابق فحص التكرار الدوري للرمز module_layout():

init: Loading module /lib/modules/kernel/.../XXX.ko with args ""
XXX: disagrees about version of symbol module_layout
init: Failed to insmod '/lib/modules/kernel/.../XXX.ko' with args ''

استخدامات ترقيم إصدارات الوحدات

يكون استخدام الإصدارات في الوحدات مفيدًا للأسباب التالية:

  • يرصد نظام ترقيم الإصدارات للوحدات التغييرات في مستوى عرض بنية البيانات. إذا كانت الوحدات تغيّر بنى البيانات غير الشفافة، أي بنى البيانات التي ليست جزءًا من KMI، ستتعطّل بعد إجراء تغييرات مستقبلية على البنية.

    على سبيل المثال، فكِّر في حقل fwnode في struct device. يجب أن يكون هذا الحقل مبهمًا للوحدات حتى لا تتمكّن من إجراء تغييرات على حقول device->fw_node أو إجراء افتراضات حول حجمها.

    ومع ذلك، إذا كانت إحدى الوحدات تتضمّن <linux/fwnode.h> (بشكل مباشر أو غير مباشر)، لن يعود حقل fwnode في struct device غير شفاف بالنسبة إليها. يمكن للوحدة عندئذٍ إجراء تغييرات على device->fwnode->dev أو device->fwnode->ops. يشكّل هذا السيناريو مشكلة لعدة أسباب، كما هو موضّح أدناه:

    • ويمكن أن يؤدي ذلك إلى كسر الافتراضات التي يطرحها رمز النواة الأساسي حول بنية البيانات الداخلية.

    • إذا غيّر تحديث مستقبلي للنواة struct fwnode_handle (نوع data fwnode)، لن تعمل الوحدة مع النواة الجديدة. بالإضافة إلى ذلك، لن يعرض stgdiff أي اختلافات لأنّ الوحدة تؤدي إلى تعطيل المعيار KMI من خلال التلاعب بهياكل البيانات الداخلية مباشرةً بطرق لا يمكن تسجيلها من خلال فحص التمثيل الثنائي فقط.

  • تُعدّ الوحدة الحالية غير متوافقة مع KMI عند تحميلها في تاريخ لاحق بواسطة نواة جديدة غير متوافقة. تضيف عملية تحديد الإصدار للوحدة عملية تحقّق من وقت التشغيل لتجنُّب تحميل وحدة غير متوافقة مع KMI مع kernel عن طريق الخطأ. يمنع هذا التحقّق حدوث مشاكل وقت التشغيل التي يصعب تصحيحها وتعطلات نظام التشغيل التي قد تنتج عن عدم توافق غير محدّد في KMI.

ويؤدي تفعيل نظام تحديد الإصدارات للوحدات إلى منع حدوث كل هذه المشاكل.

التحقّق من حالات عدم تطابق أرقام التحقق من صحة البيانات (CRC) بدون تشغيل الجهاز

يقارن stgdiff حالات عدم تطابق CRC بين النوى ويُبلغ عنها، بالإضافة إلى اختلافات ABI الأخرى.

بالإضافة إلى ذلك، يؤدي إنشاء نواة كاملة مع تفعيل CONFIG_MODVERSIONS إلى إنشاء ملف Module.symvers كجزء من عملية الإنشاء العادية. يحتوي هذا الملف على سطر واحد لكل رمز تم تصديره بواسطة النواة (vmlinux) والوحدات. يتألّف كل سطر من قيمة CRC واسم الرمز ومساحة الاسم الخاصة بالرمز وvmlinux أو اسم الوحدة التي تُصدِّر الرمز ونوع التصدير (على سبيل المثال، EXPORT_SYMBOL مقابل EXPORT_SYMBOL_GPL).

يمكنك مقارنة ملفات Module.symvers بين إصدار GKI وإصدارك للتحقّق من أي اختلافات في تسلسل التحقّق من صحة البيانات (CRC) في الرموز التي تم تصديرها باستخدام vmlinux. إذا كان هناك اختلاف في قيمة CRC في أي رمز تم تصديره بواسطة vmlinux و كان هذا الرمز يستخدمه أحد الوحدات التي تحمّلها في جهازك، لن يتم تحميل الوحدة.

إذا لم تكن لديك جميع عناصر التصميم، ولكن لديك ملفات vmlinux لملفَّي ‎GKI kernel وkernel، يمكنك مقارنة قيم CRC لرمز معيّن من خلال تنفيذ الأمر التالي على كل من ملفَّي kernel ومقارنة الإخراج:

nm <path to vmlinux>/vmlinux | grep __crc_<symbol name>

على سبيل المثال، يتحقّق الأمر التالي من قيمة CRC للرمز module_layout:

nm vmlinux | grep __crc_module_layout
0000000008663742 A __crc_module_layout

حلّ مشكلة عدم تطابق أرقام التحقق من صحة البيانات (CRC)

اتّبِع الخطوات التالية لحلّ مشكلة عدم تطابق رمز التحقّق من صحة البيانات (CRC) عند تحميل وحدة:

  1. أنشئ نواة GKI ونواة جهازك باستخدام الخيار --kbuild_symtypes كما هو موضّح في الأمر التالي:

    tools/bazel run --kbuild_symtypes //common:kernel_aarch64_dist

    ينشئ هذا الأمر ملف .symtypes لكل ملف .o. اطّلِع على KBUILD_SYMTYPES في Kleaf للحصول على التفاصيل.

    بالنسبة إلى الإصدار 13 من Android والإصدارات الأقدم، يمكنك إنشاء نواة GKI ونواة جهازك من خلال إضافة KBUILD_SYMTYPES=1 قبل الأمر الذي تستخدمه لإنشاء النواة، كما هو موضّح في الأمر التالي:

    KBUILD_SYMTYPES=1 BUILD_CONFIG=common/build.config.gki.aarch64 build/build.sh

    عند استخدام build_abi.sh,، يتم ضبط العلامة KBUILD_SYMTYPES=1 بشكل ضمني مسبقًا.

  2. ابحث عن ملف .c الذي تم تصدير الرمز الذي يتضمّن تعارضًا في رمز التحقّق من التسلسل (CRC) باستخدام الأمر التالي:

    cd common && git grep EXPORT_SYMBOL.*module_layout
    kernel/module.c:EXPORT_SYMBOL(module_layout);
  3. يحتوي ملف .c على ملف .symtypes مقابل في GKI ومواد عرض إنشاء ملف ‎ kernel للجهاز. حدِّد مكان ملف .c باستخدام الأوامر التالية:

    cd out/$BRANCH/common && ls -1 kernel/module.*
    kernel/module.o
    kernel/module.o.symversions
    kernel/module.symtypes

    في ما يلي خصائص ملف .c:

    • تنسيق ملف .c هو سطر واحد (قد يكون طويلاً جدًا) لكل رمز.

    • يشير الرمز [s|u|e|etc]# في بداية السطر إلى أنّ الرمز من نوع البيانات [struct|union|enum|etc]. مثلاً:

      t#bool typedef _Bool bool
      
    • يشير عدم توفّر البادئة # في بداية السطر إلى أنّ الرمز هو دالة. مثلاً:

      find_module s#module * find_module ( const char * )
      
  4. قارِن بين الملفَّين وأصلِح كل الاختلافات.

الحالة 1: الاختلافات بسبب مستوى رؤية نوع البيانات

إذا كانت إحدى النوى تحافظ على رمز أو نوع بيانات غير شفاف للوحدات ولا تفعل ذلك الخطوة الأخرى، يظهر هذا الاختلاف بين ملفَي .symtypes للنوى. يحتوي ملف .symtypes من إحدى النوى على UNKNOWN للرمز، ويحتوي ملف .symtypes من النواة الأخرى على عرض موسّع للرمز أو نوع البيانات.

على سبيل المثال، تؤدي إضافة السطر التالي إلىملف include/linux/device.h في نواة النظام إلى حدوث تعارضات في تسلسل التحقّق من صحة البيانات (CRC)، أحدها يخص module_layout():

 #include <linux/fwnode.h>

عند مقارنة module.symtypes لهذا الرمز، تظهر الاختلافات التالية:

 $ diff -u <GKI>/kernel/module.symtypes <your kernel>/kernel/module.symtypes
  --- <GKI>/kernel/module.symtypes
  +++ <your kernel>/kernel/module.symtypes
  @@ -334,12 +334,15 @@
  ...
  -s#fwnode_handle struct fwnode_handle { UNKNOWN }
  +s#fwnode_reference_args struct fwnode_reference_args { s#fwnode_handle * fwnode ; unsigned int nargs ; t#u64 args [ 8 ] ; }
  ...

إذا كانت قيمة نواة النظام هي UNKNOWN وكانت نواة GKI تتضمّن عرضًا موسّعًا للرمز (من غير المرجّح حدوث ذلك)، يمكنك دمج أحدث إصدار من "النواة المشتركة لنظام التشغيل Android" في النواة لكي تتمكّن من استخدام أحدث إصدار من قاعدة نواة GKI.

في معظم الحالات، يكون لوحدة GKI الأساسية قيمة UNKNOWN، ولكن تحتوي وحدة التشغيل الأساسية على التفاصيل الداخلية للرمز بسبب التغييرات التي تم إجراؤها عليها. ويعود سبب ذلك إلى أنّ أحد الملفات في نواة النظام أضاف #include غير متوفّر في نواة GKI.

غالبًا ما يكفي إخفاء #include الجديد من genksyms لحلّ المشكلة.

#ifndef __GENKSYMS__
#include <linux/fwnode.h>
#endif

في حال عدم توفّر هذه الميزة، اتّبِع الخطوات التالية لتحديد #include الذي يتسبب في الاختلاف:

  1. افتح ملف الرأس الذي يحدِّد الرمز أو نوع البيانات الذي يتضمّن هذا الاختلاف. على سبيل المثال، عدِّل include/linux/fwnode.h ليصبح struct fwnode_handle.

  2. أضِف الرمز التالي في أعلى ملف العنوان:

    #ifdef CRC_CATCH
    #error "Included from here"
    #endif
    
  3. في ملف .c الخاص بالوحدة الذي يتضمّن تعارضًا في تسلسل التحقّق من صحة البيانات (CRC)، أضِف السطر التالي كأول سطر قبل أيّ من أسطر #include.

    #define CRC_CATCH 1
    
  4. اجمع الوحدات. يعرض الخطأ الناتج عن وقت الإنشاء سلسلة ملف العنوان #include التي أدّت إلى عدم تطابق CRC هذا. مثلاً:

    In file included from .../drivers/clk/XXX.c:16:`
    In file included from .../include/linux/of_device.h:5:
    In file included from .../include/linux/cpu.h:17:
    In file included from .../include/linux/node.h:18:
    .../include/linux/device.h:16:2: error: "Included from here"
    #error "Included from here"
    

    يرجع سبب أحد الروابط في سلسلة #include هذه إلى تغيير تم إجراؤه في النواة، وهو غير متوفّر في نواة GKI.

  5. حدِّد التغيير، وألغِه في نواة النظام أو حمِّله إلى ACK واطلب دمجه.

الحالة 2: الاختلافات الناتجة عن تغييرات في نوع البيانات

إذا لم يكن عدم تطابق CRC لرمز أو نوع بيانات ناتجًا عن اختلاف في مستوى العرض، يعني ذلك أنّه ناتج عن تغييرات فعلية (إضافات أو عمليات إزالة أو تغييرات) في نوع البيانات نفسه.

على سبيل المثال، يؤدي إجراء التغيير التالي في النواة إلى حدوث عدة عدم تطابقات في CRC لأنّ العديد من الرموز تتأثر بشكل غير مباشر بهذا النوع من التغيير:

diff --git a/include/linux/iommu.h b/include/linux/iommu.h
  --- a/include/linux/iommu.h
  +++ b/include/linux/iommu.h
  @@ -259,7 +259,7 @@ struct iommu_ops {
     void (*iotlb_sync)(struct iommu_domain *domain);
     phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
     phys_addr_t (*iova_to_phys_hard)(struct iommu_domain *domain,
  -        dma_addr_t iova);
  +        dma_addr_t iova, unsigned long trans_flag);
     int (*add_device)(struct device *dev);
     void (*remove_device)(struct device *dev);
     struct iommu_group *(*device_group)(struct device *dev);

هناك عدم تطابق واحد في قيمة CRC للسمة devm_of_platform_populate().

إذا قارنت ملفات .symtypes لهذا الرمز، قد يبدو الأمر على النحو التالي:

 $ diff -u <GKI>/drivers/of/platform.symtypes <your kernel>/drivers/of/platform.symtypes
  --- <GKI>/drivers/of/platform.symtypes
  +++ <your kernel>/drivers/of/platform.symtypes
  @@ -399,7 +399,7 @@
  ...
  -s#iommu_ops struct iommu_ops { ... ; t#phy
  s_addr_t ( * iova_to_phys_hard ) ( s#iommu_domain * , t#dma_addr_t ) ; int
    ( * add_device ) ( s#device * ) ; ...
  +s#iommu_ops struct iommu_ops { ... ; t#phy
  s_addr_t ( * iova_to_phys_hard ) ( s#iommu_domain * , t#dma_addr_t , unsigned long ) ; int ( * add_device ) ( s#device * ) ; ...

لتحديد النوع الذي تم تغييره، اتّبِع الخطوات التالية:

  1. ابحث عن تعريف الرمز في رمز المصدر (عادةً في ملفات .h).

    • للاطّلاع على الاختلافات في الرموز بين نواة نظام التشغيل ونواة GKI، ابحث عن عملية الإضافة من خلال تنفيذ الأمر التالي:
    git blame
    • بالنسبة إلى الرموز المحذوفة (حيث يتم حذف رمز في شجرة وأردت أيضًا حذفه في الشجرة الأخرى)، عليك العثور على التغيير الذي أدى إلى حذف السطر. استخدِم الأمر التالي على الشجرة التي تم فيها حذف السطر:
    git log -S "copy paste of deleted line/word" -- <file where it was deleted>
  2. راجِع قائمة عمليات الربط التي تم عرضها لتحديد مكان التغيير أو الحذف. من المرجّح أنّه التغيير الأول هو التغيير الذي تبحث عنه. إذا لم يكن الأمر كذلك، انتقِل إلى أسفل القائمة للعثور على عملية الربط.

  3. بعد تحديد التغيير، يمكنك إما التراجع عنه في نواة النظام أو تحميله إلى ACK ودمجه.