[PATCH] PCI device enumeration for lua

[PATCH] PCI device enumeration for lua

[Evan Broder]

[-- Attachment #1: Type: text/plain, Size: 672 bytes --]

Hi -
    This patch adds anew enum_pci(callback) function to the Lua grub
library for enumerating devices on the PCI bus. This is not currently
possible because there's no way to get the output of a command from
grub.run.

While I think that would be useful to have in the more general case,
in this particular case using the internal grub_pci_iterate function
is better, because it keeps Lua code from having to parse the lengthy
output from the lspci command.

The callback function passed to enum_pci is called once for each
device found: the bus index, the device index, the function index, the
PCI ID as a single numeric value, and the device class.

Thanks,
 - Evan

[-- Attachment #2: grub_lua_enum_pci.diff --]
[-- Type: application/octet-stream, Size: 1696 bytes --]

=== modified file 'grub_lib.c'
--- grub_lib.c	2010-09-21 18:00:15 +0000
+++ grub_lib.c	2010-10-27 19:25:37 +0000
@@ -27,6 +27,7 @@
 #include <grub/normal.h>
 #include <grub/file.h>
 #include <grub/device.h>
+#include <grub/pci.h>
 
 /* Updates the globals grub_errno and grub_msg, leaving their values on the 
    top of the stack, and clears grub_errno. When grub_errno is zero, grub_msg
@@ -251,6 +252,38 @@
 }
 
 static int
+grub_lua_enum_pci (lua_State *state)
+{
+  auto int NESTED_FUNC_ATTR enum_pci (grub_pci_device_t dev, grub_pci_id_t pciid);
+  int NESTED_FUNC_ATTR enum_pci (grub_pci_device_t dev, grub_pci_id_t pciid)
+  {
+    int result;
+    grub_pci_address_t addr;
+    grub_uint32_t class;
+
+    lua_pushvalue (state, 1);
+    lua_pushinteger (state, grub_pci_get_bus (dev));
+    lua_pushinteger (state, grub_pci_get_device (dev));
+    lua_pushinteger (state, grub_pci_get_function (dev));
+    lua_pushinteger (state, pciid);
+
+    addr = grub_pci_make_address (dev, GRUB_PCI_REG_CLASS);
+    class = grub_pci_read (addr);
+    lua_pushinteger (state, class);
+
+    lua_call (state, 5, 1);
+    result = lua_tointeger (state, -1);
+    lua_pop (state, 1);
+
+    return result;
+  }
+
+  luaL_checktype (state, 1, LUA_TFUNCTION);
+  grub_pci_iterate (enum_pci);
+  return push_result (state);
+}
+
+static int
 grub_lua_file_open (lua_State *state)
 {
   grub_file_t file;
@@ -446,6 +479,7 @@
     {"setenv", grub_lua_setenv},
     {"enum_device", grub_lua_enum_device},
     {"enum_file", grub_lua_enum_file},
+    {"enum_pci", grub_lua_enum_pci},
     {"file_open", grub_lua_file_open},
     {"file_close", grub_lua_file_close},
     {"file_seek", grub_lua_file_seek},

Re: [PATCH] PCI device enumeration for lua

[Evan Broder]

[-- Attachment #1: Type: text/plain, Size: 1291 bytes --]

On Wed, Oct 27, 2010 at 12:29 PM, Evan Broder <evan@ebroder.net> wrote:
> Hi -
>    This patch adds anew enum_pci(callback) function to the Lua grub
> library for enumerating devices on the PCI bus. This is not currently
> possible because there's no way to get the output of a command from
> grub.run.
>
> While I think that would be useful to have in the more general case,
> in this particular case using the internal grub_pci_iterate function
> is better, because it keeps Lua code from having to parse the lengthy
> output from the lspci command.
>
> The callback function passed to enum_pci is called once for each
> device found: the bus index, the device index, the function index, the
> PCI ID as a single numeric value, and the device class.

Hi again -
    Having actually tried to work with this patch, I realized that I
wanted a little more information passed into the callback function. I
also realized that it's rather difficult to do things like separating
the vendor and device IDs in Lua, since it lacks bitwise operators. My
new patch passes 9 arguments to the callback function: bus index,
device index, function index, primary vendor ID, primary device ID,
subsystem vendor ID, subsystem device ID, base class, and sub-class.

Thanks,
 - Evan

[-- Attachment #2: grub_lua_enum_pci.diff --]
[-- Type: application/octet-stream, Size: 2174 bytes --]

=== modified file 'grub_lib.c'
--- grub_lib.c	2010-09-21 18:00:15 +0000
+++ grub_lib.c	2010-11-05 20:40:01 +0000
@@ -27,6 +27,7 @@
 #include <grub/normal.h>
 #include <grub/file.h>
 #include <grub/device.h>
+#include <grub/pci.h>
 
 /* Updates the globals grub_errno and grub_msg, leaving their values on the 
    top of the stack, and clears grub_errno. When grub_errno is zero, grub_msg
@@ -251,6 +252,53 @@
 }
 
 static int
+grub_lua_enum_pci (lua_State *state)
+{
+  auto int NESTED_FUNC_ATTR enum_pci (grub_pci_device_t dev, grub_pci_id_t pciid);
+  int NESTED_FUNC_ATTR enum_pci (grub_pci_device_t dev, grub_pci_id_t pciid)
+  {
+    int result;
+    grub_pci_address_t addr;
+    grub_pci_id_t sub_pciid;
+    grub_uint32_t class;
+
+    lua_pushvalue (state, 1);
+    lua_pushinteger (state, grub_pci_get_bus (dev));
+    lua_pushinteger (state, grub_pci_get_device (dev));
+    lua_pushinteger (state, grub_pci_get_function (dev));
+
+    /* vendor ID */
+    lua_pushinteger (state, pciid & 0xFFFF);
+    /* device ID */
+    lua_pushinteger (state, pciid >> 16);
+
+    addr = grub_pci_make_address (dev, GRUB_PCI_REG_SUBVENDOR);
+    sub_pciid = grub_pci_read (addr);
+    /* subvendor ID */
+    lua_pushinteger (state, sub_pciid & 0xFFFF);
+    /* subdevice ID */
+    lua_pushinteger (state, sub_pciid >> 16);
+
+    addr = grub_pci_make_address (dev, GRUB_PCI_REG_CLASS);
+    class = grub_pci_read (addr);
+    /* base class */
+    lua_pushinteger (state, class >> 24);
+    /* sub class */
+    lua_pushinteger (state, 0xFF & (class >> 16));
+
+    lua_call (state, 9, 1);
+    result = lua_tointeger (state, -1);
+    lua_pop (state, 1);
+
+    return result;
+  }
+
+  luaL_checktype (state, 1, LUA_TFUNCTION);
+  grub_pci_iterate (enum_pci);
+  return push_result (state);
+}
+
+static int
 grub_lua_file_open (lua_State *state)
 {
   grub_file_t file;
@@ -446,6 +494,7 @@
     {"setenv", grub_lua_setenv},
     {"enum_device", grub_lua_enum_device},
     {"enum_file", grub_lua_enum_file},
+    {"enum_pci", grub_lua_enum_pci},
     {"file_open", grub_lua_file_open},
     {"file_close", grub_lua_file_close},
     {"file_seek", grub_lua_file_seek},

Re: [PATCH] PCI device enumeration for lua

[Duboucher Thomas]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Le 05/11/2010 23:02, Evan Broder a écrit :
> Hi again -
>     Having actually tried to work with this patch, I realized that I
> wanted a little more information passed into the callback function. I
> also realized that it's rather difficult to do things like separating
> the vendor and device IDs in Lua, since it lacks bitwise operators. My
> new patch passes 9 arguments to the callback function: bus index,
> device index, function index, primary vendor ID, primary device ID,
> subsystem vendor ID, subsystem device ID, base class, and sub-class.
> 
> Thanks,
>  - Evan
> 

Hi,

Lua 5.2 will integrate bitlib by default to perform bitwise operations;
we could also readily integrate it in the current version.

- --
Thomas.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkzVKJMACgkQBV7eXqefhqg3FgCcCS2GOiZRMyWqdGP/41yFwlIT
k+8An1RBYBFKrANxTeqGg7PBkrcTobMP
=oKnY
-----END PGP SIGNATURE-----

Re: [PATCH] PCI device enumeration for lua

[Evan Broder]

On Sat, Nov 6, 2010 at 3:06 AM, Duboucher Thomas <thomas@duboucher.eu> wrote:
> Hi,
>
> Lua 5.2 will integrate bitlib by default to perform bitwise operations;
> we could also readily integrate it in the current version.

Sure, I'd be happy to submit a new patch that leaves the bit mangling
out if that library could be added. Can you point me at the specific
version of bitlib that Lua 5.2 will be using? The only bitlib I can
find is <http://luaforge.net/projects/bitlib>, which as a comment that
it's being deprecated in favor of bitop.

Thanks,
 - Evan

Re: [PATCH] PCI device enumeration for lua

[Duboucher Thomas]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Le 06/11/2010 21:12, Evan Broder a écrit :
> Sure, I'd be happy to submit a new patch that leaves the bit mangling
> out if that library could be added. Can you point me at the specific
> version of bitlib that Lua 5.2 will be using? The only bitlib I can
> find is <http://luaforge.net/projects/bitlib>, which as a comment that
> it's being deprecated in favor of bitop.
> 
> Thanks,
>  - Evan
> 

Hmm, I was a bit outdated. So you either have the choice of using bitop
if you prefer to keep Lua 5.1 (http://bitop.luajit.org/), or you can use
Lua 5.2 (http://www.lua.org/work/doc/manual.html#pdf-bit32).

- --
Thomas.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (MingW32)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAkzVx9MACgkQBV7eXqefhqisTgCfeOW+1ggr0qolww+ySHvz6IQL
ctwAn04pnTjUYamtHt8DnBunaBSyPeia
=TZoU
-----END PGP SIGNATURE-----

Re: [PATCH] PCI device enumeration for lua

[Evan Broder]

[-- Attachment #1: Type: text/plain, Size: 867 bytes --]

On Sat, Nov 6, 2010 at 2:25 PM, Duboucher Thomas <thomas@duboucher.eu> wrote:
> Hmm, I was a bit outdated. So you either have the choice of using bitop
> if you prefer to keep Lua 5.1 (http://bitop.luajit.org/), or you can use
> Lua 5.2 (http://www.lua.org/work/doc/manual.html#pdf-bit32).

Ok. It seems like a generally bad idea to switch to Lua 5.2 before
it's finalized, so I've attached grub_lua_include_bitop.diff, which
adds the bitop library. I had to make one modification to the library
itself to use GRUB's versions of the stdint types. I also had to make
a small modification to the Lua configuration so bitop could detect
what numeric type we're using.

With that in place, my enum_pci function can leave the parsing of the
various numeric values to Lua code, rather than doing it in C, so I've
updated grub_lua_enum_pci.diff to do that.

Thanks,
 - Evan

[-- Attachment #2: grub_lua_include_bitop.diff --]
[-- Type: application/octet-stream, Size: 6649 bytes --]

=== modified file 'Makefile.core.def'
--- Makefile.core.def	2010-09-24 08:54:25 +0000
+++ Makefile.core.def	2010-11-07 03:51:47 +0000
@@ -26,6 +26,7 @@
   common = contrib/lua/linit.c;
   common = contrib/lua/ltablib.c;
   common = contrib/lua/lstrlib.c;
+  common = contrib/lua/bit.c;
   common = contrib/lua/grub_main.c;
   common = contrib/lua/grub_lib.c;
   cflags = -Wno-error;

=== added file 'bit.c'
--- bit.c	1970-01-01 00:00:00 +0000
+++ bit.c	2010-11-07 04:21:37 +0000
@@ -0,0 +1,169 @@
+/*
+** Lua BitOp -- a bit operations library for Lua 5.1.
+** http://bitop.luajit.org/
+**
+** Copyright (C) 2008-2009 Mike Pall. All rights reserved.
+**
+** Permission is hereby granted, free of charge, to any person obtaining
+** a copy of this software and associated documentation files (the
+** "Software"), to deal in the Software without restriction, including
+** without limitation the rights to use, copy, modify, merge, publish,
+** distribute, sublicense, and/or sell copies of the Software, and to
+** permit persons to whom the Software is furnished to do so, subject to
+** the following conditions:
+**
+** The above copyright notice and this permission notice shall be
+** included in all copies or substantial portions of the Software.
+**
+** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+** MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+** CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+** TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+** SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**
+** [ MIT license: http://www.opensource.org/licenses/mit-license.php ]
+*/
+
+#define LUA_BITOP_VERSION	"1.0.1"
+
+#define LUA_LIB
+#include "lua.h"
+#include "lauxlib.h"
+
+typedef grub_int32_t SBits;
+typedef grub_uint32_t UBits;
+
+typedef union {
+  lua_Number n;
+#ifdef LUA_NUMBER_DOUBLE
+  grub_uint64_t b;
+#else
+  UBits b;
+#endif
+} BitNum;
+
+/* Convert argument to bit type. */
+static UBits barg(lua_State *L, int idx)
+{
+  BitNum bn;
+  UBits b;
+  bn.n = lua_tonumber(L, idx);
+#if defined(LUA_NUMBER_DOUBLE)
+  bn.n += 6755399441055744.0;  /* 2^52+2^51 */
+#ifdef SWAPPED_DOUBLE
+  b = (UBits)(bn.b >> 32);
+#else
+  b = (UBits)bn.b;
+#endif
+#elif defined(LUA_NUMBER_INT) || defined(LUA_NUMBER_LONG) || \
+      defined(LUA_NUMBER_LONGLONG) || defined(LUA_NUMBER_LONG_LONG) || \
+      defined(LUA_NUMBER_LLONG)
+  if (sizeof(UBits) == sizeof(lua_Number))
+    b = bn.b;
+  else
+    b = (UBits)(SBits)bn.n;
+#elif defined(LUA_NUMBER_FLOAT)
+#error "A 'float' lua_Number type is incompatible with this library"
+#else
+#error "Unknown number type, check LUA_NUMBER_* in luaconf.h"
+#endif
+  if (b == 0 && !lua_isnumber(L, idx))
+    luaL_typerror(L, idx, "number");
+  return b;
+}
+
+/* Return bit type. */
+#define BRET(b)  lua_pushnumber(L, (lua_Number)(SBits)(b)); return 1;
+
+static int bit_tobit(lua_State *L) { BRET(barg(L, 1)) }
+static int bit_bnot(lua_State *L) { BRET(~barg(L, 1)) }
+
+#define BIT_OP(func, opr) \
+  static int func(lua_State *L) { int i; UBits b = barg(L, 1); \
+    for (i = lua_gettop(L); i > 1; i--) b opr barg(L, i); BRET(b) }
+BIT_OP(bit_band, &=)
+BIT_OP(bit_bor, |=)
+BIT_OP(bit_bxor, ^=)
+
+#define bshl(b, n)  (b << n)
+#define bshr(b, n)  (b >> n)
+#define bsar(b, n)  ((SBits)b >> n)
+#define brol(b, n)  ((b << n) | (b >> (32-n)))
+#define bror(b, n)  ((b << (32-n)) | (b >> n))
+#define BIT_SH(func, fn) \
+  static int func(lua_State *L) { \
+    UBits b = barg(L, 1); UBits n = barg(L, 2) & 31; BRET(fn(b, n)) }
+BIT_SH(bit_lshift, bshl)
+BIT_SH(bit_rshift, bshr)
+BIT_SH(bit_arshift, bsar)
+BIT_SH(bit_rol, brol)
+BIT_SH(bit_ror, bror)
+
+static int bit_bswap(lua_State *L)
+{
+  UBits b = barg(L, 1);
+  b = (b >> 24) | ((b >> 8) & 0xff00) | ((b & 0xff00) << 8) | (b << 24);
+  BRET(b)
+}
+
+static int bit_tohex(lua_State *L)
+{
+  UBits b = barg(L, 1);
+  SBits n = lua_isnone(L, 2) ? 8 : (SBits)barg(L, 2);
+  const char *hexdigits = "0123456789abcdef";
+  char buf[8];
+  int i;
+  if (n < 0) { n = -n; hexdigits = "0123456789ABCDEF"; }
+  if (n > 8) n = 8;
+  for (i = (int)n; --i >= 0; ) { buf[i] = hexdigits[b & 15]; b >>= 4; }
+  lua_pushlstring(L, buf, (size_t)n);
+  return 1;
+}
+
+static const struct luaL_Reg bit_funcs[] = {
+  { "tobit",	bit_tobit },
+  { "bnot",	bit_bnot },
+  { "band",	bit_band },
+  { "bor",	bit_bor },
+  { "bxor",	bit_bxor },
+  { "lshift",	bit_lshift },
+  { "rshift",	bit_rshift },
+  { "arshift",	bit_arshift },
+  { "rol",	bit_rol },
+  { "ror",	bit_ror },
+  { "bswap",	bit_bswap },
+  { "tohex",	bit_tohex },
+  { NULL, NULL }
+};
+
+/* Signed right-shifts are implementation-defined per C89/C99.
+** But the de facto standard are arithmetic right-shifts on two's
+** complement CPUs. This behaviour is required here, so test for it.
+*/
+#define BAD_SAR		(bsar(-8, 2) != (SBits)-2)
+
+LUALIB_API int luaopen_bit(lua_State *L)
+{
+  UBits b;
+  lua_pushnumber(L, (lua_Number)1437217655L);
+  b = barg(L, -1);
+  if (b != (UBits)1437217655L || BAD_SAR) {  /* Perform a simple self-test. */
+    const char *msg = "compiled with incompatible luaconf.h";
+#ifdef LUA_NUMBER_DOUBLE
+#ifdef _WIN32
+    if (b == (UBits)1610612736L)
+      msg = "use D3DCREATE_FPU_PRESERVE with DirectX";
+#endif
+    if (b == (UBits)1127743488L)
+      msg = "not compiled with SWAPPED_DOUBLE";
+#endif
+    if (BAD_SAR)
+      msg = "arithmetic right-shift broken";
+    luaL_error(L, "bit library self-test failed (%s)", msg);
+  }
+  luaL_register(L, "bit", bit_funcs);
+  return 1;
+}
+

=== modified file 'linit.c'
--- linit.c	2009-10-26 20:15:26 +0000
+++ linit.c	2010-11-07 03:52:27 +0000
@@ -23,6 +23,7 @@
   {LUA_STRLIBNAME, luaopen_string},
 //  {LUA_MATHLIBNAME, luaopen_math},
 //  {LUA_DBLIBNAME, luaopen_debug},
+  {LUA_BITLIBNAME, luaopen_bit},
   {NULL, NULL}
 };
 

=== modified file 'luaconf.h'
--- luaconf.h	2010-01-20 15:06:11 +0000
+++ luaconf.h	2010-11-07 04:34:12 +0000
@@ -520,6 +520,7 @@
 #define LUAI_UACNUMBER	double
 #else
 
+#define LUA_NUMBER_INT
 #define LUA_NUMBER	int
 #define LUAI_UACNUMBER	int
 

=== modified file 'lualib.h'
--- lualib.h	2009-10-26 20:15:26 +0000
+++ lualib.h	2010-11-07 03:52:11 +0000
@@ -39,6 +39,9 @@
 #define LUA_LOADLIBNAME	"package"
 LUALIB_API int (luaopen_package) (lua_State *L);
 
+#define LUA_BITLIBNAME "bit"
+LUALIB_API int (luaopen_bit) (lua_State *L);
+
 
 /* open all previous libraries */
 LUALIB_API void (luaL_openlibs) (lua_State *L);


[-- Attachment #3: grub_lua_enum_pci.diff --]
[-- Type: application/octet-stream, Size: 1943 bytes --]

=== modified file 'grub_lib.c'
--- grub_lib.c	2010-09-21 18:00:15 +0000
+++ grub_lib.c	2010-11-07 03:54:26 +0000
@@ -27,6 +27,7 @@
 #include <grub/normal.h>
 #include <grub/file.h>
 #include <grub/device.h>
+#include <grub/pci.h>
 
 /* Updates the globals grub_errno and grub_msg, leaving their values on the 
    top of the stack, and clears grub_errno. When grub_errno is zero, grub_msg
@@ -251,6 +252,47 @@
 }
 
 static int
+grub_lua_enum_pci (lua_State *state)
+{
+  auto int NESTED_FUNC_ATTR enum_pci (grub_pci_device_t dev, grub_pci_id_t pciid);
+  int NESTED_FUNC_ATTR enum_pci (grub_pci_device_t dev, grub_pci_id_t pciid)
+  {
+    int result;
+    grub_pci_address_t addr;
+    grub_pci_id_t sub_pciid;
+    grub_uint32_t class;
+
+    lua_pushvalue (state, 1);
+    lua_pushinteger (state, grub_pci_get_bus (dev));
+    lua_pushinteger (state, grub_pci_get_device (dev));
+    lua_pushinteger (state, grub_pci_get_function (dev));
+
+    /* PCI ID */
+    lua_pushinteger (state, pciid);
+
+    /* Subsystem PCI ID */
+    addr = grub_pci_make_address (dev, GRUB_PCI_REG_SUBVENDOR);
+    sub_pciid = grub_pci_read (addr);
+    lua_pushinteger (state, sub_pciid);
+
+    /* Class code */
+    addr = grub_pci_make_address (dev, GRUB_PCI_REG_CLASS);
+    class = grub_pci_read (addr);
+    lua_pushinteger (state, class);
+
+    lua_call (state, 6, 1);
+    result = lua_tointeger (state, -1);
+    lua_pop (state, 1);
+
+    return result;
+  }
+
+  luaL_checktype (state, 1, LUA_TFUNCTION);
+  grub_pci_iterate (enum_pci);
+  return push_result (state);
+}
+
+static int
 grub_lua_file_open (lua_State *state)
 {
   grub_file_t file;
@@ -446,6 +488,7 @@
     {"setenv", grub_lua_setenv},
     {"enum_device", grub_lua_enum_device},
     {"enum_file", grub_lua_enum_file},
+    {"enum_pci", grub_lua_enum_pci},
     {"file_open", grub_lua_file_open},
     {"file_close", grub_lua_file_close},
     {"file_seek", grub_lua_file_seek},