python - 如何为双指针结构参数应用 SWIG 类型映射

Question

我有一个 API，我正尝试使用 SWIG 包装它，以便我可以从 python 调用底层 C 库。

我被某个特定的 API fn 卡住了:

int update_tracks(track_t **phash_tracks,
                  const pdws_t *pdw_frame,
                  const rdws_t *rdw_frame,
                  lib_t *lib,
                  lib_meta_t *lib_meta,
                  const cfg_t *cfg);

它是我无法处理的指向track_t 数据结构的双指针。

所有的单指针都可以正常工作。

这是唯一具有指向 track_t 的双指针的 API fn

所有其他的只有一个指针，例如

void print_hash_tracks(const track_t *hash_tracks, const cfg_t *cfg,
                       enum TRKTYPE trktype);

我很确定我需要在我的 SWIG 接口(interface)文件 (interface.i) 中创建一个类型映射，但我发现 SWIG 文档难以理解。

我认为我需要做的是创建一个类型映射，每当它看到 track_t** 类型时，它都会获取一个 track_t* 并将其转换为其地址，像这样的东西:

/* provide typemap to handle instances of track_t** parameters */
%typemap(in) track_t** (track_t *tracks) {
    $1 = &tracks;
}

但我在运行时遇到了段错误:

tracks = g3.track_t()
g3.update_tracks(tracks, pdw_frame, rdw_frame, lib, lib_meta, cfg)

在 python 方面。

我觉得我几乎已经解决了这个问题，但无法完全正确地理解类型映射规范，同时还在努力理解相关文档。

flexo - 如果你在那里 - 也许你可以阐明这一点，你似乎是这个领域的 SO 专家..

更新 - m7ython(太棒了!另一位 SWIG SO 专家)

在 C 中的使用非常简单

声明并初始化一个 track_t 指针为 NULL:

track_t *hash_tracks = NULL;

然后:

update_tracks(&hash_tracks, &pdw_frame, &rdw_frame,
              &lib, &lib_meta, &cfg);

因此指向track_t 的指针地址作为参数传递给update_tracks()。 update_tracks() fn 负责为放入 hash_tracks 的数据处理所有必要的 malloc，即 track_t 结构的哈希表

所有其他 args 都是单指针，我可以在 python 端毫无问题地创建和填充它们。

track_t 是一个包含一堆整数、 float 、char* 等的结构。例如

typedef struct
{
/* make struct hashable */
UT_hash_handle hh;

int id;
...
char name[MAX_BUF];
...
} track_t;

track_t arg 是 track_t** 而不仅仅是 track_t* 的原因是因为 hash_tracks 是一个指向散列的指针表(使用 UTHash 库)。 hash_tracks 指向哈希表中的第一个track_t。在update_tracks() fn track_t 结构的主体中，可以从哈希表中添加/删除，这样指向第一个 track_t 的指针可能会改变，即 hash_tracks 可能指向在调用 update_tracks() 之后到其他地方，因此将指针传递给指针的原因。

换句话说，track_t** arg，phash_tracks 被用作输入和输出类型 arg，因此是指向指针的指针。所有其他 args 只是输入，它们不会改变，因此可以作为单个指针传入。

我尝试使用以下 C fn 的 'helper fn' 路由:

track_t** make_phash_tracks(void)
{
    track_t **phash_tracks;

    phash_tracks = calloc(1, sizeof(track_t*));

    return phash_tracks;
}

使用calloc要保证*phash_tracks为NULL

这个编译和包装没有错误，但是当我从 python 端使用它时它出现了段错误，例如

phash_tracks = g3.make_phash_tracks()
g3.update_tracks(phash_tracks, pdw_frame, rdw_frame, lib, lib_meta, cfg)

在调用 update_tracks 之前检查 phash_tracks var 给出:

(Pdb) p phash_tracks
<Swig Object of type 'track_t **' at 0x7fb9e37c9030>

Answer 1

编辑:好的，我想我现在明白了 update_tracks 的作用。看来您可以通过两种方式使用该功能。要么更新现有的 tracks，要么创建 tracks(如果您将指针传递给 NULL 指针)。我不确定在 SWIG 中处理这两种情况的最优雅方式(或者这是否是一个问题)，但这里有一些选择。

1。 phash_tracks 是一个输出参数

首先，您必须将*phash_tracks 作为返回值传递回 Python，并以某种形式使用该函数，例如

>>> int_res, tracks = g3.update_tracks(tracks, pdw_frame, rdw_frame, lib, lib_meta, cfg)

或

>>> int_res, tracks = g3.update_tracks(pdw_frame, rdw_frame, lib, lib_meta, cfg)

这是通过以下“argout”类型映射实现的:

%typemap(argout) track_t **phash_tracks {
  %append_output(SWIG_NewPointerObj(%as_voidptr(*$1), $*1_descriptor, SWIG_POINTER_OWN));
}

也许您不希望 Python 获得 track_t* 的所有权，然后将 SWIG_POINTER_OWN 替换为 0。

2。传递一个空的 phash_tracks

如果您只想使用 update_tracks 函数来创建 tracks，您基本上可以做您已经在做的事情。使用以下“in”类型映射，并使用上面第二个示例中的函数(不带 tracks 参数)。

%typemap(in, numinputs=0) track_t **phash_tracks (track_t *tracks) {
  tracks = NULL;
  $1 = &tracks;
}

3。 phash_tracks 作为输入(和输出)参数

如果你想使用 update_tracks 更新existing tracks，你应该可以使用我之前建议的“in”类型映射，并像第一个示例一样使用 Python 中的函数(包括 tracks 参数)。

%typemap(in) track_t **phash_tracks (track_t *tracks) {
  if ((SWIG_ConvertPtr($input, (void **) &tracks, $*1_descriptor, SWIG_POINTER_EXCEPTION | SWIG_POINTER_DISOWN)) == -1)
    return NULL;
  $1 = &tracks;
}

请注意，Python 否认它的 tracks_t* 很重要。

4。同时启用上面的 (2) 和 (3)

你基本上也可以使用版本 (3) 来创建 tracks，如果你可以让 swig 传递一个包装的 NULL tracks_t*。我不确定 SWIG 是否允许这样做——但也许允许。尝试使用辅助函数:

tracks_t* empty_tracks() { return NULL; }

或者，您可以按照以下行修改“in”类型映射，尝试将提供的参数转换为 track_t* 并传递其地址，或者传递 的地址空 track_t*.

%typemap(in) track_t **phash_tracks (track_t *tracks) {
  // Alternatively, check if $input is a 0 integer `PyObject`...
  if ((SWIG_ConvertPtr($input, (void **) &tracks, $*1_descriptor, SWIG_POINTER_DISOWN)) == -1)
    tracks = NULL;
  $1 = &tracks;
}

然后，在 Python 中，只需传递其他内容即可创建 tracks:

>>> int_res, tracks = g3.update_tracks(0, pdw_frame, rdw_frame, lib, lib_meta, cfg)