परिचय
सैंडबॉक्स वाले एपीआई (एसएपीआई) का इस्तेमाल, Google के Bazel बिल्ड सिस्टम या लोकप्रिय CMake मेटा बिल्ड सिस्टम के साथ किया जा सकता है. इस पेज पर, Bazel के बारे में बताया गया है. हालांकि, CMake के लिए भी यही सुविधाएं उपलब्ध हैं. Bazel, सुझाया गया बिल्ड सिस्टम है. इसे इंटिग्रेट करना भी आसान है.
आपकी BUILD.bazel फ़ाइल में, होस्ट कोड बनाने के लिए एक बिल्ड नियम होगा. होस्ट कोड को किसी लाइब्रेरी के सैंडबॉक्स वाले वर्शन का इस्तेमाल करने के लिए, आपको एक बिल्ड टारगेट तैयार करना होगा. इसका इस्तेमाल आपका होस्ट कोड करेगा.
एसएपीआई के बिल्ड नियम
- sapi_library
sapi_library
sapi_library(name, deps, srcs, hdrs, embed, functions, lib, lib_name, input_files, namespace, header, add_default_deps, limit_scan_depth, visibility)
आउटपुट टारगेट
sapi_library() बिल्ड नियम, ये टारगेट जनरेट करता है:
- name-sapi: सैंडबॉक्स वाली लाइब्रेरी, होस्ट कोड टारगेट के तौर पर सामान्य cc_library की जगह लेती है. इसमें
zlib_sapi.binऔर सैंडबॉक्स डिपेंडेंसी शामिल होती हैं. - name.interface: जनरेट किया गया लाइब्रेरी इंटरफ़ेस.
- name.embed:
cc_embed_data()टारगेट का इस्तेमाल, बाइनरी में सैंडबॉक्सी को एम्बेड करने के लिए किया जाता है. bazel/embed_data.bzl देखें.- name.bin: सैंडबॉक्सी बाइनरी. इसमें एक छोटा कम्यूनिकेशन स्टब और वह लाइब्रेरी शामिल होती है जिसे सैंडबॉक्स किया जा रहा है.
तर्क
| विशेषताएं | |
|---|---|
| नाम |
नाम; ज़रूरी है इस टारगेट के लिए कोई यूनीक नाम. इससे सैंडबॉक्स वाली C/C++ लाइब्रेरी की पहचान की जा सकेगी. इसके लिए, name-sapi आउटपुट टारगेट देखें. |
| deps |
लेबल की सूची; ज़रूरी नहीं है सैंडबॉक्स वाली C/C++ लाइब्रेरी में लिंक की जाने वाली अन्य लाइब्रेरी की सूची. |
| srcs |
लेबल की सूची; ज़रूरी नहीं है C और C++ फ़ाइलों की सूची. इन्हें प्रोसेस करके, सैंडबॉक्स वाली C/C++ लाइब्रेरी बनाई जाती है. ये C/C++ सोर्स और हेडर फ़ाइलें होती हैं. ये जनरेट नहीं की गई (सामान्य सोर्स कोड) या जनरेट की गई हो सकती हैं. ज़्यादा जानकारी के लिए, cc_library के दस्तावेज़ में, srcs एट्रिब्यूट के बारे में जानकारी देखें. |
| hdrs | लेबल की सूची; ज़रूरी नहीं है हेडर फ़ाइलों की सूची. इन्हें प्रोसेस करके, सैंडबॉक्स वाली C/C++ लाइब्रेरी बनाई जाती है. यहां सैंडबॉक्स की परिभाषा (sandbox.h) होनी चाहिए. अगर एम्बेड की गई एसएपीआई लाइब्रेरी का इस्तेमाल किया जा रहा है और डिफ़ॉल्ट सैंडबॉक्स कॉन्फ़िगरेशन (DefaultConfig, जो |
| embed | बूलियन; ज़रूरी नहीं है; डिफ़ॉल्ट तौर पर, यह 'सही' पर सेट होता है अगर 'सही' पर सेट है, तो सैंडबॉक्स वाली लाइब्रेरी को होस्ट
कोड में एम्बेड किया जाना चाहिए. इससे एसएपीआई सैंडबॉक्स को
|
| functions | फ़ंक्शन के नामों की सूची; ज़रूरी नहीं है C/C++ लाइब्रेरी के उन फ़ंक्शन की सूची जिनके लिए सैंडबॉक्स वाला वर्शन जनरेट किया जाता है. इसके बाद, इन्हें होस्ट कोड में इस्तेमाल किया जा सकता है. खाली सूची होने पर, लाइब्रेरी में मौजूद सभी फ़ंक्शन को एक्सपोर्ट और रैप करने की कोशिश की जाएगी. |
| lib | स्ट्रिंग; ज़रूरी है C/C++ लाइब्रेरी टारगेट का नाम. यह सैंडबॉक्स वाली लाइब्रेरी बनने जा रही है. इसके लिए, ज़रूरी है कि प्रोजेक्ट में C/C++ लाइब्रेरी के लिए cc_library बिल्ड नियम हो. |
| lib_name | स्ट्रिंग; ज़रूरी है एसएपीआई ऑब्जेक्ट का नाम. इसका इस्तेमाल, फ़ंक्शन एट्रिब्यूट से लाइब्रेरी फ़ंक्शन को प्रॉक्सी करने के लिए किया जाता है. सैंडबॉक्स वाली लाइब्रेरी में किसी फ़ंक्शन को कॉल करने के लिए, एसएपीआई ऑब्जेक्ट का इस्तेमाल किया जाएगा. |
| input_files | लेबल की सूची; ज़रूरी नहीं है C और C++ फ़ाइलों की सूची. इन्हें sapi_interface नियम के इंटरनल रन के दौरान प्रोसेस किया जाता है. जनरेटर, C/C++ लाइब्रेरी के फ़ंक्शन के एलान के लिए इन फ़ाइलों को स्कैन करता है. आम तौर पर, इसकी ज़रूरत नहीं होती, क्योंकि C/C++ लाइब्रेरी के एक्सपोर्ट किए गए हेडर हमेशा स्कैन किए जाते हैं. |
| namespace | स्ट्रिंग; ज़रूरी नहीं है; डिफ़ॉल्ट तौर पर, यह sapigen पर सेट होता है C++ नेमस्पेस आइडेंटिफ़ायर, जिसमें lib_name से तय किए गए एसएपीआई ऑब्जेक्ट को रखा जाता है. डिफ़ॉल्ट नेमस्पेस sapigen है. |
| header | स्ट्रिंग; ज़रूरी नहीं है जनरेट की गई हेडर फ़ाइल के बजाय, इस्तेमाल की जाने वाली हेडर फ़ाइल का नाम. अगर आपको कोड को अपने-आप जनरेट करना है, तो इस एट्रिब्यूट का इस्तेमाल न करें |
| add_default_deps | बूलियन; ज़रूरी नहीं है; डिफ़ॉल्ट तौर पर, यह 'सही' पर सेट होता है अब सेवा में नहीं है |
| limit_scan_depth | बूलियन; ज़रूरी नहीं है; डिफ़ॉल्ट तौर पर, यह 'गलत' पर सेट होता है कॉम्प्लेक्स लाइब्रेरी के लिए, Bazel के लिए फ़ाइल की संख्या की सीमा पूरी हो सकती है ऐसे में, बिल्ड प्रोसेस पूरी नहीं हो पाएगी. यह एट्रिब्यूट, इन मुश्किल स्थितियों से बचने का एक तरीका है. ज़रूरत पड़ने पर ही इसका इस्तेमाल करें. |
| tags | |
| visibility | visibility के बारे में जानने के लिए, Bazel का दस्तावेज़ देखें |
इस्तेमाल का उदाहरण
zlib का उदाहरण, एक रेफ़रंस प्रोजेक्ट है. इससे यह पता चलता है कि sapi_library बिल्ड नियम का इस्तेमाल कैसे किया जाता है:
load(
"//sandboxed_api/tools/generator:sapi_generator.bzl",
"sapi_library",
)
sapi_library(
name = "zlib-sapi",
srcs = [], # Extra code compiled with the SAPI library
hdrs = [], # Leave empty if embedded SAPI libraries are used, and the
# default sandbox configuration (DefaultConfig) is sufficient.
embed = True, # This is the default
functions = [
"deflateInit_",
"deflate",
"deflateEnd",
],
lib = "@zlib//:zlibonly",
lib_name = "Zlib",
namespace = "sapi::zlib",
)