Page MenuHomeFreeBSD
Differential D35915

stand: Add dv_devfmt to return a string represenation of the device
ClosedPublic
Actions

Authored by imp on Jul 25 2022, 8:32 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Apr 7, 8:09 AM
Unknown Object (File)
Sun, Apr 6, 2:56 AM
Unknown Object (File)
Tue, Mar 11, 3:01 PM
Unknown Object (File)
Mon, Mar 10, 8:18 PM
Unknown Object (File)
Mar 4 2025, 7:08 PM
Unknown Object (File)
Feb 25 2025, 11:31 PM
Unknown Object (File)
Jan 22 2025, 12:34 PM
Unknown Object (File)
Jan 17 2025, 9:09 PM
View All 73 Files
Subscribers
dab

Details

Reviewers
tsoome
kevans
manu
Commits
rGe6cafedf0991: stand: Add dv_devfmt to return a string represenation of the device
rG4d4b1a298c84: stand: Add dv_devfmt to return a string represenation of the device
Summary

Add a new pointer, dv_devfmt, to allow devices to format themselves. We
will use this to simplify many of the fmtdev functions in the tree as
they are all almost the same, or all are isomorphic to each other.

Sponsored by: Netflix

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 46646
Build 43535: arc lint + arc unit

Event Timeline

imp created this revision.Jul 25 2022, 8:32 PM
Herald added a reviewer: manu. · View Herald TranscriptJul 25 2022, 8:32 PM
Herald added a subscriber: dab. · View Herald Transcript
imp requested review of this revision.Jul 25 2022, 8:32 PM
Harbormaster completed remote builds in B46560: Diff 108511.Jul 25 2022, 8:32 PM
imp added a parent revision: D35914: stand: Change disk_fmtdev to take a struct devdesc *.Jul 25 2022, 8:32 PM
imp added a child revision: D35916: stand: Add devformat to return formatted string for a device.
tsoome added inline comments.Jul 25 2022, 10:13 PM
stand/libsa/stand.h
143

Is there more background for this specific size? I mean, we have DEV_NAMLEN + 10 chars in int + colon + NUL... asking because 128 bytes add up in text+data+bss of BIOS loader:)

imp added inline comments.Jul 25 2022, 10:40 PM
stand/libsa/stand.h
143

128 was used in a lot of places (see subsequent reviews) so I used that here.
For disk devices, I don't see this ever being > diskXXXXsXXa: (so up to 10k disks, 100 partitions and maybe a bsd label for evilness).
I'm not sure what a good limit is here, but in most loaders, this will just be 128 bytes once in the devformat static buffer.

tsoome accepted this revision.Jul 26 2022, 10:30 AM
This revision is now accepted and ready to land.Jul 26 2022, 10:30 AM
imp updated this revision to Diff 108653.Jul 28 2022, 4:57 PM

rebase

This revision now requires review to proceed.Jul 28 2022, 4:57 PM
Harbormaster completed remote builds in B46646: Diff 108653.Jul 28 2022, 4:57 PM
This revision was not accepted when it landed; it landed in state Needs Review.Aug 11 2022, 4:28 PM
Closed by commit rG4d4b1a298c84: stand: Add dv_devfmt to return a string represenation of the device (authored by imp). · Explain Why
This revision was automatically updated to reflect the committed changes.
imp added a commit: rG4d4b1a298c84: stand: Add dv_devfmt to return a string represenation of the device.
imp added a commit: rGe6cafedf0991: stand: Add dv_devfmt to return a string represenation of the device.Jan 24 2023, 10:16 PM

Revision Contents
Changeset List

PathSize
stand/
libsa/
5 lines

Diff 108653

View Options

stand/libsa/stand.h

  • This file was added.
/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2023 Dave Cottlehuber <dch@FreeBSD.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <errno.h>
#include <sys/param.h>
#include <stdio.h>
#include <string.h>
#include <fetch.h>
#include <lua.h>
#include "lauxlib.h"
#include "lfetch.h"
/*
* Minimal implementation of libfetch
*/
static int
lfetch_parse_url(lua_State *L)
{
const char *url = luaL_checkstring(L, 1);
struct url *u;
u = fetchParseURL(url);
if (u == NULL) {
lua_pushnil(L);
lua_pushstring(L, "Failed to parse URL");
return (2);
}
lua_newtable(L);
lua_pushstring(L, u->scheme);
lua_setfield(L, -2, "scheme");
lua_pushstring(L, u->user);
lua_setfield(L, -2, "user");
lua_pushstring(L, u->pwd);
lua_setfield(L, -2, "password");
lua_pushstring(L, u->host);
lua_setfield(L, -2, "host");
/* if port is not explicitly set, it defaults to 0, not scheme */
kevansUnsubmitted
Done
Inline Actions

My gut reaction to this is that we probably shouldn't expose the port at all if it's not explicitly set, just leave it nil in this table to allow for more idiomatic usage where you can simply test the port as truthy before using it.f

kevans: My gut reaction to this is that we probably shouldn't expose the port at all if it's not…
lua_pushinteger(L, u->port);
lua_setfield(L, -2, "port");
/* doc is also known as the query string for http(s) */
lua_pushstring(L, u->doc);
lua_setfield(L, -2, "doc");
fetchFreeURL(u);
return (1);
}
static int
lfetch_get_url(lua_State *L) {
kevansUnsubmitted
Done
Inline Actions

Brace on its own line

kevans: Brace on its own line
const char *url = luaL_checkstring(L, 1);
const char *out = luaL_checkstring(L, 2);
struct url *u;
kevansUnsubmitted
Done
Inline Actions

This should move up above the blank line

kevans: This should move up above the blank line
u = fetchParseURL(url);
if (u == NULL) {
lua_pushnil(L);
lua_pushstring(L, "Failed to parse URL");
return (2);
}
FILE *file = fopen(out, "wb");
kevansUnsubmitted
Done
Inline Actions

IIRC style(9) still doesn't allow declarations mid-block, it would need to be at the top of this function.

kevans: IIRC style(9) still doesn't allow declarations mid-block, it would need to be at the top of…
if (file == NULL) {
lua_pushnil(L);
lua_pushfstring(L, "Failed to open output file: %s", strerror(errno));
return 2;
}
FILE *fetch = fetchGet(u, "");
if (fetch == NULL) {
lua_pushnil(L);
lua_pushfstring(L, "Failed to read from URL: %s", strerror(errno));
return 2;
kevansUnsubmitted
Done
Inline Actions

Leaks file

kevans: Leaks `file`
}
int chunk_size = 4096;
kevansUnsubmitted
Done
Inline Actions

Ditto for these declarations; chunk_size I'd probably just make a #define since we're not going to be altering it

kevans: Ditto for these declarations; chunk_size I'd probably just make a `#define` since we're not…
char buf[chunk_size];
size_t bytes;
while ((bytes = fread(buf, 1, chunk_size, fetch)) > 0) {
if (fwrite(buf, 1, bytes, file) != bytes) {
lua_pushnil(L);
lua_pushfstring(L, "Failed to write to file: %s", strerror(errno));
fclose(file);
kevansUnsubmitted
Done
Inline Actions

Leaks fetch

kevans: Leaks `fetch`
dchAuthorUnsubmitted
Done
Inline Actions

If I fclose(fetch); here, this segfaults:

Lua 5.4.4 Copyright (C) 1994-2022 Lua.org, PUC-Rio

f.get_url("https://invalid.site/", "/tmp/i")

fish: Job 1, '/usr/libexec/flua $argv' terminated by signal SIGSEGV (Address boundary error)

(lldb) thr backtrace all
* thread #1, name = 'flua', stop reason = signal SIGSEGV
  * frame #0: 0x00001252697ad0f9
    frame #1: 0xffadb0abacff9a89
dch: If I `fclose(fetch);` here, this segfaults: Lua 5.4.4 Copyright (C) 1994-2022 Lua.org, PUC…
kevansUnsubmitted
Done
Inline Actions

The context for this one has changed, the comment was originally down in the error path in the loop. This branch looks fine

kevans: The context for this one has changed, the comment was originally down in the error path in the…
return 2;
}
}
fclose(fetch);
fclose(file);
fetchFreeURL(u);
lua_pushboolean(L, 1);
return 1;
}
static const struct
luaL_Reg fetchlib[] = {
{"parse_url", lfetch_parse_url},
{"get_url", lfetch_get_url},
{NULL, NULL}
};
int
luaopen_fetch(lua_State *L)
{
luaL_newlib(L, fetchlib);
return (1);
}