… | |
… | |
12 | |
12 | |
13 | (Note that in this manual, "thread" refers to real threads as implemented |
13 | (Note that in this manual, "thread" refers to real threads as implemented |
14 | by the Coro module, not to the built-in windows process emulation which |
14 | by the Coro module, not to the built-in windows process emulation which |
15 | unfortunately is also called "threads") |
15 | unfortunately is also called "threads") |
16 | |
16 | |
17 | This module "patches" DBD::mysql database handles so that they do not |
17 | This module replaces the I/O handlers for a database connection, with the |
18 | block the whole process, but only the thread that they are used in. |
18 | effect that "patched" database handles no longer block the all threads of |
|
|
19 | a process, but only the thread that does the request. |
19 | |
20 | |
20 | This can be used to make parallel sql requests using Coro, or to do other |
21 | This can be used to make parallel sql requests using Coro, or to do other |
21 | stuff while mysql is rumbling in the background. |
22 | stuff while mysql is rumbling in the background. |
22 | |
23 | |
23 | =head2 CAVEAT |
24 | =head2 CAVEAT |
24 | |
25 | |
25 | Note that this module must be linked against exactly the same (shared, |
26 | Note that this module must be linked against exactly the same (shared, |
26 | possibly not working with all OSes) F<libmysqlclient> library as |
27 | possibly not working with all OSes) F<libmysqlclient> library as |
27 | DBD::mysql, otherwise it will not work. |
28 | DBD::mysql, otherwise it will not work. |
28 | |
29 | |
|
|
30 | Also, this module requires a header file that apparently isn't installed |
|
|
31 | everywhere (F<violite.h>), and therefore comes with it's own copy, which |
|
|
32 | might or might not be compatible to the F<violite.h> of your library - |
|
|
33 | when in doubt, make sure all the libmysqlclient header files are installed |
|
|
34 | and delete the F<violite.h> header that comes with this module. |
|
|
35 | |
|
|
36 | On the good side, this module does a multitude of checks to ensure that |
|
|
37 | the libray versions match on the binary level, so on incompatibilities you |
|
|
38 | should expect an exception when trying to unblock a handle, rather than |
|
|
39 | data corruption. |
|
|
40 | |
29 | Also, while this module makes database handles non-blocking, you still |
41 | Also, while this module makes database handles non-blocking, you still |
30 | cannot run multiple requests in parallel on the same database handle. If |
42 | cannot run multiple requests in parallel on the same database handle. If |
31 | you want to run multiple queries in parallel, you have to create multiple |
43 | you want to run multiple queries in parallel, you have to create multiple |
32 | database connections, one for each thread that runs queries. Not doing so |
44 | database connections, one for each thread that runs queries. Not doing |
33 | can corrupt your data - use a Coro::Semaphore when in doubt. |
45 | so can corrupt your data - use a Coro::Semaphore to protetc access to a |
|
|
46 | shared database handle when in doubt. |
34 | |
47 | |
35 | If you make sure that you never run two or more requests in parallel, you |
48 | If you make sure that you never run two or more requests in parallel, you |
36 | can freely share the database handles between threads, of course. |
49 | can freely share the database handles between threads, of course. |
37 | |
50 | |
38 | Also, this module uses a number of "unclean" techniques (patching an |
|
|
39 | internal libmysql structure for one thing) and was hacked within a few |
|
|
40 | hours on a long flight to Malaysia. |
|
|
41 | |
|
|
42 | It does, however, check whether it indeed got the structure layout |
|
|
43 | correct, so you should expect perl exceptions or early crashes as opposed |
|
|
44 | to data corruption when something goes wrong during patching. |
|
|
45 | |
|
|
46 | =head2 SPEED |
51 | =head2 SPEED |
47 | |
52 | |
48 | This module is implemented in XS, and as long as mysqld replies quickly |
53 | This module is implemented in XS, and as long as mysqld replies quickly |
49 | enough, it adds no overhead to the standard libmysql communication |
54 | enough, it adds no overhead to the standard libmysql communication |
50 | routines (which are very badly written, btw.). |
55 | routines (which are very badly written, btw.). In fact, since it has a |
|
|
56 | more efficient buffering and allows requests to run in parallel, it often |
|
|
57 | decreases the actual time to run many queries considerably. |
51 | |
58 | |
52 | For very fast queries ("select 0"), this module can add noticable overhead |
59 | For very fast queries ("select 0"), this module can add noticable overhead |
53 | (around 15%) as it tries to switch to other coroutines when mysqld doesn't |
60 | (around 15%, 7% when EV can be used) as it tries to switch to other |
54 | deliver the data instantly. |
61 | coroutines when mysqld doesn't deliver the data immediately, although, |
|
|
62 | again, when running queries in parallel, they will usually execute faster. |
55 | |
63 | |
56 | For most types of queries, there will be no overhead, especially on |
64 | For most types of queries, there will be no extra latency, especially on |
57 | multicore systems where your perl process can do other things while mysqld |
65 | multicore systems where your perl process can do other things while mysqld |
58 | does its stuff. |
66 | does its stuff. |
59 | |
67 | |
60 | =head2 LIMITATIONS |
68 | =head2 LIMITATIONS |
61 | |
69 | |
62 | This module only supports "standard" mysql connection handles - this |
70 | This module only supports "standard" mysql connection handles - this |
63 | means unix domain or TCP sockets, and excludes SSL/TLS connections, named |
71 | means unix domain or TCP sockets, and excludes SSL/TLS connections, named |
64 | pipes (windows) and shared memory (also windows). No support for these |
72 | pipes (windows) and shared memory (also windows). No support for these |
65 | connection types is planned, either. |
73 | connection types is planned, either. |
66 | |
74 | |
|
|
75 | =head1 CANCELLATION |
|
|
76 | |
|
|
77 | Cancelling a thread that is within a mysql query will likely make the |
|
|
78 | handle unusable. As far as Coro::Mysql is concerned, the handle can be |
|
|
79 | safely destroyed, but it's not clear how mysql itself will react to a |
|
|
80 | cancellation. |
|
|
81 | |
67 | =head1 FUNCTIONS |
82 | =head1 FUNCTIONS |
68 | |
83 | |
69 | Coro::Mysql offers a single user-accessible function: |
84 | Coro::Mysql offers a single user-accessible function: |
70 | |
85 | |
71 | =over 4 |
86 | =over 4 |
… | |
… | |
79 | |
94 | |
80 | use Scalar::Util (); |
95 | use Scalar::Util (); |
81 | use Carp qw(croak); |
96 | use Carp qw(croak); |
82 | |
97 | |
83 | use Guard; |
98 | use Guard; |
|
|
99 | use AnyEvent (); |
84 | use Coro::Handle (); |
100 | use Coro (); |
|
|
101 | use Coro::AnyEvent (); # not necessary with newer Coro versions |
85 | |
102 | |
86 | # we need this extra indirection, as Coro doesn't support |
103 | # we need this extra indirection, as Coro doesn't support |
87 | # calling SLF-like functions via call_sv. |
104 | # calling SLF-like functions via call_sv. |
88 | |
105 | |
89 | sub readable { &Coro::Handle::FH::readable } |
106 | sub readable { &Coro::Handle::FH::readable } |
90 | sub writable { &Coro::Handle::FH::writable } |
107 | sub writable { &Coro::Handle::FH::writable } |
91 | |
108 | |
92 | BEGIN { |
109 | BEGIN { |
93 | our $VERSION = '1.02'; |
110 | our $VERSION = '1.21'; |
94 | |
111 | |
95 | require XSLoader; |
112 | require XSLoader; |
96 | XSLoader::load Coro::Mysql::, $VERSION; |
113 | XSLoader::load Coro::Mysql::, $VERSION; |
97 | } |
114 | } |
98 | |
115 | |
… | |
… | |
107 | It is safe to call this function on any database handle (or just about any |
124 | It is safe to call this function on any database handle (or just about any |
108 | value), but it will only do anything to L<DBD::mysql> handles, others are |
125 | value), but it will only do anything to L<DBD::mysql> handles, others are |
109 | returned unchanged. That means it is harmless when applied to database |
126 | returned unchanged. That means it is harmless when applied to database |
110 | handles of other databases. |
127 | handles of other databases. |
111 | |
128 | |
|
|
129 | It is also safe to pass C<undef>, so code like this is works as expected: |
|
|
130 | |
|
|
131 | my $dbh = DBI->connect ($database, $user, $pass)->Coro::Mysql::unblock |
|
|
132 | or die $DBI::errstr; |
|
|
133 | |
112 | =cut |
134 | =cut |
113 | |
135 | |
114 | sub unblock { |
136 | sub unblock { |
115 | my ($DBH) = @_; |
137 | my ($DBH) = @_; |
116 | |
138 | |
117 | if ($DBH->{Driver}{Name} eq "mysql") { |
139 | if ($DBH && $DBH->{Driver}{Name} eq "mysql") { |
118 | my $sock = $DBH->{sock}; |
140 | my $sock = $DBH->{sock}; |
119 | |
141 | |
120 | open my $fh, "+>&" . $DBH->{sockfd} |
142 | open my $fh, "+>&" . $DBH->{sockfd} |
121 | or croak "Coro::Mysql unable to clone mysql fd"; |
143 | or croak "Coro::Mysql unable to clone mysql fd"; |
122 | |
144 | |
|
|
145 | if (AnyEvent::detect ne "AnyEvent::Impl::EV" || !_use_ev) { |
|
|
146 | require Coro::Handle; |
123 | $fh = Coro::Handle::unblock $fh; |
147 | $fh = Coro::Handle::unblock ($fh); |
|
|
148 | } |
124 | |
149 | |
125 | _patch $sock, $DBH->{sockfd}, $fh, tied ${$fh}; |
150 | _patch $sock, $DBH->{sockfd}, $DBH->{mysql_clientversion}, $fh, tied ${$fh}; |
126 | } |
151 | } |
127 | |
152 | |
128 | $DBH |
153 | $DBH |
129 | } |
154 | } |
130 | |
155 | |
… | |
… | |
145 | use PApp::SQL; |
170 | use PApp::SQL; |
146 | |
171 | |
147 | sub with_db($$$&) { |
172 | sub with_db($$$&) { |
148 | my ($database, $user, $pass, $cb) = @_; |
173 | my ($database, $user, $pass, $cb) = @_; |
149 | |
174 | |
150 | my $dbh = Coro::Mysql::unblock DBI->connect ($database, $user, $pass) |
175 | my $dbh = DBI->connect ($database, $user, $pass)->Coro::Mysql::unblock |
151 | or die $DBI::errstr; |
176 | or die $DBI::errstr; |
152 | |
177 | |
153 | Coro::on_enter { $PApp::SQL::DBH = $dbh }; |
178 | Coro::on_enter { $PApp::SQL::DBH = $dbh }; |
154 | |
179 | |
155 | $cb->(); |
180 | $cb->(); |
… | |
… | |
180 | |
205 | |
181 | =head1 SEE ALSO |
206 | =head1 SEE ALSO |
182 | |
207 | |
183 | L<Coro>, L<PApp::SQL> (a user friendly but efficient wrapper around DBI). |
208 | L<Coro>, L<PApp::SQL> (a user friendly but efficient wrapper around DBI). |
184 | |
209 | |
|
|
210 | =head1 HISTORY |
|
|
211 | |
|
|
212 | This module was initially hacked together within a few hours on a long |
|
|
213 | flight to Malaysia, and seems to have worked ever since, with minor |
|
|
214 | adjustments for newer libmysqlclient libraries. |
|
|
215 | |
185 | =head1 AUTHOR |
216 | =head1 AUTHOR |
186 | |
217 | |
187 | Marc Lehmann <schmorp@schmorp.de> |
218 | Marc Lehmann <schmorp@schmorp.de> |
188 | http://home.schmorp.de/ |
219 | http://home.schmorp.de/ |
189 | |
220 | |