Skip to content

Commit

Permalink
Rename KeyValue -> StringKeyValue and MakeKeyValue -> KeyValue
Browse files Browse the repository at this point in the history 
Request now references state collection rather than copying them.

inline KeyValue eql function

Un-dry Request.State.parse. This is largely so that profiling is a bit cleaner.
  • Loading branch information
@karlseguin
karlseguin committed Sep 2, 2024
1 parent 2b97d1e commit c10334c
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 64 deletions.
2 changes: 1 addition & 1 deletion src/httpz.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ pub fn Server(comptime H: type) type {
}
self.handler.handle(&req, &res);
} else {
const dispatchable_action = self._router.route(req.method, req.url.path, &req.params);
const dispatchable_action = self._router.route(req.method, req.url.path, req.params);

var executor = Executor{
.index = 0,
Expand Down
12 changes: 6 additions & 6 deletions src/key_value.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const mem = std.mem;
const ascii = std.ascii;
const Allocator = std.mem.Allocator;

fn MakeKeyValue(K: type, V: type, equalFn: fn (lhs: K, rhs: K) bool) type {
fn KeyValue(K: type, V: type, equalFn: fn (lhs: K, rhs: K) callconv(.Inline) bool) type {
return struct {
len: usize,
keys: []K,
Expand Down Expand Up @@ -89,21 +89,21 @@ fn MakeKeyValue(K: type, V: type, equalFn: fn (lhs: K, rhs: K) bool) type {
};
}

fn strEql(lhs: []const u8, rhs: []const u8) bool {
inline fn strEql(lhs: []const u8, rhs: []const u8) bool {
return std.mem.eql(u8, lhs, rhs);
}

pub const KeyValue = MakeKeyValue([]const u8, []const u8, strEql);
pub const StringKeyValue = KeyValue([]const u8, []const u8, strEql);

const MultiForm = struct {
value: []const u8,
filename: ?[]const u8 = null,
};
pub const MultiFormKeyValue = MakeKeyValue([]const u8, MultiForm, strEql);
pub const MultiFormKeyValue = KeyValue([]const u8, MultiForm, strEql);

const t = @import("t.zig");
test "KeyValue: get" {
var kv = try KeyValue.init(t.allocator, 2);
var kv = try StringKeyValue.init(t.allocator, 2);
defer kv.deinit(t.allocator);

var key = "content-type".*;
Expand All @@ -118,7 +118,7 @@ test "KeyValue: get" {
}

test "KeyValue: ignores beyond max" {
var kv = try KeyValue.init(t.allocator, 2);
var kv = try StringKeyValue.init(t.allocator, 2);
defer kv.deinit(t.allocator);
var n1 = "content-length".*;
kv.add(&n1, "cl");
Expand Down
105 changes: 66 additions & 39 deletions src/request.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const Self = @This();
const Url = @import("url.zig").Url;
const HTTPConn = @import("worker.zig").HTTPConn;
const Params = @import("params.zig").Params;
const KeyValue = @import("key_value.zig").KeyValue;
const StringKeyValue = @import("key_value.zig").StringKeyValue;
const MultiFormKeyValue = @import("key_value.zig").MultiFormKeyValue;
const Config = @import("config.zig").Config.Request;

Expand All @@ -27,10 +27,10 @@ pub const Request = struct {

// Path params (extracted from the URL based on the route).
// Using req.param(NAME) is preferred.
params: Params,
params: *Params,

// The headers of the request. Using req.header(NAME) is preferred.
headers: KeyValue,
headers: *StringKeyValue,

// The request method.
method: http.Method,
Expand All @@ -46,16 +46,16 @@ pub const Request = struct {
qs_read: bool = false,

// The query string lookup.
qs: KeyValue,
qs: *StringKeyValue,

// cannot use an optional on fd, because it's pre-allocated so always exists
fd_read: bool = false,

// The formData lookup.
fd: KeyValue,
fd: *StringKeyValue,

// The multiFormData lookup.
mfd: MultiFormKeyValue,
mfd: *MultiFormKeyValue,

// Spare space we still have in our static buffer after parsing the request
// We can use this, if needed, for example to unescape querystring parameters
Expand All @@ -79,16 +79,16 @@ pub const Request = struct {
const state = &conn.req_state;
return .{
.arena = arena,
.qs = state.qs,
.fd = state.fd,
.mfd = state.mfd,
.qs = &state.qs,
.fd = &state.fd,
.mfd = &state.mfd,
.method = state.method.?,
.protocol = state.protocol.?,
.url = Url.parse(state.url.?),
.address = conn.address,
.route_data = null,
.params = state.params,
.headers = state.headers,
.params = &state.params,
.headers = &state.headers,
.body_buffer = state.body,
.body_len = state.body_len,
.spare = state.buf[state.pos..],
Expand Down Expand Up @@ -122,7 +122,7 @@ pub const Request = struct {
return self.params.get(name);
}

pub fn query(self: *Request) !KeyValue {
pub fn query(self: *Request) !*StringKeyValue {
if (self.qs_read) {
return self.qs;
}
Expand All @@ -147,14 +147,14 @@ pub const Request = struct {
}
}

pub fn formData(self: *Request) !KeyValue {
pub fn formData(self: *Request) !*StringKeyValue {
if (self.fd_read) {
return self.fd;
}
return self.parseFormData();
}

pub fn multiFormData(self: *Request) !MultiFormKeyValue {
pub fn multiFormData(self: *Request) !*MultiFormKeyValue {
if (self.fd_read) {
return self.mfd;
}
Expand All @@ -166,14 +166,14 @@ pub const Request = struct {
// there's a url-escaped component (a key or value), we need memory to store
// the un-escaped version. Ideally, we'd like to use our static buffer for this
// but, we might not have enough space.
fn parseQuery(self: *Request) !KeyValue {
fn parseQuery(self: *Request) !*StringKeyValue {
const raw = self.url.query;
if (raw.len == 0) {
self.qs_read = true;
return self.qs;
}

var qs = &self.qs;
var qs = self.qs;
var buf = self.spare;
const allocator = self.arena;

Expand Down Expand Up @@ -205,14 +205,14 @@ pub const Request = struct {
return self.qs;
}

fn parseFormData(self: *Request) !KeyValue {
fn parseFormData(self: *Request) !*StringKeyValue {
const b = self.body() orelse "";
if (b.len == 0) {
self.fd_read = true;
return self.fd;
}

var fd = &self.fd;
var fd = self.fd;
var buf = self.spare;
const allocator = self.arena;

Expand Down Expand Up @@ -245,7 +245,7 @@ pub const Request = struct {

fn parseMultiFormData(
self: *Request,
) !MultiFormKeyValue {
) !*MultiFormKeyValue {
const body_ = self.body() orelse "";
if (body_.len == 0) {
self.fd_read = true;
Expand Down Expand Up @@ -295,7 +295,7 @@ pub const Request = struct {
return error.InvalidMultiPartFormDataHeader;
};

var mfd = &self.mfd;
var mfd = self.mfd;
var entry_it = std.mem.splitSequence(u8, body_, boundary);

{
Expand Down Expand Up @@ -476,10 +476,10 @@ pub const State = struct {
len: usize,

// Lazy-loaded in request.query();
qs: KeyValue,
qs: StringKeyValue,

// Lazy-loaded in request.formData();
fd: KeyValue,
fd: StringKeyValue,

// Lazy-loaded in request.multiFormData();
mfd: MultiFormKeyValue,
Expand Down Expand Up @@ -508,7 +508,7 @@ pub const State = struct {
// is because once we finish parsing the headers, if there's no body, we'll
// signal the worker that we have a complete request and it can proceed to
// handle it. Thus, body == null or body_len == 0 doesn't mean anything.
headers: KeyValue,
headers: StringKeyValue,

// Our body. This be a slice pointing to` buf`, or be from the buffer_pool or
// be dynamically allocated.
Expand Down Expand Up @@ -538,11 +538,11 @@ pub const State = struct {
.buffer_pool = buffer_pool,
.max_body_size = config.max_body_size orelse 1_048_576,
.middlewares = std.StringHashMap(*anyopaque).init(arena),
.qs = try KeyValue.init(arena, config.max_query_count orelse 32),
.fd = try KeyValue.init(arena, config.max_form_count orelse 0),
.qs = try StringKeyValue.init(arena, config.max_query_count orelse 32),
.fd = try StringKeyValue.init(arena, config.max_form_count orelse 0),
.mfd = try MultiFormKeyValue.init(arena, config.max_multiform_count orelse 0),
.buf = try arena.alloc(u8, config.buffer_size orelse 4_096),
.headers = try KeyValue.init(arena, config.max_header_count orelse 32),
.headers = try StringKeyValue.init(arena, config.max_header_count orelse 32),
.params = try Params.init(arena, config.max_param_count orelse 10),
};
}
Expand Down Expand Up @@ -594,24 +594,53 @@ pub const State = struct {
len = len + n;
self.len = len;

// When https://github.com/ziglang/zig/issues/8220 lands, we can probably
// DRY this up.
if (self.method == null) {
if (try self.parseMethod(req_arena, buf[0..len])) return true;
if (try self.parseMethod(buf[0..len]) == false) {
return false;
}
if (try self.parseUrl(buf[self.pos..len]) == false) {
return false;
}
if (try self.parseProtocol(buf[self.pos..len]) == false) {
return false;
}
if (try self.parseHeaders(req_arena, buf[self.pos..len]) == true) {
return true;
}
} else if (self.url == null) {
if (try self.parseUrl(req_arena, buf[self.pos..len])) return true;
if (try self.parseUrl(buf[self.pos..len]) == false) {
return false;
}
if (try self.parseProtocol(buf[self.pos..len]) == false) {
return false;
}
if (try self.parseHeaders(req_arena, buf[self.pos..len]) == true) {
return true;
}
} else if (self.protocol == null) {
if (try self.parseProtocol(req_arena, buf[self.pos..len])) return true;
if (try self.parseProtocol(buf[self.pos..len]) == false) {
return false;
}
if (try self.parseHeaders(req_arena, buf[self.pos..len]) == true) {
return true;
}
} else {
if (try self.parseHeaders(req_arena, buf[self.pos..len])) return true;
if (try self.parseHeaders(req_arena, buf[self.pos..len]) == true) {
return true;
}
}

if (self.body == null and len == buf.len) {
metrics.headerTooBig();
return error.HeaderTooBig;
}

return false;
}

fn parseMethod(self: *State, req_arena: Allocator, buf: []u8) !bool {
fn parseMethod(self: *State, buf: []u8) !bool {
const buf_len = buf.len;

// Shortest method is only 3 characters (+1 trailing space), so
Expand Down Expand Up @@ -662,11 +691,10 @@ pub const State = struct {
},
else => return error.UnknownMethod,
}

return try self.parseUrl(req_arena, buf[self.pos..]);
return true;
}

fn parseUrl(self: *State, req_arena: Allocator, buf: []u8) !bool {
fn parseUrl(self: *State, buf: []u8) !bool {
const buf_len = buf.len;
if (buf_len == 0) return false;

Expand All @@ -692,12 +720,11 @@ pub const State = struct {
}

self.pos += len;
return self.parseProtocol(req_arena, buf[len..]);
return true;
}

fn parseProtocol(self: *State, req_arena: Allocator, buf: []u8) !bool {
const buf_len = buf.len;
if (buf_len < 10) return false;
fn parseProtocol(self: *State, buf: []u8) !bool {
if (buf.len < 10) return false;

if (@as(u32, @bitCast(buf[0..4].*)) != asUint("HTTP")) {
return error.UnknownProtocol;
Expand All @@ -714,7 +741,7 @@ pub const State = struct {
}

self.pos += 10;
return try self.parseHeaders(req_arena, buf[10..]);
return true;
}

fn parseHeaders(self: *State, req_arena: Allocator, full: []u8) !bool {
Expand Down
8 changes: 4 additions & 4 deletions src/response.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ const httpz = @import("httpz.zig");
const buffer = @import("buffer.zig");

const HTTPConn = @import("worker.zig").HTTPConn;
const KeyValue = @import("key_value.zig").KeyValue;
const Config = @import("config.zig").Config.Response;
const StringKeyValue = @import("key_value.zig").StringKeyValue;

const mem = std.mem;
const Stream = std.net.Stream;
Expand All @@ -28,7 +28,7 @@ pub const Response = struct {

// The response headers.
// Using res.header(NAME, VALUE) is preferred.
headers: KeyValue,
headers: StringKeyValue,

// The content type. Use header("content-type", value) for a content type
// which isn't available in the httpz.ContentType enum.
Expand Down Expand Up @@ -427,10 +427,10 @@ fn writeAllIOVec(conn: *HTTPConn, vec: []std.posix.iovec_const) !void {
// to request.
pub const State = struct {
// re-used from request to request, exposed in via res.header(name, value
headers: KeyValue,
headers: StringKeyValue,

pub fn init(allocator: Allocator, config: *const Config) !Response.State {
var headers = try KeyValue.init(allocator, config.max_header_count orelse 16);
var headers = try StringKeyValue.init(allocator, config.max_header_count orelse 16);
errdefer headers.deinit(allocator);

return .{
Expand Down
2 changes: 1 addition & 1 deletion src/testing.zig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ pub const Testing = struct {
// This is ugly, but the Param structure is optimized for how the router
// works, so we don't have a clean API for setting 1 key=value pair. We'll
// just dig into the internals instead
var p = &self.req.params;
var p = self.req.params;
p.names[p.len] = name;
p.values[p.len] = value;
p.len += 1;
Expand Down
Loading

0 comments on commit c10334c

Please sign in to comment.