처음부터 Ruby C 확장 빌드

이번 Ruby Magic 에디션에서는 Ruby에서 C로 작성된 코드를 사용하는 방법을 보여줍니다. 이것은 코드의 성능에 민감한 부분을 최적화하거나 C 라이브러리와 Ruby 간의 인터페이스를 만드는 데 사용할 수 있습니다. 이것은 C로 작성된 라이브러리를 래핑하는 확장을 생성하여 수행됩니다.

C로 작성된 성숙하고 성능이 뛰어난 라이브러리가 많이 있습니다. 이식하여 바퀴를 재발명하는 대신 Ruby에서 이러한 라이브러리를 활용할 수도 있습니다. 이런 식으로 Ruby가 전통적으로 강력하지 않은 영역에서 C 라이브러리를 사용하면서 좋아하는 언어로 코드를 작성할 수 있습니다. AppSignal에서는 rdkafka gem을 개발할 때 이 접근 방식을 사용했습니다.

그럼 어떻게 접근할 수 있는지 알아보겠습니다. 따라하고 직접 실험하고 싶다면 예제 코드를 확인하십시오. 시작하기 위해 문자열, 숫자, 부울(C 이유, 말장난)이 포함된 이 Ruby 코드를 가져와서 C 라이브러리에 이식해 보겠습니다.

module CFromRubyExample
  class Helpers
    def self.string(value)
      "String: '#{value}'"
    end
 
    def self.number(value)
      value + 1
    end
 
    def self.boolean(value)
      !value
    end
  end
end

순서대로 표시된 메서드는 문자열을 연결하고 숫자를 1씩 늘리고 부울의 반대를 반환합니다.

C로 이식된 라이브러리

아래에서 C로 이식된 코드를 볼 수 있습니다. C 표준 라이브러리와 IO 라이브러리가 포함되어 있어 문자열 형식을 사용할 수 있습니다. char*를 사용합니다. Ruby String 대신 . char* 메모리 어딘가에 있는 문자 버퍼의 위치를 가리킵니다.

# include <stdlib.h>
# include <stdio.h>
 
char* string_from_library(char* value) {
  char* out = (char*)malloc(256 * sizeof(char));
  sprintf(out, "String: '%s'", value);
  return out;
}
 
int number_from_library(int value) {
  return value + 1;
}
 
int boolean_from_library(int value) {
  if (value == 0) {
    return 1;
  } else {
    return 0;
  }
}

보시다시피 간단한 문자열 형식 지정을 수행하려면 몇 가지 단계를 건너뛰어야 합니다. 문자열을 연결하려면 먼저 버퍼를 할당해야 합니다. 이렇게 하면 sprintf 그런 다음 함수는 형식화된 결과를 여기에 쓸 수 있습니다. 마지막으로 버퍼를 반환할 수 있습니다.

위의 코드를 사용하면 이미 충돌 또는 보안 문제가 발생할 수 있습니다. 들어오는 문자열이 245바이트보다 길면 두려운 버퍼 오버플로가 발생합니다. C를 쓸 때는 발에 총을 쏘기 쉽기 때문에 확실히 주의해야 합니다.

다음은 헤더 파일입니다.

char* string_from_library(char*);
int number_from_library(int);
int boolean_from_library(int);

이 파일은 C 라이브러리의 공개 API를 설명합니다. 다른 프로그램은 이를 사용하여 라이브러리의 어떤 함수를 호출할 수 있는지 확인합니다.

2018년 방식:`ffi` 사용 보석

이제 Ruby에서 사용하려는 C 라이브러리가 있습니다. 이 C 코드를 gem으로 래핑하는 두 가지 방법이 있습니다. 현대적인 방법은 ffi를 사용하는 것입니다. 보석. 그것은 우리가 건너야 하는 많은 후프를 자동화합니다. ffi 사용 방금 작성한 C 코드는 다음과 같습니다.

module CFromRubyExample
  class Helpers
    extend FFI::Library
 
    ffi_lib File.join(File.dirname(__FILE__), "../../ext/library.so")
 
    attach_function :string, [:string], :string
    attach_function :number, [:int], :int
    attach_function :boolean, [:int], :int
  end
end

이 기사의 목적을 위해 C 코드를 C 확장으로 래핑하는 방법도 설명합니다. 이것은 Ruby의 내부에서 모든 것이 어떻게 작동하는지에 대해 훨씬 더 많은 통찰력을 제공할 것입니다.

C 확장으로 라이브러리 래핑

이제 Ruby에서 사용하려는 C 라이브러리가 있습니다. 다음 단계는 컴파일하고 래핑하는 gem을 만드는 것입니다. gem을 만든 후 먼저 ext를 추가합니다. require_paths에 gemspec에서:

Gem::Specification.new do |spec|
  spec.name          = "c_from_ruby_example"
  # ...
  spec.require_paths = ["lib", "ext"]
end

이것은 빌드해야 하는 기본 확장이 있음을 Rubygems에 알립니다. extconf.rb라는 파일을 찾습니다. 또는 Rakefile . 이 경우 extconf.rb를 추가했습니다. :

require "mkmf"
 
create_makefile "extension"

mkmf가 필요합니다. , "Makefile 만들기"를 의미합니다. Ruby에 포함된 일련의 도우미로 C 빌드 설정의 까다로운 부분을 제거합니다. create_makefile을 호출합니다. 확장 프로그램의 이름을 설정합니다. 이것은 Makefile을 생성합니다. C 코드를 빌드하기 위한 모든 구성과 명령이 포함되어 있습니다.

다음으로 라이브러리를 Ruby에 연결하기 위한 C 코드를 작성해야 합니다. char*와 같은 C 유형을 변환하는 몇 가지 함수를 만들 것입니다. String과 같은 Ruby 유형으로 . 그런 다음 C 코드로 Ruby 클래스를 생성합니다.

먼저 Ruby의 일부 헤더 파일을 포함합니다. 이것들은 우리가 유형 변환을 수행하는 데 필요한 함수를 가져올 것입니다. library.h도 포함합니다. 라이브러리를 호출할 수 있도록 이전에 만든 헤더 파일입니다.

#include "ruby/ruby.h"
#include "ruby/encoding.h"
#include "library.h"

그런 다음 라이브러리의 각 함수를 래핑하는 함수를 만듭니다. 이것은 문자열에 대한 것입니다:

static VALUE string(VALUE self, VALUE value) {
  Check_Type(value, T_STRING);
 
  char* pointer_in = RSTRING_PTR(value);
  char* pointer_out = string_from_library(pointer_in);
  return rb_str_new2(pointer_out);
}

문자열이 아닌 값을 처리하면 모든 종류의 버그가 발생할 수 있으므로 들어오는 Ruby 값이 문자열인지 먼저 확인합니다. 그런 다음 Ruby String char*로 RSTRING_PTR Ruby가 제공하는 도우미 매크로입니다. 이제 C 라이브러리를 호출할 수 있습니다. 반환된 char*를 변환하려면 , 포함 rb_str_new2를 사용합니다. 기능. number 및 boolean에 대해 유사한 래핑 기능을 추가할 예정입니다.

숫자의 경우 NUM2INT를 사용하여 유사한 작업을 수행합니다. 및 INT2NUM 도우미:

static VALUE number(VALUE self, VALUE value) {
  Check_Type(value, T_FIXNUM);
 
  int number_in = NUM2INT(value);
  int number_out = number_from_library(number_in);
  return INT2NUM(number_out);
}

부울 버전도 비슷합니다. C에는 실제로 부울 유형이 없습니다. 대신 0과 1을 사용하는 것이 관례입니다.

static VALUE boolean(VALUE self, VALUE value) {
  int boolean_in = RTEST(value);
  int boolean_out = boolean_from_library(boolean_in);
  if (boolean_out == 1) {
    return Qtrue;
  } else {
    return Qfalse;
  }
}

마지막으로 Ruby에서 호출할 수 있도록 모든 것을 연결할 수 있습니다.

void Init_extension(void) {
  VALUE CFromRubyExample = rb_define_module("CFromRubyExample");
  VALUE NativeHelpers = rb_define_class_under(CFromRubyExample, "NativeHelpers", rb_cObject);
 
  rb_define_singleton_method(NativeHelpers, "string", string, 1);
  rb_define_singleton_method(NativeHelpers, "number", number, 1);
  rb_define_singleton_method(NativeHelpers, "boolean", boolean, 1);
}

네, 맞습니다. C에서 Ruby 모듈, 클래스 및 메소드를 생성할 수 있습니다. 여기에서 클래스를 설정합니다. 그런 다음 클래스에 Ruby 메서드를 추가합니다. Ruby 메소드의 이름, 호출될 C 래퍼 함수의 이름 및 인수의 수를 표시해야 합니다.

모든 작업이 끝나면 마침내 C 코드를 호출할 수 있습니다.

CFromRubyExample::NativeHelpers.string("a string")

결론

우리는 장애물을 뛰어 넘었고 충돌하지 않았으며 C 확장이 작동하도록 했습니다. C 확장을 작성하는 것은 희미한 마음을 위한 것이 아닙니다. ffi를 사용하는 경우에도 gem을 사용하면 여전히 Ruby 프로세스가 매우 쉽게 충돌할 수 있습니다. 하지만 가능하고 성능이 뛰어나고 안정적인 C 라이브러리의 세계를 열 수 있습니다!

처음부터 Ruby C 확장 빌드

C로 이식된 라이브러리

2018년 방식:ffi 사용 보석

C 확장으로 라이브러리 래핑

결론

2018년 방식:`ffi` 사용 보석