linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Add iSCSI IBFT Support (v0.3)
@ 2007-11-26 22:56 Konrad Rzeszutek
  2007-11-26 23:53 ` Randy Dunlap
                   ` (2 more replies)
  0 siblings, 3 replies; 19+ messages in thread
From: Konrad Rzeszutek @ 2007-11-26 22:56 UTC (permalink / raw)
  To: linux-kernel
  Cc: pjones, konradr, konradr, greg, randy.dunlap, hpa, lenb,
	mike.anderson, dwm


This patch adds /sysfs/firmware/ibft/[chosen|aliases|ethernet@0,X|target@0,X]
directories along with text properties which export the the iSCSI Boot
Firmware Table (iBFT) structure. The layout of the directories mirrors
how PowerPC OpenBoot exports this data.

What is iSCSI Boot Firmware Table? It is a mechanism for the iSCSI
tools to extract from the machine NICs the iSCSI connection information
so that they can automagically mount the iSCSI share/target. Currently
the iSCSI information is hard-coded in th initrd.

For full details of the IBFT structure please take a look at:
ftp://ftp.software.ibm.com/systems/support/system_x_pdf/ibm_iscsi_boot_firmware_table_v1.02.pdf


Signed-off-by: Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
Signed-off-by: Peter Jones <pjones@redhat.com>

diff --git a/arch/x86/kernel/setup_32.c b/arch/x86/kernel/setup_32.c
index e1e18c3..e3ed866 100644
--- a/arch/x86/kernel/setup_32.c
+++ b/arch/x86/kernel/setup_32.c
@@ -39,6 +39,7 @@ #include <linux/module.h>
 #include <linux/efi.h>
 #include <linux/init.h>
 #include <linux/edd.h>
+#include <linux/iscsi_ibft.h>
 #include <linux/nodemask.h>
 #include <linux/kexec.h>
 #include <linux/crash_dump.h>
@@ -148,6 +149,23 @@ static inline void copy_edd(void)
 }
 #endif
 
+#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
+void *ibft_phys;
+#if defined(CONFIG_ISCSI_IBFT_MODULE)
+EXPORT_SYMBOL(ibft_phys);
+#endif
+static void __init reserve_ibft_region(void)
+{
+	unsigned int ibft_len;
+	ibft_len = find_ibft();
+	if (ibft_len)
+		reserve_bootmem((unsigned int)ibft_phys, PAGE_ALIGN(ibft_len));
+}
+
+#else
+static void __init reserve_ibft_region(void) { };
+#endif
+
 int __initdata user_defined_memmap = 0;
 
 /*
@@ -496,6 +514,7 @@ #ifdef CONFIG_BLK_DEV_INITRD
 	}
 #endif
 	reserve_crashkernel();
+	reserve_ibft_region();
 }
 
 /*
diff --git a/arch/x86/kernel/setup_64.c b/arch/x86/kernel/setup_64.c
index 30d94d1..ba6fd21 100644
--- a/arch/x86/kernel/setup_64.c
+++ b/arch/x86/kernel/setup_64.c
@@ -33,6 +33,7 @@ #include <linux/pci.h>
 #include <linux/acpi.h>
 #include <linux/kallsyms.h>
 #include <linux/edd.h>
+#include <linux/iscsi_ibft.h>
 #include <linux/mmzone.h>
 #include <linux/kexec.h>
 #include <linux/cpufreq.h>
@@ -198,6 +199,23 @@ static inline void copy_edd(void)
 }
 #endif
 
+#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
+void *ibft_phys;
+#if defined(CONFIG_ISCSI_IBFT_MODULE)
+EXPORT_SYMBOL(ibft_phys);
+#endif
+static void __init reserve_ibft_region(void)
+{
+	unsigned int ibft_len;
+	ibft_len = find_ibft();
+	if (ibft_len)
+		reserve_bootmem_generic(ibft_phys, PAGE_ALIGN(ibft_len));
+}
+
+#else
+static void __init reserve_ibft_region(void) { };
+#endif
+
 #ifdef CONFIG_KEXEC
 static void __init reserve_crashkernel(void)
 {
@@ -403,6 +421,7 @@ #ifdef CONFIG_BLK_DEV_INITRD
 	}
 #endif
 	reserve_crashkernel();
+	reserve_ibft_region();
 	paging_init();
 
 #ifdef CONFIG_PCI
diff --git a/drivers/firmware/Kconfig b/drivers/firmware/Kconfig
index 05f02a3..b132f37 100644
--- a/drivers/firmware/Kconfig
+++ b/drivers/firmware/Kconfig
@@ -93,4 +93,13 @@ config DMIID
 	  information from userspace through /sys/class/dmi/id/ or if you want
 	  DMI-based module auto-loading.
 
+config ISCSI_IBFT
+	tristate "iSCSI Boot Firmware Table Attributes"
+	default	n
+	help
+	  This option enables support for detection of an iSCSI
+	  Boot Firmware Table (iBFT).  If you wish to detect iSCSI boot
+	  parameters dynamically during system boot, say Y.
+	  Otherwise, say N.
+
 endmenu
diff --git a/drivers/firmware/Makefile b/drivers/firmware/Makefile
index 8d4ebc8..5b6638e 100644
--- a/drivers/firmware/Makefile
+++ b/drivers/firmware/Makefile
@@ -8,3 +8,5 @@ obj-$(CONFIG_EFI_PCDP)		+= pcdp.o
 obj-$(CONFIG_DELL_RBU)          += dell_rbu.o
 obj-$(CONFIG_DCDBAS)		+= dcdbas.o
 obj-$(CONFIG_DMIID)		+= dmi-id.o
+obj-$(CONFIG_ISCSI_IBFT)	+= iscsi_ibft.o
+
diff --git a/drivers/firmware/iscsi_ibft.c b/drivers/firmware/iscsi_ibft.c
new file mode 100644
index 0000000..7e4e117
--- /dev/null
+++ b/drivers/firmware/iscsi_ibft.c
@@ -0,0 +1,612 @@
+/*
+ *  Copyright 2007 Red Hat, Inc.
+ *  by Peter Jones <pjones@redhat.com>
+ *  Copyright 2007 IBM, Inc.
+ *  by Konrad Rzeszutek <konradr@us.ibm.com>
+ *
+ * This code exposes the the iSCSI Boot Format Table to userland via sysfs.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License v2.0 as published by
+ * the Free Software Foundation
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <linux/module.h>
+#include <linux/string.h>
+#include <linux/types.h>
+#include <linux/init.h>
+#include <linux/stat.h>
+#include <linux/err.h>
+#include <linux/ctype.h>
+#include <linux/slab.h>
+#include <linux/limits.h>
+#include <linux/device.h>
+#include <linux/pci.h>
+#include <linux/blkdev.h>
+
+#include <linux/iscsi_ibft.h>
+
+#define IBFT_ISCSI_VERSION  "0.3"
+#define IBFT_ISCSI_DATE	 "2007-Nov-21"
+
+MODULE_AUTHOR("Peter Jones <pjones@redhat.com> and \
+Konrad Rzeszutek <konradr@us.ibm.com>");
+MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
+MODULE_LICENSE("GPL");
+MODULE_VERSION(IBFT_ISCSI_VERSION);
+
+static LIST_HEAD(ibft_attr_list);
+static LIST_HEAD(ibft_kobject_list);
+static LIST_HEAD(ibft_data_list);
+
+static const char nulls[16];
+static struct ibft_table_header *ibft_device;
+
+/*
+ * Helper functions to parse data properly.
+ */
+static ssize_t sprintf_ipaddr(char *buf, const char *name, u8 *ip)
+{
+	if (ip[0] == 0 && ip[1] == 0 && ip[2] == 0 && ip[3] == 0 &&
+	    ip[4] == 0 && ip[5] == 0 && ip[6] == 0 && ip[7] == 0 &&
+	    ip[8] == 0 && ip[9] == 0 && ip[10] == 0xff && ip[11] == 0xff) {
+		/*
+		 * IPV4
+		 */
+		return sprintf(buf, "%s=%d.%d.%d.%d,", name, ip[12],
+			ip[13], ip[14], ip[15]);
+	} else {
+		return 0;
+	}
+}
+
+static ssize_t sprintf_string(char *str, const char *name, int len, char *buf)
+{
+	return sprintf(str, "%s=%.*s,", name, len, buf);
+}
+
+/*
+ * Helper function to verify the IBFT header.
+ */
+static int ibft_verify_hdr(struct ibft_hdr *hdr, int id, int length)
+{
+#define IBFT_VERIFY_HDR_FIELD(hdr2, val, name) \
+	if (hdr2->val != val) { \
+		printk(KERN_INFO  \
+			"error, in IBFT structure (%s) expected %d but" \
+			" found %d\n", \
+			name, val, hdr2->val); \
+		return -ENODEV; \
+	}
+	IBFT_VERIFY_HDR_FIELD(hdr, id, "ID");
+	IBFT_VERIFY_HDR_FIELD(hdr, length, "Length");
+#undef IBFT_VERIFY_HDR_FIELD
+	return 0;
+}
+
+static void ibft_release(struct kobject *kobj)
+{
+	struct ibft_kobject *ibft =
+		container_of(kobj, struct ibft_kobject, kobj);
+	kfree(ibft);
+}
+
+/*
+ *  Routines for reading of the iBFT data in a human readable fashion.
+ */
+ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
+				 struct ibft_attribute *attr,
+				 char *buf)
+{
+	struct ibft_initiator *initiator = attr->initiator;
+	void *ibft_loc = entry->data->hdr;
+	char *str = buf;
+
+	if (!initiator)
+		return 0;
+
+	str += sprintf_ipaddr(str, "isns", initiator->isns_server);
+	str += sprintf_ipaddr(str, "slp", initiator->slp_server);
+	str += sprintf_ipaddr(str, "primary_radius_server",
+		initiator->pri_radius_server);
+	str += sprintf_ipaddr(str, "secondary_radius_server",
+		initiator->sec_radius_server);
+	str += sprintf_string(str, "itname", initiator->initiator_name_len,
+		(char *)ibft_loc + initiator->initiator_name_off);
+	str--;
+
+	return str-buf;
+}
+
+ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
+			   struct ibft_attribute *attr,
+			   char *buf)
+{
+	struct ibft_nic *nic = attr->nic;
+	void *ibft_loc = entry->data->hdr;
+	char *str = buf;
+
+	if (!nic)
+		return 0;
+	/*
+	 * Assume dhcp if any non-zero portions of its address are set.
+	 */
+	if (memcmp(nic->dhcp, nulls, sizeof(nic->dhcp))) {
+		str += sprintf_ipaddr(str, "dhcp", nic->dhcp);
+	} else {
+		str += sprintf_ipaddr(str, "ciaddr", nic->ip_addr);
+		str += sprintf_ipaddr(str, "giaddr", nic->gateway);
+		str += sprintf_ipaddr(str, "dnsaddr1", nic->primary_dns);
+		str += sprintf_ipaddr(str, "dnsaddr2", nic->secondary_dns);
+	}
+	if (nic->hostname_len)
+		str += sprintf_string(str, "hostname", nic->hostname_len,
+				(char *)ibft_loc + nic->hostname_off);
+	/* Cut off the comma. */
+	str--;
+
+	return str-buf;
+}
+
+ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
+			      struct ibft_attribute *attr,
+			      char *buf)
+{
+	struct ibft_tgt *tgt = attr->tgt;
+	void *ibft_loc = entry->data->hdr;
+	char *str = buf;
+	int i;
+
+	if (!tgt)
+		return 0;
+
+	str += sprintf_ipaddr(str, "siaddr", tgt->ip_addr);
+	str += sprintf(str, "iport=%d,", tgt->port);
+	str += sprintf(str, "ilun=");
+	for (i = 0; i < 8; i++)
+		str += sprintf(str, "%x", (u8)tgt->lun[i]);
+	str += sprintf(str, ",");
+
+	if (tgt->tgt_name_len)
+		str += sprintf_string(str, "iname", tgt->tgt_name_len,
+		(void *)ibft_loc + tgt->tgt_name_off);
+
+	if (tgt->chap_name_len)
+		str += sprintf_string(str, "chapid", tgt->chap_name_len,
+			(char *)ibft_loc + tgt->chap_name_off);
+	if (tgt->chap_secret_len)
+		str += sprintf_string(str, "chappw", tgt->chap_secret_len,
+			(char *)ibft_loc + tgt->chap_secret_off);
+	if (tgt->rev_chap_name_len)
+		str += sprintf_string(str, "ichapid", tgt->rev_chap_name_len,
+			(char *)ibft_loc + tgt->rev_chap_name_off);
+	if (tgt->rev_chap_secret_len)
+		str += sprintf_string(str, "ichappw", tgt->rev_chap_secret_len,
+			(char *)ibft_loc + tgt->rev_chap_secret_off);
+
+	/* Cut off the comma. */
+	str--;
+
+	return str-buf;
+}
+
+ssize_t ibft_attr_show_disk(struct ibft_kobject *dev,
+			    struct ibft_attribute *ibft_attr,
+			    char *buf)
+{
+	char *str = buf;
+
+	str += sprintf(str, "//ethernet@0,%d:iscsi,", dev->data->index);
+	str += ibft_attr_show_initiator(dev, ibft_attr, str);
+	str += sprintf(str, ",");
+	str += ibft_attr_show_target(dev, ibft_attr, str);
+	str += sprintf(str, ",");
+	str += ibft_attr_show_nic(dev, ibft_attr, str);
+
+	return str-buf;
+}
+
+ssize_t ibft_attr_show_mac(struct ibft_kobject *entry,
+			   struct ibft_attribute *attr,
+			   char *buf)
+{
+	struct ibft_nic *nic = attr->nic;
+	int len = 6;
+
+	if (!nic)
+		return 0;
+
+	memcpy(buf, attr->nic->mac, len);
+
+	return len;
+}
+
+/*
+ * The main routine which allows the user to read the IBFT data.
+ */
+static ssize_t ibft_show_attribute(struct kobject *kobj,
+				   struct attribute *attr,
+				   char *buf)
+{
+	struct ibft_kobject *dev =
+		container_of(kobj, struct ibft_kobject, kobj);
+	struct ibft_attribute *ibft_attr =
+		container_of(attr, struct ibft_attribute, attr);
+	ssize_t ret = -EIO;
+	char *str = buf;
+
+	if (!capable(CAP_SYS_ADMIN))
+		return -EACCES;
+
+	if (ibft_attr->show)
+		ret = ibft_attr->show(dev, ibft_attr, str);
+
+	return ret;
+}
+
+static struct sysfs_ops ibft_attr_ops = {
+	.show = ibft_show_attribute,
+};
+
+static struct kobj_type ktype_ibft = {
+	.release = ibft_release,
+	.sysfs_ops = &ibft_attr_ops,
+};
+
+static decl_subsys(ibft, &ktype_ibft, NULL);
+
+
+static int ibft_alloc_device(void *idev)
+{
+	int len;
+	struct ibft_table_header *hdr;
+
+	if (!idev)
+		return -ENOENT;
+
+	hdr = (struct ibft_table_header *)phys_to_virt(
+			(unsigned long)ibft_phys);
+
+	len = hdr->length;
+
+	ibft_device = kzalloc(len, GFP_KERNEL);
+
+	if (!ibft_device)
+		return -ENOMEM;
+
+	memcpy(ibft_device, hdr, len);
+
+	return 0;
+}
+
+static void ibft_free_device(struct ibft_table_header *hdr)
+{
+	kfree(hdr);
+};
+
+
+/*
+ * Helper function for ibft_scan_device.
+ */
+static int ibft_populate_data(struct ibft_table_header *header,
+			      struct ibft_hdr *hdr,
+			      struct ibft_initiator *initiator,
+			      struct list_head *list)
+{
+	struct ibft_data *i, *n, *data = NULL;
+	int rc = 0;
+
+	/* Based on the header index value find the data tuple,
+	if possibly. */
+	list_for_each_entry_safe(i, n, list, node) {
+		if (hdr->index == i->index) {
+			data = i;
+			break;
+		}
+	}
+	if (!data) {
+		data = kzalloc(sizeof(*data), GFP_KERNEL);
+		if (!data)
+			return -ENOMEM;
+		/* There is only _one_ initiator. We make every 'data'
+		   struct carry it for convience. */
+		data->initiator = initiator;
+		data->hdr = header;
+		data->index = hdr->index;
+		list_add_tail(&data->node, list);
+	}
+
+	switch (hdr->id) {
+	case id_nic:
+		data->nic = (struct ibft_nic *)hdr;
+		rc = ibft_verify_hdr(hdr, id_nic, sizeof(*data->nic));
+		break;
+	case id_target:
+		data->tgt = (struct ibft_tgt *)hdr;
+		rc = ibft_verify_hdr(hdr, id_target, sizeof(*data->tgt));
+		break;
+	default:
+		/* Extension field which we don't support. Ignore it */
+		break;
+	}
+	return rc;
+};
+
+/*
+ * Scan the IBFT table structure for the NIC and Target fields. When
+ * found add them on the passed in list.
+ */
+static int ibft_scan_device(struct ibft_table_header *header,
+			    struct list_head *list)
+{
+	struct ibft_control *control = NULL;
+	struct ibft_initiator *initiator = NULL;
+	void *ptr, *end;
+	int rc = 0;
+	u16 offset;
+
+	control = (void *)header + sizeof(*header);
+	initiator = (void *)header + control->initiator_off;
+
+	end = (void *)control + control->hdr.length;
+
+	/* We can have multiple NICs and multiple targets. The index in
+	   their header defines their 1-to-1 correlation.
+	*/
+	for (ptr = &control->nic0_off; ptr <= end; ptr += sizeof(u16)) {
+		offset = *(u16 *)ptr;
+		if (offset) {
+			rc = ibft_populate_data(header,
+					(void *)header + offset,
+					initiator, list);
+			if (rc)
+				return rc;
+		}
+	}
+	return rc;
+};
+
+static void ibft_free_data(struct list_head *list)
+{
+	struct ibft_data *data = NULL, *n;
+
+	list_for_each_entry_safe(data, n, list, node) {
+		list_del(&data->node);
+		kfree(data);
+	}
+	list_del_init(list);
+};
+
+/*
+ * Helper function for ibft_register_kobjects.
+ */
+static int ibft_create_kobject(struct ibft_data *data,
+			       u8 type, const char *name,
+			       struct list_head *list)
+{
+	struct ibft_kobject *obj = NULL;
+	int rc = 0;
+
+	obj = kzalloc(sizeof(*obj), GFP_KERNEL);
+	if (!obj)
+		return -ENOMEM;
+
+	snprintf(obj->name, IBFT_ISCSI_KOBJECT_MAX_LEN, name, data->index);
+
+	obj->data = data;
+	obj->type = type;
+
+	kobject_set_name(&obj->kobj, obj->name);
+	kobj_set_kset_s(obj, ibft_subsys);
+
+	rc = kobject_register(&obj->kobj);
+	if (rc)
+		return rc;
+
+	list_add_tail(&obj->node, list);
+	return rc;
+}
+
+static int ibft_register_kobjects(struct list_head *data_list,
+				  struct list_head *kobj_list)
+{
+	struct ibft_data *data = NULL, *n = NULL;
+	int rc = 0;
+
+	list_for_each_entry_safe(data, n, data_list, node) {
+		if (data->tgt)
+			rc |= ibft_create_kobject(data, kobject_type_target,
+				IBFT_ISCSI_KOBJECT_TARGET_NAME, kobj_list);
+		if (data->nic)
+			rc |= ibft_create_kobject(data, kobject_type_ethernet,
+				IBFT_ISCSI_KOBJECT_ETHERNET_NAME, kobj_list);
+		if (data->nic && (data->nic->hdr.flags &
+			ISCSI_IBFT_INIT_FLAG_FW_SEL_BOOT)) {
+			rc |= ibft_create_kobject(data, kobject_type_chosen,
+				IBFT_ISCSI_KOBJECT_CHOSEN_NAME, kobj_list);
+			rc |= ibft_create_kobject(data, kobject_type_aliases,
+				IBFT_ISCSI_KOBJECT_ALIASES_NAME, kobj_list);
+		}
+		if (rc) break;
+	}
+	return rc;
+};
+
+static void ibft_unregister_kobjects(struct list_head *list)
+{
+	struct ibft_kobject *data = NULL, *n;
+	list_for_each_entry_safe(data, n, list, node) {
+		list_del(&data->node);
+		kobject_unregister(&data->kobj);
+	};
+	list_del_init(list);
+};
+
+static int ibft_create_attribute(struct ibft_kobject *kobj_data,
+				 const char *name,
+				 ssize_t (*show) (struct  ibft_kobject *entry,
+						  struct ibft_attribute *attr,
+						  char *buf),
+				 struct list_head *list)
+{
+	struct ibft_attribute *attr = NULL;
+
+	attr = kzalloc(sizeof(*attr), GFP_KERNEL);
+	if (!attr)
+		return -ENOMEM;
+
+	snprintf(attr->name, IBFT_ISCSI_ATTR_MAX_LEN, name,
+		kobj_data->data->index);
+
+	attr->attr.name = attr->name;
+	attr->attr.mode = S_IRUSR;
+	attr->attr.owner = THIS_MODULE;
+
+	attr->nic = kobj_data->data->nic;
+	attr->tgt = kobj_data->data->tgt;
+	attr->initiator = kobj_data->data->initiator;
+
+	attr->show = show;
+	attr->kobj = &kobj_data->kobj;
+
+	list_add_tail(&attr->node, list);
+	return 0;
+}
+/*
+ *  Register the attributes for all of the kobjects.
+ */
+static int ibft_register_attributes(struct list_head *kobject_list,
+				    struct list_head *attr_list)
+{
+	int rc = 0;
+	struct ibft_kobject *data = NULL;
+	struct ibft_attribute *attr = NULL, *m;
+
+	list_for_each_entry(data, kobject_list, node) {
+		switch (data->type) {
+		case kobject_type_chosen:
+			rc = ibft_create_attribute(data,
+				IBFT_ISCSI_ATTR_BOOTPATH_NAME,
+				ibft_attr_show_disk, attr_list);
+			break;
+		case kobject_type_ethernet:
+			rc |= ibft_create_attribute(data,
+					IBFT_ISCSI_ATTR_LOCAL_MAC_ADDRESS_NAME,
+					ibft_attr_show_mac, attr_list);
+			rc |= ibft_create_attribute(data,
+					IBFT_ISCSI_ATTR_PROPERTY_NAME,
+					ibft_attr_show_nic, attr_list);
+			break;
+		case kobject_type_target:
+			rc |= ibft_create_attribute(data,
+					IBFT_ISCSI_ATTR_PROPERTY_NAME,
+					ibft_attr_show_target, attr_list);
+			break;
+		case kobject_type_aliases:
+			rc |= ibft_create_attribute(data,
+					IBFT_ISCSI_ATTR_DISK_NAME,
+					ibft_attr_show_disk, attr_list);
+			break;
+		default:
+			break;
+		}
+		if (rc)
+			break;
+	}
+	list_for_each_entry_safe(attr, m, attr_list, node) {
+		rc = sysfs_create_file(attr->kobj, &attr->attr);
+		if (rc) {
+			list_del(&attr->node);
+			kfree(attr);
+			break;
+		}
+	}
+	return rc;
+};
+
+static void ibft_unregister_attributes(struct list_head *list)
+{
+	struct ibft_attribute *attr = NULL, *m;
+
+	list_for_each_entry_safe(attr, m, list, node) {
+		sysfs_remove_file(attr->kobj, &attr->attr);
+		list_del(&attr->node);
+		kfree(attr);
+	}
+	list_del_init(list);
+};
+
+
+/*
+ * ibft_init() - creates sysfs tree entries for iBFT data.
+ */
+static int __init ibft_init(void)
+{
+	int rc = 0;
+
+	if (!ibft_phys)
+		find_ibft();
+
+	rc = firmware_register(&ibft_subsys);
+	if (rc)
+		return rc;
+
+	if (ibft_phys) {
+		printk(KERN_INFO "iBFT detected at 0x%lx.\n",
+		       (unsigned long)ibft_phys);
+
+		rc = ibft_alloc_device(ibft_phys);
+		if (rc)
+			goto out_firmware_unregister;
+
+		/* Scan the IBFT for data. */
+		rc = ibft_scan_device(ibft_device, &ibft_data_list);
+		if (rc)
+			goto out_free;
+
+		/* Register the kobjects based on the ibft_data_list */
+		rc = ibft_register_kobjects(&ibft_data_list,
+				&ibft_kobject_list);
+		if (rc)
+			goto out_free;
+
+		/* Register the attributes */
+		rc = ibft_register_attributes(&ibft_kobject_list,
+				&ibft_attr_list);
+		if (rc)
+			goto out_free;
+	} else
+		printk(KERN_INFO "No iBFT detected.\n");
+
+	if (!rc)
+		return rc;
+
+out_free:
+	ibft_unregister_attributes(&ibft_attr_list);
+	ibft_unregister_kobjects(&ibft_kobject_list);
+	ibft_free_data(&ibft_data_list);
+	ibft_free_device(ibft_device);
+	ibft_device = NULL;
+out_firmware_unregister:
+	firmware_unregister(&ibft_subsys);
+	return rc;
+}
+
+static void __exit ibft_exit(void)
+{
+	ibft_unregister_attributes(&ibft_attr_list);
+	ibft_unregister_kobjects(&ibft_kobject_list);
+	ibft_free_data(&ibft_data_list);
+	ibft_free_device(ibft_device);
+	ibft_device = NULL;
+	firmware_unregister(&ibft_subsys);
+	ibft_phys = 0;
+}
+
+module_init(ibft_init);
+module_exit(ibft_exit);
diff --git a/include/linux/iscsi_ibft.h b/include/linux/iscsi_ibft.h
new file mode 100644
index 0000000..bbbb53c
--- /dev/null
+++ b/include/linux/iscsi_ibft.h
@@ -0,0 +1,198 @@
+#ifndef ISCSI_IBFT_H
+#define ISCSI_IBFT_H
+
+extern void *ibft_phys;
+
+struct ibft_table_header {
+	char signature[4];
+	u32 length;
+	u8 revision;
+	u8 checksum;
+	char oem_id[6];
+	char oem_table_id[8];
+	char reserved[24];
+} __attribute__((__packed__));
+
+#define ISCSI_IBFT_INIT_FLAG_FW_SEL_BOOT 2
+
+enum ibft_id {
+    id_reserved = 0,
+    id_control = 1,
+    id_initiator = 2,
+    id_nic = 3,
+    id_target = 4,
+    id_extensions,
+};
+struct ibft_hdr {
+	u8 id;
+	u8 version;
+	u16 length;
+	u8 index;
+	u8 flags;
+} __attribute__((__packed__));
+
+struct ibft_control {
+    struct ibft_hdr hdr;
+    u16 extensions;
+    u16 initiator_off;
+    u16 nic0_off;
+    u16 tgt0_off;
+    u16 nic1_off;
+    u16 tgt1_off;
+} __attribute__((__packed__));
+
+struct ibft_initiator {
+	struct ibft_hdr hdr;
+	char isns_server[16];
+	char slp_server[16];
+	char pri_radius_server[16];
+	char sec_radius_server[16];
+	u16 initiator_name_len;
+	u16 initiator_name_off;
+} __attribute__((__packed__));
+
+struct ibft_nic {
+	struct ibft_hdr hdr;
+	char ip_addr[16];
+	u8 subnet_mask_prefix;
+	u8 origin;
+	char gateway[16];
+	char primary_dns[16];
+	char secondary_dns[16];
+	char dhcp[16];
+	u16 vlan;
+	char mac[6];
+	u16 pci_bdf;
+	u16 hostname_len;
+	u16 hostname_off;
+} __attribute__((__packed__));
+
+struct ibft_tgt {
+	struct ibft_hdr hdr;
+	char ip_addr[16];
+	u16 port;
+	char lun[8];
+	u8 chap_type;
+	u8 nic_assoc;
+	u16 tgt_name_len;
+	u16 tgt_name_off;
+	u16 chap_name_len;
+	u16 chap_name_off;
+	u16 chap_secret_len;
+	u16 chap_secret_off;
+	u16 rev_chap_name_len;
+	u16 rev_chap_name_off;
+	u16 rev_chap_secret_len;
+	u16 rev_chap_secret_off;
+} __attribute__((__packed__));
+
+#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
+
+#define IBFT_SIGN "iBFT"
+#define IBFT_SIGN_LEN 4
+#define IBFT_START 0x80000 /* 512kB */
+#define IBFT_END 0x100000 /* 1MB */
+#define VGA_MEM 0xA0000 /* VGA buffer */
+#define VGA_SIZE 0x20000 /* 132kB */
+static ssize_t find_ibft(void)
+{
+	unsigned long pos;
+
+	for (pos = IBFT_START; pos < IBFT_END; pos += 16) {
+		void *virt;
+		/* The table can't be inside the VGA BIOS reserved space,
+		 * so skip that area */
+		if (pos == VGA_MEM)
+			pos += VGA_SIZE;
+		virt = phys_to_virt(pos);
+		if (memcmp(virt, IBFT_SIGN, IBFT_SIGN_LEN) == 0) {
+			unsigned long *addr =
+			    (unsigned long *)phys_to_virt(pos + 4);
+			unsigned int len = *addr;
+			/* if the length of the table extends past 1M,
+			 * the table cannot be valid. */
+			if (pos + len <= (IBFT_END-1)) {
+				ibft_phys = (void *)pos;
+				return len;
+			}
+		}
+	}
+	return 0;
+}
+
+/*
+ * The tuple of data containing a pointer to the appropiate
+ * (by index number) NIC and Target.
+ *
+ */
+struct ibft_data {
+	u8 index;
+	struct ibft_table_header *hdr;
+	struct ibft_initiator *initiator;
+	struct ibft_nic *nic;
+	struct ibft_tgt *tgt;
+	struct list_head node;
+};
+
+/*
+ * The various kobjects which are linked to the ibft_data.
+ * These are the following kobjects based on the data:
+ *  ethernet@0,X
+ *	+---- local-mac-address
+ *	+---- property
+ *  target@0,X
+ *	+---- property
+ *  chosen
+ *      +---- bootpath (only one)
+ *  aliases
+ *      +---- iscsi-diskX
+ *
+ */
+#define IBFT_ISCSI_KOBJECT_MAX_LEN 15
+#define IBFT_ISCSI_KOBJECT_CHOSEN_NAME "chosen"
+#define IBFT_ISCSI_KOBJECT_ETHERNET_NAME "ethernet@0,%d"
+#define IBFT_ISCSI_KOBJECT_TARGET_NAME "target@0,%d"
+#define IBFT_ISCSI_KOBJECT_ALIASES_NAME "aliases"
+
+enum ibft_kobject_type {
+	kobject_type_chosen,
+	kobject_type_ethernet,
+	kobject_type_target,
+	kobject_type_aliases
+};
+struct ibft_kobject {
+	struct ibft_data *data;
+	char name[IBFT_ISCSI_KOBJECT_MAX_LEN];
+	u8 type;
+	struct kobject kobj;
+	struct list_head node;
+};
+
+/*
+ * The text attributes, which can be:
+ *  - local-mac-address (many of them)
+ *  - property (many of them)
+ *  - bootpath (one) , iscsi-diskX (many)
+ *
+*/
+#define IBFT_ISCSI_ATTR_DISK_NAME "iscsi-disk%d"
+#define IBFT_ISCSI_ATTR_PROPERTY_NAME "property"
+#define IBFT_ISCSI_ATTR_BOOTPATH_NAME "bootpath"
+#define IBFT_ISCSI_ATTR_LOCAL_MAC_ADDRESS_NAME "local-mac-address"
+#define IBFT_ISCSI_ATTR_MAX_LEN 18
+
+struct ibft_attribute {
+	struct attribute attr;
+	ssize_t (*show) (struct  ibft_kobject *entry,
+			 struct ibft_attribute *attr, char *buf);
+	struct ibft_initiator *initiator;
+	struct ibft_nic *nic;
+	struct ibft_tgt *tgt;
+	struct kobject *kobj;
+	char name[IBFT_ISCSI_ATTR_MAX_LEN];
+	struct list_head node;
+};
+
+#endif
+
+#endif /* ISCSI_IBFT_H */

^ permalink raw reply related	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-26 22:56 [PATCH] Add iSCSI IBFT Support (v0.3) Konrad Rzeszutek
@ 2007-11-26 23:53 ` Randy Dunlap
  2007-11-27  4:23   ` Konrad Rzeszutek
  2007-11-27  3:23 ` Greg KH
  2007-11-27  3:31 ` Greg KH
  2 siblings, 1 reply; 19+ messages in thread
From: Randy Dunlap @ 2007-11-26 23:53 UTC (permalink / raw)
  To: Konrad Rzeszutek
  Cc: linux-kernel, pjones, konradr, konradr, greg, hpa, lenb,
	mike.anderson, dwm

Konrad Rzeszutek wrote:
> This patch adds /sysfs/firmware/ibft/[chosen|aliases|ethernet@0,X|target@0,X]
> directories along with text properties which export the the iSCSI Boot
> Firmware Table (iBFT) structure. The layout of the directories mirrors
> how PowerPC OpenBoot exports this data.
> 
> What is iSCSI Boot Firmware Table? It is a mechanism for the iSCSI
> tools to extract from the machine NICs the iSCSI connection information
> so that they can automagically mount the iSCSI share/target. Currently
> the iSCSI information is hard-coded in th initrd.
> 
> For full details of the IBFT structure please take a look at:
> ftp://ftp.software.ibm.com/systems/support/system_x_pdf/ibm_iscsi_boot_firmware_table_v1.02.pdf
> 
> 
> Signed-off-by: Konrad Rzeszutek <konradr@linux.vnet.ibm.com>
> Signed-off-by: Peter Jones <pjones@redhat.com>
> 
> diff --git a/arch/x86/kernel/setup_32.c b/arch/x86/kernel/setup_32.c
> index e1e18c3..e3ed866 100644
> --- a/arch/x86/kernel/setup_32.c
> +++ b/arch/x86/kernel/setup_32.c
> @@ -148,6 +149,23 @@ static inline void copy_edd(void)
>  }
>  #endif
>  
> +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> +void *ibft_phys;
> +#if defined(CONFIG_ISCSI_IBFT_MODULE)
> +EXPORT_SYMBOL(ibft_phys);
> +#endif
> +static void __init reserve_ibft_region(void)
> +{
> +	unsigned int ibft_len;
> +	ibft_len = find_ibft();
> +	if (ibft_len)
> +		reserve_bootmem((unsigned int)ibft_phys, PAGE_ALIGN(ibft_len));
> +}
> +
> +#else
> +static void __init reserve_ibft_region(void) { };

No ending ; above.

> +#endif
> +
>  int __initdata user_defined_memmap = 0;
>  
>  /*

> diff --git a/arch/x86/kernel/setup_64.c b/arch/x86/kernel/setup_64.c
> index 30d94d1..ba6fd21 100644
> --- a/arch/x86/kernel/setup_64.c
> +++ b/arch/x86/kernel/setup_64.c
> @@ -198,6 +199,23 @@ static inline void copy_edd(void)
>  }
>  #endif
>  
> +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> +void *ibft_phys;
> +#if defined(CONFIG_ISCSI_IBFT_MODULE)
> +EXPORT_SYMBOL(ibft_phys);
> +#endif
> +static void __init reserve_ibft_region(void)
> +{
> +	unsigned int ibft_len;
> +	ibft_len = find_ibft();
> +	if (ibft_len)
> +		reserve_bootmem_generic(ibft_phys, PAGE_ALIGN(ibft_len));
> +}
> +
> +#else
> +static void __init reserve_ibft_region(void) { };

Ditto.

> +#endif
> +
>  #ifdef CONFIG_KEXEC
>  static void __init reserve_crashkernel(void)
>  {

> diff --git a/drivers/firmware/iscsi_ibft.c b/drivers/firmware/iscsi_ibft.c
> new file mode 100644
> index 0000000..7e4e117
> --- /dev/null
> +++ b/drivers/firmware/iscsi_ibft.c
> @@ -0,0 +1,612 @@
> +
> +#include <linux/module.h>
> +#include <linux/string.h>
> +#include <linux/types.h>
> +#include <linux/init.h>
> +#include <linux/stat.h>
> +#include <linux/err.h>
> +#include <linux/ctype.h>
> +#include <linux/slab.h>
> +#include <linux/limits.h>
> +#include <linux/device.h>
> +#include <linux/pci.h>
> +#include <linux/blkdev.h>
> +

No blank line here, please.

> +#include <linux/iscsi_ibft.h>
> +
> +#define IBFT_ISCSI_VERSION  "0.3"
> +#define IBFT_ISCSI_DATE	 "2007-Nov-21"
> +
> +MODULE_AUTHOR("Peter Jones <pjones@redhat.com> and \
> +Konrad Rzeszutek <konradr@us.ibm.com>");
> +MODULE_DESCRIPTION("sysfs interface to BIOS iBFT information");
> +MODULE_LICENSE("GPL");
> +MODULE_VERSION(IBFT_ISCSI_VERSION);
> +
> +static LIST_HEAD(ibft_attr_list);
> +static LIST_HEAD(ibft_kobject_list);
> +static LIST_HEAD(ibft_data_list);
> +
> +static const char nulls[16];
> +static struct ibft_table_header *ibft_device;
> +

> +/*
> + * Helper function to verify the IBFT header.
> + */
> +static int ibft_verify_hdr(struct ibft_hdr *hdr, int id, int length)
> +{
> +#define IBFT_VERIFY_HDR_FIELD(hdr2, val, name) \
> +	if (hdr2->val != val) { \
> +		printk(KERN_INFO  \

Looks like this should use KERN_ERROR or KERN_WARNING?

> +			"error, in IBFT structure (%s) expected %d but" \
> +			" found %d\n", \
> +			name, val, hdr2->val); \
> +		return -ENODEV; \
> +	}
> +	IBFT_VERIFY_HDR_FIELD(hdr, id, "ID");
> +	IBFT_VERIFY_HDR_FIELD(hdr, length, "Length");
> +#undef IBFT_VERIFY_HDR_FIELD
> +	return 0;
> +}
> +
> +static void ibft_release(struct kobject *kobj)
> +{
> +	struct ibft_kobject *ibft =
> +		container_of(kobj, struct ibft_kobject, kobj);
> +	kfree(ibft);
> +}
> +
> +/*
> + *  Routines for reading of the iBFT data in a human readable fashion.
> + */
> +ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
> +				 struct ibft_attribute *attr,
> +				 char *buf)
> +{
> +	struct ibft_initiator *initiator = attr->initiator;
> +	void *ibft_loc = entry->data->hdr;
> +	char *str = buf;
> +
> +	if (!initiator)
> +		return 0;
> +
> +	str += sprintf_ipaddr(str, "isns", initiator->isns_server);
> +	str += sprintf_ipaddr(str, "slp", initiator->slp_server);
> +	str += sprintf_ipaddr(str, "primary_radius_server",
> +		initiator->pri_radius_server);
> +	str += sprintf_ipaddr(str, "secondary_radius_server",
> +		initiator->sec_radius_server);
> +	str += sprintf_string(str, "itname", initiator->initiator_name_len,
> +		(char *)ibft_loc + initiator->initiator_name_off);
> +	str--;
> +
> +	return str-buf;

	preferred form:
	return str - buf;

> +}
> +
> +ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
> +			   struct ibft_attribute *attr,
> +			   char *buf)
> +{
> +	struct ibft_nic *nic = attr->nic;
> +	void *ibft_loc = entry->data->hdr;
> +	char *str = buf;
> +
> +	if (!nic)
> +		return 0;
> +	/*
> +	 * Assume dhcp if any non-zero portions of its address are set.
> +	 */
> +	if (memcmp(nic->dhcp, nulls, sizeof(nic->dhcp))) {
> +		str += sprintf_ipaddr(str, "dhcp", nic->dhcp);
> +	} else {
> +		str += sprintf_ipaddr(str, "ciaddr", nic->ip_addr);
> +		str += sprintf_ipaddr(str, "giaddr", nic->gateway);
> +		str += sprintf_ipaddr(str, "dnsaddr1", nic->primary_dns);
> +		str += sprintf_ipaddr(str, "dnsaddr2", nic->secondary_dns);
> +	}
> +	if (nic->hostname_len)
> +		str += sprintf_string(str, "hostname", nic->hostname_len,
> +				(char *)ibft_loc + nic->hostname_off);
> +	/* Cut off the comma. */
> +	str--;
> +
> +	return str-buf;

	Ditto.

> +}
> +
> +ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
> +			      struct ibft_attribute *attr,
> +			      char *buf)
> +{
> +	struct ibft_tgt *tgt = attr->tgt;
> +	void *ibft_loc = entry->data->hdr;
> +	char *str = buf;
> +	int i;
> +
> +	if (!tgt)
> +		return 0;
> +
> +	str += sprintf_ipaddr(str, "siaddr", tgt->ip_addr);
> +	str += sprintf(str, "iport=%d,", tgt->port);
> +	str += sprintf(str, "ilun=");
> +	for (i = 0; i < 8; i++)
> +		str += sprintf(str, "%x", (u8)tgt->lun[i]);
> +	str += sprintf(str, ",");
> +
> +	if (tgt->tgt_name_len)
> +		str += sprintf_string(str, "iname", tgt->tgt_name_len,
> +		(void *)ibft_loc + tgt->tgt_name_off);
> +
> +	if (tgt->chap_name_len)
> +		str += sprintf_string(str, "chapid", tgt->chap_name_len,
> +			(char *)ibft_loc + tgt->chap_name_off);
> +	if (tgt->chap_secret_len)
> +		str += sprintf_string(str, "chappw", tgt->chap_secret_len,
> +			(char *)ibft_loc + tgt->chap_secret_off);
> +	if (tgt->rev_chap_name_len)
> +		str += sprintf_string(str, "ichapid", tgt->rev_chap_name_len,
> +			(char *)ibft_loc + tgt->rev_chap_name_off);
> +	if (tgt->rev_chap_secret_len)
> +		str += sprintf_string(str, "ichappw", tgt->rev_chap_secret_len,
> +			(char *)ibft_loc + tgt->rev_chap_secret_off);
> +
> +	/* Cut off the comma. */
> +	str--;
> +
> +	return str-buf;

	Ditto.

> +}
> +
> +ssize_t ibft_attr_show_disk(struct ibft_kobject *dev,
> +			    struct ibft_attribute *ibft_attr,
> +			    char *buf)
> +{
> +	char *str = buf;
> +
> +	str += sprintf(str, "//ethernet@0,%d:iscsi,", dev->data->index);
> +	str += ibft_attr_show_initiator(dev, ibft_attr, str);
> +	str += sprintf(str, ",");
> +	str += ibft_attr_show_target(dev, ibft_attr, str);
> +	str += sprintf(str, ",");
> +	str += ibft_attr_show_nic(dev, ibft_attr, str);
> +
> +	return str-buf;

	Ditto.

> +}
> +
> +ssize_t ibft_attr_show_mac(struct ibft_kobject *entry,
> +			   struct ibft_attribute *attr,
> +			   char *buf)
> +{
> +	struct ibft_nic *nic = attr->nic;
> +	int len = 6;

Could you just use ETH_ALEN instead of <len> and 6?
and #include <linux/if_ether.h>

Or add a define for IBFT_ALEN (of 6) and use that?

> +
> +	if (!nic)
> +		return 0;
> +
> +	memcpy(buf, attr->nic->mac, len);
> +
> +	return len;
> +}
> +
> +/*
> + * The main routine which allows the user to read the IBFT data.
> + */
> +static ssize_t ibft_show_attribute(struct kobject *kobj,
> +				   struct attribute *attr,
> +				   char *buf)
> +{
> +	struct ibft_kobject *dev =
> +		container_of(kobj, struct ibft_kobject, kobj);
> +	struct ibft_attribute *ibft_attr =
> +		container_of(attr, struct ibft_attribute, attr);
> +	ssize_t ret = -EIO;
> +	char *str = buf;
> +
> +	if (!capable(CAP_SYS_ADMIN))
> +		return -EACCES;
> +
> +	if (ibft_attr->show)
> +		ret = ibft_attr->show(dev, ibft_attr, str);
> +
> +	return ret;
> +}
> +
> +static struct sysfs_ops ibft_attr_ops = {
> +	.show = ibft_show_attribute,
> +};
> +
> +static struct kobj_type ktype_ibft = {
> +	.release = ibft_release,
> +	.sysfs_ops = &ibft_attr_ops,
> +};
> +
> +static decl_subsys(ibft, &ktype_ibft, NULL);
> +
> +
> +static int ibft_alloc_device(void *idev)
> +{
> +	int len;
> +	struct ibft_table_header *hdr;
> +
> +	if (!idev)
> +		return -ENOENT;
> +
> +	hdr = (struct ibft_table_header *)phys_to_virt(
> +			(unsigned long)ibft_phys);
> +
> +	len = hdr->length;
> +
> +	ibft_device = kzalloc(len, GFP_KERNEL);
> +
> +	if (!ibft_device)
> +		return -ENOMEM;
> +
> +	memcpy(ibft_device, hdr, len);
> +
> +	return 0;
> +}
> +
> +static void ibft_free_device(struct ibft_table_header *hdr)
> +{
> +	kfree(hdr);
> +};
> +
> +
> +/*
> + * Helper function for ibft_scan_device.
> + */
> +static int ibft_populate_data(struct ibft_table_header *header,
> +			      struct ibft_hdr *hdr,
> +			      struct ibft_initiator *initiator,
> +			      struct list_head *list)
> +{
> +	struct ibft_data *i, *n, *data = NULL;
> +	int rc = 0;
> +
> +	/* Based on the header index value find the data tuple,
> +	if possibly. */
	   if possible. */

or better:
	/*
	 * Based on the header index value, find the data tuple
	 * if possible.
	 */

> +	list_for_each_entry_safe(i, n, list, node) {
> +		if (hdr->index == i->index) {
> +			data = i;
> +			break;
> +		}
> +	}
> +	if (!data) {
> +		data = kzalloc(sizeof(*data), GFP_KERNEL);
> +		if (!data)
> +			return -ENOMEM;
> +		/* There is only _one_ initiator. We make every 'data'
> +		   struct carry it for convience. */

					convenience.

> +		data->initiator = initiator;
> +		data->hdr = header;
> +		data->index = hdr->index;
> +		list_add_tail(&data->node, list);
> +	}
> +
> +	switch (hdr->id) {
> +	case id_nic:
> +		data->nic = (struct ibft_nic *)hdr;
> +		rc = ibft_verify_hdr(hdr, id_nic, sizeof(*data->nic));
> +		break;
> +	case id_target:
> +		data->tgt = (struct ibft_tgt *)hdr;
> +		rc = ibft_verify_hdr(hdr, id_target, sizeof(*data->tgt));
> +		break;
> +	default:
> +		/* Extension field which we don't support. Ignore it */
> +		break;
> +	}
> +	return rc;
> +};
> +
> +/*
> + * Scan the IBFT table structure for the NIC and Target fields. When
> + * found add them on the passed in list.

				passed-in list.

> + */
> +static int ibft_scan_device(struct ibft_table_header *header,
> +			    struct list_head *list)
> +{
> +	struct ibft_control *control = NULL;
> +	struct ibft_initiator *initiator = NULL;
> +	void *ptr, *end;
> +	int rc = 0;
> +	u16 offset;
> +
> +	control = (void *)header + sizeof(*header);
> +	initiator = (void *)header + control->initiator_off;
> +
> +	end = (void *)control + control->hdr.length;
> +
> +	/* We can have multiple NICs and multiple targets. The index in
> +	   their header defines their 1-to-1 correlation.
> +	*/
> +	for (ptr = &control->nic0_off; ptr <= end; ptr += sizeof(u16)) {

In many searches, <end> would be the first address beyond the end of the
table, so the loop-terminating condition test would be:

					ptr < end;

It looks like that should be the case here also....


> +		offset = *(u16 *)ptr;
> +		if (offset) {
> +			rc = ibft_populate_data(header,
> +					(void *)header + offset,
> +					initiator, list);
> +			if (rc)
> +				return rc;
> +		}
> +	}
> +	return rc;
> +};
> +
> +static void ibft_free_data(struct list_head *list)
> +{
> +	struct ibft_data *data = NULL, *n;
> +
> +	list_for_each_entry_safe(data, n, list, node) {
> +		list_del(&data->node);
> +		kfree(data);
> +	}
> +	list_del_init(list);
> +};
> +
> +/*
> + * Helper function for ibft_register_kobjects.
> + */
> +static int ibft_create_kobject(struct ibft_data *data,
> +			       u8 type, const char *name,
> +			       struct list_head *list)
> +{
> +	struct ibft_kobject *obj = NULL;
> +	int rc = 0;
> +
> +	obj = kzalloc(sizeof(*obj), GFP_KERNEL);
> +	if (!obj)
> +		return -ENOMEM;
> +
> +	snprintf(obj->name, IBFT_ISCSI_KOBJECT_MAX_LEN, name, data->index);
> +
> +	obj->data = data;
> +	obj->type = type;
> +
> +	kobject_set_name(&obj->kobj, obj->name);
> +	kobj_set_kset_s(obj, ibft_subsys);
> +
> +	rc = kobject_register(&obj->kobj);
> +	if (rc)
> +		return rc;
> +
> +	list_add_tail(&obj->node, list);
> +	return rc;
> +}
> +
> +static int ibft_register_kobjects(struct list_head *data_list,
> +				  struct list_head *kobj_list)
> +{
> +	struct ibft_data *data = NULL, *n = NULL;
> +	int rc = 0;
> +
> +	list_for_each_entry_safe(data, n, data_list, node) {
> +		if (data->tgt)
> +			rc |= ibft_create_kobject(data, kobject_type_target,
> +				IBFT_ISCSI_KOBJECT_TARGET_NAME, kobj_list);
> +		if (data->nic)
> +			rc |= ibft_create_kobject(data, kobject_type_ethernet,
> +				IBFT_ISCSI_KOBJECT_ETHERNET_NAME, kobj_list);
> +		if (data->nic && (data->nic->hdr.flags &
> +			ISCSI_IBFT_INIT_FLAG_FW_SEL_BOOT)) {
> +			rc |= ibft_create_kobject(data, kobject_type_chosen,
> +				IBFT_ISCSI_KOBJECT_CHOSEN_NAME, kobj_list);
> +			rc |= ibft_create_kobject(data, kobject_type_aliases,
> +				IBFT_ISCSI_KOBJECT_ALIASES_NAME, kobj_list);
> +		}
> +		if (rc) break;

	break;
		on a separate line.

Did you check this patch with scripts/checkpatch.pl ?

> +	}
> +	return rc;
> +};
> +
> +static void ibft_unregister_kobjects(struct list_head *list)
> +{
> +	struct ibft_kobject *data = NULL, *n;
> +	list_for_each_entry_safe(data, n, list, node) {
> +		list_del(&data->node);
> +		kobject_unregister(&data->kobj);
> +	};
> +	list_del_init(list);
> +};
> +
> +static int ibft_create_attribute(struct ibft_kobject *kobj_data,
> +				 const char *name,
> +				 ssize_t (*show) (struct  ibft_kobject *entry,
> +						  struct ibft_attribute *attr,
> +						  char *buf),
> +				 struct list_head *list)
> +{
> +	struct ibft_attribute *attr = NULL;
> +
> +	attr = kzalloc(sizeof(*attr), GFP_KERNEL);
> +	if (!attr)
> +		return -ENOMEM;
> +
> +	snprintf(attr->name, IBFT_ISCSI_ATTR_MAX_LEN, name,
> +		kobj_data->data->index);
> +
> +	attr->attr.name = attr->name;
> +	attr->attr.mode = S_IRUSR;
> +	attr->attr.owner = THIS_MODULE;
> +
> +	attr->nic = kobj_data->data->nic;
> +	attr->tgt = kobj_data->data->tgt;
> +	attr->initiator = kobj_data->data->initiator;
> +
> +	attr->show = show;
> +	attr->kobj = &kobj_data->kobj;
> +
> +	list_add_tail(&attr->node, list);
> +	return 0;
> +}
> +/*
> + *  Register the attributes for all of the kobjects.
> + */
> +static int ibft_register_attributes(struct list_head *kobject_list,
> +				    struct list_head *attr_list)
> +{
> +	int rc = 0;
> +	struct ibft_kobject *data = NULL;
> +	struct ibft_attribute *attr = NULL, *m;
> +
> +	list_for_each_entry(data, kobject_list, node) {
> +		switch (data->type) {
> +		case kobject_type_chosen:
> +			rc = ibft_create_attribute(data,
> +				IBFT_ISCSI_ATTR_BOOTPATH_NAME,
> +				ibft_attr_show_disk, attr_list);
> +			break;
> +		case kobject_type_ethernet:
> +			rc |= ibft_create_attribute(data,
> +					IBFT_ISCSI_ATTR_LOCAL_MAC_ADDRESS_NAME,
> +					ibft_attr_show_mac, attr_list);
> +			rc |= ibft_create_attribute(data,
> +					IBFT_ISCSI_ATTR_PROPERTY_NAME,
> +					ibft_attr_show_nic, attr_list);
> +			break;
> +		case kobject_type_target:
> +			rc |= ibft_create_attribute(data,
> +					IBFT_ISCSI_ATTR_PROPERTY_NAME,
> +					ibft_attr_show_target, attr_list);
> +			break;
> +		case kobject_type_aliases:
> +			rc |= ibft_create_attribute(data,
> +					IBFT_ISCSI_ATTR_DISK_NAME,
> +					ibft_attr_show_disk, attr_list);
> +			break;
> +		default:
> +			break;
> +		}
> +		if (rc)
> +			break;
> +	}
> +	list_for_each_entry_safe(attr, m, attr_list, node) {
> +		rc = sysfs_create_file(attr->kobj, &attr->attr);
> +		if (rc) {
> +			list_del(&attr->node);
> +			kfree(attr);
> +			break;
> +		}
> +	}
> +	return rc;
> +};
> +
> +static void ibft_unregister_attributes(struct list_head *list)
> +{
> +	struct ibft_attribute *attr = NULL, *m;
> +
> +	list_for_each_entry_safe(attr, m, list, node) {
> +		sysfs_remove_file(attr->kobj, &attr->attr);
> +		list_del(&attr->node);
> +		kfree(attr);
> +	}
> +	list_del_init(list);
> +};
> +
> +
> +/*
> + * ibft_init() - creates sysfs tree entries for iBFT data.
> + */
> +static int __init ibft_init(void)
> +{
> +	int rc = 0;
> +
> +	if (!ibft_phys)
> +		find_ibft();
> +
> +	rc = firmware_register(&ibft_subsys);
> +	if (rc)
> +		return rc;
> +
> +	if (ibft_phys) {
> +		printk(KERN_INFO "iBFT detected at 0x%lx.\n",
> +		       (unsigned long)ibft_phys);

Use %p to print pointer values.

> +
> +		rc = ibft_alloc_device(ibft_phys);
> +		if (rc)
> +			goto out_firmware_unregister;
> +
> +		/* Scan the IBFT for data. */
> +		rc = ibft_scan_device(ibft_device, &ibft_data_list);
> +		if (rc)
> +			goto out_free;
> +
> +		/* Register the kobjects based on the ibft_data_list */
> +		rc = ibft_register_kobjects(&ibft_data_list,
> +				&ibft_kobject_list);
> +		if (rc)
> +			goto out_free;
> +
> +		/* Register the attributes */
> +		rc = ibft_register_attributes(&ibft_kobject_list,
> +				&ibft_attr_list);
> +		if (rc)
> +			goto out_free;
> +	} else
> +		printk(KERN_INFO "No iBFT detected.\n");
> +
> +	if (!rc)
> +		return rc;

Can't this always just be
	return 0;
?

> +
> +out_free:
> +	ibft_unregister_attributes(&ibft_attr_list);
> +	ibft_unregister_kobjects(&ibft_kobject_list);
> +	ibft_free_data(&ibft_data_list);
> +	ibft_free_device(ibft_device);
> +	ibft_device = NULL;
> +out_firmware_unregister:
> +	firmware_unregister(&ibft_subsys);
> +	return rc;
> +}
> +
> +static void __exit ibft_exit(void)
> +{
> +	ibft_unregister_attributes(&ibft_attr_list);
> +	ibft_unregister_kobjects(&ibft_kobject_list);
> +	ibft_free_data(&ibft_data_list);
> +	ibft_free_device(ibft_device);
> +	ibft_device = NULL;
> +	firmware_unregister(&ibft_subsys);
> +	ibft_phys = 0;
> +}
> +
> +module_init(ibft_init);
> +module_exit(ibft_exit);
> diff --git a/include/linux/iscsi_ibft.h b/include/linux/iscsi_ibft.h
> new file mode 100644
> index 0000000..bbbb53c
> --- /dev/null
> +++ b/include/linux/iscsi_ibft.h
> @@ -0,0 +1,198 @@
> +#ifndef ISCSI_IBFT_H
> +#define ISCSI_IBFT_H
> +
> +extern void *ibft_phys;
> +
> +struct ibft_table_header {
> +	char signature[4];
> +	u32 length;
> +	u8 revision;
> +	u8 checksum;
> +	char oem_id[6];
> +	char oem_table_id[8];
> +	char reserved[24];
> +} __attribute__((__packed__));
> +
> +#define ISCSI_IBFT_INIT_FLAG_FW_SEL_BOOT 2
> +
> +enum ibft_id {
> +    id_reserved = 0,
> +    id_control = 1,
> +    id_initiator = 2,
> +    id_nic = 3,
> +    id_target = 4,
> +    id_extensions,
> +};
> +struct ibft_hdr {
> +	u8 id;
> +	u8 version;
> +	u16 length;
> +	u8 index;
> +	u8 flags;
> +} __attribute__((__packed__));
> +
> +struct ibft_control {
> +    struct ibft_hdr hdr;
> +    u16 extensions;
> +    u16 initiator_off;
> +    u16 nic0_off;
> +    u16 tgt0_off;
> +    u16 nic1_off;
> +    u16 tgt1_off;
> +} __attribute__((__packed__));
> +
> +struct ibft_initiator {
> +	struct ibft_hdr hdr;
> +	char isns_server[16];
> +	char slp_server[16];
> +	char pri_radius_server[16];
> +	char sec_radius_server[16];
> +	u16 initiator_name_len;
> +	u16 initiator_name_off;
> +} __attribute__((__packed__));
> +
> +struct ibft_nic {
> +	struct ibft_hdr hdr;
> +	char ip_addr[16];
> +	u8 subnet_mask_prefix;
> +	u8 origin;
> +	char gateway[16];
> +	char primary_dns[16];
> +	char secondary_dns[16];
> +	char dhcp[16];
> +	u16 vlan;
> +	char mac[6];
> +	u16 pci_bdf;
> +	u16 hostname_len;
> +	u16 hostname_off;
> +} __attribute__((__packed__));
> +
> +struct ibft_tgt {
> +	struct ibft_hdr hdr;
> +	char ip_addr[16];
> +	u16 port;
> +	char lun[8];
> +	u8 chap_type;
> +	u8 nic_assoc;
> +	u16 tgt_name_len;
> +	u16 tgt_name_off;
> +	u16 chap_name_len;
> +	u16 chap_name_off;
> +	u16 chap_secret_len;
> +	u16 chap_secret_off;
> +	u16 rev_chap_name_len;
> +	u16 rev_chap_name_off;
> +	u16 rev_chap_secret_len;
> +	u16 rev_chap_secret_off;
> +} __attribute__((__packed__));
> +
> +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)

Why is this #if line here instead of nearer the top of this header file?

> +#define IBFT_SIGN "iBFT"
> +#define IBFT_SIGN_LEN 4
> +#define IBFT_START 0x80000 /* 512kB */
> +#define IBFT_END 0x100000 /* 1MB */
> +#define VGA_MEM 0xA0000 /* VGA buffer */
> +#define VGA_SIZE 0x20000 /* 132kB */

I'd say that if 0x80000 is 512kB, then 0x20000 is 128kB.

Add blank line here, please.

> +static ssize_t find_ibft(void)
> +{
> +	unsigned long pos;
> +
> +	for (pos = IBFT_START; pos < IBFT_END; pos += 16) {
> +		void *virt;
> +		/* The table can't be inside the VGA BIOS reserved space,
> +		 * so skip that area */
> +		if (pos == VGA_MEM)
> +			pos += VGA_SIZE;
> +		virt = phys_to_virt(pos);
> +		if (memcmp(virt, IBFT_SIGN, IBFT_SIGN_LEN) == 0) {
> +			unsigned long *addr =
> +			    (unsigned long *)phys_to_virt(pos + 4);
> +			unsigned int len = *addr;
> +			/* if the length of the table extends past 1M,
> +			 * the table cannot be valid. */
> +			if (pos + len <= (IBFT_END-1)) {
> +				ibft_phys = (void *)pos;
> +				return len;
> +			}
> +		}
> +	}
> +	return 0;
> +}
> +

...

> +};
> +
> +#endif
> +
> +#endif /* ISCSI_IBFT_H */


-- 
~Randy

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-26 22:56 [PATCH] Add iSCSI IBFT Support (v0.3) Konrad Rzeszutek
  2007-11-26 23:53 ` Randy Dunlap
@ 2007-11-27  3:23 ` Greg KH
  2007-11-27  3:31 ` Greg KH
  2 siblings, 0 replies; 19+ messages in thread
From: Greg KH @ 2007-11-27  3:23 UTC (permalink / raw)
  To: Konrad Rzeszutek
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Mon, Nov 26, 2007 at 06:56:42PM -0400, Konrad Rzeszutek wrote:
> 
> This patch adds /sysfs/firmware/ibft/[chosen|aliases|ethernet@0,X|target@0,X]
> directories along with text properties which export the the iSCSI Boot
> Firmware Table (iBFT) structure. The layout of the directories mirrors
> how PowerPC OpenBoot exports this data.
> 
> What is iSCSI Boot Firmware Table? It is a mechanism for the iSCSI
> tools to extract from the machine NICs the iSCSI connection information
> so that they can automagically mount the iSCSI share/target. Currently
> the iSCSI information is hard-coded in th initrd.
> 
> For full details of the IBFT structure please take a look at:
> ftp://ftp.software.ibm.com/systems/support/system_x_pdf/ibm_iscsi_boot_firmware_table_v1.02.pdf

As you are adding sysfs files in /sys/firmware, please add documentation
to Documentation/ABI as to what these files are, what they do, what is
in them, and what they are to be used for.

> +	rc = firmware_register(&ibft_subsys);
> +	if (rc)
> +		return rc;

This function, as well as the whole decl_subsys() stuff is gone in my
tree and in -mm.  /sys/firmware is now just a simple kobject that you
are free to chain off of.  If you describe just what these sysfs
subdirectories and files are for and how they are going to be used, I'd
be glad to rework this patch to use the new interfaces.

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-26 22:56 [PATCH] Add iSCSI IBFT Support (v0.3) Konrad Rzeszutek
  2007-11-26 23:53 ` Randy Dunlap
  2007-11-27  3:23 ` Greg KH
@ 2007-11-27  3:31 ` Greg KH
  2007-11-27  4:12   ` Doug Maxey
  2007-11-27  4:23   ` Konrad Rzeszutek
  2 siblings, 2 replies; 19+ messages in thread
From: Greg KH @ 2007-11-27  3:31 UTC (permalink / raw)
  To: Konrad Rzeszutek
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Mon, Nov 26, 2007 at 06:56:42PM -0400, Konrad Rzeszutek wrote:
> +/*
> + *  Routines for reading of the iBFT data in a human readable fashion.
> + */
> +ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
> +				 struct ibft_attribute *attr,
> +				 char *buf)
> +{
> +	struct ibft_initiator *initiator = attr->initiator;
> +	void *ibft_loc = entry->data->hdr;
> +	char *str = buf;
> +
> +	if (!initiator)
> +		return 0;
> +
> +	str += sprintf_ipaddr(str, "isns", initiator->isns_server);
> +	str += sprintf_ipaddr(str, "slp", initiator->slp_server);
> +	str += sprintf_ipaddr(str, "primary_radius_server",
> +		initiator->pri_radius_server);
> +	str += sprintf_ipaddr(str, "secondary_radius_server",
> +		initiator->sec_radius_server);
> +	str += sprintf_string(str, "itname", initiator->initiator_name_len,
> +		(char *)ibft_loc + initiator->initiator_name_off);
> +	str--;
> +
> +	return str-buf;
> +}

sysfs files have ONE VALUE PER FILE, not a whole bunch of different
things in a single file.  Please fix this.


> +
> +ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
> +			   struct ibft_attribute *attr,
> +			   char *buf)
> +{
> +	struct ibft_nic *nic = attr->nic;
> +	void *ibft_loc = entry->data->hdr;
> +	char *str = buf;
> +
> +	if (!nic)
> +		return 0;
> +	/*
> +	 * Assume dhcp if any non-zero portions of its address are set.
> +	 */
> +	if (memcmp(nic->dhcp, nulls, sizeof(nic->dhcp))) {
> +		str += sprintf_ipaddr(str, "dhcp", nic->dhcp);
> +	} else {
> +		str += sprintf_ipaddr(str, "ciaddr", nic->ip_addr);
> +		str += sprintf_ipaddr(str, "giaddr", nic->gateway);
> +		str += sprintf_ipaddr(str, "dnsaddr1", nic->primary_dns);
> +		str += sprintf_ipaddr(str, "dnsaddr2", nic->secondary_dns);
> +	}
> +	if (nic->hostname_len)
> +		str += sprintf_string(str, "hostname", nic->hostname_len,
> +				(char *)ibft_loc + nic->hostname_off);
> +	/* Cut off the comma. */
> +	str--;
> +
> +	return str-buf;
> +}

Same here.

> +ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
> +			      struct ibft_attribute *attr,
> +			      char *buf)
> +{
> +	struct ibft_tgt *tgt = attr->tgt;
> +	void *ibft_loc = entry->data->hdr;
> +	char *str = buf;
> +	int i;
> +
> +	if (!tgt)
> +		return 0;
> +
> +	str += sprintf_ipaddr(str, "siaddr", tgt->ip_addr);
> +	str += sprintf(str, "iport=%d,", tgt->port);
> +	str += sprintf(str, "ilun=");
> +	for (i = 0; i < 8; i++)
> +		str += sprintf(str, "%x", (u8)tgt->lun[i]);
> +	str += sprintf(str, ",");
> +
> +	if (tgt->tgt_name_len)
> +		str += sprintf_string(str, "iname", tgt->tgt_name_len,
> +		(void *)ibft_loc + tgt->tgt_name_off);
> +
> +	if (tgt->chap_name_len)
> +		str += sprintf_string(str, "chapid", tgt->chap_name_len,
> +			(char *)ibft_loc + tgt->chap_name_off);
> +	if (tgt->chap_secret_len)
> +		str += sprintf_string(str, "chappw", tgt->chap_secret_len,
> +			(char *)ibft_loc + tgt->chap_secret_off);
> +	if (tgt->rev_chap_name_len)
> +		str += sprintf_string(str, "ichapid", tgt->rev_chap_name_len,
> +			(char *)ibft_loc + tgt->rev_chap_name_off);
> +	if (tgt->rev_chap_secret_len)
> +		str += sprintf_string(str, "ichappw", tgt->rev_chap_secret_len,
> +			(char *)ibft_loc + tgt->rev_chap_secret_off);
> +
> +	/* Cut off the comma. */
> +	str--;
> +
> +	return str-buf;
> +}

Same here, are we writing a novella or something to userspace?  :)

> +ssize_t ibft_attr_show_disk(struct ibft_kobject *dev,
> +			    struct ibft_attribute *ibft_attr,
> +			    char *buf)
> +{
> +	char *str = buf;
> +
> +	str += sprintf(str, "//ethernet@0,%d:iscsi,", dev->data->index);
> +	str += ibft_attr_show_initiator(dev, ibft_attr, str);
> +	str += sprintf(str, ",");
> +	str += ibft_attr_show_target(dev, ibft_attr, str);
> +	str += sprintf(str, ",");
> +	str += ibft_attr_show_nic(dev, ibft_attr, str);
> +
> +	return str-buf;
> +}

And here, do I need to go on?

> +ssize_t ibft_attr_show_mac(struct ibft_kobject *entry,
> +			   struct ibft_attribute *attr,
> +			   char *buf)
> +{
> +	struct ibft_nic *nic = attr->nic;
> +	int len = 6;
> +
> +	if (!nic)
> +		return 0;
> +
> +	memcpy(buf, attr->nic->mac, len);
> +
> +	return len;
> +}

Is mac a user readable string?  Then perhaps a simple sprintf would work
instead, as I doubt you are including a \n here...

> +/*
> + * The main routine which allows the user to read the IBFT data.
> + */
> +static ssize_t ibft_show_attribute(struct kobject *kobj,
> +				   struct attribute *attr,
> +				   char *buf)
> +{
> +	struct ibft_kobject *dev =
> +		container_of(kobj, struct ibft_kobject, kobj);
> +	struct ibft_attribute *ibft_attr =
> +		container_of(attr, struct ibft_attribute, attr);
> +	ssize_t ret = -EIO;
> +	char *str = buf;
> +
> +	if (!capable(CAP_SYS_ADMIN))
> +		return -EACCES;
> +
> +	if (ibft_attr->show)
> +		ret = ibft_attr->show(dev, ibft_attr, str);
> +
> +	return ret;
> +}
> +
> +static struct sysfs_ops ibft_attr_ops = {
> +	.show = ibft_show_attribute,
> +};

I think this whole mess can go away in the new rework Kay and I have
done, please document this whole thing and I'll see what I can do.

> +struct ibft_control {
> +    struct ibft_hdr hdr;
> +    u16 extensions;
> +    u16 initiator_off;
> +    u16 nic0_off;
> +    u16 tgt0_off;
> +    u16 nic1_off;
> +    u16 tgt1_off;
> +} __attribute__((__packed__));

Did we loose tabs for some reason?  I'm guessing your editor is not
showing them properly, nor did you use scripts/checkpatch.pl :(

> +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> +
> +#define IBFT_SIGN "iBFT"
> +#define IBFT_SIGN_LEN 4
> +#define IBFT_START 0x80000 /* 512kB */
> +#define IBFT_END 0x100000 /* 1MB */
> +#define VGA_MEM 0xA0000 /* VGA buffer */
> +#define VGA_SIZE 0x20000 /* 132kB */
> +static ssize_t find_ibft(void)
> +{
> +	unsigned long pos;
> +
> +	for (pos = IBFT_START; pos < IBFT_END; pos += 16) {
> +		void *virt;
> +		/* The table can't be inside the VGA BIOS reserved space,
> +		 * so skip that area */
> +		if (pos == VGA_MEM)
> +			pos += VGA_SIZE;
> +		virt = phys_to_virt(pos);
> +		if (memcmp(virt, IBFT_SIGN, IBFT_SIGN_LEN) == 0) {
> +			unsigned long *addr =
> +			    (unsigned long *)phys_to_virt(pos + 4);
> +			unsigned int len = *addr;
> +			/* if the length of the table extends past 1M,
> +			 * the table cannot be valid. */
> +			if (pos + len <= (IBFT_END-1)) {
> +				ibft_phys = (void *)pos;
> +				return len;
> +			}
> +		}
> +	}
> +	return 0;
> +}

What is a function (not even an inline one) doing in a .h file?

> +enum ibft_kobject_type {
> +	kobject_type_chosen,
> +	kobject_type_ethernet,
> +	kobject_type_target,
> +	kobject_type_aliases
> +};
> +struct ibft_kobject {
> +	struct ibft_data *data;
> +	char name[IBFT_ISCSI_KOBJECT_MAX_LEN];

Why have this,

> +	u8 type;
> +	struct kobject kobj;

When the kobject itself has an unlimited size name associated with it?

> +	struct list_head node;
> +};
> +
> +/*
> + * The text attributes, which can be:
> + *  - local-mac-address (many of them)
> + *  - property (many of them)
> + *  - bootpath (one) , iscsi-diskX (many)
> + *
> +*/
> +#define IBFT_ISCSI_ATTR_DISK_NAME "iscsi-disk%d"
> +#define IBFT_ISCSI_ATTR_PROPERTY_NAME "property"
> +#define IBFT_ISCSI_ATTR_BOOTPATH_NAME "bootpath"
> +#define IBFT_ISCSI_ATTR_LOCAL_MAC_ADDRESS_NAME "local-mac-address"
> +#define IBFT_ISCSI_ATTR_MAX_LEN 18
> +
> +struct ibft_attribute {
> +	struct attribute attr;
> +	ssize_t (*show) (struct  ibft_kobject *entry,
> +			 struct ibft_attribute *attr, char *buf);
> +	struct ibft_initiator *initiator;
> +	struct ibft_nic *nic;
> +	struct ibft_tgt *tgt;
> +	struct kobject *kobj;
> +	char name[IBFT_ISCSI_ATTR_MAX_LEN];

Same here, an attribute already has a pointer to a name, no need to have
another one in the same structure.

> +	struct list_head node;
> +};


thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  3:31 ` Greg KH
@ 2007-11-27  4:12   ` Doug Maxey
  2007-11-27  4:50     ` Konrad Rzeszutek
  2007-11-27  4:23   ` Konrad Rzeszutek
  1 sibling, 1 reply; 19+ messages in thread
From: Doug Maxey @ 2007-11-27  4:12 UTC (permalink / raw)
  To: Greg KH
  Cc: Konrad Rzeszutek, linux-kernel, pjones, konradr, konradr,
	randy.dunlap, hpa, lenb, mike.anderson, dwm


On Mon, 26 Nov 2007 19:31:38 PST, Greg KH wrote:
> On Mon, Nov 26, 2007 at 06:56:42PM -0400, Konrad Rzeszutek wrote:
> > +/*
> > + *  Routines for reading of the iBFT data in a human readable fashion.
> > + */
> > +ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
> > +				 struct ibft_attribute *attr,
> > +				 char *buf)
> > +{
> > +	struct ibft_initiator *initiator = attr->initiator;
> > +	void *ibft_loc = entry->data->hdr;
> > +	char *str = buf;
> > +
> > +	if (!initiator)
> > +		return 0;
> > +
> > +	str += sprintf_ipaddr(str, "isns", initiator->isns_server);
> > +	str += sprintf_ipaddr(str, "slp", initiator->slp_server);
> > +	str += sprintf_ipaddr(str, "primary_radius_server",
> > +		initiator->pri_radius_server);
> > +	str += sprintf_ipaddr(str, "secondary_radius_server",
> > +		initiator->sec_radius_server);
> > +	str += sprintf_string(str, "itname", initiator->initiator_name_len,
> > +		(char *)ibft_loc + initiator->initiator_name_off);
> > +	str--;
> > +
> > +	return str-buf;
> > +}
> 
> sysfs files have ONE VALUE PER FILE, not a whole bunch of different
> things in a single file.  Please fix this.

The subparameters _are_ actually part of a single value, that value being 
associated with the initiator instance.

Konrad is trying to implement a "work-alike" for what open firmware does.
open-iscsi already has the ability to extract the same format 
bits from real OFW.

See open-iscsi.git/utils/fwparam_ppc.

> 
> 
> > +
> > +ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
> > +			   struct ibft_attribute *attr,
> > +			   char *buf)
> > +{
> > +	struct ibft_nic *nic = attr->nic;
> > +	void *ibft_loc = entry->data->hdr;
> > +	char *str = buf;
> > +
> > +	if (!nic)
> > +		return 0;
> > +	/*
> > +	 * Assume dhcp if any non-zero portions of its address are set.
> > +	 */
> > +	if (memcmp(nic->dhcp, nulls, sizeof(nic->dhcp))) {
> > +		str += sprintf_ipaddr(str, "dhcp", nic->dhcp);
> > +	} else {
> > +		str += sprintf_ipaddr(str, "ciaddr", nic->ip_addr);
> > +		str += sprintf_ipaddr(str, "giaddr", nic->gateway);
> > +		str += sprintf_ipaddr(str, "dnsaddr1", nic->primary_dns);
> > +		str += sprintf_ipaddr(str, "dnsaddr2", nic->secondary_dns);
> > +	}
> > +	if (nic->hostname_len)
> > +		str += sprintf_string(str, "hostname", nic->hostname_len,
> > +				(char *)ibft_loc + nic->hostname_off);
> > +	/* Cut off the comma. */
> > +	str--;
> > +
> > +	return str-buf;
> > +}
> 
> Same here.
> 
> > +ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
> > +			      struct ibft_attribute *attr,
> > +			      char *buf)
> > +{
> > +	struct ibft_tgt *tgt = attr->tgt;
> > +	void *ibft_loc = entry->data->hdr;
> > +	char *str = buf;
> > +	int i;
> > +
> > +	if (!tgt)
> > +		return 0;
> > +
> > +	str += sprintf_ipaddr(str, "siaddr", tgt->ip_addr);
> > +	str += sprintf(str, "iport=%d,", tgt->port);
> > +	str += sprintf(str, "ilun=");
> > +	for (i = 0; i < 8; i++)
> > +		str += sprintf(str, "%x", (u8)tgt->lun[i]);
> > +	str += sprintf(str, ",");
> > +
> > +	if (tgt->tgt_name_len)
> > +		str += sprintf_string(str, "iname", tgt->tgt_name_len,
> > +		(void *)ibft_loc + tgt->tgt_name_off);
> > +
> > +	if (tgt->chap_name_len)
> > +		str += sprintf_string(str, "chapid", tgt->chap_name_len,
> > +			(char *)ibft_loc + tgt->chap_name_off);
> > +	if (tgt->chap_secret_len)
> > +		str += sprintf_string(str, "chappw", tgt->chap_secret_len,
> > +			(char *)ibft_loc + tgt->chap_secret_off);
> > +	if (tgt->rev_chap_name_len)
> > +		str += sprintf_string(str, "ichapid", tgt->rev_chap_name_len,
> > +			(char *)ibft_loc + tgt->rev_chap_name_off);
> > +	if (tgt->rev_chap_secret_len)
> > +		str += sprintf_string(str, "ichappw", tgt->rev_chap_secret_len,
> > +			(char *)ibft_loc + tgt->rev_chap_secret_off);
> > +
> > +	/* Cut off the comma. */
> > +	str--;
> > +
> > +	return str-buf;
> > +}
> 
> Same here, are we writing a novella or something to userspace?  :)

Yep.  Just like real OFW.

> 
> > +ssize_t ibft_attr_show_disk(struct ibft_kobject *dev,
> > +			    struct ibft_attribute *ibft_attr,
> > +			    char *buf)
> > +{
> > +	char *str = buf;
> > +
> > +	str += sprintf(str, "//ethernet@0,%d:iscsi,", dev->data->index);
> > +	str += ibft_attr_show_initiator(dev, ibft_attr, str);
> > +	str += sprintf(str, ",");
> > +	str += ibft_attr_show_target(dev, ibft_attr, str);
> > +	str += sprintf(str, ",");
> > +	str += ibft_attr_show_nic(dev, ibft_attr, str);
> > +
> > +	return str-buf;
> > +}
> 
> And here, do I need to go on?
> 
> > +ssize_t ibft_attr_show_mac(struct ibft_kobject *entry,
> > +			   struct ibft_attribute *attr,
> > +			   char *buf)
> > +{
> > +	struct ibft_nic *nic = attr->nic;
> > +	int len = 6;
> > +
> > +	if (!nic)
> > +		return 0;
> > +
> > +	memcpy(buf, attr->nic->mac, len);
> > +
> > +	return len;
> > +}
> 
> Is mac a user readable string?  

Nope.  The actual value in OFW is u8[6] in BE.  Again, this all input 
for the fwparam_ppc parser. 

++doug


^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  3:31 ` Greg KH
  2007-11-27  4:12   ` Doug Maxey
@ 2007-11-27  4:23   ` Konrad Rzeszutek
  2007-11-27  5:29     ` Greg KH
  1 sibling, 1 reply; 19+ messages in thread
From: Konrad Rzeszutek @ 2007-11-27  4:23 UTC (permalink / raw)
  To: Greg KH
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Monday 26 November 2007 22:31:38 Greg KH wrote:
> On Mon, Nov 26, 2007 at 06:56:42PM -0400, Konrad Rzeszutek wrote:
> > +/*
> > + *  Routines for reading of the iBFT data in a human readable fashion.
> > + */
> > +ssize_t ibft_attr_show_initiator(struct ibft_kobject *entry,
> > +				 struct ibft_attribute *attr,
> > +				 char *buf)
> > +{
.. snip..
> > +
> > +	str += sprintf_ipaddr(str, "isns", initiator->isns_server);
> > +	str += sprintf_ipaddr(str, "slp", initiator->slp_server);
.. snip ..
>
> sysfs files have ONE VALUE PER FILE, not a whole bunch of different
> things in a single file.  Please fix this.

No problem. I will have that shortly posted.

>
> > +
> > +ssize_t ibft_attr_show_nic(struct ibft_kobject *entry,
> > +			   struct ibft_attribute *attr,
> > +			   char *buf)
.. snip.. 
> > +		str += sprintf_ipaddr(str, "giaddr", nic->gateway);
> > +		str += sprintf_ipaddr(str, "dnsaddr1", nic->primary_dns);
>
> Same here.

Yup. 
>
> > +ssize_t ibft_attr_show_target(struct ibft_kobject *entry,
> > +			      struct ibft_attribute *attr,
> > +			      char *buf)
> > +{
.. snip..
> > +}
>
> Same here, are we writing a novella or something to userspace?  :)

Hehe.. I will make it simpler :-)

>
> > +ssize_t ibft_attr_show_disk(struct ibft_kobject *dev,
> > +			    struct ibft_attribute *ibft_attr,
> > +			    char *buf)
> > +{
.. snip ..
> > +}
>
> And here, do I need to go on?

I will have a new version posted quite shortly.

>
> > +ssize_t ibft_attr_show_mac(struct ibft_kobject *entry,
> > +			   struct ibft_attribute *attr,
> > +			   char *buf)
> > +{
..snip..
> > +
> > +	memcpy(buf, attr->nic->mac, len);
> > +
> > +	return len;
> > +}
>
> Is mac a user readable string?  Then perhaps a simple sprintf would work
> instead, as I doubt you are including a \n here...

It was meant to be as a binary value. But that doesn't fit in sysfs directory, 
so let me make it use sprintf here.

>
> > +/*
> > + * The main routine which allows the user to read the IBFT data.
> > + */
> > +static ssize_t ibft_show_attribute(struct kobject *kobj,
> > +				   struct attribute *attr,
> > +				   char *buf)
> > +{
..snip..
> > +
> > +static struct sysfs_ops ibft_attr_ops = {
> > +	.show = ibft_show_attribute,
> > +};
>
> I think this whole mess can go away in the new rework Kay and I have
> done, please document this whole thing and I'll see what I can do.

Absolutely.

>
> > +struct ibft_control {
> > +    struct ibft_hdr hdr;
> > +    u16 extensions;
> > +    u16 initiator_off;
> > +    u16 nic0_off;
> > +    u16 tgt0_off;
> > +    u16 nic1_off;
> > +    u16 tgt1_off;
> > +} __attribute__((__packed__));
>
> Did we loose tabs for some reason?  I'm guessing your editor is not
> showing them properly, nor did you use scripts/checkpatch.pl :(

I did use checkpatch.pl v0.99 downloaded somewhere from the web. I hadn't
realized it was now residing in scripts/checkpatch.pl - and from now on I will 
use that.

>
> > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
..snip..
> > +static ssize_t find_ibft(void)
> > +{
..snip..
> > +}
>
> What is a function (not even an inline one) doing in a .h file?

I was not sure where to put it. This function (find_ibft) is used by the 
setup_[32|64].c and the iscsi_ibft.c code. Randy suggested I put in .c file, 
but I am not sure exactly where? Should I make a new file in called 
libs/iscsi_ibft_helper.c ?

>
..snip..
> > +struct ibft_kobject {
> > +	struct ibft_data *data;
> > +	char name[IBFT_ISCSI_KOBJECT_MAX_LEN];
>
> Why have this,
>
> > +	u8 type;
> > +	struct kobject kobj;
>
> When the kobject itself has an unlimited size name associated with it?

Absolutely no reason at all. It was a evolution vestige of the code that is
not needed anymore. 

>
..snip..
> > +	char name[IBFT_ISCSI_ATTR_MAX_LEN];
>
> Same here, an attribute already has a pointer to a name, no need to have
> another one in the same structure.

Thanks. Will remove it.
>
> > +	struct list_head node;
> > +};
>
> thanks,

Thank you for taking your time to review the code. I will have the new
version out shortly.
>
> greg k-h



^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-26 23:53 ` Randy Dunlap
@ 2007-11-27  4:23   ` Konrad Rzeszutek
  0 siblings, 0 replies; 19+ messages in thread
From: Konrad Rzeszutek @ 2007-11-27  4:23 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, pjones, konradr, konradr, greg, hpa, lenb,
	mike.anderson, dwm


.. snip..
> > +#else
> > +static void __init reserve_ibft_region(void) { };
>
> No ending ; above.

Fixed.
>
..snip..
> > +static void __init reserve_ibft_region(void) { };
>
> Ditto.

Fixed.

.. snip..
> > +#include <linux/blkdev.h>
> > +
>
> No blank line here, please.

Why that creeps back in the code I am not sure myself. In your first review 
you mentioned this, I fixed it in my tree, and now it is back!? Either way, 
it is fixed.

>
> > +#include <linux/iscsi_ibft.h>

..snip..

> > +		printk(KERN_INFO  \
>
> Looks like this should use KERN_ERROR or KERN_WARNING?

Yes! Thanks for catching that.
>
> > +			"error, in IBFT structure (%s) expected %d but" \
> > +	return str-buf;
>
> 	preferred form:
> 	return str - buf;

Fixed.
>
..snip..
> > +
> > +	return str-buf;
>
> 	Ditto.
Fixed.

>
..snip..
> > +	return str-buf;
>
> 	Ditto.
Fixed.

..snip..
> > +	return str-buf;
>
> 	Ditto.
Fixed.
..snip..
> > +	int len = 6;
>
> Could you just use ETH_ALEN instead of <len> and 6?
> and #include <linux/if_ether.h>

Yes. That makes much more sense.

>
> Or add a define for IBFT_ALEN (of 6) and use that?

Either one works. The first suggestion is much better.


..snip..
>
> > +
> > +	/* Based on the header index value find the data tuple,
> > +	if possibly. */
>
> 	   if possible. */
>
> or better:
> 	/*
> 	 * Based on the header index value, find the data tuple
> 	 * if possible.
> 	 */

Yes, much more understandable - and now that I read I realized this was
not a proper assumption. One of the data structures (struct ibft_tgt) has a
'nic_assoc' value which makes a N-to-1 mapping to the NIC data structure,
so this will re-work. Thanks for catching a bug that early in the cycle!

..snip..
> > +		   struct carry it for convience. */
>
> 					convenience.
Fixed.

..snip..
> > + * Scan the IBFT table structure for the NIC and Target fields. When
> > + * found add them on the passed in list.
>
> 				passed-in list.

Fixed.

>
> > + */
> > +static int ibft_scan_device(struct ibft_table_header *header,
> > +			    struct list_head *list)
> > +{
> > +
> > +	/* We can have multiple NICs and multiple targets. The index in
> > +	   their header defines their 1-to-1 correlation.

Not true. I will have to re-work this code to do a 1-to-N correlation.
> > +	*/
> > +	for (ptr = &control->nic0_off; ptr <= end; ptr += sizeof(u16)) {
>
> In many searches, <end> would be the first address beyond the end of the
> table, so the loop-terminating condition test would be:
>
> 					ptr < end;

Yes. That is correct. It did actually check the next offset, which fortunately 
had nothing in it.
>
> It looks like that should be the case here also....

To check the offset to make sure it is within the full IBFT data structure? 
Yes, that is a good check - will implement.

>
..snip..
> > +		if (rc) break;
>
> 	break;
> 		on a separate line.
>
> Did you check this patch with scripts/checkpatch.pl ?

Yes. I ran it with check-patch-0.99.pl that I downloaded somewhere from Dave 
Jones web page. I hadn't realized that its home is now in 
scripts/checkpatch.pl - will make sure to use that improved-new version.

>
..snip..
> > +		printk(KERN_INFO "iBFT detected at 0x%lx.\n",
> > +		       (unsigned long)ibft_phys);
>
> Use %p to print pointer values.

This is actually not a pointer yet. It is a true physical address which I 
thought might be useful for troubleshooting purposes.

>
..snip.
> > +	if (!rc)
> > +		return rc;
>
> Can't this always just be
> 	return 0;
> ?

Yes, I was thinking that perhaps a more nicer way was to do 
"goto end;" where the end label is just "return rc;"  But this 
definitely trumps it.

>
> > +
..snip..
> > +
> > +struct ibft_tgt {
> > +	struct ibft_hdr hdr;
> > +	char ip_addr[16];
> > +	u16 port;
> > +	char lun[8];
> > +	u8 chap_type;
> > +	u8 nic_assoc;
> > +	u16 tgt_name_len;
> > +	u16 tgt_name_off;
> > +	u16 chap_name_len;
> > +	u16 chap_name_off;
> > +	u16 chap_secret_len;
> > +	u16 chap_secret_off;
> > +	u16 rev_chap_name_len;
> > +	u16 rev_chap_name_off;
> > +	u16 rev_chap_secret_len;
> > +	u16 rev_chap_secret_off;
> > +} __attribute__((__packed__));
> > +
> > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
>
> Why is this #if line here instead of nearer the top of this header file?

My thought was that if other kernel users might want to include this header 
file they do not have to exposed to the semi-internal data structures of this 
header file. If that is not a concern then I think I can remove the 
conditional altogether.

>
> > +#define IBFT_SIGN "iBFT"
> > +#define IBFT_SIGN_LEN 4
> > +#define IBFT_START 0x80000 /* 512kB */
> > +#define IBFT_END 0x100000 /* 1MB */
> > +#define VGA_MEM 0xA0000 /* VGA buffer */
> > +#define VGA_SIZE 0x20000 /* 132kB */
>
> I'd say that if 0x80000 is 512kB, then 0x20000 is 128kB.

Yes. Did the decimal conversion and forgot about the 1000 != 1024!

>
> Add blank line here, please.
Done.
>

Thanks again for your thorough review. The next version _should_ require no 
comments from you :-)


^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  4:12   ` Doug Maxey
@ 2007-11-27  4:50     ` Konrad Rzeszutek
  2007-11-27  5:28       ` Greg KH
  2007-11-27 23:06       ` Arjan van de Ven
  0 siblings, 2 replies; 19+ messages in thread
From: Konrad Rzeszutek @ 2007-11-27  4:50 UTC (permalink / raw)
  To: Doug Maxey
  Cc: Greg KH, linux-kernel, pjones, konradr, konradr, randy.dunlap,
	hpa, lenb, mike.anderson, dwm

> >
> > sysfs files have ONE VALUE PER FILE, not a whole bunch of different
> > things in a single file.  Please fix this.
>
> The subparameters _are_ actually part of a single value, that value being
> associated with the initiator instance.
>
> Konrad is trying to implement a "work-alike" for what open firmware does.
> open-iscsi already has the ability to extract the same format
> bits from real OFW.
>
> See open-iscsi.git/utils/fwparam_ppc.


Greg,

In light of what Doug says (which is all true), should I go ahead with a new 
version of this module which would export one value per file? The problem 
that will be encountered is that a ethernetX sysfs directory would have (for 
example):

/sys/firmware/ibft/ethernet0/pci-bdf
5:1:0
/sys/firmware/ibft/ethernet0/mac
00:11:25:9d:8b:00
/sys/firmware/ibft/ethernet0/vlan
0
/sys/firmware/ibft/ethernet0/gateway
192.168.79.254
/sys/firmware/ibft/ethernet0/origin
0
/sys/firmware/ibft/ethernet0/subnet-mask
22
/sys/firmware/ibft/ethernet0/ip-addr
192.168.77.41
/sys/firmware/ibft/ethernet0/flags
7

And the flag would contain the value "7" which would mean the user would have 
to parse what each bit means? (the v0.3 of the module does not export this 
flag but uses it to figure out which is the boot iSCSI target).


^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  4:50     ` Konrad Rzeszutek
@ 2007-11-27  5:28       ` Greg KH
  2007-11-27 23:06       ` Arjan van de Ven
  1 sibling, 0 replies; 19+ messages in thread
From: Greg KH @ 2007-11-27  5:28 UTC (permalink / raw)
  To: Konrad Rzeszutek
  Cc: Doug Maxey, linux-kernel, pjones, konradr, konradr, randy.dunlap,
	hpa, lenb, mike.anderson, dwm

On Mon, Nov 26, 2007 at 11:50:10PM -0500, Konrad Rzeszutek wrote:
> > >
> > > sysfs files have ONE VALUE PER FILE, not a whole bunch of different
> > > things in a single file.  Please fix this.
> >
> > The subparameters _are_ actually part of a single value, that value being
> > associated with the initiator instance.
> >
> > Konrad is trying to implement a "work-alike" for what open firmware does.
> > open-iscsi already has the ability to extract the same format
> > bits from real OFW.
> >
> > See open-iscsi.git/utils/fwparam_ppc.
> 
> 
> Greg,
> 
> In light of what Doug says (which is all true), should I go ahead with a new 
> version of this module which would export one value per file? The problem 
> that will be encountered is that a ethernetX sysfs directory would have (for 
> example):
> 
> /sys/firmware/ibft/ethernet0/pci-bdf
> 5:1:0
> /sys/firmware/ibft/ethernet0/mac
> 00:11:25:9d:8b:00
> /sys/firmware/ibft/ethernet0/vlan
> 0
> /sys/firmware/ibft/ethernet0/gateway
> 192.168.79.254
> /sys/firmware/ibft/ethernet0/origin
> 0
> /sys/firmware/ibft/ethernet0/subnet-mask
> 22
> /sys/firmware/ibft/ethernet0/ip-addr
> 192.168.77.41
> /sys/firmware/ibft/ethernet0/flags
> 7

Yes, that is the proper way to do this kind of thing in sysfs.

> And the flag would contain the value "7" which would mean the user would have 
> to parse what each bit means? (the v0.3 of the module does not export this 
> flag but uses it to figure out which is the boot iSCSI target).

Sure, as long as it means something to userspace, and is a single value,
and is documented, that's fine.

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  4:23   ` Konrad Rzeszutek
@ 2007-11-27  5:29     ` Greg KH
  2007-11-27 18:09       ` darnok
  0 siblings, 1 reply; 19+ messages in thread
From: Greg KH @ 2007-11-27  5:29 UTC (permalink / raw)
  To: Konrad Rzeszutek
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Mon, Nov 26, 2007 at 11:23:31PM -0500, Konrad Rzeszutek wrote:
> On Monday 26 November 2007 22:31:38 Greg KH wrote:
> > > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> ..snip..
> > > +static ssize_t find_ibft(void)
> > > +{
> ..snip..
> > > +}
> >
> > What is a function (not even an inline one) doing in a .h file?
> 
> I was not sure where to put it. This function (find_ibft) is used by the 
> setup_[32|64].c and the iscsi_ibft.c code. Randy suggested I put in .c file, 
> but I am not sure exactly where? Should I make a new file in called 
> libs/iscsi_ibft_helper.c ?

Put it in your .c file and make it a global function to be called by
someone else if they need it.

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  5:29     ` Greg KH
@ 2007-11-27 18:09       ` darnok
  2007-11-27 19:09         ` Greg KH
  0 siblings, 1 reply; 19+ messages in thread
From: darnok @ 2007-11-27 18:09 UTC (permalink / raw)
  To: Greg KH
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Mon, Nov 26, 2007 at 09:29:55PM -0800, Greg KH wrote:
> On Mon, Nov 26, 2007 at 11:23:31PM -0500, Konrad Rzeszutek wrote:
> > On Monday 26 November 2007 22:31:38 Greg KH wrote:
> > > > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> > ..snip..
> > > > +static ssize_t find_ibft(void)
> > > > +{
> > ..snip..
> > > > +}
> > >
> > > What is a function (not even an inline one) doing in a .h file?
> > 
> > I was not sure where to put it. This function (find_ibft) is used by the 
> > setup_[32|64].c and the iscsi_ibft.c code. Randy suggested I put in .c file, 
> > but I am not sure exactly where? Should I make a new file in called 
> > libs/iscsi_ibft_helper.c ?
> 
> Put it in your .c file and make it a global function to be called by
> someone else if they need it.

If the kernel is built with CONFIG_ISCSI_IBFT=m, the
setup_[32|64],c code would depend on the 'find_ibft' symbol which is
in a module (in the iscsi_ibft.c), which is not available during
the bootup phase and not linked to vmlinuz.

This isn't an issue if the module is built with CONFIG_ISCSI_IBFT=y of
course.

Or did by 'your .c file' mean a new file in arch/x86/kernel directory?

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27 18:09       ` darnok
@ 2007-11-27 19:09         ` Greg KH
  2007-11-28 19:21           ` darnok
  0 siblings, 1 reply; 19+ messages in thread
From: Greg KH @ 2007-11-27 19:09 UTC (permalink / raw)
  To: darnok
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Tue, Nov 27, 2007 at 02:09:50PM -0400, darnok@68k.org wrote:
> On Mon, Nov 26, 2007 at 09:29:55PM -0800, Greg KH wrote:
> > On Mon, Nov 26, 2007 at 11:23:31PM -0500, Konrad Rzeszutek wrote:
> > > On Monday 26 November 2007 22:31:38 Greg KH wrote:
> > > > > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> > > ..snip..
> > > > > +static ssize_t find_ibft(void)
> > > > > +{
> > > ..snip..
> > > > > +}
> > > >
> > > > What is a function (not even an inline one) doing in a .h file?
> > > 
> > > I was not sure where to put it. This function (find_ibft) is used by the 
> > > setup_[32|64].c and the iscsi_ibft.c code. Randy suggested I put in .c file, 
> > > but I am not sure exactly where? Should I make a new file in called 
> > > libs/iscsi_ibft_helper.c ?
> > 
> > Put it in your .c file and make it a global function to be called by
> > someone else if they need it.
> 
> If the kernel is built with CONFIG_ISCSI_IBFT=m, the
> setup_[32|64],c code would depend on the 'find_ibft' symbol which is
> in a module (in the iscsi_ibft.c), which is not available during
> the bootup phase and not linked to vmlinuz.

Ah, then don't allow that :)

> This isn't an issue if the module is built with CONFIG_ISCSI_IBFT=y of
> course.
> 
> Or did by 'your .c file' mean a new file in arch/x86/kernel directory?

I didn't realize an external file, outside of your changes, needed this
function.  If it does, then perhaps you need to just place it elsewhere.

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27  4:50     ` Konrad Rzeszutek
  2007-11-27  5:28       ` Greg KH
@ 2007-11-27 23:06       ` Arjan van de Ven
  2007-11-29 15:36         ` darnok
  1 sibling, 1 reply; 19+ messages in thread
From: Arjan van de Ven @ 2007-11-27 23:06 UTC (permalink / raw)
  To: Konrad Rzeszutek
  Cc: Doug Maxey, Greg KH, linux-kernel, pjones, konradr, konradr,
	randy.dunlap, hpa, lenb, mike.anderson, dwm

On Mon, 26 Nov 2007 23:50:10 -0500
Konrad Rzeszutek <konrad@darnok.org> wrote:

> > >
> > > sysfs files have ONE VALUE PER FILE, not a whole bunch of
> > > different things in a single file.  Please fix this.
> >
> > The subparameters _are_ actually part of a single value, that value
> > being associated with the initiator instance.
> >
> > Konrad is trying to implement a "work-alike" for what open firmware
> > does. open-iscsi already has the ability to extract the same format
> > bits from real OFW.
> >
> > See open-iscsi.git/utils/fwparam_ppc.
> 
> 
> Greg,
> 
> In light of what Doug says (which is all true), should I go ahead
> with a new version of this module which would export one value per
> file? The problem that will be encountered is that a ethernetX sysfs
> directory would have (for example):
> 
> /sys/firmware/ibft/ethernet0/pci-bdf
> 5:1:0

shouldn't this somehow also have a symlink to the kernels ethX view of
ethernet devices?
(and if so.. how much of the info is duplicated..)


-- 
If you want to reach me at my work email, use arjan@linux.intel.com
For development, discussion and tips for power savings, 
visit http://www.lesswatts.org

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27 19:09         ` Greg KH
@ 2007-11-28 19:21           ` darnok
  2007-11-28 19:45             ` Greg KH
  0 siblings, 1 reply; 19+ messages in thread
From: darnok @ 2007-11-28 19:21 UTC (permalink / raw)
  To: Greg KH
  Cc: darnok, linux-kernel, pjones, konradr, konradr, randy.dunlap,
	hpa, lenb, mike.anderson, dwm

On Tue, Nov 27, 2007 at 11:09:19AM -0800, Greg KH wrote:
> On Tue, Nov 27, 2007 at 02:09:50PM -0400, darnok@68k.org wrote:
> > On Mon, Nov 26, 2007 at 09:29:55PM -0800, Greg KH wrote:
> > > On Mon, Nov 26, 2007 at 11:23:31PM -0500, Konrad Rzeszutek wrote:
> > > > On Monday 26 November 2007 22:31:38 Greg KH wrote:
> > > > > > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> > > > ..snip..
> > > > > > +static ssize_t find_ibft(void)
> > > > > > +{
> > > > ..snip..
> > > > > > +}
> > > > >
> > > > > What is a function (not even an inline one) doing in a .h file?
> > > > 
> > > > I was not sure where to put it. This function (find_ibft) is used by the 
> > > > setup_[32|64].c and the iscsi_ibft.c code. Randy suggested I put in .c file, 
> > > > but I am not sure exactly where? Should I make a new file in called 
> > > > libs/iscsi_ibft_helper.c ?
> > > 
> > > Put it in your .c file and make it a global function to be called by
> > > someone else if they need it.
> > 
> > If the kernel is built with CONFIG_ISCSI_IBFT=m, the
> > setup_[32|64],c code would depend on the 'find_ibft' symbol which is
> > in a module (in the iscsi_ibft.c), which is not available during
> > the bootup phase and not linked to vmlinuz.
> 
> Ah, then don't allow that :)
> 
> > This isn't an issue if the module is built with CONFIG_ISCSI_IBFT=y of
> > course.
> > 
> > Or did by 'your .c file' mean a new file in arch/x86/kernel directory?
> 
> I didn't realize an external file, outside of your changes, needed this
> function.  If it does, then perhaps you need to just place it elsewhere.

The fundamental problem is that 'find_ibft' ought to be available
from anywhere (or at least from the iscsi_ibft.c) so that the iscsi_ibft
module can be loaded on any platform. But on x86, it needs to be called
 from setup_[32|64].c because the IBFT can be located anywhere
between 512KB and 1MB - and the E820 does not neccesarily have to
exclude that region. Hence the patch I proposed implements a
'reserve_ibft_region' code which would reserve the region of memory
found by 'find_ibft' so that it can be preserved when iscsi_ibft
module is actually loaded.

It ends up that there are three consumers of 'find_ibft':
 a) the module itself (iscsi_ibft.c)
 b) setup_32.c
 c) setup_64.c

The first choice, which looked the most flexible, was to have it
in iscsi_ibft.h file.
The second one, which would inhibit the user from making iscsi_ibft
a module, would be to move it to iscsi_ibft.c and make it
EXPORT_SYMBOL(), but that seems wasteful from a memory foot-print
look.
A third option was to put in /lib, but that doesn't seem right - this
'find_ibft' code is specific to this module.

Of all the options, the cleanest looks to be the first choice :-(
(I am not trying to be obstinate here - I just can't think of any
other reasonable place).

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-28 19:21           ` darnok
@ 2007-11-28 19:45             ` Greg KH
  2007-11-28 20:24               ` darnok
  0 siblings, 1 reply; 19+ messages in thread
From: Greg KH @ 2007-11-28 19:45 UTC (permalink / raw)
  To: darnok
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Wed, Nov 28, 2007 at 03:21:40PM -0400, darnok@68k.org wrote:
> On Tue, Nov 27, 2007 at 11:09:19AM -0800, Greg KH wrote:
> > On Tue, Nov 27, 2007 at 02:09:50PM -0400, darnok@68k.org wrote:
> > > On Mon, Nov 26, 2007 at 09:29:55PM -0800, Greg KH wrote:
> > > > On Mon, Nov 26, 2007 at 11:23:31PM -0500, Konrad Rzeszutek wrote:
> > > > > On Monday 26 November 2007 22:31:38 Greg KH wrote:
> > > > > > > +#if defined(CONFIG_ISCSI_IBFT) || defined(CONFIG_ISCSI_IBFT_MODULE)
> > > > > ..snip..
> > > > > > > +static ssize_t find_ibft(void)
> > > > > > > +{
> > > > > ..snip..
> > > > > > > +}
> > > > > >
> > > > > > What is a function (not even an inline one) doing in a .h file?
> > > > > 
> > > > > I was not sure where to put it. This function (find_ibft) is used by the 
> > > > > setup_[32|64].c and the iscsi_ibft.c code. Randy suggested I put in .c file, 
> > > > > but I am not sure exactly where? Should I make a new file in called 
> > > > > libs/iscsi_ibft_helper.c ?
> > > > 
> > > > Put it in your .c file and make it a global function to be called by
> > > > someone else if they need it.
> > > 
> > > If the kernel is built with CONFIG_ISCSI_IBFT=m, the
> > > setup_[32|64],c code would depend on the 'find_ibft' symbol which is
> > > in a module (in the iscsi_ibft.c), which is not available during
> > > the bootup phase and not linked to vmlinuz.
> > 
> > Ah, then don't allow that :)
> > 
> > > This isn't an issue if the module is built with CONFIG_ISCSI_IBFT=y of
> > > course.
> > > 
> > > Or did by 'your .c file' mean a new file in arch/x86/kernel directory?
> > 
> > I didn't realize an external file, outside of your changes, needed this
> > function.  If it does, then perhaps you need to just place it elsewhere.
> 
> The fundamental problem is that 'find_ibft' ought to be available
> from anywhere (or at least from the iscsi_ibft.c) so that the iscsi_ibft
> module can be loaded on any platform. But on x86, it needs to be called
>  from setup_[32|64].c because the IBFT can be located anywhere
> between 512KB and 1MB - and the E820 does not neccesarily have to
> exclude that region. Hence the patch I proposed implements a
> 'reserve_ibft_region' code which would reserve the region of memory
> found by 'find_ibft' so that it can be preserved when iscsi_ibft
> module is actually loaded.
> 
> It ends up that there are three consumers of 'find_ibft':
>  a) the module itself (iscsi_ibft.c)
>  b) setup_32.c
>  c) setup_64.c
> 
> The first choice, which looked the most flexible, was to have it
> in iscsi_ibft.h file.
> The second one, which would inhibit the user from making iscsi_ibft
> a module, would be to move it to iscsi_ibft.c and make it
> EXPORT_SYMBOL(), but that seems wasteful from a memory foot-print
> look.
> A third option was to put in /lib, but that doesn't seem right - this
> 'find_ibft' code is specific to this module.
> 
> Of all the options, the cleanest looks to be the first choice :-(
> (I am not trying to be obstinate here - I just can't think of any
> other reasonable place).

If you insist on putting it in a .h file, it needs to be marked "inline"
at the least.

But, why not just put it in a separate file, that is built in if the
user wants iscsi support?  That way the setup code can call it properly
if needed.

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-28 19:45             ` Greg KH
@ 2007-11-28 20:24               ` darnok
  2007-11-28 20:33                 ` Greg KH
  0 siblings, 1 reply; 19+ messages in thread
From: darnok @ 2007-11-28 20:24 UTC (permalink / raw)
  To: Greg KH
  Cc: darnok, linux-kernel, pjones, konradr, konradr, randy.dunlap,
	hpa, lenb, mike.anderson, dwm

> > > I didn't realize an external file, outside of your changes, needed this
> > > function.  If it does, then perhaps you need to just place it elsewhere.
> > 
> > The fundamental problem is that 'find_ibft' ought to be available
> > from anywhere (or at least from the iscsi_ibft.c) so that the iscsi_ibft
> > module can be loaded on any platform. But on x86, it needs to be called
> >  from setup_[32|64].c because the IBFT can be located anywhere
> > between 512KB and 1MB - and the E820 does not neccesarily have to
> > exclude that region. Hence the patch I proposed implements a
> > 'reserve_ibft_region' code which would reserve the region of memory
> > found by 'find_ibft' so that it can be preserved when iscsi_ibft
> > module is actually loaded.
> > 
> > It ends up that there are three consumers of 'find_ibft':
> >  a) the module itself (iscsi_ibft.c)
> >  b) setup_32.c
> >  c) setup_64.c
> > 
> > The first choice, which looked the most flexible, was to have it
> > in iscsi_ibft.h file.
> > The second one, which would inhibit the user from making iscsi_ibft
> > a module, would be to move it to iscsi_ibft.c and make it
> > EXPORT_SYMBOL(), but that seems wasteful from a memory foot-print
> > look.
> > A third option was to put in /lib, but that doesn't seem right - this
> > 'find_ibft' code is specific to this module.
> > 
> > Of all the options, the cleanest looks to be the first choice :-(
> > (I am not trying to be obstinate here - I just can't think of any
> > other reasonable place).
> 
> If you insist on putting it in a .h file, it needs to be marked "inline"
> at the least.

Ok.

> But, why not just put it in a separate file, that is built in if the
> user wants iscsi support?  That way the setup code can call it properly
> if needed.

In what directory should I put that file? It can't be in the arch/*
directories b/c the iscsi_ibft.c wouldn't build on all platforms.
Should I put it in drivers/firmware ?


^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-28 20:24               ` darnok
@ 2007-11-28 20:33                 ` Greg KH
  0 siblings, 0 replies; 19+ messages in thread
From: Greg KH @ 2007-11-28 20:33 UTC (permalink / raw)
  To: darnok
  Cc: linux-kernel, pjones, konradr, konradr, randy.dunlap, hpa, lenb,
	mike.anderson, dwm

On Wed, Nov 28, 2007 at 04:24:32PM -0400, darnok@68k.org wrote:
> > But, why not just put it in a separate file, that is built in if the
> > user wants iscsi support?  That way the setup code can call it properly
> > if needed.
> 
> In what directory should I put that file? It can't be in the arch/*
> directories b/c the iscsi_ibft.c wouldn't build on all platforms.
> Should I put it in drivers/firmware ?

Put it in the same directory your other iscsi files are.  Or wherever
you feel it is best suited.

thanks,

greg k-h

^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-27 23:06       ` Arjan van de Ven
@ 2007-11-29 15:36         ` darnok
  2007-12-05  0:39           ` Konrad Rzeszutek
  0 siblings, 1 reply; 19+ messages in thread
From: darnok @ 2007-11-29 15:36 UTC (permalink / raw)
  To: Arjan van de Ven
  Cc: Doug Maxey, Greg KH, linux-kernel, pjones, konradr, konradr,
	randy.dunlap, hpa, lenb, mike.anderson, dwm

> > 
> > /sys/firmware/ibft/ethernet0/pci-bdf
> > 5:1:0
> 
> shouldn't this somehow also have a symlink to the kernels ethX view of
> ethernet devices?
> (and if so.. how much of the info is duplicated..)

That NIC is used by the NIC firmware (or the BIOS) to negotiate
the iSCSI target. The information that is in this directory is what
the BIOS used (note past tense) which might very well be completly
different from what Linux uses.

My rationale behind _not_ linking to ethX view was that it could
be confusing and not entirely useful for users: "It says that _this_
NIC, with this IP, uses this iSCSI target. But Linux is using a
completly different NIC (and IP) to setup a iSCSI connection to the
same iSCSI target!?"


^ permalink raw reply	[flat|nested] 19+ messages in thread

* Re: [PATCH] Add iSCSI IBFT Support (v0.3)
  2007-11-29 15:36         ` darnok
@ 2007-12-05  0:39           ` Konrad Rzeszutek
  0 siblings, 0 replies; 19+ messages in thread
From: Konrad Rzeszutek @ 2007-12-05  0:39 UTC (permalink / raw)
  To: darnok
  Cc: Arjan van de Ven, Doug Maxey, Greg KH, linux-kernel, pjones,
	konradr, konradr, randy.dunlap, hpa, lenb, mike.anderson, dwm

On Thu, Nov 29, 2007 at 11:36:21AM -0400, darnok@68k.org wrote:
> > > 
> > > /sys/firmware/ibft/ethernet0/pci-bdf
> > > 5:1:0
> > 
> > shouldn't this somehow also have a symlink to the kernels ethX view of
> > ethernet devices?
> > (and if so.. how much of the info is duplicated..)
> 
> That NIC is used by the NIC firmware (or the BIOS) to negotiate
> the iSCSI target. The information that is in this directory is what
> the BIOS used (note past tense) which might very well be completly
> different from what Linux uses.
> 
> My rationale behind _not_ linking to ethX view was that it could
> be confusing and not entirely useful for users: "It says that _this_
> NIC, with this IP, uses this iSCSI target. But Linux is using a
> completly different NIC (and IP) to setup a iSCSI connection to the
> same iSCSI target!?"

On the other hand having a link to the device and being able to
extra data sounds good too. I've made a modification and posted
a new version, under the 'REPORT [PATCH] Add iSCSI iBFT v0.4'.

Review would be much appreciated.

^ permalink raw reply	[flat|nested] 19+ messages in thread

end of thread, other threads:[~2007-12-05  0:40 UTC | newest]

Thread overview: 19+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2007-11-26 22:56 [PATCH] Add iSCSI IBFT Support (v0.3) Konrad Rzeszutek
2007-11-26 23:53 ` Randy Dunlap
2007-11-27  4:23   ` Konrad Rzeszutek
2007-11-27  3:23 ` Greg KH
2007-11-27  3:31 ` Greg KH
2007-11-27  4:12   ` Doug Maxey
2007-11-27  4:50     ` Konrad Rzeszutek
2007-11-27  5:28       ` Greg KH
2007-11-27 23:06       ` Arjan van de Ven
2007-11-29 15:36         ` darnok
2007-12-05  0:39           ` Konrad Rzeszutek
2007-11-27  4:23   ` Konrad Rzeszutek
2007-11-27  5:29     ` Greg KH
2007-11-27 18:09       ` darnok
2007-11-27 19:09         ` Greg KH
2007-11-28 19:21           ` darnok
2007-11-28 19:45             ` Greg KH
2007-11-28 20:24               ` darnok
2007-11-28 20:33                 ` Greg KH

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).