Android Rust के पैटर्न

इस पेज में Android लॉगिंग के बारे में जानकारी होती है, रस्ट एआईडीएल का उदाहरण देता है. C से Rust को कॉल करें और निर्देश दें CXX का इस्तेमाल करके रस्ट/C++ इंटरऑप की सुविधा का इस्तेमाल करें.

Android में लॉग इन करने की सुविधा

यहां दिए गए उदाहरण में, अपने मैसेज को logcat (डिवाइस पर) में लॉग करने का तरीका बताया गया है या stdout (होस्ट).

अपने Android.bp मॉड्यूल में, liblogger और liblog_rust को डिपेंडेंसी के तौर पर जोड़ें:

rust_binary {
    name: "logging_test",
    srcs: ["src/main.rs"],
    rustlibs: [
        "liblogger",
        "liblog_rust",
    ],
}

इसके बाद, अपने Rust सोर्स में यह कोड जोड़ें:

use log::{debug, error, LevelFilter};

fn main() {
    let _init_success = logger::init(
        logger::Config::default()
            .with_tag_on_device("mytag")
            .with_max_level(LevelFilter::Trace),
    );
    debug!("This is a debug message.");
    error!("Something went wrong!");
}

इसका मतलब है कि ऊपर दिखाई गई दो डिपेंडेंसी (liblogger और liblog_rust) जोड़ें, init तरीके को एक बार कॉल करें (ज़रूरी होने पर, एक से ज़्यादा बार कॉल किया जा सकता है) और दिए गए मैक्रो का उपयोग करके संदेश लॉग करें. ज़्यादा जानकारी के लिए, लॉगर क्रेट देखें.

लॉगर क्रेट एक एपीआई उपलब्ध कराता है. इससे यह तय किया जा सकता है कि आपको क्या लॉग करना है. इसके आधार पर कोड डिवाइस पर चल रहा है या होस्ट पर (जैसे कि होस्ट-साइड टेस्ट), मैसेज android_logger का इस्तेमाल करके लॉग किए जाते हैं या env_logger.

रस्ट एआईडीएल का उदाहरण

इस सेक्शन में, हैलो वर्ल्ड स्टाइल में 'रस्ट' के साथ एआईडीएल का इस्तेमाल करने का उदाहरण दिया गया है.

Android डेवलपर गाइड एआईडीएल की खास जानकारी का इस्तेमाल करना सेक्शन में शुरुआत करते हैं, तो external/rust/binder_example/aidl/com/example/android/IRemoteService.aidl बनाएं IRemoteService.aidl फ़ाइल में इसे इन कॉन्टेंट के साथ डालें:

// IRemoteService.aidl
package com.example.android;

// Declare any non-default types here with import statements

/** Example service interface */
interface IRemoteService {
    /** Request the process ID of this service, to do evil things with it. */
    int getPid();

    /**
     * Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
            double aDouble, String aString);
}

इसके बाद, external/rust/binder_example/aidl/Android.bp फ़ाइल में, aidl_interface मॉड्यूल. आपको Rust बैकएंड को साफ़ तौर पर चालू करना होगा, क्योंकि यह डिफ़ॉल्ट रूप से चालू नहीं होता.

ध्यान दें: पक्का करें कि aidl_interface वाली Android.bp फ़ाइल, रूट में मौजूद हो एआईडीएल परिभाषाएं वाला पाथ. इस मामले में यह external/rust/binder_example/aidl/.

aidl_interface {
    name: "com.example.android.remoteservice",
    srcs: [ "aidl/com/example/android/*.aidl", ],
    unstable: true, // Add during development until the interface is stabilized.
    backend: {
        rust: {
            // By default, the Rust backend is not enabled
            enabled: true,
        },
    },
}

AIDL बैकएंड, Rust सोर्स जनरेटर है, इसलिए यह अन्य Rust सोर्स की तरह काम करता है यहां रस्ट लाइब्रेरी बनाई जाती है. तैयार किए गए Rust लाइब्रेरी मॉड्यूल को दूसरे Rust मॉड्यूल, डिपेंडेंसी के तौर पर इस्तेमाल किए जाते हैं. उदाहरण के तौर पर, लाइब्रेरी को डिपेंडेंसी के तौर पर सेट करता है, तो rust_library को इस तरह परिभाषित किया जा सकता है: external/rust/binder_example/Android.bp:

rust_library {
    name: "libmyservice",
    srcs: ["src/lib.rs"],
    crate_name: "myservice",
    rustlibs: [
        "com.example.android.remoteservice-rust",
        "libbinder_rs",
    ],
}

ध्यान दें कि rustlibs में इस्तेमाल की जाने वाली एआईडीएल से जनरेट की गई लाइब्रेरी के लिए, मॉड्यूल के नाम का फ़ॉर्मैट aidl_interface मॉड्यूल का नाम है, इसके बाद -rust; इस मामले में, com.example.android.remoteservice-rust.

इसके बाद, एआईडीएल इंटरफ़ेस का रेफ़रंस src/lib.rs में इस तरह दिया जा सकता है:

// Note carefully the AIDL crates structure:
// * the AIDL module name: "com_example_android_remoteservice"
// * next "::aidl"
// * next the AIDL package name "::com::example::android"
// * the interface: "::IRemoteService"
// * finally, the 'BnRemoteService' and 'IRemoteService' submodules

//! This module implements the IRemoteService AIDL interface
use com_example_android_remoteservice::aidl::com::example::android::{
  IRemoteService::{BnRemoteService, IRemoteService}
};
use binder::{
    BinderFeatures, Interface, Result as BinderResult, Strong,
};

/// This struct is defined to implement IRemoteService AIDL interface.
pub struct MyService;

impl Interface for MyService {}

impl IRemoteService for MyService {
    fn getPid(&self) -> BinderResult<i32> {
        Ok(42)
    }

    fn basicTypes(&self, _: i32, _: i64, _: bool, _: f32, _: f64, _: &str) -> BinderResult<()> {
        // Do something interesting...
        Ok(())
    }
}

आखिर में, सेवा को Rust बाइनरी में शुरू करें, जैसा कि यहां दिखाया गया है:

use myservice::MyService;

fn main() {
    // [...]
    let my_service = MyService;
    let my_service_binder = BnRemoteService::new_binder(
        my_service,
        BinderFeatures::default(),
    );
    binder::add_service("myservice", my_service_binder.as_binder())
        .expect("Failed to register service?");
    // Does not return - spawn or perform any work you mean to do before this call.
    binder::ProcessState::join_thread_pool()
}

एक साथ काम नहीं करने वाली रस्ट एआईडीएल का उदाहरण

इस सेक्शन में, हैलो वर्ल्ड स्टाइल में एक उदाहरण दिया गया है. इसमें एक साथ कई रस्ट के साथ एआईडीएल का इस्तेमाल करने का उदाहरण दिया गया है.

RemoteService उदाहरण के हिसाब से, जनरेट की गई एआईडीएल बैकएंड लाइब्रेरी इसमें ऐसे एसिंक्रोनस इंटरफ़ेस शामिल हैं जिनका इस्तेमाल एक एसिंक्रोनस सर्वर को लागू करने के लिए किया जा सकता है AIDL इंटरफ़ेस RemoteService को लागू करना.

जनरेट किया गया एक साथ काम नहीं करने वाला सर्वर इंटरफ़ेस IRemoteServiceAsyncServer इस तरह लागू किया जाता है:

use com_example_android_remoteservice::aidl::com::example::android::IRemoteService::{
    BnRemoteService, IRemoteServiceAsyncServer,
};
use binder::{BinderFeatures, Interface, Result as BinderResult};

/// This struct is defined to implement IRemoteServiceAsyncServer AIDL interface.
pub struct MyAsyncService;

impl Interface for MyAsyncService {}

#[async_trait]
impl IRemoteServiceAsyncServer for MyAsyncService {
    async fn getPid(&self) -> BinderResult<i32> {
        //Do something interesting...
        Ok(42)
    }

    async fn basicTypes(&self, _: i32, _: i64, _: bool, _: f32, _: f64,_: &str,) -> BinderResult<()> {
        //Do something interesting...
        Ok(())
    }
}

एक साथ काम नहीं करने वाले सर्वर को इस तरह से लागू किया जा सकता है:

#[tokio::main(flavor = "multi_thread", worker_threads = 2)]
async fn main() {
    binder::ProcessState::start_thread_pool();

    let my_service = MyAsyncService;
    let my_service_binder = BnRemoteService::new_async_binder(
        my_service,
        TokioRuntime(Handle::current()),
        BinderFeatures::default(),
    );

    binder::add_service("myservice", my_service_binder.as_binder())
        .expect("Failed to register service?");

    task::block_in_place(move || {
        binder::ProcessState::join_thread_pool();
    });
}

ध्यान दें कि block_in_place एसिंक्रोनस संदर्भ को छोड़ने के लिए इसकी आवश्यकता होती है, जो join_thread_pool को आंतरिक तौर पर block_on. ऐसा इसलिए होता है, क्योंकि #[tokio::main] कोड को रैप करता है block_on के कॉल में हैं और join_thread_pool शायद कॉल करें आने वाले लेन-देन को मैनेज करते समय block_on. किसी block_on में से block_on खतरे में आ गया है. ऐसा भी हो सकता है Tokio रनटाइम बनाकर, इससे बचा जा सकता है मैन्युअल तरीके से इसके लिए, #[tokio::main] का इस्तेमाल करें. इसके बाद, join_thread_pool पर कॉल करें block_on तरीके के बाहर.

इसके अलावा, रस्ट बैकएंड से जनरेट की गई लाइब्रेरी में एक ऐसा इंटरफ़ेस शामिल है जो RemoteService के लिए एक साथ काम नहीं करने वाली क्लाइंट IRemoteServiceAsync लागू करने की वजह से नीचे बताए गए तरीके से लागू किया जाएगा:

use com_example_android_remoteservice::aidl::com::example::android::IRemoteService::IRemoteServiceAsync;
use binder_tokio::Tokio;

#[tokio::main(flavor = "current_thread")]
async fn main() {
    let binder_service = binder_tokio::wait_for_interface::<dyn IRemoteServiceAsync<Tokio>>("myservice");

    let my_client = binder_service.await.expect("Cannot find Remote Service");

    let result = my_client.getPid().await;

    match result {
        Err(err) => panic!("Cannot get the process id from Remote Service {:?}", err),
        Ok(p_id) => println!("PID = {}", p_id),
    }
}

C से Rust को कॉल करें

इस उदाहरण में C से Rust को कॉल करने का तरीका बताया गया है.

Rust लाइब्रेरी का उदाहरण

libsimple_printer फ़ाइल को external/rust/simple_printer/libsimple_printer.rs में तय करें इस तरह से:

//! A simple hello world example that can be called from C

#[no_mangle]
/// Print "Hello Rust!"
pub extern fn print_c_hello_rust() {
    println!("Hello Rust!");
}

Rust लाइब्रेरी से हेडर तय किए जाने चाहिए, ताकि डिपेंडेंट C मॉड्यूल अंदर आ सकें, इसलिए external/rust/simple_printer/simple_printer.h हेडर को इस तरह परिभाषित करें:

#ifndef SIMPLE_PRINTER_H
#define SIMPLE_PRINTER_H

void print_c_hello_rust();


#endif

external/rust/simple_printer/Android.bp के बारे में यहां देखें:

rust_ffi {
    name: "libsimple_c_printer",
    crate_name: "simple_c_printer",
    srcs: ["libsimple_c_printer.rs"],

    // Define export_include_dirs so cc_binary knows where the headers are.
    export_include_dirs: ["."],
}

उदाहरण C बाइनरी

external/rust/c_hello_rust/main.c को इस तरह परिभाषित करें:

#include "simple_printer.h"

int main() {
  print_c_hello_rust();
  return 0;
}

external/rust/c_hello_rust/Android.bp को इस तरह परिभाषित करें:

cc_binary {
    name: "c_hello_rust",
    srcs: ["main.c"],
    shared_libs: ["libsimple_c_printer"],
}

आखिर में, m c_hello_rust को कॉल करके बिल्ड करें.

रस्ट-जावा इंटरऑप

jni क्रेट, Java नेटिव के ज़रिए Java के साथ रस्ट इंटरऑपरेबिलिटी (दूसरे सिस्टम के साथ काम करना) की सुविधा देता है इंटरफ़ेस (जेएनआई). यह Rust के लिए ज़रूरी प्रकार की परिभाषाएं तय करता है, Rust cdylib की लाइब्रेरी जो सीधे Java के JNI (JNIEnv, JClass, JString वगैरह). cxx के ज़रिए कोडजन करने वाली C++ बाइंडिंग के उलट, JNI के माध्यम से Java इंटरऑपरेबिलिटी के लिए कोड-जनरेशन चरण की आवश्यकता नहीं है बिल्ड के दौरान इस्तेमाल किया जाता है. इसलिए, इसके लिए खास बिल्ड-सिस्टम सपोर्ट की ज़रूरत नहीं होती है. Java कोड, किसी दूसरी नेटिव लाइब्रेरी की तरह, Rust के ज़रिए दिए गए cdylib को लोड करता है.

इस्तेमाल

Rust और Java कोड, दोनों के इस्तेमाल को jni क्रेट के दस्तावेज़. प्लीज़ शुरुआती जानकारी को फ़ॉलो करें दिया गया है. src/lib.rs लिखने के बाद, इस पेज पर वापस जाएँ Android के बिल्ड सिस्टम से लाइब्रेरी बनाने का तरीका जानें.

बिल्ड की परिभाषा

Java के लिए ज़रूरी है कि Rust लाइब्रेरी को cdylib के तौर पर दिया जाए, ताकि इसे डाइनैमिक रूप से लोड होता है. सूंग में रस्ट लाइब्रेरी की परिभाषा यह है:

rust_ffi_shared {
    name: "libhello_jni",
    crate_name: "hello_jni",
    srcs: ["src/lib.rs"],

    // The jni crate is required
    rustlibs: ["libjni"],
}

Java लाइब्रेरी में, Rust लाइब्रेरी को required डिपेंडेंसी के तौर पर लिस्ट किया गया है; इससे यह पक्का होता है कि यह डिवाइस पर Java लाइब्रेरी के साथ इंस्टॉल किया गया है या नहीं यह बिल्ड-टाइम डिपेंडेंसी नहीं है:

java_library {
        name: "libhelloworld",
        [...]
        required: ["libhellorust"]
        [...]
}

इसके अलावा, अगर आपको AndroidManifest.xml में Rust लाइब्रेरी को शामिल करना होगा फ़ाइल के लिए, लाइब्रेरी को uses_libs में इस तरह जोड़ें:

java_library {
        name: "libhelloworld",
        [...]
        uses_libs: ["libhellorust"]
        [...]
}

CXX का इस्तेमाल करके रस्ट–C++ इंटरऑप

CXX क्रेट सुरक्षित एफ़एफ़आई देता है Rust और C++ के सबसेट के बीच सेट करें. CXX दस्तावेज़ यह सामान्य तौर पर कैसे काम करता है इसके अच्छे उदाहरण देता है और हमारा सुझाव है कि पहले इसे पढ़ें से जाना जा सकता है. कॉन्टेंट बनाने नीचे दिया गया उदाहरण Android में इसका इस्तेमाल करने का तरीका दिखाता है.

CXX जिस C++ कोड में कॉल को रस्ट करता है उसे जनरेट करने के लिए, genrule उसे लाइब्रेरी में बंडल करने के लिए, CXX और cc_library_static को शुरू करें. अगर आपको C++ कॉल Rust कोड पाने के लिए, या C++ और Rust के बीच शेयर किए गए प्रकारों का इस्तेमाल करने के लिए, दूसरा जेनरुल (रस्ट बाइंडिंग वाला C++ हेडर जनरेट करने के लिए).

cc_library_static {
    name: "libcxx_test_cpp",
    srcs: ["cxx_test.cpp"],
    generated_headers: [
        "cxx-bridge-header",
        "libcxx_test_bridge_header"
    ],
    generated_sources: ["libcxx_test_bridge_code"],
}

// Generate the C++ code that Rust calls into.
genrule {
    name: "libcxx_test_bridge_code",
    tools: ["cxxbridge"],
    cmd: "$(location cxxbridge) $(in) > $(out)",
    srcs: ["lib.rs"],
    out: ["libcxx_test_cxx_generated.cc"],
}

// Generate a C++ header containing the C++ bindings
// to the Rust exported functions in lib.rs.
genrule {
    name: "libcxx_test_bridge_header",
    tools: ["cxxbridge"],
    cmd: "$(location cxxbridge) $(in) --header > $(out)",
    srcs: ["lib.rs"],
    out: ["lib.rs.h"],
}

cxxbridge टूल का उपयोग ऊपर पुल का C++ साइड जनरेट करने के लिए किया जाता है. libcxx_test_cpp हमारे Rust एक्ज़ीक्यूटेबल के लिए, इसके बाद स्टैटिक लाइब्रेरी का इस्तेमाल डिपेंडेंसी के तौर पर किया जाता है:

rust_binary {
    name: "cxx_test",
    srcs: ["lib.rs"],
    rustlibs: ["libcxx"],
    static_libs: ["libcxx_test_cpp"],
}

.cpp और .hpp फ़ाइलों में, C++ फ़ंक्शन को अपने हिसाब से तय करें, अपने हिसाब से CXX रैपर टाइप का इस्तेमाल करें. उदाहरण के लिए, cxx_test.hpp की परिभाषा में ये चीज़ें शामिल हैं:

#pragma once

#include "rust/cxx.h"
#include "lib.rs.h"

int greet(rust::Str greetee);

जबकि cxx_test.cppमें यह शामिल है

#include "cxx_test.hpp"
#include "lib.rs.h"

#include <iostream>

int greet(rust::Str greetee) {
  std::cout << "Hello, " << greetee << std::endl;
  return get_num();
}

Rust से इसका इस्तेमाल करने के लिए, lib.rs में नीचे बताए गए तरीके से CXX ब्रिज तय करें:

#[cxx::bridge]
mod ffi {
    unsafe extern "C++" {
        include!("cxx_test.hpp");
        fn greet(greetee: &str) -> i32;
    }
    extern "Rust" {
        fn get_num() -> i32;
    }
}

fn main() {
    let result = ffi::greet("world");
    println!("C++ returned {}", result);
}

fn get_num() -> i32 {
    return 42;
}