פריסה של ספריית פלט

הדף הזה עוסק בדרישות ובפריסה של ספריות פלט.

דרישות

הדרישות לפריסה של ספריית פלט:

• לא התנגשות אם מספר משתמשים בונים על אותה תיבה.
• תמיכה במבנה של סביבות עבודה מרובות בו-זמנית.
• תמיכה ביצירה של מספר הגדרות יעד באותה סביבת עבודה.
• לא מתנגש עם כלים אחרים.
• קל לגשת אליה.
• קל לנקות, אפילו סלקטיבי.
• הוא לא חד-משמעי, גם אם המשתמש מסתמך על קישורים סמליים כשהוא משתנה בספריית הלקוח שלו.
• כל מצב ה-build לכל משתמש צריך להיות חלק מספרייה אחת ("I's כדי לנקות את כל קובצי .o מכל הלקוחות שלי.")

הפריסה הנוכחית

הפתרון שמיושם כרגע:

• יש להפעיל את Bazel מספרייה שמכילה קובץ WORKSPACE ( "ספריית Workspace") או ספריית משנה שלו. אם לא, הוא מדווח על שגיאה.
• ספריית OutputRoot מוגדרת כברירת מחדל ל-~/.cache/bazel ב-Linux, /private/var/tmp ב-macOS וב-Windows מוגדרת כברירת מחדל ל-%HOME% אם היא מוגדרת, אחרת %USERPROFILE% אם היא מוגדרת, אחרת היא תוצאה של התקשרות SHGetKnownFolderPath() עם מערך ה-FOLDERID_Profile המוגדר. אם הערך של משתנה הסביבה $TEST_TMPDIR, כמו בבדיקה של Bazel עצמו, הערך הזה מבטל את ברירת המחדל.
• מצב ה-build של המשתמש ב-Bazel ממוקם מתחת ל-outputRoot/_bazel_$USER. היא נקראת הספרייה OutputUserRoot.
• מתחת לספריית outputUserRoot יש ספריית install, וזוהי ספריית installBase שהשם שלה הוא גיבוב MD5 של מניפסט ההתקנה של Bazel.
• מתחת לספרייה outputUserRoot, נוצרת גם ספרייה של outputBase, שהשם שלה הוא גיבוב MD5 של שם הנתיב בספרייה של סביבת העבודה. לדוגמה, אם Bazel פועלת בספרייה של סביבת העבודה /home/user/src/my-project (או בספרייה שסומנה עם הספרייה הזו), נוצרת ספרייה של בסיס פלט בשם: /home/user/.cache/bazel/_bazel_user/7ffd56a6e4cb724ea575aba15733d113
• ניתן להשתמש באפשרות ההפעלה --output_base של Bazel כדי לשנות את ספריית ברירת המחדל של בסיס הפלט. לדוגמה: bazel --output_base=/tmp/bazel/output build x/y:z.
• ניתן גם להשתמש באפשרות ההפעלה --output_user_root של Bazel כדי לעקוף את ספריות הבסיס של ההתקנות ובסיסי ברירת המחדל. למשל: bazel --output_user_root=/tmp/bazel build x/y:z.

הסמלים של מירכאות;"bazel-<workspace-name>", "bazel-out", "bazel-testlogs" ו-"bazel-bin" נכללים בספריית סביבת העבודה; הקישורים האלה מפנים לספריות של ספריות בתוך פלט ספציפי ליעד. קישורים אלה מיועדים רק לנוחות המשתמש, מאחר ש-Bazel עצמה לא משתמשת בהם. גם ההגדרה הזו מבוצעת רק אם ספריית סביבת העבודה ניתנת לכתיבה.

תרשים פריסה

הספריות מסודרות כך:

<workspace-name>/                         <== The workspace directory
  bazel-my-project => <...my-project>     <== Symlink to execRoot
  bazel-out => <...bin>                   <== Convenience symlink to outputPath
  bazel-bin => <...bin>                   <== Convenience symlink to most recent written bin dir $(BINDIR)
  bazel-testlogs => <...testlogs>         <== Convenience symlink to the test logs directory

/home/user/.cache/bazel/                  <== Root for all Bazel output on a machine: outputRoot
  _bazel_$USER/                           <== Top level directory for a given user depends on the user name:
                                              outputUserRoot
    install/
      fba9a2c87ee9589d72889caf082f1029/   <== Hash of the Bazel install manifest: installBase
        _embedded_binaries/               <== Contains binaries and scripts unpacked from the data section of
                                              the bazel executable on first run (such as helper scripts and the
                                              main Java file BazelServer_deploy.jar)
    7ffd56a6e4cb724ea575aba15733d113/     <== Hash of the client's workspace directory (such as
                                              /home/some-user/src/my-project): outputBase
      action_cache/                       <== Action cache directory hierarchy
                                              This contains the persistent record of the file
                                              metadata (timestamps, and perhaps eventually also MD5
                                              sums) used by the FilesystemValueChecker.
      action_outs/                        <== Action output directory. This contains a file with the
                                              stdout/stderr for every action from the most recent
                                              bazel run that produced output.
      command.log                         <== A copy of the stdout/stderr output from the most
                                              recent bazel command.
      external/                           <== The directory that remote repositories are
                                              downloaded/symlinked into.
      server/                             <== The Bazel server puts all server-related files (such
                                              as socket file, logs, etc) here.
        jvm.out                           <== The debugging output for the server.
      execroot/                           <== The working directory for all actions. For special
                                              cases such as sandboxing and remote execution, the
                                              actions run in a directory that mimics execroot.
                                              Implementation details, such as where the directories
                                              are created, are intentionally hidden from the action.
                                              All actions can access its inputs and outputs relative
                                              to the execroot directory.
        <workspace-name>/                 <== Working tree for the Bazel build & root of symlink forest: execRoot
          _bin/                           <== Helper tools are linked from or copied to here.

          bazel-out/                      <== All actual output of the build is under here: outputPath
            local_linux-fastbuild/        <== one subdirectory per unique target BuildConfiguration instance;
                                              this is currently encoded
              bin/                        <== Bazel outputs binaries for target configuration here: $(BINDIR)
                foo/bar/_objs/baz/        <== Object files for a cc_* rule named //foo/bar:baz
                  foo/bar/baz1.o          <== Object files from source //foo/bar:baz1.cc
                  other_package/other.o   <== Object files from source //other_package:other.cc
                foo/bar/baz               <== foo/bar/baz might be the artifact generated by a cc_binary named
                                              //foo/bar:baz
                foo/bar/baz.runfiles/     <== The runfiles symlink farm for the //foo/bar:baz executable.
                  MANIFEST
                  <workspace-name>/
                    ...
              genfiles/                   <== Bazel puts generated source for the target configuration here:
                                              $(GENDIR)
                foo/bar.h                     such as foo/bar.h might be a headerfile generated by //foo:bargen
              testlogs/                   <== Bazel internal test runner puts test log files here
                foo/bartest.log               such as foo/bar.log might be an output of the //foo:bartest test with
                foo/bartest.status            foo/bartest.status containing exit status of the test (such as
                                              PASSED or FAILED (Exit 1), etc)
              include/                    <== a tree with include symlinks, generated as needed. The
                                              bazel-include symlinks point to here. This is used for
                                              linkstamp stuff, etc.
            host/                         <== BuildConfiguration for build host (user's workstation), for
                                              building prerequisite tools, that will be used in later stages
                                              of the build (ex: Protocol Compiler)
        <packages>/                       <== Packages referenced in the build appear as if under a regular workspace

הפריסה של ספריות *.runfiles מתועדת בפירוט רב יותר במקומות שאליהם מצביעה מערכת RunfilesSupport.

bazel clean

bazel clean מבצע rm -rf ב-outputPath ובספריית action_cache. היא גם מסירה את הסמלים של סביבת העבודה. האפשרות --expunge תנקה את כל Basebase.