Οδηγός χρήσης του Git με το Unified Vitis IDE

Ξεκινώντας με το Git στο Vitis IDE

Η χρήση του Git με το νέο "Unified Vitis" IDE, που βασίζεται στο VSCode, παρουσιάζει μοναδικές προκλήσεις σε σύγκριση με την παλαιότερη έκδοση που βασίζεται στο Eclipse. Ο οδηγός έργου εισαγωγής/εξαγωγής λείπει στην πιο πρόσφατη έκδοση, προκαλώντας δυσκολίες στην αποτελεσματική διαχείριση του ελέγχου έκδοσης.

Αυτός ο οδηγός στοχεύει να αντιμετωπίσει τα ζητήματα που αντιμετωπίζονται κατά τη χρήση του Git στο Vitis, συμπεριλαμβανομένου του χειρισμού δημιουργημένων αρχείων με απόλυτες διαδρομές και της εξασφάλισης ομαλής συνεργασίας μεταξύ διαφορετικών συστημάτων ανάπτυξης. Θα διερευνήσουμε μια πρακτική ροή εργασιών για τη διαχείριση των έργων σας στο Vitis αποτελεσματικά με το Git.

Επεξήγηση των Σεναρίων Αυτοματισμού Vitis

Το πρώτο σενάριο αυτοματοποιεί τη ρύθμιση ενός έργου Vitis χρησιμοποιώντας Python. Ξεκινά με την εισαγωγή των απαραίτητων μονάδων, συγκεκριμένα vitis και os. Στη συνέχεια ορίζει τη διαδρομή ρίζας και δημιουργεί τον κατάλογο κατασκευής εάν δεν υπάρχει χρησιμοποιώντας os.makedirs(). Το σενάριο ρυθμίζει τις αναμενόμενες διαδρομές για το αρχείο XSA και τον κύριο κατάλογο προέλευσης. Στη συνέχεια, δημιουργεί ένα πρόγραμμα-πελάτη Vitis και ορίζει τον χώρο εργασίας στον πρόσφατα δημιουργημένο κατάλογο κατασκευής. Το στοιχείο πλατφόρμας δημιουργείται με client.create_platform_component(), προσδιορίζοντας το υλικό, το λειτουργικό σύστημα και τη διαμόρφωση της CPU. Μόλις κατασκευαστεί το στοιχείο πλατφόρμας, δημιουργείται ένα στοιχείο εφαρμογής και συνδέεται με το στοιχείο πλατφόρμας. Τέλος, τα απαραίτητα αρχεία εισάγονται στο έργο Vitis και το στοιχείο κατασκευάζεται.

Το δεύτερο σενάριο είναι ένα σενάριο φλοιού που αρχικοποιεί το έργο Vitis και ρυθμίζει την ενοποίηση Git. Καθορίζει τη διαδρομή ρίζας και τον κατάλογο κατασκευής, δημιουργώντας τον κατάλογο εάν δεν υπάρχει. Στη συνέχεια, το σενάριο εκτελεί το σενάριο Python χρησιμοποιώντας vitis -s tools/build_app.py για την αυτοματοποίηση της ρύθμισης του έργου. Μετά την εκτέλεση του σεναρίου Python, το σενάριο του κελύφους δημιουργεί ένα αποθετήριο Git με πλοήγηση στον ριζικό κατάλογο, αρχικοποιώντας το Git με git initκαι προσθέτοντας καταλόγους κατασκευής στο .gitignore αρχείο. Σταδιοποιεί τα σχετικά αρχεία με git add και τα δεσμεύει στο αποθετήριο με git commit -m. Αυτή η προσέγγιση διασφαλίζει ότι οι κατάλογοι build εξαιρούνται από τον έλεγχο έκδοσης, ενώ παράλληλα παρακολουθούνται τα απαραίτητα αρχεία έργου.

import vitis
import os

ROOT_PATH = os.path.abspath(os.path.dirname(__file__))
VITIS_BUILD_DIR_PATH = os.path.join(ROOT_PATH, "build-vitis")
os.makedirs(VITIS_BUILD_DIR_PATH, exist_ok=True)
EXPECTED_XSA_FILE_PATH = os.path.join(ROOT_PATH, "build-vivado", "mydesign.xsa")
COMPONENT_NAME = "MyComponent"
MAIN_SRC_PATH = os.path.join(ROOT_PATH, "src")

client = vitis.create_client()
client.set_workspace(path=VITIS_BUILD_DIR_PATH)

PLATFORM_NAME = "platform_baremetal"
platform = client.create_platform_component(
    name=PLATFORM_NAME,
    hw=EXPECTED_XSA_FILE_PATH,
    os="standalone",
    cpu="mycpu"
)

platform = client.get_platform_component(name=PLATFORM_NAME)
status = platform.build()

comp = client.create_app_component(
    name=COMPONENT_NAME,
    platform=os.path.join(VITIS_BUILD_DIR_PATH, PLATFORM_NAME, "export", PLATFORM_NAME, f"{PLATFORM_NAME}.xpfm"),
    domain="mydomainname"
)

comp = client.get_component(name=COMPONENT_NAME)
status = comp.import_files(
    from_loc=MAIN_SRC_PATH,
    files=["CMakeLists.txt", "UserConfig.cmake", "lscript.ld", "NOTUSED.cpp"],
    dest_dir_in_cmp="src"
)

comp.build()

#!/bin/bash

ROOT_PATH=$(pwd)
VITIS_BUILD_DIR_PATH="$ROOT_PATH/build-vitis"
mkdir -p "$VITIS_BUILD_DIR_PATH"
EXPECTED_XSA_FILE_PATH="$ROOT_PATH/build-vivado/mydesign.xsa"
COMPONENT_NAME="MyComponent"
MAIN_SRC_PATH="$ROOT_PATH/src"

vitis -s tools/build_app.py

# After running the Python script, set up Git repository
cd "$ROOT_PATH"
git init
echo "build-vitis/" >> .gitignore
echo "build-vivado/" >> .gitignore
git add src/ tools/ .gitignore
git commit -m "Initial commit with project structure and scripts"

# Script end

Κατανόηση Vitis IDE και Version Control

Μια πτυχή της χρήσης του νέου "Unified Vitis" IDE με το Git περιλαμβάνει την κατανόηση της δομής και των στοιχείων των έργων Vitis. Το Vitis IDE δημιουργεί πολλά αρχεία, πολλά με απόλυτες διαδρομές, γεγονός που περιπλέκει τον έλεγχο έκδοσης. Αυτά τα αρχεία περιλαμβάνουν διαμορφώσεις πλατφόρμας, περιγραφές υλικού και μεταδεδομένα ειδικά για IDE. Όταν αυτά τα αρχεία ελέγχονται από την έκδοση χωρίς σωστό χειρισμό, οι προγραμματιστές ενδέχεται να αντιμετωπίσουν ζητήματα όπως σφάλματα κατασκευής λόγω μη αντιστοίχισης διαδρομών σε διαφορετικά συστήματα.

Για να μετριαστούν αυτά τα προβλήματα, μια κοινή πρακτική είναι να εξαιρούνται οι φάκελοι που διαχειρίζονται το Vitis από τον έλεγχο έκδοσης. Αντίθετα, τα κρίσιμα αρχεία διαμόρφωσης, όπως τα σενάρια σύνδεσης, τα αρχεία CMake και άλλα βασικά αρχεία έργου αντιγράφονται με μη αυτόματο τρόπο στις κατάλληλες θέσεις που αναμένεται από το Vitis. Αυτή η προσέγγιση διασφαλίζει ότι μόνο τα απαραίτητα αρχεία ελέγχονται από την έκδοση, μειώνοντας τον κίνδυνο διενέξεων και σφαλμάτων κατά τη συνεργασία με άλλους προγραμματιστές. Επιπλέον, η χρήση σεναρίων αυτοματισμού όπως η Python ή τα σενάρια κελύφους μπορεί να απλοποιήσει αυτή τη διαδικασία, διασφαλίζοντας ότι η ρύθμιση του έργου και η διαχείριση αρχείων είναι συνεπείς και αναπαραγώγιμες.

Βασικά σημεία για αποτελεσματικό έλεγχο εκδόσεων στο Vitis IDE

Η εφαρμογή ελέγχου έκδοσης με το νέο Unified Vitis IDE περιλαμβάνει πολλά κρίσιμα βήματα. Ξεκινήστε εξαιρώντας τους φακέλους που δημιουργούνται από το Vitis από τον έλεγχο έκδοσης για να αποφύγετε διενέξεις και σφάλματα. Αντίθετα, εστιάστε στην παρακολούθηση βασικών αρχείων διαμόρφωσης, όπως σενάρια σύνδεσης, αρχεία CMake και άλλα ζωτικής σημασίας στοιχεία του έργου. Τα σενάρια αυτοματισμού, ιδιαίτερα αυτά που είναι γραμμένα σε Python, μπορούν να βελτιώσουν σημαντικά αυτή τη διαδικασία αυτοματοποιώντας τη ρύθμιση του έργου και διασφαλίζοντας ότι όλα τα απαραίτητα αρχεία βρίσκονται στις σωστές θέσεις.

Με την αυτοματοποίηση της εγκατάστασης, μπορείτε να διασφαλίσετε ένα συνεπές περιβάλλον ανάπτυξης σε διαφορετικά συστήματα, μειώνοντας την πιθανότητα προβλημάτων που σχετίζονται με τη διαδρομή. Αυτή η προσέγγιση όχι μόνο απλοποιεί τη διαχείριση έργου, αλλά διευκολύνει επίσης την ομαλότερη συνεργασία μεταξύ των προγραμματιστών. Επιπλέον, η διατήρηση των αρχείων προέλευσης στους αρχικούς καταλόγους τους και η χρήση του CMake για να δείχνει σε αυτούς τους καταλόγους επιτρέπει την ευκολότερη επεξεργασία και τον έλεγχο της έκδοσης, αποφεύγοντας ταυτόχρονα την πολυπλοκότητα της αντιμετώπισης των εσωτερικών δομών αρχείων του Vitis.